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

chore(docs): Updated API Reference (automated) (#10258)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]Oli JuhlShahed Nasser
 authored and GitHub committed 2024-11-25 14:33:22 +00:00
1 parent 3ab056e572
commit 7865909891
73 files changed
+2943 -275
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/utils/generated/oas-output/schemas/AdminBatchProductRequest.ts
+1 -1
View File
@@ -13,7 +13,7 @@
* type: array
* description: The products to update.
* items:
* $ref: "#/components/schemas/AdminUpdateProduct"
* $ref: "#/components/schemas/AdminBatchUpdateProduct"
* delete:
* type: array
* description: The products to delete.
www/utils/generated/oas-output/schemas/AdminBatchUpdateProduct.ts
+162
View File
@@ -0,0 +1,162 @@
/**
* @schema AdminBatchUpdateProduct
* type: object
* description: The product's details.
* x-schemaName: AdminBatchUpdateProduct
* properties:
* title:
* type: string
* title: title
* description: The product's title.
* subtitle:
* type: string
* title: subtitle
* description: The product's subtitle.
* description:
* type: string
* title: description
* description: The product's description.
* is_giftcard:
* type: boolean
* title: is_giftcard
* description: Whether the product is a gift card.
* discountable:
* type: boolean
* title: discountable
* description: Whether discounts can be applied on the product.
* images:
* type: array
* description: The product's images.
* items:
* type: object
* description: The image's details.
* required:
* - url
* properties:
* url:
* type: string
* title: url
* description: The image's URL.
* thumbnail:
* type: string
* title: thumbnail
* description: The product's thumbnail URL.
* handle:
* type: string
* title: handle
* description: The product's unique handle.
* status:
* type: string
* description: The product's status.
* enum:
* - draft
* - proposed
* - published
* - rejected
* type_id:
* type: string
* title: type_id
* description: The ID of the product's type.
* collection_id:
* type: string
* title: collection_id
* description: The ID of the product's collection.
* categories:
* type: array
* description: The product's categories.
* items:
* type: object
* description: The product's category.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The category's ID.
* tags:
* type: array
* description: The product's tags.
* items:
* type: object
* description: The product's tag.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The tag's ID.
* options:
* type: array
* description: The product's options.
* items:
* $ref: "#/components/schemas/AdminUpdateProductOption"
* variants:
* type: array
* description: The product's variants. You can add new variants or update existing ones, passing their IDs in the object.
* items:
* oneOf:
* - $ref: "#/components/schemas/AdminCreateProductVariant"
* - $ref: "#/components/schemas/AdminUpdateProductVariant"
* sales_channels:
* type: array
* description: The sales channels that the product is available in.
* items:
* type: object
* description: The sales channel's details.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The sales channel's ID.
* weight:
* type: number
* title: weight
* description: The product's weight.
* length:
* type: number
* title: length
* description: The product's length.
* height:
* type: number
* title: height
* description: The product's height.
* width:
* type: number
* title: width
* description: The product's width.
* hs_code:
* type: string
* title: hs_code
* description: The product's HS code.
* mid_code:
* type: string
* title: mid_code
* description: The product's MID code.
* origin_country:
* type: string
* title: origin_country
* description: The product's origin country.
* material:
* type: string
* title: material
* description: The product's material.
* metadata:
* type: object
* description: The product's metadata, can hold custom key-value pairs.
* external_id:
* type: string
* title: external_id
* description: The ID of the product in an external or third-party system.
* id:
* type: string
* title: id
* description: The product's ID.
* required:
* - id
*
*/
www/utils/generated/oas-output/schemas/AdminProductImage.ts
+5
View File
@@ -30,9 +30,14 @@
* metadata:
* type: object
* description: The image's metadata, can hold custom key-value pairs.
* rank:
* type: number
* title: rank
* description: The image's rank among sibling images.
* required:
* - id
* - url
* - rank
*
*/
www/utils/generated/oas-output/schemas/AdminTransferOrder.ts
+23
View File
@@ -0,0 +1,23 @@
/**
* @schema AdminTransferOrder
* type: object
* description: The details of the request to transfer the order.
* x-schemaName: AdminTransferOrder
* required:
* - customer_id
* properties:
* customer_id:
* type: string
* title: customer_id
* description: The ID of the customer to transfer the order to.
* description:
* type: string
* title: description
* description: The description of the order transfer, which can be shown to the customer receiving the order transfer request.
* internal_note:
* type: string
* title: internal_note
* description: An internal note viewable only by admin users.
*
*/
www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts
+54
View File
@@ -53,9 +53,63 @@
* calculated_price:
* type: object
* description: The calculated price's details.
* properties:
* id:
* type: string
* title: id
* description: The ID of the price.
* price_list_id:
* type: string
* title: price_list_id
* description: The ID of the associated price list.
* price_list_type:
* type: string
* title: price_list_type
* description: The price list's type. For example, sale.
* min_quantity:
* type: number
* title: min_quantity
* description: The minimum quantity required in the cart for this price to apply.
* max_quantity:
* type: number
* title: max_quantity
* description: The maximum quantity allowed in the cart for this price to apply.
* required:
* - id
* - price_list_id
* - price_list_type
* - min_quantity
* - max_quantity
* original_price:
* type: object
* description: The original price's details.
* properties:
* id:
* type: string
* title: id
* description: The ID of the price.
* price_list_id:
* type: string
* title: price_list_id
* description: The ID of the associated price list.
* price_list_type:
* type: string
* title: price_list_type
* description: The price list's type. For example, sale.
* min_quantity:
* type: number
* title: min_quantity
* description: The minimum quantity required in the cart for this price to apply.
* max_quantity:
* type: number
* title: max_quantity
* description: The maximum quantity allowed in the cart for this price to apply.
* required:
* - id
* - price_list_id
* - price_list_type
* - min_quantity
* - max_quantity
*
*/
www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts
+10 -10
View File
@@ -52,7 +52,7 @@
* type: object
* description: The shipping method's data, useful for fulfillment handling by third-party services.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property
* url: https://docs.medusajs.com/resources/commerce-modules/cart/concepts#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
@@ -77,36 +77,36 @@
* title: updated_at
* description: The date the shipping method was updated.
* original_total:
* type: string
* type: number
* title: original_total
* description: The shipping method's total including taxes, excluding promotions.
* original_subtotal:
* type: string
* type: number
* title: original_subtotal
* description: The shipping method's total excluding taxes, including promotions.
* original_tax_total:
* type: string
* type: number
* title: original_tax_total
* description: The total taxes applied on the shipping method's amount including promotions.
* total:
* type: string
* type: number
* title: total
* description: The shipping method's total amount including taxes and promotions.
* subtotal:
* type: string
* type: number
* title: subtotal
* description: The shipping method's total amount excluding taxes, including promotions.
* tax_total:
* type: string
* type: number
* title: tax_total
* description: The total taxes applied on the shipping method's amount including promotions.
* discount_total:
* type: string
* type: number
* title: discount_total
* description: The total amount discounted.
* discount_tax_total:
* type: string
* title: discount_total
* type: number
* title: discount_tax_total
* description: The taxes applied on the discounted amount.
*
*/
www/utils/generated/oas-output/schemas/BaseLineItemAdjustment.ts
+8 -8
View File
@@ -3,6 +3,14 @@
* type: object
* description: The adjustment's details.
* x-schemaName: BaseLineItemAdjustment
* required:
* - item
* - item_id
* - id
* - amount
* - cart_id
* - created_at
* - updated_at
* properties:
* item:
* $ref: "#/components/schemas/BaseCartLineItem"
@@ -48,14 +56,6 @@
* format: date-time
* title: updated_at
* description: The date the adjustment was updated.
* required:
* - item
* - item_id
* - id
* - amount
* - cart_id
* - created_at
* - updated_at
*
*/
www/utils/generated/oas-output/schemas/BaseLineItemTaxLine.ts
+10 -10
View File
@@ -3,6 +3,16 @@
* type: object
* description: The tax line's details
* x-schemaName: BaseLineItemTaxLine
* required:
* - item
* - item_id
* - total
* - subtotal
* - id
* - code
* - rate
* - created_at
* - updated_at
* properties:
* item:
* $ref: "#/components/schemas/BaseCartLineItem"
@@ -52,16 +62,6 @@
* format: date-time
* title: updated_at
* description: The date the tax line was updated.
* required:
* - item
* - item_id
* - total
* - subtotal
* - id
* - code
* - rate
* - created_at
* - updated_at
*
*/
www/utils/generated/oas-output/schemas/BaseProductImage.ts
+5
View File
@@ -30,9 +30,14 @@
* metadata:
* type: object
* description: The image's metadata, can hold custom key-value pairs.
* rank:
* type: number
* title: rank
* description: The image's rank among its sibling images.
* required:
* - id
* - url
* - rank
*
*/
www/utils/generated/oas-output/schemas/StoreAcceptOrderTransfer.ts
+15
View File
@@ -0,0 +1,15 @@
/**
* @schema StoreAcceptOrderTransfer
* type: object
* description: The details of accepting the order transfer.
* x-schemaName: StoreAcceptOrderTransfer
* required:
* - token
* properties:
* token:
* type: string
* title: token
* description: The order transfer's token issued when the transfer was requested.
*
*/
www/utils/generated/oas-output/schemas/StoreDeclineOrderTransferRequest.ts
+15
View File
@@ -0,0 +1,15 @@
/**
* @schema StoreDeclineOrderTransferRequest
* type: object
* description: The details of declining the order transfer request.
* x-schemaName: StoreDeclineOrderTransferRequest
* required:
* - token
* properties:
* token:
* type: string
* title: token
* description: The order transfer's token issued when the transfer was requested.
*
*/
www/utils/generated/oas-output/schemas/StoreProductImage.ts
+5
View File
@@ -6,6 +6,7 @@
* required:
* - id
* - url
* - rank
* properties:
* id:
* type: string
@@ -33,6 +34,10 @@
* metadata:
* type: object
* description: The image's metadata, can hold custom key-value pairs.
* rank:
* type: number
* title: rank
* description: The image's rank among its sibling images
*
*/
www/utils/generated/oas-output/schemas/StoreRequestOrderTransfer.ts
+13
View File
@@ -0,0 +1,13 @@
/**
* @schema StoreRequestOrderTransfer
* type: object
* description: The details of requesting the order transfer.
* x-schemaName: StoreRequestOrderTransfer
* properties:
* description:
* type: string
* title: description
* description: The transfer's description, which can be shown to the other customer receiving the request.
*
*/