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

docs: generate OAS for 2.11.2 (#13925)

Browse Source
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-10-31 16:15:46 +02:00
1 parent 13d7d15be5
commit 604ff55a5b
403 files changed
+17473 -5392
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts → www/utils/generated/oas-output/schemas/AdminAddClaimItems.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostClaimItemsReqSchema
* @schema AdminAddClaimItems
* type: object
* description: The details of the order items to add to the claim.
* x-schemaName: AdminPostClaimItemsReqSchema
* x-schemaName: AdminAddClaimItems
* properties:
* items:
* type: array
www/utils/generated/oas-output/schemas/AdminAddClaimOutboundItems.ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @schema AdminAddClaimOutboundItems
* type: object
* description: The details of the outbound items to add to the claim.
* x-schemaName: AdminAddClaimOutboundItems
* properties:
* items:
* type: array
* description: The outbound item's details.
* items:
* type: object
* description: An item's details.
* required:
* - id
* - quantity
* properties:
* quantity:
* type: number
* title: quantity
* description: The quantity to send to the customer.
* internal_note:
* type: string
* title: internal_note
* description: A note viewed only by admin users.
* id:
* type: string
* title: id
* description: The item's ID.
* reason:
* type: string
* description: The item's reason.
* enum:
* - missing_item
* - wrong_item
* - production_failure
* - other
* description:
* type: string
* title: description
* description: The item's description.
*
*/
www/utils/generated/oas-output/schemas/AdminPostExchangesReturnRequestItemsReqSchema.ts → www/utils/generated/oas-output/schemas/AdminAddExchangeInboundItems.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostExchangesReturnRequestItemsReqSchema
* @schema AdminAddExchangeInboundItems
* type: object
* description: The details of the inbound (return) items.
* x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema
* x-schemaName: AdminAddExchangeInboundItems
* properties:
* items:
* type: array
www/utils/generated/oas-output/schemas/AdminPostExchangesAddItemsReqSchema.ts → www/utils/generated/oas-output/schemas/AdminAddExchangeOutboundItems.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostExchangesAddItemsReqSchema
* @schema AdminAddExchangeOutboundItems
* type: object
* description: The details of outbound items.
* x-schemaName: AdminPostExchangesAddItemsReqSchema
* x-schemaName: AdminAddExchangeOutboundItems
* properties:
* items:
* type: array
www/utils/generated/oas-output/schemas/AdminAddReturnItem.ts
+34
View File
@@ -0,0 +1,34 @@
/**
* @schema AdminAddReturnItem
* type: object
* description: An item's details.
* 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: A note viewed only by admin users.
* metadata:
* type: object
* description: The item's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* x-schemaName: AdminAddReturnItem
*
*/
www/utils/generated/oas-output/schemas/AdminAddReturnItems.ts
+16
View File
@@ -0,0 +1,16 @@
/**
* @schema AdminAddReturnItems
* type: object
* description: The items' details.
* x-schemaName: AdminAddReturnItems
* properties:
* items:
* type: array
* description: The items' details.
* items:
* $ref: "#/components/schemas/AdminAddReturnItem"
* required:
* - items
*
*/
www/utils/generated/oas-output/schemas/AdminAddReturnShipping.ts
+33
View File
@@ -0,0 +1,33 @@
/**
* @schema AdminAddReturnShipping
* type: object
* description: The shipping method's details.
* x-schemaName: AdminAddReturnShipping
* required:
* - shipping_option_id
* properties:
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The ID of the associated shipping option.
* custom_amount:
* type: number
* title: custom_amount
* description: Set the price of the shipping method.
* description:
* type: string
* title: description
* description: The shipping method's description.
* internal_note:
* type: string
* title: internal_note
* description: A note viewed only by admin users.
* metadata:
* type: object
* description: The exchange's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
*
*/
www/utils/generated/oas-output/schemas/AdminCreateInventoryLocationLevel.ts → www/utils/generated/oas-output/schemas/AdminBatchCreateInventoryItemLocationLevels.ts
+2 -2
View File
@@ -1,5 +1,5 @@
/**
* @schema AdminCreateInventoryLocationLevel
* @schema AdminBatchCreateInventoryItemLocationLevels
* type: object
* description: The inventory level's details.
* required:
@@ -17,7 +17,7 @@
* type: number
* title: incoming_quantity
* description: The inventory level's incoming quantity.
* x-schemaName: AdminCreateInventoryLocationLevel
* x-schemaName: AdminBatchCreateInventoryItemLocationLevels
*
*/
www/utils/generated/oas-output/schemas/AdminBatchImageVariantRequest.ts
+23
View File
@@ -0,0 +1,23 @@
/**
* @schema AdminBatchImageVariantRequest
* type: object
* description: Details of the associations between variants and a product image to manage.
* x-schemaName: AdminBatchImageVariantRequest
* properties:
* add:
* type: array
* description: The IDs of product variants to add the image to.
* items:
* type: string
* title: add
* description: The ID of the variant to add.
* remove:
* type: array
* description: The IDs of product variants to remove the image from.
* items:
* type: string
* title: remove
* description: The ID of the variant to remove.
*
*/
www/utils/generated/oas-output/schemas/AdminBatchImageVariantResponse.ts
+26
View File
@@ -0,0 +1,26 @@
/**
* @schema AdminBatchImageVariantResponse
* type: object
* description: Result of managing the associations between variants and a product image.
* x-schemaName: AdminBatchImageVariantResponse
* required:
* - added
* - removed
* properties:
* added:
* type: array
* description: The IDs of product variants added the image to.
* items:
* type: string
* title: added
* description: The ID of the variant added.
* removed:
* type: array
* description: The IDs of product variants removed the image from.
* items:
* type: string
* title: removed
* description: The ID of the variant removed.
*
*/
www/utils/generated/oas-output/schemas/AdminBatchLink.ts
+23
View File
@@ -0,0 +1,23 @@
/**
* @schema AdminBatchLink
* type: object
* description: A batch operation to manage the associations between two entities.
* properties:
* add:
* type: array
* description: The IDs of an entity to add to the other.
* items:
* type: string
* title: add
* description: The entity's ID.
* remove:
* type: array
* description: The IDs of an entity to remove from the other.
* items:
* type: string
* title: remove
* description: The entity's ID.
* x-schemaName: AdminBatchLink
*
*/
www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts
+4
View File
@@ -37,6 +37,10 @@
* type: string
* title: url
* description: The image's URL.
* id:
* type: string
* title: id
* description: The image's ID.
* thumbnail:
* type: string
* title: thumbnail
www/utils/generated/oas-output/schemas/AdminBatchUpdateProductVariant.ts
+4
View File
@@ -86,6 +86,10 @@
* type: string
* title: id
* description: The update's ID.
* thumbnail:
* type: string
* title: thumbnail
* description: The variant's thumbnail.
* required:
* - id
*
www/utils/generated/oas-output/schemas/AdminBatchVariantImagesRequest.ts
+23
View File
@@ -0,0 +1,23 @@
/**
* @schema AdminBatchVariantImagesRequest
* type: object
* description: Details of the associations between images and a product variant to manage.
* x-schemaName: AdminBatchVariantImagesRequest
* properties:
* add:
* type: array
* description: The IDs of product images to add to the variant.
* items:
* type: string
* title: add
* description: The ID of the image to add.
* remove:
* type: array
* description: The IDs of product images to remove from the variant.
* items:
* type: string
* title: remove
* description: The ID of the image to remove.
*
*/
www/utils/generated/oas-output/schemas/AdminBatchVariantImagesResponse.ts
+26
View File
@@ -0,0 +1,26 @@
/**
* @schema AdminBatchVariantImagesResponse
* type: object
* description: Result of managing the associations between images and a product variant.
* x-schemaName: AdminBatchVariantImagesResponse
* required:
* - added
* - removed
* properties:
* added:
* type: array
* description: The IDs of product images added to the variant.
* items:
* type: string
* title: added
* description: The ID of the image added.
* removed:
* type: array
* description: The IDs of product images removed from the variant.
* items:
* type: string
* title: removed
* description: The ID of the image removed.
*
*/
www/utils/generated/oas-output/schemas/AdminCreatePaymentCapture.ts → www/utils/generated/oas-output/schemas/AdminCapturePayment.ts
+2 -2
View File
@@ -1,5 +1,5 @@
/**
* @schema AdminCreatePaymentCapture
* @schema AdminCapturePayment
* type: object
* description: The payment's details.
* properties:
@@ -7,7 +7,7 @@
* type: number
* title: amount
* description: The amount to capture.
* x-schemaName: AdminCreatePaymentCapture
* x-schemaName: AdminCapturePayment
*
*/
www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts → www/utils/generated/oas-output/schemas/AdminClaimAddOutboundShipping.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostClaimsShippingReqSchema
* @schema AdminClaimAddOutboundShipping
* type: object
* description: The details of the shipping method used to ship outbound items.
* x-schemaName: AdminPostClaimsShippingReqSchema
* x-schemaName: AdminClaimAddOutboundShipping
* required:
* - shipping_option_id
* properties:
www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts → www/utils/generated/oas-output/schemas/AdminClaimUpdateInboundShipping.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostClaimsShippingActionReqSchema
* @schema AdminClaimUpdateInboundShipping
* type: object
* description: The details to update in the shipping method.
* x-schemaName: AdminPostClaimsShippingActionReqSchema
* x-schemaName: AdminClaimUpdateInboundShipping
* properties:
* custom_amount:
* type: number
www/utils/generated/oas-output/schemas/AdminClaimUpdateOutboundShipping.ts
+23
View File
@@ -0,0 +1,23 @@
/**
* @schema AdminClaimUpdateOutboundShipping
* type: object
* description: The details to update in the shipping method.
* x-schemaName: AdminClaimUpdateOutboundShipping
* properties:
* custom_amount:
* type: number
* title: custom_amount
* description: The shipping method's custom amount.
* internal_note:
* type: string
* title: internal_note
* description: A note only viewed by admin users.
* metadata:
* type: object
* description: The claim's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
*
*/
www/utils/generated/oas-output/schemas/AdminPostReturnsConfirmRequestReqSchema.ts → www/utils/generated/oas-output/schemas/AdminConfirmReceiveReturn.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostReturnsConfirmRequestReqSchema
* @schema AdminConfirmReceiveReturn
* type: object
* description: The confirmation's details.
* x-schemaName: AdminPostReturnsConfirmRequestReqSchema
* x-schemaName: AdminConfirmReceiveReturn
* properties:
* no_notification:
* type: boolean
www/utils/generated/oas-output/schemas/AdminConfirmReturnRequest.ts
+13
View File
@@ -0,0 +1,13 @@
/**
* @schema AdminConfirmReturnRequest
* type: object
* description: The confirmation's details.
* x-schemaName: AdminConfirmReturnRequest
* properties:
* no_notification:
* type: boolean
* title: no_notification
* description: Whether to send the customer a notification about the confirmation.
*
*/
www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts → www/utils/generated/oas-output/schemas/AdminCreateClaim.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostOrderClaimsReqSchema
* @schema AdminCreateClaim
* type: object
* description: The claim's details.
* x-schemaName: AdminPostOrderClaimsReqSchema
* x-schemaName: AdminCreateClaim
* required:
* - type
* - order_id
www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts → www/utils/generated/oas-output/schemas/AdminCreateExchange.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostOrderExchangesReqSchema
* @schema AdminCreateExchange
* type: object
* description: The exchange's details.
* x-schemaName: AdminPostOrderExchangesReqSchema
* x-schemaName: AdminCreateExchange
* required:
* - order_id
* properties:
www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts
+5 -108
View File
@@ -4,14 +4,12 @@
* description: The filfillment's details.
* x-schemaName: AdminCreateFulfillment
* required:
* - items
* - metadata
* - order_id
* - data
* - location_id
* - provider_id
* - delivery_address
* - items
* - labels
* - order_id
* properties:
* location_id:
* type: string
@@ -22,118 +20,17 @@
* title: provider_id
* description: The ID of the provider handling this fulfillment.
* delivery_address:
* type: object
* description: The address to deliver the items to.
* properties:
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* phone:
* type: string
* title: phone
* description: The customer's phone.
* company:
* type: string
* title: company
* description: The delivery address's company.
* address_1:
* type: string
* title: address_1
* description: The delivery address's first line.
* address_2:
* type: string
* title: address_2
* description: The delivery address's second line.
* city:
* type: string
* title: city
* description: The delivery address's city.
* country_code:
* type: string
* title: country_code
* description: The delivery address's country code.
* province:
* type: string
* title: province
* description: The delivery address's ISO 3166-2 province code. Must be lower-case.
* example: us-ca
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
* description: The delivery address's postal code.
* metadata:
* type: object
* description: The delivery address's metadata, used to store custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* $ref: "#/components/schemas/AdminFulfillmentDeliveryAddress"
* items:
* type: array
* description: The items to fulfill.
* items:
* type: object
* description: An item to fulfill.
* required:
* - title
* - quantity
* - sku
* - barcode
* properties:
* title:
* type: string
* title: title
* description: The item's title.
* sku:
* type: string
* title: sku
* description: The item's SKU.
* quantity:
* type: number
* title: quantity
* description: The quantity to fulfill of the item.
* barcode:
* type: string
* title: barcode
* description: The item's barcode.
* line_item_id:
* type: string
* title: line_item_id
* description: The ID of the associated line item.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The ID of the inventory item associated with the underlying variant.
* $ref: "#/components/schemas/AdminCreateFulfillmentItem"
* labels:
* type: array
* description: The labels for the fulfillment's shipments.
* items:
* type: object
* description: A shipment's label.
* required:
* - tracking_number
* - tracking_url
* - label_url
* properties:
* tracking_number:
* type: string
* title: tracking_number
* description: The label's tracking number.
* tracking_url:
* type: string
* title: tracking_url
* description: The label's tracking URL.
* label_url:
* type: string
* title: label_url
* description: The label's URL.
* $ref: "#/components/schemas/AdminCreateFulfillmentLabel"
* order_id:
* type: string
* title: order_id
www/utils/generated/oas-output/schemas/AdminCreateFulfillmentItem.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @schema AdminCreateFulfillmentItem
* type: object
* description: An item to fulfill.
* required:
* - title
* - sku
* - quantity
* - barcode
* properties:
* title:
* type: string
* title: title
* description: The item's title.
* sku:
* type: string
* title: sku
* description: The item's SKU.
* quantity:
* type: number
* title: quantity
* description: The quantity to fulfill of the item.
* barcode:
* type: string
* title: barcode
* description: The item's barcode.
* line_item_id:
* type: string
* title: line_item_id
* description: The ID of the associated line item.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The ID of the inventory item associated with the underlying variant.
* x-schemaName: AdminCreateFulfillmentItem
*
*/
www/utils/generated/oas-output/schemas/AdminCreateFulfillmentLabel.ts
+25
View File
@@ -0,0 +1,25 @@
/**
* @schema AdminCreateFulfillmentLabel
* type: object
* description: Details of the fulfillment label to create.
* required:
* - tracking_number
* - tracking_url
* - label_url
* properties:
* tracking_number:
* type: string
* title: tracking_number
* description: The label's tracking number.
* tracking_url:
* type: string
* title: tracking_url
* description: The label's tracking URL.
* label_url:
* type: string
* title: label_url
* description: The label's URL.
* x-schemaName: AdminCreateFulfillmentLabel
*
*/
www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZones.ts → www/utils/generated/oas-output/schemas/AdminCreateFulfillmentSetServiceZone.ts
+4 -3
View File
@@ -1,9 +1,10 @@
/**
* @schema AdminCreateFulfillmentSetServiceZones
* @schema AdminCreateFulfillmentSetServiceZone
* type: object
* description: The service zone's details.
* description: Details of the service zone to create for the fulfillment set.
* required:
* - name
* - geo_zones
* properties:
* name:
* type: string
@@ -143,7 +144,7 @@
* postal_expression:
* type: object
* description: The geo zone's postal expression or ZIP code.
* x-schemaName: AdminCreateFulfillmentSetServiceZones
* x-schemaName: AdminCreateFulfillmentSetServiceZone
*
*/
www/utils/generated/oas-output/schemas/AdminCreateFulfillmentShipment.ts
+16
View File
@@ -0,0 +1,16 @@
/**
* @schema AdminCreateFulfillmentShipment
* type: object
* description: Details of the shipment to create for a fulfillment.
* x-schemaName: AdminCreateFulfillmentShipment
* required:
* - labels
* properties:
* labels:
* type: array
* description: The shipment's labels.
* items:
* $ref: "#/components/schemas/AdminCreateFulfillmentLabel"
*
*/
www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLines.ts → www/utils/generated/oas-output/schemas/AdminCreateOrderCreditLine.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminCreateOrderCreditLines
* @schema AdminCreateOrderCreditLine
* type: object
* description: The details of a credit line to add to an order.
* x-schemaName: AdminCreateOrderCreditLines
* x-schemaName: AdminCreateOrderCreditLine
* required:
* - amount
* - reference
www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts
+1 -32
View File
@@ -46,38 +46,7 @@
* type: array
* description: The price list's prices.
* items:
* type: object
* description: A price's details.
* required:
* - currency_code
* - variant_id
* - amount
* 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 ID of the product variant this price is for.
* min_quantity:
* type: number
* title: min_quantity
* description: The minimum quantity required in the cart for this price to be applied.
* max_quantity:
* type: number
* title: max_quantity
* description: The maximum quantity in the cart that shouldn't be crossed for this price to be applied.
* rules:
* type: object
* description: The price's rules.
* example:
* region_id: reg_123
* $ref: "#/components/schemas/AdminCreatePriceListPrice"
*
*/
www/utils/generated/oas-output/schemas/AdminCreatePriceListPrice.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @schema AdminCreatePriceListPrice
* type: object
* description: The details of a price to be created within a price list.
* 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 ID of the product variant this price is for.
* min_quantity:
* type: number
* title: min_quantity
* description: The minimum quantity required in the cart for this price to be applied.
* max_quantity:
* type: number
* title: max_quantity
* description: The maximum quantity in the cart that shouldn't be crossed for this price to be applied.
* rules:
* type: object
* description: The price's rules.
* example:
* region_id: reg_123
* x-schemaName: AdminCreatePriceListPrice
*
*/
www/utils/generated/oas-output/schemas/AdminCreateShipment.ts
-34
View File
@@ -1,34 +0,0 @@
/**
* @schema AdminCreateShipment
* type: object
* description: The shipment's details.
* x-schemaName: AdminCreateShipment
* required:
* - labels
* properties:
* labels:
* type: array
* description: The shipment's labels.
* items:
* type: object
* description: A shipment label's details.
* required:
* - tracking_number
* - tracking_url
* - label_url
* properties:
* tracking_number:
* type: string
* title: tracking_number
* description: The label's tracking number.
* tracking_url:
* type: string
* title: tracking_url
* description: The label's tracking URL.
* label_url:
* type: string
* title: label_url
* description: The label's URL.
*
*/
www/utils/generated/oas-output/schemas/AdminCreateStockLocationFulfillmentSet.ts
+1 -1
View File
@@ -3,8 +3,8 @@
* type: object
* description: The fulfillment set to create.
* required:
* - type
* - name
* - type
* properties:
* name:
* type: string
www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts
+1 -1
View File
@@ -4,8 +4,8 @@
* description: The details of the variant-inventory item association.
* x-schemaName: AdminCreateVariantInventoryItem
* required:
* - inventory_item_id
* - required_quantity
* - inventory_item_id
* properties:
* required_quantity:
* type: number
www/utils/generated/oas-output/schemas/AdminDismissItems.ts
+31
View File
@@ -0,0 +1,31 @@
/**
* @schema AdminDismissItems
* type: object
* description: The items details.
* x-schemaName: AdminDismissItems
* properties:
* items:
* type: array
* description: The items details.
* items:
* type: object
* description: An item's details.
* required:
* - id
* - quantity
* properties:
* id:
* type: string
* title: id
* description: The ID of the item in the order.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* internal_note:
* type: string
* title: internal_note
* description: A note viewed only by admin users.
*
*/
www/utils/generated/oas-output/schemas/AdminDraftOrder.ts
+1 -1
View File
@@ -8,13 +8,13 @@
* - items
* - shipping_methods
* - status
* - currency_code
* - id
* - version
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - currency_code
* - payment_status
* - fulfillment_status
* - summary
www/utils/generated/oas-output/schemas/AdminDraftOrderParams.ts
+13
View File
@@ -0,0 +1,13 @@
/**
* @schema AdminDraftOrderParams
* type: object
* description: The parameters for retrieving draft orders.
* x-schemaName: AdminDraftOrderParams
* properties:
* fields:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
*/
www/utils/generated/oas-output/schemas/AdminDraftOrderPreview.ts
+1 -1
View File
@@ -7,13 +7,13 @@
* - return_requested_total
* - order_change
* - status
* - currency_code
* - id
* - version
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - currency_code
* - payment_collections
* - payment_status
* - fulfillment_status
www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts → www/utils/generated/oas-output/schemas/AdminExchangeAddOutboundShipping.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostExchangesShippingReqSchema
* @schema AdminExchangeAddOutboundShipping
* type: object
* description: The outbound shipping method's details.
* x-schemaName: AdminPostExchangesShippingReqSchema
* x-schemaName: AdminExchangeAddOutboundShipping
* required:
* - shipping_option_id
* properties:
www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts → www/utils/generated/oas-output/schemas/AdminExchangeUpdateInboundShipping.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostExchangesShippingActionReqSchema
* @schema AdminExchangeUpdateInboundShipping
* type: object
* description: The details of the shipping method to update.
* x-schemaName: AdminPostExchangesShippingActionReqSchema
* x-schemaName: AdminExchangeUpdateInboundShipping
* properties:
* custom_amount:
* type: number
www/utils/generated/oas-output/schemas/AdminExchangeUpdateOutboundShipping.ts
+23
View File
@@ -0,0 +1,23 @@
/**
* @schema AdminExchangeUpdateOutboundShipping
* type: object
* description: The details of the shipping method to update.
* x-schemaName: AdminExchangeUpdateOutboundShipping
* properties:
* custom_amount:
* type: number
* title: custom_amount
* description: The shipping method's custom amount.
* internal_note:
* type: string
* title: internal_note
* description: A note viewed by admin users only.
* metadata:
* type: object
* description: The exchange's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
*
*/
www/utils/generated/oas-output/schemas/AdminFulfillmentDeliveryAddress.ts
+59
View File
@@ -0,0 +1,59 @@
/**
* @schema AdminFulfillmentDeliveryAddress
* type: object
* description: The address to deliver the items to.
* properties:
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* phone:
* type: string
* title: phone
* description: The customer's phone.
* company:
* type: string
* title: company
* description: The delivery address's company.
* address_1:
* type: string
* title: address_1
* description: The delivery address's first line.
* address_2:
* type: string
* title: address_2
* description: The delivery address's second line.
* city:
* type: string
* title: city
* description: The delivery address's city.
* country_code:
* type: string
* title: country_code
* description: The delivery address's country code.
* province:
* type: string
* title: province
* description: The delivery address's ISO 3166-2 province code. Must be lower-case.
* example: us-ca
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
* description: The delivery address's postal code.
* metadata:
* type: object
* description: The delivery address's metadata, used to store custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* x-schemaName: AdminFulfillmentDeliveryAddress
*
*/
www/utils/generated/oas-output/schemas/AdminIndexDetailsResponse.ts
+16
View File
@@ -0,0 +1,16 @@
/**
* @schema AdminIndexDetailsResponse
* type: object
* description: The index's metadata details.
* x-schemaName: AdminIndexDetailsResponse
* required:
* - metadata
* properties:
* metadata:
* type: array
* description: The index's metadata.
* items:
* $ref: "#/components/schemas/IndexInfo"
*
*/
www/utils/generated/oas-output/schemas/AdminIndexSyncPayload.ts
+17
View File
@@ -0,0 +1,17 @@
/**
* @schema AdminIndexSyncPayload
* type: object
* description: The details of the index sync.
* x-schemaName: AdminIndexSyncPayload
* required:
* - strategy
* properties:
* strategy:
* type: string
* description: The syncing strategy. `full` indicates a full reindex, while `reset` truncates tables and performs a fresh sync.
* enum:
* - full
* - reset
*
*/
www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts → www/utils/generated/oas-output/schemas/AdminInitiateReceiveReturn.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostReceiveReturnsReqSchema
* @schema AdminInitiateReceiveReturn
* type: object
* description: The return receival details.
* x-schemaName: AdminPostReceiveReturnsReqSchema
* x-schemaName: AdminInitiateReceiveReturn
* properties:
* internal_note:
* type: string
www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts → www/utils/generated/oas-output/schemas/AdminInitiateReturnRequest.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostReturnsReqSchema
* @schema AdminInitiateReturnRequest
* type: object
* description: The return's details.
* x-schemaName: AdminPostReturnsReqSchema
* x-schemaName: AdminInitiateReturnRequest
* required:
* - order_id
* properties:
www/utils/generated/oas-output/schemas/AdminMarkPaymentCollectionPaid.ts → www/utils/generated/oas-output/schemas/AdminMarkPaymentCollectionAsPaid.ts
+2 -2
View File
@@ -1,5 +1,5 @@
/**
* @schema AdminMarkPaymentCollectionPaid
* @schema AdminMarkPaymentCollectionAsPaid
* type: object
* description: The payment details.
* required:
@@ -9,7 +9,7 @@
* type: string
* title: order_id
* description: The ID of the order associated with the payment collection.
* x-schemaName: AdminMarkPaymentCollectionPaid
* x-schemaName: AdminMarkPaymentCollectionAsPaid
*
*/
www/utils/generated/oas-output/schemas/AdminOrder.ts
+1 -1
View File
@@ -8,13 +8,13 @@
* - items
* - shipping_methods
* - status
* - currency_code
* - id
* - version
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - currency_code
* - payment_status
* - fulfillment_status
* - summary
www/utils/generated/oas-output/schemas/AdminOrderChange.ts
+1 -1
View File
@@ -16,7 +16,6 @@
* - created_at
* - updated_at
* - order_id
* - canceled_at
* - return_id
* - exchange_id
* - claim_id
@@ -28,6 +27,7 @@
* - declined_reason
* - declined_at
* - canceled_by
* - canceled_at
* properties:
* id:
* type: string
www/utils/generated/oas-output/schemas/AdminOrderPreview.ts
+1 -1
View File
@@ -7,13 +7,13 @@
* - return_requested_total
* - order_change
* - status
* - currency_code
* - id
* - version
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - currency_code
* - payment_collections
* - payment_status
* - fulfillment_status
www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts
-41
View File
@@ -1,41 +0,0 @@
/**
* @schema AdminPostClaimsAddItemsReqSchema
* type: object
* description: The details of the outbound items to add to the claim.
* x-schemaName: AdminPostClaimsAddItemsReqSchema
* properties:
* items:
* type: array
* description: The outbound item's details.
* items:
* type: object
* description: An item's details.
* required:
* - variant_id
* - quantity
* properties:
* variant_id:
* type: string
* title: variant_id
* description: The ID of the associated product variant.
* quantity:
* type: number
* title: quantity
* description: The quantity to send to the customer.
* unit_price:
* type: number
* title: unit_price
* description: The item's unit price.
* internal_note:
* type: string
* title: internal_note
* description: A note viewed only by admin users.
* metadata:
* type: object
* description: The item's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
*
*/
www/utils/generated/oas-output/schemas/AdminProduct.ts
+1 -1
View File
@@ -11,13 +11,13 @@
* - length
* - title
* - status
* - description
* - id
* - created_at
* - updated_at
* - subtitle
* - thumbnail
* - handle
* - description
* - is_giftcard
* - width
* - weight
www/utils/generated/oas-output/schemas/AdminProductImage.ts
+7
View File
@@ -37,6 +37,13 @@
* type: number
* title: rank
* description: The image's rank among sibling images.
* product:
* $ref: "#/components/schemas/AdminProduct"
* variants:
* type: array
* description: The variants associated with the image.
* items:
* $ref: "#/components/schemas/AdminProductVariant"
* required:
* - id
* - url
www/utils/generated/oas-output/schemas/AdminProductVariant.ts
+10
View File
@@ -12,6 +12,7 @@
* - barcode
* - ean
* - upc
* - thumbnail
* - allow_backorder
* - manage_inventory
* - hs_code
@@ -142,6 +143,15 @@
* description: The variant's inventory items.
* items:
* $ref: "#/components/schemas/AdminProductVariantInventoryItemLink"
* images:
* type: array
* description: The variant's images.
* items:
* $ref: "#/components/schemas/AdminProductImage"
* thumbnail:
* type: string
* title: thumbnail
* description: The variant's thumbnail.
*
*/
www/utils/generated/oas-output/schemas/AdminPostReturnsReceiveItemsReqSchema.ts → www/utils/generated/oas-output/schemas/AdminReceiveItems.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostReturnsReceiveItemsReqSchema
* @schema AdminReceiveItems
* type: object
* description: The items details.
* x-schemaName: AdminPostReturnsReceiveItemsReqSchema
* x-schemaName: AdminReceiveItems
* properties:
* items:
* type: array
www/utils/generated/oas-output/schemas/AdminCreatePaymentRefund.ts → www/utils/generated/oas-output/schemas/AdminRefundPayment.ts
+2 -2
View File
@@ -1,5 +1,5 @@
/**
* @schema AdminCreatePaymentRefund
* @schema AdminRefundPayment
* type: object
* description: The refund's details.
* properties:
@@ -15,7 +15,7 @@
* type: string
* title: note
* description: A note to attach to the refund.
* x-schemaName: AdminCreatePaymentRefund
* x-schemaName: AdminRefundPayment
*
*/
www/utils/generated/oas-output/schemas/AdminRegion.ts
+2 -2
View File
@@ -4,9 +4,9 @@
* description: The region's details.
* x-schemaName: AdminRegion
* required:
* - name
* - currency_code
* - id
* - currency_code
* - name
* properties:
* id:
* type: string
www/utils/generated/oas-output/schemas/AdminTransferOrder.ts → www/utils/generated/oas-output/schemas/AdminRequestOrderTransfer.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminTransferOrder
* @schema AdminRequestOrderTransfer
* type: object
* description: The details of the request to transfer the order.
* x-schemaName: AdminTransferOrder
* x-schemaName: AdminRequestOrderTransfer
* required:
* - customer_id
* properties:
www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts → www/utils/generated/oas-output/schemas/AdminUpdateClaimItem.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostClaimsItemsActionReqSchema
* @schema AdminUpdateClaimItem
* type: object
* description: The details to update in the item.
* x-schemaName: AdminPostClaimsItemsActionReqSchema
* x-schemaName: AdminUpdateClaimItem
* properties:
* quantity:
* type: number
www/utils/generated/oas-output/schemas/AdminUpdateClaimOutboundItem.ts
+21
View File
@@ -0,0 +1,21 @@
/**
* @schema AdminUpdateClaimOutboundItem
* type: object
* description: The details to update in the item.
* x-schemaName: AdminUpdateClaimOutboundItem
* properties:
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* reason_id:
* type: string
* title: reason_id
* description: The ID of the return reason associated with the item.
* internal_note:
* type: string
* title: internal_note
* description: A note that's only viewed by admin users.
*
*/
www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts
+2 -108
View File
@@ -10,115 +10,9 @@
* description: The customer email associated with the draft order.
* format: email
* shipping_address:
* type: object
* description: The draft order's shipping address.
* properties:
* first_name:
* type: string
* title: first_name
* description: The shipping address's first name.
* last_name:
* type: string
* title: last_name
* description: The shipping address's last name.
* phone:
* type: string
* title: phone
* description: The shipping address's phone.
* company:
* type: string
* title: company
* description: The shipping address's company.
* address_1:
* type: string
* title: address_1
* description: The first address line.
* address_2:
* type: string
* title: address_2
* description: The second address line.
* city:
* type: string
* title: city
* description: The shipping address's city.
* country_code:
* type: string
* title: country_code
* description: The shipping address's country code.
* example: us
* province:
* type: string
* title: province
* description: The shipping address's ISO 3166-2 province code. Must be lower-case.
* example: us-ca
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
* description: The shipping address's postal code.
* metadata:
* type: object
* description: The shipping address's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* $ref: "#/components/schemas/OrderAddress"
* billing_address:
* type: object
* description: The draft order's billing address.
* properties:
* 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 first address line.
* address_2:
* type: string
* title: address_2
* description: The second address line.
* 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.
* example: us
* province:
* type: string
* title: province
* description: The billing address's ISO 3166-2 province code. Must be lower-case.
* example: us-ca
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
* description: The billing address's postal code.
* metadata:
* type: object
* description: The billing address's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* $ref: "#/components/schemas/OrderAddress"
* metadata:
* type: object
* description: The draft order's metadata, can hold custom key-value pairs.
www/utils/generated/oas-output/schemas/AdminPostExchangesItemsActionReqSchema.ts → www/utils/generated/oas-output/schemas/AdminUpdateExchangeOutboundItem.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostExchangesItemsActionReqSchema
* @schema AdminUpdateExchangeOutboundItem
* type: object
* description: The details to update in an outbound item.
* x-schemaName: AdminPostExchangesItemsActionReqSchema
* x-schemaName: AdminUpdateExchangeOutboundItem
* properties:
* quantity:
* type: number
www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZones.ts → www/utils/generated/oas-output/schemas/AdminUpdateFulfillmentSetServiceZone.ts
+2 -2
View File
@@ -1,5 +1,5 @@
/**
* @schema AdminUpdateFulfillmentSetServiceZones
* @schema AdminUpdateFulfillmentSetServiceZone
* type: object
* description: The service zone's details.
* properties:
@@ -157,7 +157,7 @@
* type: string
* title: id
* description: The ID of an existing geo zone.
* x-schemaName: AdminUpdateFulfillmentSetServiceZones
* x-schemaName: AdminUpdateFulfillmentSetServiceZone
*
*/
www/utils/generated/oas-output/schemas/AdminUpdateInventoryLocationLevel.ts → www/utils/generated/oas-output/schemas/AdminUpdateInventoryLevel.ts
+2 -2
View File
@@ -1,5 +1,5 @@
/**
* @schema AdminUpdateInventoryLocationLevel
* @schema AdminUpdateInventoryLevel
* type: object
* description: The properties to update in the inventory level.
* properties:
@@ -11,7 +11,7 @@
* type: number
* title: incoming_quantity
* description: The inventory level's incoming quantity.
* x-schemaName: AdminUpdateInventoryLocationLevel
* x-schemaName: AdminUpdateInventoryLevel
*
*/
www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts
+2 -108
View File
@@ -10,115 +10,9 @@
* description: The order's email.
* format: email
* shipping_address:
* type: object
* description: The order's shipping address.
* properties:
* first_name:
* type: string
* title: first_name
* description: The address's first name.
* last_name:
* type: string
* title: last_name
* description: The address's last name.
* phone:
* type: string
* title: phone
* description: The address's phone.
* company:
* type: string
* title: company
* description: The address's company.
* address_1:
* type: string
* title: address_1
* description: The address's first line.
* address_2:
* type: string
* title: address_2
* description: The address's second line.
* city:
* type: string
* title: city
* description: The address's city.
* country_code:
* type: string
* title: country_code
* description: The address's country code.
* example: us
* province:
* type: string
* title: province
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: us-ca
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
* description: The address's postal code.
* metadata:
* type: object
* description: The address's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* $ref: "#/components/schemas/OrderAddress"
* billing_address:
* type: object
* description: The order's billing address.
* properties:
* first_name:
* type: string
* title: first_name
* description: The address's first name.
* last_name:
* type: string
* title: last_name
* description: The address's last name.
* phone:
* type: string
* title: phone
* description: The address's phone.
* company:
* type: string
* title: company
* description: The address's company.
* address_1:
* type: string
* title: address_1
* description: The address's first line.
* address_2:
* type: string
* title: address_2
* description: The address's second line.
* city:
* type: string
* title: city
* description: The address's city.
* country_code:
* type: string
* title: country_code
* description: The address's country code.
* example: us
* province:
* type: string
* title: province
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: us-ca
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
* description: The address's postal code.
* metadata:
* type: object
* description: The address's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* $ref: "#/components/schemas/OrderAddress"
* metadata:
* type: object
* description: The order's metadata, can hold custom key-value pairs.
www/utils/generated/oas-output/schemas/AdminUpdatePaymentRefundReason.ts → www/utils/generated/oas-output/schemas/AdminUpdateRefundReason.ts
+8 -2
View File
@@ -1,5 +1,5 @@
/**
* @schema AdminUpdatePaymentRefundReason
* @schema AdminUpdateRefundReason
* type: object
* description: The properties to update in the refund reason.
* properties:
@@ -15,7 +15,13 @@
* type: string
* title: code
* description: The refund reason's code.
* x-schemaName: AdminUpdatePaymentRefundReason
* metadata:
* type: object
* description: The refund reason's metadata.
* x-schemaName: AdminUpdateRefundReason
* required:
* - label
* - code
*
*/
www/utils/generated/oas-output/schemas/AdminUpdateReturnItems.ts
+27
View File
@@ -0,0 +1,27 @@
/**
* @schema AdminUpdateReturnItems
* type: object
* description: The details to update in the item.
* x-schemaName: AdminUpdateReturnItems
* properties:
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* internal_note:
* type: string
* title: internal_note
* description: A note viewed only by admin users.
* reason_id:
* type: string
* title: reason_id
* description: The ID of the associated return reason.
* metadata:
* type: object
* description: The claim's metadata, can hold custom key-value pairs.
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
*
*/
www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts → www/utils/generated/oas-output/schemas/AdminUpdateReturnRequest.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostReturnsReturnReqSchema
* @schema AdminUpdateReturnRequest
* type: object
* description: The return's details.
* x-schemaName: AdminPostReturnsReturnReqSchema
* x-schemaName: AdminUpdateReturnRequest
* properties:
* location_id:
* type: string
www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts → www/utils/generated/oas-output/schemas/AdminUpdateReturnShipping.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema AdminPostReturnsShippingActionReqSchema
* @schema AdminUpdateReturnShipping
* type: object
* description: The shipping method's details.
* x-schemaName: AdminPostReturnsShippingActionReqSchema
* x-schemaName: AdminUpdateReturnShipping
* properties:
* custom_amount:
* type: number
www/utils/generated/oas-output/schemas/AdminUpdateShippingOption.ts
+214
View File
@@ -0,0 +1,214 @@
/**
* @schema AdminUpdateShippingOption
* type: object
* description: The properties to update in the shipping option type.
* properties:
* name:
* type: string
* title: name
* description: The shipping option's name.
* data:
* type: object
* description: The shipping option's data.
* price_type:
* type: string
* description: The shipping option's price type.
* enum:
* - flat
* - calculated
* provider_id:
* type: string
* title: provider_id
* description: The shipping option's provider id.
* shipping_profile_id:
* type: string
* title: shipping_profile_id
* description: The shipping option's shipping profile id.
* type:
* $ref: "#/components/schemas/AdminCreateShippingOptionType"
* type_id:
* type: string
* title: type_id
* description: The shipping option's type id.
* prices:
* type: array
* description: The shipping option's prices.
* items:
* oneOf:
* - type: object
* description: The price's prices.
* x-schemaName: AdminUpdateShippingOptionPriceWithCurrency
* properties:
* id:
* type: string
* title: id
* description: The price's ID.
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* amount:
* type: number
* title: amount
* description: The price's amount.
* rules:
* type: array
* description: The price's rules.
* items:
* type: object
* description: The rule's rules.
* x-schemaName: PriceRule
* required:
* - attribute
* - operator
* - value
* properties:
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* operator:
* type: string
* description: The rule's operator.
* enum:
* - gt
* - lt
* - eq
* - lte
* - gte
* value:
* type: number
* title: value
* description: The rule's value.
* - type: object
* description: The price's prices.
* x-schemaName: AdminUpdateShippingOptionPriceWithRegion
* properties:
* id:
* type: string
* title: id
* description: The price's ID.
* region_id:
* type: string
* title: region_id
* description: The price's region id.
* amount:
* type: number
* title: amount
* description: The price's amount.
* rules:
* type: array
* description: The price's rules.
* items:
* type: object
* description: The rule's rules.
* x-schemaName: PriceRule
* required:
* - attribute
* - operator
* - value
* properties:
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* operator:
* type: string
* description: The rule's operator.
* enum:
* - gt
* - lt
* - eq
* - lte
* - gte
* value:
* type: number
* title: value
* description: The rule's value.
* rules:
* type: array
* description: The shipping option's rules.
* items:
* oneOf:
* - type: object
* description: The rule's rules.
* x-schemaName: AdminCreateShippingOptionRule
* required:
* - operator
* - attribute
* - value
* properties:
* operator:
* type: string
* description: The rule's operator.
* enum:
* - gt
* - lt
* - eq
* - ne
* - in
* - lte
* - gte
* - nin
* 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.
* - type: object
* description: The rule's rules.
* x-schemaName: AdminUpdateShippingOptionRule
* required:
* - id
* - operator
* - attribute
* - value
* properties:
* id:
* type: string
* title: id
* description: The rule's ID.
* operator:
* type: string
* description: The rule's operator.
* enum:
* - gt
* - lt
* - eq
* - ne
* - in
* - lte
* - gte
* - nin
* 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.
* metadata:
* type: object
* description: The shipping option's metadata.
* x-schemaName: AdminUpdateShippingOption
*
*/
www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts
+1 -43
View File
@@ -9,49 +9,7 @@
* title: name
* description: The stock location's name.
* address:
* type: object
* description: The stock location's address. Pass this property if you're creating a new address to associate with the location.
* required:
* - address_1
* - country_code
* properties:
* address_1:
* type: string
* title: address_1
* description: The address's first line.
* address_2:
* type: string
* title: address_2
* description: The address's second line.
* company:
* type: string
* title: company
* description: The address's company.
* city:
* type: string
* title: city
* description: The address's city.
* country_code:
* type: string
* title: country_code
* description: The address's country code.
* example: us
* phone:
* type: string
* title: phone
* description: The address's phone.
* postal_code:
* type: string
* title: postal_code
* description: The address's postal code.
* province:
* type: string
* title: province
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: us-ca
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* $ref: "#/components/schemas/AdminUpsertStockLocationAddress"
* address_id:
* type: string
* title: address_id
www/utils/generated/oas-output/schemas/AdminUpdateStore.ts
+1 -18
View File
@@ -12,24 +12,7 @@
* type: array
* description: The store's supported currencies.
* items:
* type: object
* description: A store currency.
* required:
* - currency_code
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The currency's code.
* example: usd
* is_default:
* type: boolean
* title: is_default
* description: Whether the currency is the default in the store.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: Whether prices using this currency are tax inclusive.
* $ref: "#/components/schemas/AdminUpdateStoreSupportedCurrency"
* default_sales_channel_id:
* type: string
* title: default_sales_channel_id
www/utils/generated/oas-output/schemas/AdminUpdateStoreSupportedCurrency.ts
+24
View File
@@ -0,0 +1,24 @@
/**
* @schema AdminUpdateStoreSupportedCurrency
* type: object
* description: The details to update in a supported currency of the store.
* required:
* - currency_code
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The currency's code.
* example: usd
* is_default:
* type: boolean
* title: is_default
* description: Whether the currency is the default in the store.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: Whether prices using this currency are tax inclusive.
* x-schemaName: AdminUpdateStoreSupportedCurrency
*
*/
www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts
+3 -16
View File
@@ -16,22 +16,7 @@
* type: array
* description: The tax rate's rules.
* items:
* type: object
* description: A tax rate rule.
* required:
* - reference
* - reference_id
* properties:
* reference:
* type: string
* title: reference
* description: The name of the table this rule references.
* example: product_type
* reference_id:
* type: string
* title: reference_id
* description: The ID of the record in the table that the rule references.
* example: ptyp_123
* $ref: "#/components/schemas/AdminCreateTaxRateRule"
* name:
* type: string
* title: name
@@ -52,6 +37,8 @@
* externalDocs:
* url: https://docs.medusajs.com/api/admin#manage-metadata
* description: Learn how to manage metadata
* required:
* - code
*
*/
www/utils/generated/oas-output/schemas/BaseProductVariant.ts
+5
View File
@@ -10,6 +10,7 @@
* - barcode
* - ean
* - upc
* - thumbnail
* - allow_backorder
* - manage_inventory
* - hs_code
@@ -131,6 +132,10 @@
* externalDocs:
* url: https://docs.medusajs.com/api/store#manage-metadata
* description: Learn how to manage metadata
* thumbnail:
* type: string
* title: thumbnail
* description: The variant's thumbnail.
*
*/
www/utils/generated/oas-output/schemas/IndexInfo.ts
+48
View File
@@ -0,0 +1,48 @@
/**
* @schema IndexInfo
* type: object
* description: The index's metadata information.
* x-schemaName: IndexInfo
* required:
* - id
* - entity
* - status
* - fields
* - updated_at
* - last_synced_key
* properties:
* id:
* type: string
* title: id
* description: The index's ID.
* entity:
* type: string
* title: entity
* description: The index's entity.
* status:
* type: string
* description: The index's syncing or ingesting status.
* enum:
* - pending
* - error
* - done
* - processing
* fields:
* type: array
* description: The index's fields.
* items:
* type: string
* title: fields
* description: The index's fields.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the index was last updated.
* last_synced_key:
* type: string
* title: last_synced_key
* description: The key of the last index sync.
*
*/
www/utils/generated/oas-output/schemas/StoreCart.ts
+1 -1
View File
@@ -5,8 +5,8 @@
* x-schemaName: StoreCart
* required:
* - promotions
* - currency_code
* - id
* - currency_code
* - original_item_total
* - original_item_subtotal
* - original_item_tax_total
www/utils/generated/oas-output/schemas/StoreDeclineOrderTransferRequest.ts → www/utils/generated/oas-output/schemas/StoreDeclineOrderTransfer.ts
+2 -2
View File
@@ -1,8 +1,8 @@
/**
* @schema StoreDeclineOrderTransferRequest
* @schema StoreDeclineOrderTransfer
* type: object
* description: The details of declining the order transfer request.
* x-schemaName: StoreDeclineOrderTransferRequest
* x-schemaName: StoreDeclineOrderTransfer
* required:
* - token
* properties:
www/utils/generated/oas-output/schemas/StoreOrder.ts
+1 -1
View File
@@ -7,12 +7,12 @@
* - items
* - shipping_methods
* - status
* - currency_code
* - id
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - currency_code
* - payment_status
* - fulfillment_status
* - summary
www/utils/generated/oas-output/schemas/StoreProductVariant.ts
+7 -2
View File
@@ -116,6 +116,10 @@
* description: The variant's rank among its siblings.
* calculated_price:
* $ref: "#/components/schemas/BaseCalculatedPriceSet"
* thumbnail:
* type: string
* title: thumbnail
* description: The variant's thumbnail.
* required:
* - options
* - length
@@ -123,6 +127,7 @@
* - id
* - created_at
* - updated_at
* - thumbnail
* - width
* - weight
* - height
@@ -131,12 +136,12 @@
* - mid_code
* - material
* - deleted_at
* - sku
* - barcode
* - manage_inventory
* - allow_backorder
* - ean
* - upc
* - barcode
* - sku
*
*/
www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts
+1 -1
View File
@@ -103,7 +103,7 @@
* type: string
* title: country_code
* description: The address's country code.
* example: "us"
* example: us
* province:
* type: string
* title: province