chore(docs): Generated OAS (#6752)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and GitHub committed 2024-03-20 11:30:24 +01:00
1 parent 95738804cd
commit 53653f5266
198 files changed
+8998 -331

No files matched your search

@@ -0,0 +1,9 @@
/**
* @schema AdminDeletePricingRuleTypesRuleTypeReq
* type: object
* description: SUMMARY
* x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq
* properties: {}
*
*/
@@ -0,0 +1,36 @@
/**
* @schema AdminGetPricingRuleTypesParams
* type: object
* description: SUMMARY
* x-schemaName: AdminGetPricingRuleTypesParams
* properties:
* rule_attribute:
* type: array
* description: The pricing's rule attribute.
* items:
* type: string
* title: rule_attribute
* description: The rule attribute's details.
* expand:
* type: string
* title: expand
* description: The pricing's expand.
* fields:
* type: string
* title: fields
* description: The pricing's fields.
* offset:
* type: number
* title: offset
* description: The pricing's offset.
* limit:
* type: number
* title: limit
* description: The pricing's limit.
* order:
* type: string
* title: order
* description: The pricing's order.
*
*/
@@ -0,0 +1,17 @@
/**
* @schema AdminGetPricingRuleTypesRuleTypeParams
* type: object
* description: SUMMARY
* x-schemaName: AdminGetPricingRuleTypesRuleTypeParams
* properties:
* expand:
* type: string
* title: expand
* description: The pricing's expand.
* fields:
* type: string
* title: fields
* description: The pricing's fields.
*
*/
@@ -0,0 +1,723 @@
/**
* @schema AdminGetProductsParams
* type: object
* description: SUMMARY
* x-schemaName: AdminGetProductsParams
* properties:
* q:
* type: string
* title: q
* description: The product's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The product's ID.
* - type: array
* description: The product's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* status:
* type: array
* description: The product's status.
* items: {}
* title:
* type: string
* title: title
* description: The product's title.
* handle:
* type: string
* title: handle
* description: The product's handle.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The product's is giftcard.
* price_list_id:
* type: array
* description: The product's price list id.
* items:
* type: string
* title: price_list_id
* description: The price list id's details.
* collection_id:
* type: array
* description: The product's collection id.
* items:
* type: string
* title: collection_id
* description: The collection id's details.
* tags:
* type: array
* description: The product's tags.
* items:
* type: string
* title: tags
* description: The tag's tags.
* type_id:
* type: array
* description: The product's type id.
* items:
* type: string
* title: type_id
* description: The type id's details.
* variants:
* type: object
* description: The product's variants.
* properties: {}
* created_at: {}
* updated_at: {}
* deleted_at: {}
* $and:
* type: array
* description: The product's $and.
* items:
* type: object
* description: The $and's details.
* x-schemaName: AdminGetProductsParams
* properties:
* q:
* type: string
* title: q
* description: The $and's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The $and's ID.
* - type: array
* description: The $and's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* status:
* type: array
* description: The $and's status.
* items: {}
* title:
* type: string
* title: title
* description: The $and's title.
* handle:
* type: string
* title: handle
* description: The $and's handle.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The $and's is giftcard.
* price_list_id:
* type: array
* description: The $and's price list id.
* items:
* type: string
* title: price_list_id
* description: The price list id's details.
* collection_id:
* type: array
* description: The $and's collection id.
* items:
* type: string
* title: collection_id
* description: The collection id's details.
* tags:
* type: array
* description: The $and's tags.
* items:
* type: string
* title: tags
* description: The tag's tags.
* type_id:
* type: array
* description: The $and's type id.
* items:
* type: string
* title: type_id
* description: The type id's details.
* variants:
* type: object
* description: The $and's variants.
* properties: {}
* created_at: {}
* updated_at: {}
* deleted_at: {}
* $and:
* type: array
* description: The $and's details.
* items:
* type: object
* description: The $and's details.
* x-schemaName: AdminGetProductsParams
* properties:
* q:
* type: string
* title: q
* description: The $and's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The $and's ID.
* - type: array
* description: The $and's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* status:
* type: array
* description: The $and's status.
* items: {}
* title:
* type: string
* title: title
* description: The $and's title.
* handle:
* type: string
* title: handle
* description: The $and's handle.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The $and's is giftcard.
* price_list_id:
* type: array
* description: The $and's price list id.
* items:
* type: string
* title: price_list_id
* description: The price list id's details.
* collection_id:
* type: array
* description: The $and's collection id.
* items:
* type: string
* title: collection_id
* description: The collection id's details.
* tags:
* type: array
* description: The $and's tags.
* items:
* type: string
* title: tags
* description: The tag's tags.
* type_id:
* type: array
* description: The $and's type id.
* items:
* type: string
* title: type_id
* description: The type id's details.
* variants:
* type: object
* description: The $and's variants.
* properties: {}
* created_at: {}
* updated_at: {}
* deleted_at: {}
* $and:
* type: array
* description: The $and's details.
* items:
* type: object
* description: The $and's details.
* x-schemaName: AdminGetProductsParams
* properties: {}
* $or:
* type: array
* description: The $and's $or.
* items:
* type: object
* description: The $or's details.
* x-schemaName: AdminGetProductsParams
* properties: {}
* expand:
* type: string
* title: expand
* description: The $and's expand.
* fields:
* type: string
* title: fields
* description: The $and's fields.
* offset:
* type: number
* title: offset
* description: The $and's offset.
* limit:
* type: number
* title: limit
* description: The $and's limit.
* order:
* type: string
* title: order
* description: The $and's order.
* $or:
* type: array
* description: The $and's $or.
* items:
* type: object
* description: The $or's details.
* x-schemaName: AdminGetProductsParams
* properties:
* q:
* type: string
* title: q
* description: The $or's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The $or's ID.
* - type: array
* description: The $or's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* status:
* type: array
* description: The $or's status.
* items: {}
* title:
* type: string
* title: title
* description: The $or's title.
* handle:
* type: string
* title: handle
* description: The $or's handle.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The $or's is giftcard.
* price_list_id:
* type: array
* description: The $or's price list id.
* items:
* type: string
* title: price_list_id
* description: The price list id's details.
* collection_id:
* type: array
* description: The $or's collection id.
* items:
* type: string
* title: collection_id
* description: The collection id's details.
* tags:
* type: array
* description: The $or's tags.
* items:
* type: string
* title: tags
* description: The tag's tags.
* type_id:
* type: array
* description: The $or's type id.
* items:
* type: string
* title: type_id
* description: The type id's details.
* variants:
* type: object
* description: The $or's variants.
* properties: {}
* created_at: {}
* updated_at: {}
* deleted_at: {}
* $and:
* type: array
* description: The $or's $and.
* items:
* type: object
* description: The $and's details.
* x-schemaName: AdminGetProductsParams
* properties: {}
* $or:
* type: array
* description: The $or's details.
* items:
* type: object
* description: The $or's details.
* x-schemaName: AdminGetProductsParams
* properties: {}
* expand:
* type: string
* title: expand
* description: The $or's expand.
* fields:
* type: string
* title: fields
* description: The $or's fields.
* offset:
* type: number
* title: offset
* description: The $or's offset.
* limit:
* type: number
* title: limit
* description: The $or's limit.
* order:
* type: string
* title: order
* description: The $or's order.
* expand:
* type: string
* title: expand
* description: The $and's expand.
* fields:
* type: string
* title: fields
* description: The $and's fields.
* offset:
* type: number
* title: offset
* description: The $and's offset.
* limit:
* type: number
* title: limit
* description: The $and's limit.
* order:
* type: string
* title: order
* description: The $and's order.
* $or:
* type: array
* description: The product's $or.
* items:
* type: object
* description: The $or's details.
* x-schemaName: AdminGetProductsParams
* properties:
* q:
* type: string
* title: q
* description: The $or's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The $or's ID.
* - type: array
* description: The $or's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* status:
* type: array
* description: The $or's status.
* items: {}
* title:
* type: string
* title: title
* description: The $or's title.
* handle:
* type: string
* title: handle
* description: The $or's handle.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The $or's is giftcard.
* price_list_id:
* type: array
* description: The $or's price list id.
* items:
* type: string
* title: price_list_id
* description: The price list id's details.
* collection_id:
* type: array
* description: The $or's collection id.
* items:
* type: string
* title: collection_id
* description: The collection id's details.
* tags:
* type: array
* description: The $or's tags.
* items:
* type: string
* title: tags
* description: The tag's tags.
* type_id:
* type: array
* description: The $or's type id.
* items:
* type: string
* title: type_id
* description: The type id's details.
* variants:
* type: object
* description: The $or's variants.
* properties: {}
* created_at: {}
* updated_at: {}
* deleted_at: {}
* $and:
* type: array
* description: The $or's $and.
* items:
* type: object
* description: The $and's details.
* x-schemaName: AdminGetProductsParams
* properties:
* q:
* type: string
* title: q
* description: The $and's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The $and's ID.
* - type: array
* description: The $and's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* status:
* type: array
* description: The $and's status.
* items: {}
* title:
* type: string
* title: title
* description: The $and's title.
* handle:
* type: string
* title: handle
* description: The $and's handle.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The $and's is giftcard.
* price_list_id:
* type: array
* description: The $and's price list id.
* items:
* type: string
* title: price_list_id
* description: The price list id's details.
* collection_id:
* type: array
* description: The $and's collection id.
* items:
* type: string
* title: collection_id
* description: The collection id's details.
* tags:
* type: array
* description: The $and's tags.
* items:
* type: string
* title: tags
* description: The tag's tags.
* type_id:
* type: array
* description: The $and's type id.
* items:
* type: string
* title: type_id
* description: The type id's details.
* variants:
* type: object
* description: The $and's variants.
* properties: {}
* created_at: {}
* updated_at: {}
* deleted_at: {}
* $and:
* type: array
* description: The $and's details.
* items:
* type: object
* description: The $and's details.
* x-schemaName: AdminGetProductsParams
* properties: {}
* $or:
* type: array
* description: The $and's $or.
* items:
* type: object
* description: The $or's details.
* x-schemaName: AdminGetProductsParams
* properties: {}
* expand:
* type: string
* title: expand
* description: The $and's expand.
* fields:
* type: string
* title: fields
* description: The $and's fields.
* offset:
* type: number
* title: offset
* description: The $and's offset.
* limit:
* type: number
* title: limit
* description: The $and's limit.
* order:
* type: string
* title: order
* description: The $and's order.
* $or:
* type: array
* description: The $or's details.
* items:
* type: object
* description: The $or's details.
* x-schemaName: AdminGetProductsParams
* properties:
* q:
* type: string
* title: q
* description: The $or's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The $or's ID.
* - type: array
* description: The $or's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* status:
* type: array
* description: The $or's status.
* items: {}
* title:
* type: string
* title: title
* description: The $or's title.
* handle:
* type: string
* title: handle
* description: The $or's handle.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: The $or's is giftcard.
* price_list_id:
* type: array
* description: The $or's price list id.
* items:
* type: string
* title: price_list_id
* description: The price list id's details.
* collection_id:
* type: array
* description: The $or's collection id.
* items:
* type: string
* title: collection_id
* description: The collection id's details.
* tags:
* type: array
* description: The $or's tags.
* items:
* type: string
* title: tags
* description: The tag's tags.
* type_id:
* type: array
* description: The $or's type id.
* items:
* type: string
* title: type_id
* description: The type id's details.
* variants:
* type: object
* description: The $or's variants.
* properties: {}
* created_at: {}
* updated_at: {}
* deleted_at: {}
* $and:
* type: array
* description: The $or's $and.
* items:
* type: object
* description: The $and's details.
* x-schemaName: AdminGetProductsParams
* properties: {}
* $or:
* type: array
* description: The $or's details.
* items:
* type: object
* description: The $or's details.
* x-schemaName: AdminGetProductsParams
* properties: {}
* expand:
* type: string
* title: expand
* description: The $or's expand.
* fields:
* type: string
* title: fields
* description: The $or's fields.
* offset:
* type: number
* title: offset
* description: The $or's offset.
* limit:
* type: number
* title: limit
* description: The $or's limit.
* order:
* type: string
* title: order
* description: The $or's order.
* expand:
* type: string
* title: expand
* description: The $or's expand.
* fields:
* type: string
* title: fields
* description: The $or's fields.
* offset:
* type: number
* title: offset
* description: The $or's offset.
* limit:
* type: number
* title: limit
* description: The $or's limit.
* order:
* type: string
* title: order
* description: The $or's order.
* expand:
* type: string
* title: expand
* description: The product's expand.
* fields:
* type: string
* title: fields
* description: The product's fields.
* offset:
* type: number
* title: offset
* description: The product's offset.
* limit:
* type: number
* title: limit
* description: The product's limit.
* order:
* type: string
* title: order
* description: The product's order.
*
*/
@@ -0,0 +1,33 @@
/**
* @schema AdminGetPromotionsParams
* type: object
* description: SUMMARY
* x-schemaName: AdminGetPromotionsParams
* properties:
* code:
* type: string
* title: code
* description: The promotion's code.
* expand:
* type: string
* title: expand
* description: The promotion's expand.
* fields:
* type: string
* title: fields
* description: The promotion's fields.
* offset:
* type: number
* title: offset
* description: The promotion's offset.
* limit:
* type: number
* title: limit
* description: The promotion's limit.
* order:
* type: string
* title: order
* description: The promotion's order.
*
*/
@@ -0,0 +1,51 @@
/**
* @schema AdminPostCampaignsReq
* type: object
* description: The promotion's campaign.
* x-schemaName: AdminPostCampaignsReq
* required:
* - name
* properties:
* name:
* type: string
* title: name
* description: The campaign's name.
* campaign_identifier:
* type: string
* title: campaign_identifier
* description: The campaign's campaign identifier.
* description:
* type: string
* title: description
* description: The campaign's description.
* currency:
* type: string
* title: currency
* description: The campaign's currency.
* budget:
* $ref: "#/components/schemas/CampaignBudget"
* 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.
* promotions:
* type: array
* description: The campaign's promotions.
* items:
* type: object
* description: The promotion's promotions.
* x-schemaName: IdObject
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The promotion's ID.
*
*/
@@ -0,0 +1,25 @@
/**
* @schema AdminPostCustomerGroupsGroupCustomersBatchReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq
* required:
* - customer_ids
* properties:
* customer_ids:
* type: array
* description: The customer group's customer ids.
* items:
* type: object
* description: The customer id's customer ids.
* x-schemaName: CustomerGroupsBatchCustomer
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The customer id's ID.
*
*/
@@ -0,0 +1,39 @@
/**
* @schema AdminPostFulfillmentShippingOptionsRulesBatchAddReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchAddReq
* required:
* - rules
* properties:
* rules:
* type: array
* description: The fulfillment's rules.
* items:
* type: object
* description: The rule's rules.
* x-schemaName: FulfillmentRuleCreate
* required:
* - operator
* - attribute
* - value
* properties:
* operator: {}
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* value:
* oneOf:
* - type: string
* title: value
* description: The rule's value.
* - type: array
* description: The rule's value.
* items:
* type: string
* title: value
* description: The value's details.
*
*/
@@ -0,0 +1,18 @@
/**
* @schema AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq
* required:
* - rule_ids
* properties:
* rule_ids:
* type: array
* description: The fulfillment's rule ids.
* items:
* type: string
* title: rule_ids
* description: The rule id's rule ids.
*
*/
@@ -0,0 +1,24 @@
/**
* @schema AdminPostInventoryItemsItemLocationLevelsReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq
* required:
* - location_id
* - stocked_quantity
* properties:
* location_id:
* type: string
* title: location_id
* description: The inventory item's location id.
* stocked_quantity:
* type: number
* title: stocked_quantity
* description: The inventory item's stocked quantity.
* incoming_quantity:
* type: number
* title: incoming_quantity
* description: The inventory item's incoming quantity.
*
*/
@@ -0,0 +1,61 @@
/**
* @schema AdminPostInventoryItemsReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostInventoryItemsReq
* properties:
* sku:
* type: string
* title: sku
* description: The inventory item's sku.
* hs_code:
* type: string
* title: hs_code
* description: The inventory item's hs code.
* weight:
* type: number
* title: weight
* description: The inventory item's weight.
* length:
* type: number
* title: length
* description: The inventory item's length.
* height:
* type: number
* title: height
* description: The inventory item's height.
* width:
* type: number
* title: width
* description: The inventory item's width.
* origin_country:
* type: string
* title: origin_country
* description: The inventory item's origin country.
* mid_code:
* type: string
* title: mid_code
* description: The inventory item's mid code.
* material:
* type: string
* title: material
* description: The inventory item's material.
* title:
* type: string
* title: title
* description: The inventory item's title.
* description:
* type: string
* title: description
* description: The inventory item's description.
* thumbnail:
* type: string
* title: thumbnail
* description: The inventory item's thumbnail.
* metadata:
* type: object
* description: The inventory item's metadata.
* properties: {}
*
*/
@@ -0,0 +1,20 @@
/**
* @schema AdminPostInvitesInviteAcceptReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostInvitesInviteAcceptReq
* required:
* - first_name
* - last_name
* properties:
* first_name:
* type: string
* title: first_name
* description: The invite's first name.
* last_name:
* type: string
* title: last_name
* description: The invite's last name.
*
*/
@@ -0,0 +1,13 @@
/**
* @schema AdminPostPaymentsCapturesReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPaymentsCapturesReq
* properties:
* amount:
* type: number
* title: amount
* description: The payment's amount.
*
*/
@@ -0,0 +1,13 @@
/**
* @schema AdminPostPaymentsRefundsReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPaymentsRefundsReq
* properties:
* amount:
* type: number
* title: amount
* description: The payment's amount.
*
*/
@@ -0,0 +1,47 @@
/**
* @schema AdminPostPriceListsPriceListPricesBatchAddReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPriceListsPriceListPricesBatchAddReq
* required:
* - prices
* properties:
* prices:
* type: array
* description: The price list's prices.
* items:
* type: object
* description: The price's prices.
* x-schemaName: AdminPriceListPricesCreateReq
* required:
* - currency_code
* - amount
* - variant_id
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* amount:
* type: number
* title: amount
* description: The price's amount.
* variant_id:
* type: string
* title: variant_id
* description: The price's variant id.
* min_quantity:
* type: number
* title: min_quantity
* description: The price's min quantity.
* max_quantity:
* type: number
* title: max_quantity
* description: The price's max quantity.
* rules:
* type: object
* description: The price's rules.
* properties: {}
*
*/
@@ -0,0 +1,18 @@
/**
* @schema AdminPostPriceListsPriceListPricesBatchRemoveReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPriceListsPriceListPricesBatchRemoveReq
* required:
* - ids
* properties:
* ids:
* type: array
* description: The price list's ids.
* items:
* type: string
* title: ids
* description: The id's ids.
*
*/
@@ -0,0 +1,69 @@
/**
* @schema AdminPostPriceListsPriceListReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPriceListsPriceListReq
* required:
* - prices
* properties:
* title:
* type: string
* title: title
* description: The price list's title.
* description:
* type: string
* title: description
* description: The price list's description.
* starts_at:
* type: string
* title: starts_at
* description: The price list's starts at.
* ends_at:
* type: string
* title: ends_at
* description: The price list's ends at.
* status: {}
* type: {}
* prices:
* type: array
* description: The price list's prices.
* items:
* type: object
* description: The price's prices.
* x-schemaName: AdminPriceListPricesCreateReq
* required:
* - currency_code
* - amount
* - variant_id
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* amount:
* type: number
* title: amount
* description: The price's amount.
* variant_id:
* type: string
* title: variant_id
* description: The price's variant id.
* min_quantity:
* type: number
* title: min_quantity
* description: The price's min quantity.
* max_quantity:
* type: number
* title: max_quantity
* description: The price's max quantity.
* rules:
* type: object
* description: The price's rules.
* properties: {}
* rules:
* type: object
* description: The price list's rules.
* properties: {}
*
*/
@@ -0,0 +1,72 @@
/**
* @schema AdminPostPriceListsReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPriceListsReq
* required:
* - title
* - description
* - type
* - prices
* properties:
* title:
* type: string
* title: title
* description: The price list's title.
* description:
* type: string
* title: description
* description: The price list's description.
* starts_at:
* type: string
* title: starts_at
* description: The price list's starts at.
* ends_at:
* type: string
* title: ends_at
* description: The price list's ends at.
* status: {}
* type: {}
* prices:
* type: array
* description: The price list's prices.
* items:
* type: object
* description: The price's prices.
* x-schemaName: AdminPriceListPricesCreateReq
* required:
* - currency_code
* - amount
* - variant_id
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* amount:
* type: number
* title: amount
* description: The price's amount.
* variant_id:
* type: string
* title: variant_id
* description: The price's variant id.
* min_quantity:
* type: number
* title: min_quantity
* description: The price's min quantity.
* max_quantity:
* type: number
* title: max_quantity
* description: The price's max quantity.
* rules:
* type: object
* description: The price's rules.
* properties: {}
* rules:
* type: object
* description: The price list's rules.
* properties: {}
*
*/
@@ -0,0 +1,25 @@
/**
* @schema AdminPostPricingRuleTypesReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPricingRuleTypesReq
* required:
* - name
* - rule_attribute
* - default_priority
* properties:
* name:
* type: string
* title: name
* description: The pricing's name.
* rule_attribute:
* type: string
* title: rule_attribute
* description: The pricing's rule attribute.
* default_priority:
* type: number
* title: default_priority
* description: The pricing's default priority.
*
*/
@@ -0,0 +1,21 @@
/**
* @schema AdminPostPricingRuleTypesRuleTypeReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPricingRuleTypesRuleTypeReq
* properties:
* name:
* type: string
* title: name
* description: The pricing's name.
* rule_attribute:
* type: string
* title: rule_attribute
* description: The pricing's rule attribute.
* default_priority:
* type: number
* title: default_priority
* description: The pricing's default priority.
*
*/
@@ -0,0 +1,54 @@
/**
* @schema AdminPostPromotionsPromotionReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPromotionsPromotionReq
* properties:
* code:
* type: string
* title: code
* description: The promotion's code.
* is_automatic:
* type: boolean
* title: is_automatic
* description: The promotion's is automatic.
* type: {}
* campaign_id:
* type: string
* title: campaign_id
* description: The promotion's campaign id.
* campaign:
* $ref: "#/components/schemas/AdminPostCampaignsReq"
* application_method:
* $ref: "#/components/schemas/ApplicationMethodsMethodPostReq"
* rules:
* type: array
* description: The promotion's rules.
* items:
* type: object
* description: The rule's rules.
* x-schemaName: PromotionRule
* required:
* - operator
* - attribute
* - values
* properties:
* operator: {}
* description:
* type: string
* title: description
* description: The rule's description.
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* values:
* type: array
* description: The rule's values.
* items:
* type: string
* title: values
* description: The value's values.
*
*/
@@ -0,0 +1,39 @@
/**
* @schema AdminPostPromotionsPromotionRulesBatchAddReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPromotionsPromotionRulesBatchAddReq
* required:
* - rules
* properties:
* rules:
* type: array
* description: The promotion's rules.
* items:
* type: object
* description: The rule's rules.
* x-schemaName: PromotionRule
* required:
* - operator
* - attribute
* - values
* properties:
* operator: {}
* description:
* type: string
* title: description
* description: The rule's description.
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* values:
* type: array
* description: The rule's values.
* items:
* type: string
* title: values
* description: The value's values.
*
*/
@@ -0,0 +1,18 @@
/**
* @schema AdminPostPromotionsPromotionRulesBatchRemoveReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPromotionsPromotionRulesBatchRemoveReq
* required:
* - rule_ids
* properties:
* rule_ids:
* type: array
* description: The promotion's rule ids.
* items:
* type: string
* title: rule_ids
* description: The rule id's rule ids.
*
*/
@@ -0,0 +1,43 @@
/**
* @schema AdminPostPromotionsPromotionRulesBatchUpdateReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostPromotionsPromotionRulesBatchUpdateReq
* required:
* - rules
* properties:
* rules:
* type: array
* description: The promotion's rules.
* items:
* type: object
* description: The rule's rules.
* x-schemaName: UpdatePromotionRule
* required:
* - id
* - attribute
* - values
* properties:
* id:
* type: string
* title: id
* description: The rule's ID.
* operator: {}
* description:
* type: string
* title: description
* description: The rule's description.
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* values:
* type: array
* description: The rule's values.
* items:
* type: string
* title: values
* description: The value's values.
*
*/
@@ -0,0 +1,59 @@
/**
* @schema AdminPostTaxRatesReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostTaxRatesReq
* required:
* - name
* - tax_region_id
* properties:
* rate:
* type: number
* title: rate
* description: The tax rate's rate.
* code:
* type: string
* title: code
* description: The tax rate's code.
* rules:
* type: array
* description: The tax rate's rules.
* items:
* type: object
* description: The rule's rules.
* x-schemaName: CreateTaxRateRule
* required:
* - reference
* - reference_id
* properties:
* reference:
* type: string
* title: reference
* description: The rule's reference.
* reference_id:
* type: string
* title: reference_id
* description: The rule's reference id.
* name:
* type: string
* title: name
* description: The tax rate's name.
* is_default:
* type: boolean
* title: is_default
* description: The tax rate's is default.
* is_combinable:
* type: boolean
* title: is_combinable
* description: The tax rate's is combinable.
* tax_region_id:
* type: string
* title: tax_region_id
* description: The tax rate's tax region id.
* metadata:
* type: object
* description: The tax rate's metadata.
* properties: {}
*
*/
@@ -0,0 +1,46 @@
/**
* @schema AdminPostTaxRatesTaxRateReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostTaxRatesTaxRateReq
* properties:
* code:
* type: string
* title: code
* description: The tax rate's code.
* name:
* type: string
* title: name
* description: The tax rate's name.
* region_id:
* type: string
* title: region_id
* description: The tax rate's region id.
* rate:
* type: number
* title: rate
* description: The tax rate's rate.
* products:
* type: array
* description: The tax rate's products.
* items:
* type: string
* title: products
* description: The product's products.
* shipping_options:
* type: array
* description: The tax rate's shipping options.
* items:
* type: string
* title: shipping_options
* description: The shipping option's shipping options.
* product_types:
* type: array
* description: The tax rate's product types.
* items:
* type: string
* title: product_types
* description: The product type's product types.
*
*/
@@ -0,0 +1,20 @@
/**
* @schema AdminPostTaxRatesTaxRateRulesReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostTaxRatesTaxRateRulesReq
* required:
* - reference
* - reference_id
* properties:
* reference:
* type: string
* title: reference
* description: The tax rate's reference.
* reference_id:
* type: string
* title: reference_id
* description: The tax rate's reference id.
*
*/
@@ -0,0 +1,29 @@
/**
* @schema AdminPostTaxRegionsReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostTaxRegionsReq
* required:
* - country_code
* properties:
* country_code:
* type: string
* title: country_code
* description: The tax region's country code.
* province_code:
* type: string
* title: province_code
* description: The tax region's province code.
* parent_id:
* type: string
* title: parent_id
* description: The tax region's parent id.
* default_tax_rate:
* $ref: "#/components/schemas/CreateDefaultTaxRate"
* metadata:
* type: object
* description: The tax region's metadata.
* properties: {}
*
*/
@@ -0,0 +1,23 @@
/**
* @schema AdminPostWorkflowsAsyncResponseReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostWorkflowsAsyncResponseReq
* required:
* - transaction_id
* - step_id
* properties:
* transaction_id:
* type: string
* title: transaction_id
* description: The workflows execution's transaction id.
* step_id:
* type: string
* title: step_id
* description: The workflows execution's step id.
* response: {}
* compensate_input: {}
* action: {}
*
*/
@@ -0,0 +1,14 @@
/**
* @schema AdminPostWorkflowsRunReq
* type: object
* description: SUMMARY
* x-schemaName: AdminPostWorkflowsRunReq
* properties:
* input: {}
* transaction_id:
* type: string
* title: transaction_id
* description: The workflows execution's transaction id.
*
*/
@@ -0,0 +1,23 @@
/**
* @schema AdminUpdateUserRequest
* type: object
* description: SUMMARY
* x-schemaName: AdminUpdateUserRequest
* required:
* - avatar_url
* properties:
* first_name:
* type: string
* title: first_name
* description: The user's first name.
* last_name:
* type: string
* title: last_name
* description: The user's last name.
* avatar_url:
* type: string
* title: avatar_url
* description: The user's avatar url.
*
*/
@@ -0,0 +1,88 @@
/**
* @schema ApplicationMethodsMethodPostReq
* type: object
* description: The promotion's application method.
* x-schemaName: ApplicationMethodsMethodPostReq
* properties:
* description:
* type: string
* title: description
* description: The application method's description.
* value:
* type: string
* title: value
* description: The application method's value.
* max_quantity:
* type: number
* title: max_quantity
* description: The application method's max quantity.
* type: {}
* target_type: {}
* allocation: {}
* target_rules:
* type: array
* description: The application method's target rules.
* items:
* type: object
* description: The target rule's target rules.
* x-schemaName: PromotionRule
* required:
* - operator
* - attribute
* - values
* properties:
* operator: {}
* description:
* type: string
* title: description
* description: The target rule's description.
* attribute:
* type: string
* title: attribute
* description: The target rule's attribute.
* values:
* type: array
* description: The target rule's values.
* items:
* type: string
* title: values
* description: The value's values.
* buy_rules:
* type: array
* description: The application method's buy rules.
* items:
* type: object
* description: The buy rule's buy rules.
* x-schemaName: PromotionRule
* required:
* - operator
* - attribute
* - values
* properties:
* operator: {}
* description:
* type: string
* title: description
* description: The buy rule's description.
* attribute:
* type: string
* title: attribute
* description: The buy rule's attribute.
* values:
* type: array
* description: The buy rule's values.
* items:
* type: string
* title: values
* description: The value's values.
* apply_to_quantity:
* type: number
* title: apply_to_quantity
* description: The application method's apply to quantity.
* buy_rules_min_quantity:
* type: number
* title: buy_rules_min_quantity
* description: The application method's buy rules min quantity.
*
*/
@@ -0,0 +1,14 @@
/**
* @schema CampaignBudget
* type: object
* description: The campaign's budget.
* x-schemaName: CampaignBudget
* properties:
* type: {}
* limit:
* type: number
* title: limit
* description: The budget's limit.
*
*/
@@ -0,0 +1,27 @@
/**
* @schema CreateDefaultTaxRate
* type: object
* description: The tax region's default tax rate.
* x-schemaName: CreateDefaultTaxRate
* required:
* - name
* properties:
* rate:
* type: number
* title: rate
* description: The default tax rate's rate.
* code:
* type: string
* title: code
* description: The default tax rate's code.
* name:
* type: string
* title: name
* description: The default tax rate's name.
* metadata:
* type: object
* description: The default tax rate's metadata.
* properties: {}
*
*/
@@ -0,0 +1,9 @@
/**
* @schema StorePostCartsCartTaxesReq
* type: object
* description: SUMMARY
* x-schemaName: StorePostCartsCartTaxesReq
* properties: {}
*
*/
@@ -0,0 +1,20 @@
/**
* @schema StorePostPaymentCollectionsPaymentSessionReq
* type: object
* description: SUMMARY
* x-schemaName: StorePostPaymentCollectionsPaymentSessionReq
* required:
* - provider_id
* properties:
* provider_id:
* type: string
* title: provider_id
* description: The payment collection's provider id.
* context: {}
* data:
* type: object
* description: The payment collection's data.
* properties: {}
*
*/