asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

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

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andkodiakhq authored and GitHub committed 2024-08-30 08:35:10 +02:00
1 parent 891037081d
commit 524be62312
749 files changed
+9092 -52161
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/utils/generated/oas-output/schemas/AdminApiKey.ts
+65
View File
@@ -0,0 +1,65 @@
/**
* @schema AdminApiKey
* type: object
* description: The api key's details.
* x-schemaName: AdminApiKey
* required:
* - id
* - token
* - redacted
* - title
* - type
* - last_used_at
* - created_by
* - created_at
* - revoked_by
* - revoked_at
* properties:
* id:
* type: string
* title: id
* description: The api key's ID.
* token:
* type: string
* title: token
* description: The api key's token.
* redacted:
* type: string
* title: redacted
* description: The api key's redacted.
* title:
* type: string
* title: title
* description: The api key's title.
* type:
* type: string
* description: The api key's type.
* enum:
* - secret
* - publishable
* last_used_at:
* type: string
* title: last_used_at
* description: The api key's last used at.
* format: date-time
* created_by:
* type: string
* title: created_by
* description: The api key's created by.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The api key's created at.
* revoked_by:
* type: string
* title: revoked_by
* description: The api key's revoked by.
* revoked_at:
* type: string
* title: revoked_at
* description: The api key's revoked at.
* format: date-time
*
*/
www/utils/generated/oas-output/schemas/AdminApiKeyResponse.ts
+1 -1
View File
@@ -7,7 +7,7 @@
* - api_key
* properties:
* api_key:
* $ref: "#/components/schemas/ApiKeyResponse"
* $ref: "#/components/schemas/AdminApiKey"
*
*/
www/utils/generated/oas-output/schemas/AdminBatchProductResponse.ts
+3 -3
View File
@@ -20,7 +20,7 @@
* $ref: "#/components/schemas/AdminProduct"
* deleted:
* type: object
* description: The product's deleted.
* description: SUMMARY
* required:
* - ids
* - object
@@ -36,11 +36,11 @@
* object:
* type: string
* title: object
* description: The deleted's object.
* description: SUMMARY
* deleted:
* type: boolean
* title: deleted
* description: The deleted's details.
* description: SUMMARY
*
*/
www/utils/generated/oas-output/schemas/AdminBatchProductVariantResponse.ts
+3 -3
View File
@@ -20,7 +20,7 @@
* $ref: "#/components/schemas/AdminProductVariant"
* deleted:
* type: object
* description: The product's deleted.
* description: SUMMARY
* required:
* - ids
* - object
@@ -36,11 +36,11 @@
* object:
* type: string
* title: object
* description: The deleted's object.
* description: SUMMARY
* deleted:
* type: boolean
* title: deleted
* description: The deleted's details.
* description: SUMMARY
*
*/
www/utils/generated/oas-output/schemas/AdminCampaign.ts
+78
View File
@@ -0,0 +1,78 @@
/**
* @schema AdminCampaign
* type: object
* description: The campaign's details.
* x-schemaName: AdminCampaign
* 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
* description: The budget's type.
* 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.
*
*/
www/utils/generated/oas-output/schemas/AdminCampaignResponse.ts
+1 -1
View File
@@ -7,7 +7,7 @@
* - campaign
* properties:
* campaign:
* $ref: "#/components/schemas/CampaignResponse"
* $ref: "#/components/schemas/AdminCampaign"
*
*/
www/utils/generated/oas-output/schemas/AdminClaim.ts
+2
View File
@@ -115,6 +115,7 @@
* $ref: "#/components/schemas/BasePaymentCollection"
* payment_status:
* type: string
* description: The claim's payment status.
* enum:
* - canceled
* - not_paid
@@ -133,6 +134,7 @@
* $ref: "#/components/schemas/BaseOrderFulfillment"
* fulfillment_status:
* type: string
* description: The claim's fulfillment status.
* enum:
* - canceled
* - not_fulfilled
www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The claim's object.
* description: The name of the deleted object.
* default: claim
* deleted:
* type: boolean
* title: deleted
* description: The claim's deleted.
* description: Whether the Claim was deleted.
* parent:
* type: object
* description: The claim's parent.
www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The collection's object.
* description: The name of the deleted object.
* default: collection
* deleted:
* type: boolean
* title: deleted
* description: The collection's deleted.
* description: Whether the Collection was deleted.
* parent:
* type: object
* description: The collection's parent.
www/utils/generated/oas-output/schemas/AdminCreateApiKey.ts
+1
View File
@@ -13,6 +13,7 @@
* description: The api key's title.
* type:
* type: string
* description: The api key's type.
* enum:
* - publishable
* - secret
www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts
+2
View File
@@ -27,11 +27,13 @@
* description: The price list's ends at.
* status:
* type: string
* description: The price list's status.
* enum:
* - active
* - draft
* type:
* type: string
* description: The price list's type.
* enum:
* - sale
* - override
www/utils/generated/oas-output/schemas/AdminCreateProduct.ts
+1
View File
@@ -49,6 +49,7 @@
* description: The create's handle.
* status:
* type: string
* description: The create's status.
* enum:
* - draft
* - proposed
www/utils/generated/oas-output/schemas/AdminCreateWorkflowsAsyncResponse.ts
+1
View File
@@ -19,6 +19,7 @@
* compensate_input: {}
* action:
* type: string
* description: The workflows execution's action.
* enum:
* - invoke
* - compensate
www/utils/generated/oas-output/schemas/AdminExchange.ts
+2
View File
@@ -116,6 +116,7 @@
* $ref: "#/components/schemas/BasePaymentCollection"
* payment_status:
* type: string
* description: The exchange's payment status.
* enum:
* - canceled
* - not_paid
@@ -134,6 +135,7 @@
* $ref: "#/components/schemas/BaseOrderFulfillment"
* fulfillment_status:
* type: string
* description: The exchange's fulfillment status.
* enum:
* - canceled
* - not_fulfilled
www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The fulfillment set's object.
* description: The name of the deleted object.
* default: fulfillment_set
* deleted:
* type: boolean
* title: deleted
* description: The fulfillment set's deleted.
* description: Whether the Fulfillment Set was deleted.
* parent:
* type: object
* description: The fulfillment set's parent.
www/utils/generated/oas-output/schemas/AdminInvite.ts
+2 -2
View File
@@ -36,14 +36,14 @@
* description: The invite's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The invite's created at.
* format: date-time
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The invite's updated at.
* format: date-time
*
*/
www/utils/generated/oas-output/schemas/AdminOrder.ts
+2
View File
@@ -102,6 +102,7 @@
* $ref: "#/components/schemas/BaseOrderShippingMethod"
* payment_status:
* type: string
* description: The order's payment status.
* enum:
* - canceled
* - not_paid
@@ -115,6 +116,7 @@
* - requires_action
* fulfillment_status:
* type: string
* description: The order's fulfillment status.
* enum:
* - canceled
* - not_fulfilled
www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts
+16
View File
@@ -0,0 +1,16 @@
/**
* @schema AdminOrderChangesResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminOrderChangesResponse
* required:
* - order_changes
* properties:
* order_changes:
* type: array
* description: The order's order changes.
* items:
* $ref: "#/components/schemas/BaseOrderChange"
*
*/
www/utils/generated/oas-output/schemas/AdminOrderPreview.ts
+4 -2
View File
@@ -202,14 +202,14 @@
* $ref: "#/components/schemas/BaseOrderItemDetail"
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The item's created at.
* format: date-time
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The item's updated at.
* format: date-time
* metadata:
* type: object
* description: The item's metadata.
@@ -507,6 +507,7 @@
* $ref: "#/components/schemas/AdminPaymentCollection"
* payment_status:
* type: string
* description: The order preview's payment status.
* enum:
* - canceled
* - not_paid
@@ -525,6 +526,7 @@
* $ref: "#/components/schemas/BaseOrderFulfillment"
* fulfillment_status:
* type: string
* description: The order preview's fulfillment status.
* enum:
* - canceled
* - not_fulfilled
www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts
+1
View File
@@ -95,6 +95,7 @@
* description: The payment collection's metadata.
* status:
* type: string
* description: The payment collection's status.
* enum:
* - canceled
* - not_paid
www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts
+1
View File
@@ -24,6 +24,7 @@
* description: The item's quantity.
* reason:
* type: string
* description: The item's reason.
* enum:
* - missing_item
* - wrong_item
www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts
+1
View File
@@ -11,6 +11,7 @@
* properties:
* type:
* type: string
* description: The claim's type.
* enum:
* - refund
* - replace
www/utils/generated/oas-output/schemas/AdminPriceList.ts
+2
View File
@@ -42,11 +42,13 @@
* description: The price list's ends at.
* status:
* type: string
* description: The price list's status.
* enum:
* - draft
* - active
* type:
* type: string
* description: The price list's type.
* enum:
* - sale
* - override
www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts
+3 -3
View File
@@ -20,7 +20,7 @@
* $ref: "#/components/schemas/AdminPrice"
* deleted:
* type: object
* description: The price list's deleted.
* description: SUMMARY
* required:
* - ids
* - object
@@ -36,11 +36,11 @@
* object:
* type: string
* title: object
* description: The deleted's object.
* description: SUMMARY
* deleted:
* type: boolean
* title: deleted
* description: The deleted's details.
* description: SUMMARY
*
*/
www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The price list's object.
* description: The name of the deleted object.
* default: price_list
* deleted:
* type: boolean
* title: deleted
* description: The price list's deleted.
* description: Whether the Price List was deleted.
* parent:
* type: object
* description: The price list's parent.
www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The price preference's object.
* description: The name of the deleted object.
* default: price_preference
* deleted:
* type: boolean
* title: deleted
* description: The price preference's deleted.
* description: Whether the Price Preference was deleted.
* parent:
* type: object
* description: The price preference's parent.
www/utils/generated/oas-output/schemas/AdminProduct.ts
+2 -1
View File
@@ -49,7 +49,7 @@
* items:
* $ref: "#/components/schemas/AdminProductVariant"
* type:
* $ref: "#/components/schemas/AdminProduct"
* $ref: "#/components/schemas/AdminProductType"
* tags:
* type: array
* description: The parent's tags.
@@ -61,6 +61,7 @@
* description: The parent's title.
* status:
* type: string
* description: The parent's status.
* enum:
* - draft
* - proposed
www/utils/generated/oas-output/schemas/AdminProductCategory.ts
+3
View File
@@ -42,6 +42,9 @@
* type: string
* title: id
* description: The category's ID.
* metadata:
* type: object
* description: The category's metadata.
* created_at:
* type: string
* format: date-time
www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The product category's object.
* description: The name of the deleted object.
* default: product_category
* deleted:
* type: boolean
* title: deleted
* description: The product category's deleted.
* description: Whether the Product Category was deleted.
* parent:
* type: object
* description: The product category's parent.
www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The product's object.
* description: The name of the deleted object.
* default: product
* deleted:
* type: boolean
* title: deleted
* description: The product's deleted.
* description: Whether the Product was deleted.
* parent:
* type: object
* description: The product's parent.
www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The product's object.
* description: The name of the deleted object.
* default: product_option
* deleted:
* type: boolean
* title: deleted
* description: The product's deleted.
* description: Whether the Product was deleted.
* parent:
* $ref: "#/components/schemas/AdminProduct"
*
www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The product tag's object.
* description: The name of the deleted object.
* default: product_tag
* deleted:
* type: boolean
* title: deleted
* description: The product tag's deleted.
* description: Whether the Product Tag was deleted.
* parent:
* type: object
* description: The product tag's parent.
www/utils/generated/oas-output/schemas/AdminProductType.ts
+40
View File
@@ -0,0 +1,40 @@
/**
* @schema AdminProductType
* type: object
* description: The parent's type.
* x-schemaName: AdminProductType
* required:
* - id
* - value
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The type's ID.
* value:
* type: string
* title: value
* description: The type's value.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The type's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The type's updated at.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The type's deleted at.
* metadata:
* type: object
* description: The type's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The product type's object.
* description: The name of the deleted object.
* default: product_type
* deleted:
* type: boolean
* title: deleted
* description: The product type's deleted.
* description: Whether the Product Type was deleted.
* parent:
* type: object
* description: The product type's parent.
www/utils/generated/oas-output/schemas/AdminProductTypeListResponse.ts
+1 -1
View File
@@ -25,7 +25,7 @@
* type: array
* description: The product type's product types.
* items:
* $ref: "#/components/schemas/AdminProduct"
* $ref: "#/components/schemas/AdminProductType"
*
*/
www/utils/generated/oas-output/schemas/AdminProductTypeResponse.ts
+1 -1
View File
@@ -7,7 +7,7 @@
* - product_type
* properties:
* product_type:
* $ref: "#/components/schemas/AdminProduct"
* $ref: "#/components/schemas/AdminProductType"
*
*/
www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The product's object.
* description: The name of the deleted object.
* default: variant
* deleted:
* type: boolean
* title: deleted
* description: The product's deleted.
* description: Whether the Product was deleted.
* parent:
* $ref: "#/components/schemas/AdminProduct"
*
www/utils/generated/oas-output/schemas/AdminProductVariantInventoryBatchResponse.ts
+2 -2
View File
@@ -78,10 +78,10 @@
* oneOf:
* - $ref: "#/components/schemas/AdminProductVariantInventoryLink"
* - type: array
* description: The product's deleted.
* description: SUMMARY
* items:
* type: object
* description: The deleted's details.
* description: SUMMARY
* x-schemaName: AdminProductVariantInventoryLink
* required:
* - productService
www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts
+2 -2
View File
@@ -14,11 +14,11 @@
* object:
* type: string
* title: object
* description: The product's object.
* description: The name of the deleted object.
* deleted:
* type: boolean
* title: deleted
* description: The product's deleted.
* description: Whether the Product was deleted.
* parent:
* $ref: "#/components/schemas/AdminProductVariant"
*
www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts
+4 -10
View File
@@ -64,20 +64,14 @@
* type: array
* description: The variant's $and.
* items:
* type: array
* description: The $and's details.
* items:
* type: object
* title: $and
* type: object
* title: $and
* $or:
* type: array
* description: The variant's $or.
* items:
* type: array
* description: The $or's details.
* items:
* type: object
* title: $or
* type: object
* title: $or
*
*/
www/utils/generated/oas-output/schemas/AdminPromotion.ts
+2 -1
View File
@@ -16,6 +16,7 @@
* description: The promotion's code.
* type:
* type: string
* description: The promotion's type.
* enum:
* - standard
* - buyget
@@ -35,7 +36,7 @@
* title: campaign_id
* description: The promotion's campaign id.
* campaign:
* $ref: "#/components/schemas/CampaignResponse"
* $ref: "#/components/schemas/AdminCampaign"
*
*/
www/utils/generated/oas-output/schemas/AdminPromotionRule.ts
+1
View File
@@ -21,6 +21,7 @@
* description: The updated's attribute.
* operator:
* type: string
* description: The updated's operator.
* enum:
* - gt
* - lt
www/utils/generated/oas-output/schemas/AdminReservation.ts
+71
View File
@@ -0,0 +1,71 @@
/**
* @schema AdminReservation
* type: object
* description: The reservation's details.
* x-schemaName: AdminReservation
* required:
* - id
* - line_item_id
* - location_id
* - quantity
* - external_id
* - description
* - inventory_item_id
* - inventory_item
* properties:
* id:
* type: string
* title: id
* description: The reservation's ID.
* line_item_id:
* type: string
* title: line_item_id
* description: The reservation's line item id.
* location_id:
* type: string
* title: location_id
* description: The reservation's location id.
* quantity:
* type: string
* title: quantity
* description: The reservation's quantity.
* external_id:
* type: string
* title: external_id
* description: The reservation's external id.
* description:
* type: string
* title: description
* description: The reservation's description.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The reservation's inventory item id.
* inventory_item:
* type: object
* description: The reservation's inventory item.
* metadata:
* type: object
* description: The reservation's metadata.
* created_by:
* type: string
* title: created_by
* description: The reservation's created by.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The reservation's deleted at.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The reservation's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The reservation's updated at.
*
*/
www/utils/generated/oas-output/schemas/AdminReservationResponse.ts
+1 -1
View File
@@ -7,7 +7,7 @@
* - reservation
* properties:
* reservation:
* $ref: "#/components/schemas/ReservationResponse"
* $ref: "#/components/schemas/AdminReservation"
*
*/
www/utils/generated/oas-output/schemas/AdminReturn.ts
+5
View File
@@ -11,6 +11,7 @@
* - items
* - received_at
* - created_at
* - canceled_at
* properties:
* id:
* type: string
@@ -66,6 +67,10 @@
* format: date-time
* title: created_at
* description: The return's created at.
* canceled_at:
* type: string
* title: canceled_at
* description: The return's canceled at.
*
*/
www/utils/generated/oas-output/schemas/AdminReturnItem.ts
+5
View File
@@ -7,6 +7,7 @@
* - id
* - quantity
* - received_quantity
* - damaged_quantity
* - item_id
* - return_id
* properties:
@@ -22,6 +23,10 @@
* type: number
* title: received_quantity
* description: The return item's received quantity.
* damaged_quantity:
* type: number
* title: damaged_quantity
* description: The return item's damaged quantity.
* reason_id:
* type: string
* title: reason_id
www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The sales channel's object.
* description: The name of the deleted object.
* default: sales-channel
* deleted:
* type: boolean
* title: deleted
* description: The sales channel's deleted.
* description: Whether the Sales Channel was deleted.
* parent:
* type: object
* description: The sales channel's parent.
www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The shipping option's object.
* description: The name of the deleted object.
* default: shipping_option
* deleted:
* type: boolean
* title: deleted
* description: The shipping option's deleted.
* description: Whether the Shipping Option was deleted.
* parent:
* type: object
* description: The shipping option's parent.
www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The shipping profile's object.
* description: The name of the deleted object.
* default: shipping_profile
* deleted:
* type: boolean
* title: deleted
* description: The shipping profile's deleted.
* description: Whether the Shipping Profile was deleted.
* parent:
* type: object
* description: The shipping profile's parent.
www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The stock location's object.
* description: The name of the deleted object.
* default: stock_location
* deleted:
* type: boolean
* title: deleted
* description: The stock location's deleted.
* description: Whether the Stock Location was deleted.
* parent:
* type: object
* description: The stock location's parent.
www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The tax rate's object.
* description: The name of the deleted object.
* default: tax_rate
* deleted:
* type: boolean
* title: deleted
* description: The tax rate's deleted.
* description: Whether the Tax Rate was deleted.
* parent:
* type: object
* description: The tax rate's parent.
www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The tax region's object.
* description: The name of the deleted object.
* default: tax_region
* deleted:
* type: boolean
* title: deleted
* description: The tax region's deleted.
* description: Whether the Tax Region was deleted.
* parent:
* type: object
* description: The tax region's parent.
www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts
+2
View File
@@ -26,11 +26,13 @@
* description: The price list's ends at.
* status:
* type: string
* description: The price list's status.
* enum:
* - active
* - draft
* type:
* type: string
* description: The price list's type.
* enum:
* - sale
* - override
www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts
+1
View File
@@ -47,6 +47,7 @@
* description: The update's handle.
* status:
* type: string
* description: The update's status.
* enum:
* - draft
* - proposed
www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts
+2 -2
View File
@@ -15,12 +15,12 @@
* object:
* type: string
* title: object
* description: The user's object.
* description: The name of the deleted object.
* default: user
* deleted:
* type: boolean
* title: deleted
* description: The user's deleted.
* description: Whether the User was deleted.
* parent:
* type: object
* description: The user's parent.
www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts
+15 -10
View File
@@ -12,7 +12,6 @@
* - state
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
@@ -27,29 +26,35 @@
* title: transaction_id
* description: The workflow execution's transaction id.
* execution:
* type: string
* title: execution
* description: The workflow execution's execution.
* $ref: "#/components/schemas/AdminWorkflowExecutionExecution"
* context:
* $ref: "#/components/schemas/WorkflowExecutionContext"
* state:
* type: string
* title: context
* description: The workflow execution's context.
* state: {}
* description: The workflow execution's state.
* enum:
* - not_started
* - invoking
* - waiting_to_compensate
* - compensating
* - done
* - reverted
* - failed
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The workflow execution's created at.
* format: date-time
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The workflow execution's updated at.
* format: date-time
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The workflow execution's deleted at.
* format: date-time
*
*/
www/utils/generated/oas-output/schemas/AdminWorkflowExecutionExecution.ts
+14
View File
@@ -0,0 +1,14 @@
/**
* @schema AdminWorkflowExecutionExecution
* type: object
* description: The workflow execution's execution.
* x-schemaName: AdminWorkflowExecutionExecution
* required:
* - steps
* properties:
* steps:
* type: object
* description: The execution's steps.
*
*/
www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts
+3
View File
@@ -12,17 +12,20 @@
* description: The application method's ID.
* type:
* type: string
* description: The application method's type.
* enum:
* - fixed
* - percentage
* target_type:
* type: string
* description: The application method's target type.
* enum:
* - items
* - shipping_methods
* - order
* allocation:
* type: string
* description: The application method's allocation.
* enum:
* - each
* - across
www/utils/generated/oas-output/schemas/BaseCartLineItem.ts
+3 -3
View File
@@ -161,19 +161,19 @@
* description: The item's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The item's created at.
* format: date-time
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The item's updated at.
* format: date-time
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The item's deleted at.
* format: date-time
* original_total:
* oneOf:
* - type: string
www/utils/generated/oas-output/schemas/BaseClaimItem.ts
+1
View File
@@ -34,6 +34,7 @@
* description: The claim item's quantity.
* reason:
* type: string
* description: The claim item's reason.
* enum:
* - missing_item
* - wrong_item
www/utils/generated/oas-output/schemas/BaseOrderChange.ts
+1
View File
@@ -121,6 +121,7 @@
* description: The order change's version.
* change_type:
* type: string
* description: The order change's change type.
* enum:
* - return
* - exchange
www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts
+2 -2
View File
@@ -61,14 +61,14 @@
* description: The fulfillment's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The fulfillment's created at.
* format: date-time
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The fulfillment's updated at.
* format: date-time
*
*/
www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts
+2 -2
View File
@@ -148,14 +148,14 @@
* $ref: "#/components/schemas/BaseOrderItemDetail"
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The item's created at.
* format: date-time
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The item's updated at.
* format: date-time
* metadata:
* type: object
* description: The item's metadata.
www/utils/generated/oas-output/schemas/BasePaymentCollection.ts
+1
View File
@@ -95,6 +95,7 @@
* description: The payment collection's metadata.
* status:
* type: string
* description: The payment collection's status.
* enum:
* - canceled
* - not_paid
www/utils/generated/oas-output/schemas/BaseProduct.ts
+1
View File
@@ -57,6 +57,7 @@
* description: The product's is giftcard.
* status:
* type: string
* description: The product's status.
* enum:
* - draft
* - proposed
www/utils/generated/oas-output/schemas/BasePromotionRule.ts
+1
View File
@@ -21,6 +21,7 @@
* description: The rule's attribute.
* operator:
* type: string
* description: The rule's operator.
* enum:
* - gt
* - lt
www/utils/generated/oas-output/schemas/OrderChange.ts
+1
View File
@@ -39,6 +39,7 @@
* description: The order change's version.
* change_type:
* type: string
* description: The order change's change type.
* enum:
* - return
* - exchange
www/utils/generated/oas-output/schemas/OrderPreview.ts
+3 -2
View File
@@ -214,14 +214,14 @@
* $ref: "#/components/schemas/OrderItem"
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The item's created at.
* format: date-time
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The item's updated at.
* format: date-time
* metadata:
* type: object
* description: The item's metadata.
@@ -661,6 +661,7 @@
* x-schemaName: OrderChangeAction
* status:
* type: string
* description: The order preview's status.
* enum:
* - canceled
* - requires_action
www/utils/generated/oas-output/schemas/StoreCartAddress.ts
+82
View File
@@ -0,0 +1,82 @@
/**
* @schema StoreCartAddress
* type: object
* description: The cart's billing address.
* x-schemaName: StoreCartAddress
* required:
* - id
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The billing address's ID.
* customer_id:
* type: string
* title: customer_id
* description: The billing address's customer id.
* first_name:
* type: string
* title: first_name
* description: The billing address's first name.
* last_name:
* type: string
* title: last_name
* description: The billing address's last name.
* phone:
* type: string
* title: phone
* description: The billing address's phone.
* company:
* type: string
* title: company
* description: The billing address's company.
* address_1:
* type: string
* title: address_1
* description: The billing address's address 1.
* address_2:
* type: string
* title: address_2
* description: The billing address's address 2.
* city:
* type: string
* title: city
* description: The billing address's city.
* country_code:
* type: string
* title: country_code
* description: The billing address's country code.
* province:
* type: string
* title: province
* description: The billing address's province.
* postal_code:
* type: string
* title: postal_code
* description: The billing address's postal code.
* metadata:
* type: object
* description: The billing address's metadata.
* created_at:
* oneOf:
* - type: string
* title: created_at
* description: The billing address's created at.
* - type: string
* title: created_at
* description: The billing address's created at.
* format: date-time
* updated_at:
* oneOf:
* - type: string
* title: updated_at
* description: The billing address's updated at.
* - type: string
* title: updated_at
* description: The billing address's updated at.
* format: date-time
*
*/
www/utils/generated/oas-output/schemas/StoreCartLineItem.ts
+311
View File
@@ -0,0 +1,311 @@
/**
* @schema StoreCartLineItem
* type: object
* description: The item's items.
* x-schemaName: StoreCartLineItem
* required:
* - id
* - title
* - quantity
* - requires_shipping
* - is_discountable
* - is_tax_inclusive
* - unit_price
* - cart
* - cart_id
* - original_total
* - original_subtotal
* - original_tax_total
* - item_total
* - item_subtotal
* - item_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* properties:
* id:
* type: string
* title: id
* description: The item's ID.
* title:
* type: string
* title: title
* description: The item's title.
* subtitle:
* type: string
* title: subtitle
* description: The item's subtitle.
* thumbnail:
* type: string
* title: thumbnail
* description: The item's thumbnail.
* quantity:
* oneOf:
* - type: string
* title: quantity
* description: The item's quantity.
* - type: number
* title: quantity
* description: The item's quantity.
* - type: string
* title: quantity
* description: The item's quantity.
* - $ref: "#/components/schemas/IBigNumber"
* product:
* $ref: "#/components/schemas/BaseProduct"
* product_id:
* type: string
* title: product_id
* description: The item's product id.
* product_title:
* type: string
* title: product_title
* description: The item's product title.
* product_description:
* type: string
* title: product_description
* description: The item's product description.
* product_subtitle:
* type: string
* title: product_subtitle
* description: The item's product subtitle.
* product_type:
* type: string
* title: product_type
* description: The item's product type.
* product_collection:
* type: string
* title: product_collection
* description: The item's product collection.
* product_handle:
* type: string
* title: product_handle
* description: The item's product handle.
* variant:
* $ref: "#/components/schemas/BaseProductVariant"
* variant_id:
* type: string
* title: variant_id
* description: The item's variant id.
* variant_sku:
* type: string
* title: variant_sku
* description: The item's variant sku.
* variant_barcode:
* type: string
* title: variant_barcode
* description: The item's variant barcode.
* variant_title:
* type: string
* title: variant_title
* description: The item's variant title.
* variant_option_values:
* type: object
* description: The item's variant option values.
* requires_shipping:
* type: boolean
* title: requires_shipping
* description: The item's requires shipping.
* is_discountable:
* type: boolean
* title: is_discountable
* description: The item's is discountable.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: The item's is tax inclusive.
* compare_at_unit_price:
* oneOf:
* - type: string
* title: compare_at_unit_price
* description: The item's compare at unit price.
* - type: number
* title: compare_at_unit_price
* description: The item's compare at unit price.
* - type: string
* title: compare_at_unit_price
* description: The item's compare at unit price.
* - $ref: "#/components/schemas/IBigNumber"
* unit_price:
* oneOf:
* - type: string
* title: unit_price
* description: The item's unit price.
* - type: number
* title: unit_price
* description: The item's unit price.
* - type: string
* title: unit_price
* description: The item's unit price.
* - $ref: "#/components/schemas/IBigNumber"
* tax_lines:
* type: array
* description: The item's tax lines.
* items:
* $ref: "#/components/schemas/BaseLineItemTaxLine"
* adjustments:
* type: array
* description: The item's adjustments.
* items:
* $ref: "#/components/schemas/BaseLineItemAdjustment"
* cart:
* $ref: "#/components/schemas/BaseCart"
* cart_id:
* type: string
* title: cart_id
* description: The item's cart id.
* metadata:
* type: object
* description: The item's metadata.
* created_at:
* type: string
* title: created_at
* description: The item's created at.
* format: date-time
* updated_at:
* type: string
* title: updated_at
* description: The item's updated at.
* format: date-time
* deleted_at:
* type: string
* title: deleted_at
* description: The item's deleted at.
* format: date-time
* original_total:
* oneOf:
* - type: string
* title: original_total
* description: The item's original total.
* - type: number
* title: original_total
* description: The item's original total.
* - type: string
* title: original_total
* description: The item's original total.
* - $ref: "#/components/schemas/IBigNumber"
* original_subtotal:
* oneOf:
* - type: string
* title: original_subtotal
* description: The item's original subtotal.
* - type: number
* title: original_subtotal
* description: The item's original subtotal.
* - type: string
* title: original_subtotal
* description: The item's original subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_tax_total:
* oneOf:
* - type: string
* title: original_tax_total
* description: The item's original tax total.
* - type: number
* title: original_tax_total
* description: The item's original tax total.
* - type: string
* title: original_tax_total
* description: The item's original tax total.
* - $ref: "#/components/schemas/IBigNumber"
* item_total:
* oneOf:
* - type: string
* title: item_total
* description: The item's item total.
* - type: number
* title: item_total
* description: The item's item total.
* - type: string
* title: item_total
* description: The item's item total.
* - $ref: "#/components/schemas/IBigNumber"
* item_subtotal:
* oneOf:
* - type: string
* title: item_subtotal
* description: The item's item subtotal.
* - type: number
* title: item_subtotal
* description: The item's item subtotal.
* - type: string
* title: item_subtotal
* description: The item's item subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* item_tax_total:
* oneOf:
* - type: string
* title: item_tax_total
* description: The item's item tax total.
* - type: number
* title: item_tax_total
* description: The item's item tax total.
* - type: string
* title: item_tax_total
* description: The item's item tax total.
* - $ref: "#/components/schemas/IBigNumber"
* total:
* oneOf:
* - type: string
* title: total
* description: The item's total.
* - type: number
* title: total
* description: The item's total.
* - type: string
* title: total
* description: The item's total.
* - $ref: "#/components/schemas/IBigNumber"
* subtotal:
* oneOf:
* - type: string
* title: subtotal
* description: The item's subtotal.
* - type: number
* title: subtotal
* description: The item's subtotal.
* - type: string
* title: subtotal
* description: The item's subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* tax_total:
* oneOf:
* - type: string
* title: tax_total
* description: The item's tax total.
* - type: number
* title: tax_total
* description: The item's tax total.
* - type: string
* title: tax_total
* description: The item's tax total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_total:
* oneOf:
* - type: string
* title: discount_total
* description: The item's discount total.
* - type: number
* title: discount_total
* description: The item's discount total.
* - type: string
* title: discount_total
* description: The item's discount total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_tax_total:
* oneOf:
* - type: string
* title: discount_tax_total
* description: The item's discount tax total.
* - type: number
* title: discount_tax_total
* description: The item's discount tax total.
* - type: string
* title: discount_tax_total
* description: The item's discount tax total.
* - $ref: "#/components/schemas/IBigNumber"
*
*/
www/utils/generated/oas-output/schemas/StoreOrder.ts
+2
View File
@@ -96,6 +96,7 @@
* $ref: "#/components/schemas/BasePaymentCollection"
* payment_status:
* type: string
* description: The order's payment status.
* enum:
* - canceled
* - not_paid
@@ -114,6 +115,7 @@
* $ref: "#/components/schemas/BaseOrderFulfillment"
* fulfillment_status:
* type: string
* description: The order's fulfillment status.
* enum:
* - canceled
* - not_fulfilled
www/utils/generated/oas-output/schemas/StorePaymentCollection.ts
+1
View File
@@ -95,6 +95,7 @@
* description: The payment collection's metadata.
* status:
* type: string
* description: The payment collection's status.
* enum:
* - canceled
* - not_paid
www/utils/generated/oas-output/schemas/StoreProduct.ts
+1
View File
@@ -44,6 +44,7 @@
* description: The product's title.
* status:
* type: string
* description: The product's status.
* enum:
* - draft
* - proposed
www/utils/generated/oas-output/schemas/StoreProductCategory.ts
+3
View File
@@ -62,6 +62,9 @@
* description: The category's category children.
* items:
* $ref: "#/components/schemas/BaseProductCategory"
* metadata:
* type: object
* description: The category's metadata.
* created_at:
* type: string
* format: date-time
www/utils/generated/oas-output/schemas/StoreReturn.ts
+5
View File
@@ -11,6 +11,7 @@
* - items
* - received_at
* - created_at
* - canceled_at
* properties:
* id:
* type: string
@@ -66,6 +67,10 @@
* format: date-time
* title: created_at
* description: The return's created at.
* canceled_at:
* type: string
* title: canceled_at
* description: The return's canceled at.
*
*/
www/utils/generated/oas-output/schemas/StoreShippingOption.ts
+1
View File
@@ -28,6 +28,7 @@
* description: The shipping option's name.
* price_type:
* type: string
* description: The shipping option's price type.
* enum:
* - flat
* - calculated
www/utils/generated/oas-output/schemas/WorkflowExecutionContext.ts
+24
View File
@@ -0,0 +1,24 @@
/**
* @schema WorkflowExecutionContext
* type: object
* description: The workflow execution's context.
* x-schemaName: WorkflowExecutionContext
* required:
* - compensate
* - errors
* properties:
* data:
* type: object
* description: The context's data.
* compensate:
* type: object
* description: The context's compensate.
* errors:
* type: array
* description: The context's errors.
* items:
* type: object
* description: The error's errors.
*
*/