chore(docs): Generated API Reference (v2) (#8155)

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>

www/utils/generated/oas-output/schemas/AdminCollection.ts

@@ -3,6 +3,14 @@
  * type: object
  * description: The parent's collection.
  * x-schemaName: AdminCollection
+ * required:
+ *   - id
+ *   - title
+ *   - handle
+ *   - created_at
+ *   - updated_at
+ *   - deleted_at
+ *   - metadata
  * properties:
  *   id:
  *     type: string

www/utils/generated/oas-output/schemas/AdminCreatePricePreference.ts

@@ -0,0 +1,21 @@
+/**
+ * @schema AdminCreatePricePreference
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: AdminCreatePricePreference
+ * properties:
+ *   attribute:
+ *     type: string
+ *     title: attribute
+ *     description: The price preference's attribute.
+ *   value:
+ *     type: string
+ *     title: value
+ *     description: The price preference's value.
+ *   is_tax_inclusive:
+ *     type: boolean
+ *     title: is_tax_inclusive
+ *     description: The price preference's is tax inclusive.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/AdminCreateProductVariantPrice.ts

@@ -23,6 +23,9 @@
  *     type: number
  *     title: max_quantity
  *     description: The price's max quantity.
+ *   rules:
+ *     type: object
+ *     description: The price's rules.
  * 
 */
 

www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts

@@ -41,10 +41,9 @@
  *         title: name
  *         description: The default tax rate's name.
  *       is_combinable:
- *         type: string
- *         enum:
- *           - "true"
- *           - "false"
+ *         type: boolean
+ *         title: is_combinable
+ *         description: The default tax rate's is combinable.
  *       metadata:
  *         type: object
  *         description: The default tax rate's metadata.

www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts

@@ -22,7 +22,6 @@
  *         - id
  *         - quantity
  *         - reason_id
- *         - note
  *       properties:
  *         id:
  *           type: string

www/utils/generated/oas-output/schemas/AdminPostReturnsConfirmRequestReqSchema.ts

@@ -0,0 +1,13 @@
+/**
+ * @schema AdminPostReturnsConfirmRequestReqSchema
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: AdminPostReturnsConfirmRequestReqSchema
+ * properties:
+ *   no_notification:
+ *     type: boolean
+ *     title: no_notification
+ *     description: The return's no notification.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts

@@ -5,73 +5,31 @@
  * x-schemaName: AdminPostReturnsReqSchema
  * required:
  *   - order_id
- *   - items
- *   - return_shipping
- *   - internal_note
- *   - location_id
+ *   - metadata
  * properties:
  *   order_id:
  *     type: string
  *     title: order_id
  *     description: The return's order id.
- *   items:
- *     type: array
- *     description: The return's items.
- *     items:
- *       type: object
- *       description: The item's items.
- *       required:
- *         - id
- *         - quantity
- *         - reason_id
- *         - note
- *       properties:
- *         id:
- *           type: string
- *           title: id
- *           description: The item's ID.
- *         quantity:
- *           type: number
- *           title: quantity
- *           description: The item's quantity.
- *         reason_id:
- *           type: string
- *           title: reason_id
- *           description: The item's reason id.
- *         note:
- *           type: string
- *           title: note
- *           description: The item's note.
- *   return_shipping:
- *     type: object
- *     description: The return's return shipping.
- *     required:
- *       - option_id
- *     properties:
- *       option_id:
- *         type: string
- *         title: option_id
- *         description: The return shipping's option id.
- *       price:
- *         type: number
- *         title: price
- *         description: The return shipping's price.
- *   internal_note:
- *     type: string
- *     title: internal_note
- *     description: The return's internal note.
- *   receive_now:
- *     type: boolean
- *     title: receive_now
- *     description: The return's receive now.
- *   refund_amount:
- *     type: number
- *     title: refund_amount
- *     description: The return's refund amount.
  *   location_id:
  *     type: string
  *     title: location_id
  *     description: The return's location id.
+ *   description:
+ *     type: string
+ *     title: description
+ *     description: The return's description.
+ *   internal_note:
+ *     type: string
+ *     title: internal_note
+ *     description: The return's internal note.
+ *   no_notification:
+ *     type: boolean
+ *     title: no_notification
+ *     description: The return's no notification.
+ *   metadata:
+ *     type: object
+ *     description: The return's metadata.
  * 
 */
 

www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts

@@ -0,0 +1,17 @@
+/**
+ * @schema AdminPostReturnsRequestItemsActionReqSchema
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: AdminPostReturnsRequestItemsActionReqSchema
+ * properties:
+ *   quantity:
+ *     type: number
+ *     title: quantity
+ *     description: The return's quantity.
+ *   internal_note:
+ *     type: string
+ *     title: internal_note
+ *     description: The return's internal note.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts

@@ -0,0 +1,38 @@
+/**
+ * @schema AdminPostReturnsRequestItemsReqSchema
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: AdminPostReturnsRequestItemsReqSchema
+ * properties:
+ *   items:
+ *     type: array
+ *     description: The return's items.
+ *     items:
+ *       type: object
+ *       description: The item's items.
+ *       required:
+ *         - id
+ *         - quantity
+ *       properties:
+ *         id:
+ *           type: string
+ *           title: id
+ *           description: The item's ID.
+ *         quantity:
+ *           type: number
+ *           title: quantity
+ *           description: The item's quantity.
+ *         description:
+ *           type: string
+ *           title: description
+ *           description: The item's description.
+ *         internal_note:
+ *           type: string
+ *           title: internal_note
+ *           description: The item's internal note.
+ *         metadata:
+ *           type: object
+ *           description: The item's metadata.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts

@@ -0,0 +1,20 @@
+/**
+ * @schema AdminPostReturnsShippingActionReqSchema
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: AdminPostReturnsShippingActionReqSchema
+ * properties:
+ *   custom_price:
+ *     type: number
+ *     title: custom_price
+ *     description: The return's custom price.
+ *   internal_note:
+ *     type: string
+ *     title: internal_note
+ *     description: The return's internal note.
+ *   metadata:
+ *     type: object
+ *     description: The return's metadata.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts

@@ -0,0 +1,30 @@
+/**
+ * @schema AdminPostReturnsShippingReqSchema
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: AdminPostReturnsShippingReqSchema
+ * required:
+ *   - shipping_option_id
+ * properties:
+ *   shipping_option_id:
+ *     type: string
+ *     title: shipping_option_id
+ *     description: The return's shipping option id.
+ *   custom_price:
+ *     type: number
+ *     title: custom_price
+ *     description: The return's custom price.
+ *   description:
+ *     type: string
+ *     title: description
+ *     description: The return's description.
+ *   internal_note:
+ *     type: string
+ *     title: internal_note
+ *     description: The return's internal note.
+ *   metadata:
+ *     type: object
+ *     description: The return's metadata.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/AdminProduct.ts

@@ -27,7 +27,6 @@
  *   - is_giftcard
  *   - collection_id
  *   - type_id
- *   - tags
  *   - images
  *   - discountable
  *   - external_id
@@ -51,6 +50,11 @@
  *       $ref: "#/components/schemas/AdminProductVariant"
  *   type:
  *     $ref: "#/components/schemas/AdminProduct"
+ *   tags:
+ *     type: array
+ *     description: The parent's tags.
+ *     items:
+ *       $ref: "#/components/schemas/AdminProductTag"
  *   title:
  *     type: string
  *     title: title
@@ -149,11 +153,6 @@
  *     type: string
  *     title: type_id
  *     description: The parent's type id.
- *   tags:
- *     type: array
- *     description: The parent's tags.
- *     items:
- *       $ref: "#/components/schemas/BaseProductTag"
  *   images:
  *     type: array
  *     description: The parent's images.

www/utils/generated/oas-output/schemas/AdminProductTag.ts

@@ -0,0 +1,40 @@
+/**
+ * @schema AdminProductTag
+ * type: object
+ * description: The tag's tags.
+ * x-schemaName: AdminProductTag
+ * required:
+ *   - id
+ *   - value
+ *   - created_at
+ *   - updated_at
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The tag's ID.
+ *   value:
+ *     type: string
+ *     title: value
+ *     description: The tag's value.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The tag's created at.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The tag's updated at.
+ *   deleted_at:
+ *     type: string
+ *     format: date-time
+ *     title: deleted_at
+ *     description: The tag's deleted at.
+ *   metadata:
+ *     type: object
+ *     description: The tag's metadata.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/AdminProductVariant.ts

@@ -95,6 +95,10 @@
  *     type: number
  *     title: width
  *     description: The updated's width.
+ *   variant_rank:
+ *     type: number
+ *     title: variant_rank
+ *     description: The updated's variant rank.
  *   options:
  *     type: array
  *     description: The updated's options.
@@ -106,10 +110,8 @@
  *     type: string
  *     title: product_id
  *     description: The updated's product id.
- *   variant_rank:
- *     type: number
- *     title: variant_rank
- *     description: The updated's variant rank.
+ *   calculated_price:
+ *     $ref: "#/components/schemas/BaseCalculatedPriceSet"
  *   created_at:
  *     type: string
  *     format: date-time

www/utils/generated/oas-output/schemas/AdminUpdateCampaign.ts

@@ -23,6 +23,8 @@
  *   budget:
  *     type: object
  *     description: The campaign's budget.
+ *     required:
+ *       - limit
  *     properties:
  *       limit:
  *         type: number

www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts

@@ -4,7 +4,6 @@
  * description: SUMMARY
  * x-schemaName: AdminUpdateCustomerGroup
  * required:
- *   - name
  *   - metadata
  * properties:
  *   name:

www/utils/generated/oas-output/schemas/AdminUpdatePricePreference.ts

@@ -0,0 +1,21 @@
+/**
+ * @schema AdminUpdatePricePreference
+ * type: object
+ * description: SUMMARY
+ * x-schemaName: AdminUpdatePricePreference
+ * properties:
+ *   attribute:
+ *     type: string
+ *     title: attribute
+ *     description: The price preference's attribute.
+ *   value:
+ *     type: string
+ *     title: value
+ *     description: The price preference's value.
+ *   is_tax_inclusive:
+ *     type: boolean
+ *     title: is_tax_inclusive
+ *     description: The price preference's is tax inclusive.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/AdminUpdateStore.ts

@@ -4,7 +4,6 @@
  * description: SUMMARY
  * x-schemaName: AdminUpdateStore
  * required:
- *   - name
  *   - default_sales_channel_id
  *   - default_region_id
  *   - default_location_id
@@ -31,6 +30,10 @@
  *           type: boolean
  *           title: is_default
  *           description: The supported currency's is default.
+ *         is_tax_inclusive:
+ *           type: boolean
+ *           title: is_tax_inclusive
+ *           description: The supported currency's is tax inclusive.
  *   default_sales_channel_id:
  *     type: string
  *     title: default_sales_channel_id

www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts

@@ -4,6 +4,7 @@
  * description: SUMMARY
  * x-schemaName: AdminUpdateTaxRate
  * required:
+ *   - code
  *   - metadata
  * properties:
  *   rate:

www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts

@@ -0,0 +1,60 @@
+/**
+ * @schema BaseCalculatedPriceSet
+ * type: object
+ * description: The updated's calculated price.
+ * x-schemaName: BaseCalculatedPriceSet
+ * required:
+ *   - id
+ *   - calculated_amount
+ *   - original_amount
+ *   - currency_code
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The calculated price's ID.
+ *   is_calculated_price_price_list:
+ *     type: boolean
+ *     title: is_calculated_price_price_list
+ *     description: The calculated price's is calculated price price list.
+ *   is_calculated_price_tax_inclusive:
+ *     type: boolean
+ *     title: is_calculated_price_tax_inclusive
+ *     description: The calculated price's is calculated price tax inclusive.
+ *   calculated_amount:
+ *     type: number
+ *     title: calculated_amount
+ *     description: The calculated price's calculated amount.
+ *   calculated_amount_with_tax:
+ *     type: number
+ *     title: calculated_amount_with_tax
+ *     description: The calculated price's calculated amount with tax.
+ *   calculated_amount_without_tax:
+ *     type: number
+ *     title: calculated_amount_without_tax
+ *     description: The calculated price's calculated amount without tax.
+ *   is_original_price_price_list:
+ *     type: boolean
+ *     title: is_original_price_price_list
+ *     description: The calculated price's is original price price list.
+ *   is_original_price_tax_inclusive:
+ *     type: boolean
+ *     title: is_original_price_tax_inclusive
+ *     description: The calculated price's is original price tax inclusive.
+ *   original_amount:
+ *     type: number
+ *     title: original_amount
+ *     description: The calculated price's original amount.
+ *   currency_code:
+ *     type: string
+ *     title: currency_code
+ *     description: The calculated price's currency code.
+ *   calculated_price:
+ *     type: object
+ *     description: The calculated price's details.
+ *   original_price:
+ *     type: object
+ *     description: The calculated price's original price.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/BaseProduct.ts

@@ -22,7 +22,6 @@
  *   - material
  *   - collection_id
  *   - type_id
- *   - tags
  *   - variants
  *   - options
  *   - images

www/utils/generated/oas-output/schemas/StoreProduct.ts

@@ -27,7 +27,6 @@
  *   - is_giftcard
  *   - collection_id
  *   - type_id
- *   - tags
  *   - images
  *   - discountable
  *   - external_id