Files
medusa-store/www/utils/generated/oas-output/schemas/CampaignResponse.ts
github-actions[bot] b23ddcdde8 chore(docs): Updated API Reference (v2) (#8609)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-08-15 14:31:35 +00:00

78 lines
1.7 KiB
TypeScript

/**
* @schema CampaignResponse
* type: object
* description: The campaign's details.
* x-schemaName: CampaignResponse
* required:
* - id
* - name
* - description
* - currency
* - campaign_identifier
* - starts_at
* - ends_at
* - budget
* properties:
* id:
* type: string
* title: id
* description: The campaign's ID.
* name:
* type: string
* title: name
* description: The campaign's name.
* description:
* type: string
* title: description
* description: The campaign's description.
* currency:
* type: string
* title: currency
* description: The campaign's currency.
* campaign_identifier:
* type: string
* title: campaign_identifier
* description: The campaign's campaign identifier.
* starts_at:
* type: string
* title: starts_at
* description: The campaign's starts at.
* ends_at:
* type: string
* title: ends_at
* description: The campaign's ends at.
* budget:
* type: object
* description: The campaign's budget.
* required:
* - id
* - type
* - currency_code
* - limit
* - used
* properties:
* id:
* type: string
* title: id
* description: The budget's ID.
* type:
* type: string
* enum:
* - spend
* - usage
* currency_code:
* type: string
* title: currency_code
* description: The budget's currency code.
* limit:
* type: number
* title: limit
* description: The budget's limit.
* used:
* type: number
* title: used
* description: The budget's used.
*
*/