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

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

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-07-29 09:41:02 +02:00
committed by GitHub
co-authored by kodiakhq
parent 56f634da4b
commit e40b4c6183
134 changed files with 7310 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/schemas/AdminExportProductResponse.ts
+4 -4
View File
@@ -4,12 +4,12 @@
* description: SUMMARY
* x-schemaName: AdminExportProductResponse
* required:
* - workflow_id
* - transaction_id
* properties:
* workflow_id:
* transaction_id:
* type: string
* title: workflow_id
* description: The product's workflow id.
* title: transaction_id
* description: The product's transaction id.
*
*/
www/utils/generated/oas-output/schemas/AdminImportProductResponse.ts
+20 -4
View File
@@ -4,12 +4,28 @@
* description: SUMMARY
* x-schemaName: AdminImportProductResponse
* required:
* - workflow_id
* - transaction_id
* - summary
* properties:
* workflow_id:
* transaction_id:
* type: string
* title: workflow_id
* description: The product's workflow id.
* title: transaction_id
* description: The product's transaction id.
* summary:
* type: object
* description: The product's summary.
* required:
* - toCreate
* - toUpdate
* properties:
* toCreate:
* type: number
* title: toCreate
* description: The summary's tocreate.
* toUpdate:
* type: number
* title: toUpdate
* description: The summary's toupdate.
*
*/
www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @schema AdminPostClaimItemsReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimItemsReqSchema
* properties:
* items:
* type: array
* description: The claim's items.
* items:
* type: object
* description: The item's items.
* required:
* - id
* - quantity
* properties:
* id:
* type: string
* title: id
* description: The item's ID.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* description:
* type: string
* title: description
* description: The item's description.
* internal_note:
* type: string
* title: internal_note
* description: The item's internal note.
* metadata:
* type: object
* description: The item's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminPostClaimsAddItemsReqSchema.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @schema AdminPostClaimsAddItemsReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimsAddItemsReqSchema
* properties:
* items:
* type: array
* description: The claim's items.
* items:
* type: object
* description: The item's items.
* required:
* - variant_id
* - quantity
* properties:
* variant_id:
* type: string
* title: variant_id
* description: The item's variant id.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* unit_price:
* type: number
* title: unit_price
* description: The item's unit price.
* internal_note:
* type: string
* title: internal_note
* description: The item's internal note.
* metadata:
* type: object
* description: The item's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts
+17
View File
@@ -0,0 +1,17 @@
/**
* @schema AdminPostClaimsItemsActionReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimsItemsActionReqSchema
* properties:
* quantity:
* type: number
* title: quantity
* description: The claim's quantity.
* internal_note:
* type: string
* title: internal_note
* description: The claim's internal note.
*
*/
www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts
+20
View File
@@ -0,0 +1,20 @@
/**
* @schema AdminPostClaimsShippingActionReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimsShippingActionReqSchema
* properties:
* custom_price:
* type: number
* title: custom_price
* description: The claim's custom price.
* internal_note:
* type: string
* title: internal_note
* description: The claim's internal note.
* metadata:
* type: object
* description: The claim's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts
+30
View File
@@ -0,0 +1,30 @@
/**
* @schema AdminPostClaimsShippingReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimsShippingReqSchema
* required:
* - shipping_option_id
* properties:
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The claim's shipping option id.
* custom_price:
* type: number
* title: custom_price
* description: The claim's custom price.
* description:
* type: string
* title: description
* description: The claim's description.
* internal_note:
* type: string
* title: internal_note
* description: The claim's internal note.
* metadata:
* type: object
* description: The claim's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts
+33
View File
@@ -0,0 +1,33 @@
/**
* @schema AdminPostOrderClaimsReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostOrderClaimsReqSchema
* required:
* - type
* - order_id
* - metadata
* properties:
* type:
* type: string
* enum:
* - refund
* - replace
* order_id:
* type: string
* title: order_id
* description: The claim's order id.
* description:
* type: string
* title: description
* description: The claim's description.
* internal_note:
* type: string
* title: internal_note
* description: The claim's internal note.
* metadata:
* type: object
* description: The claim's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsActionReqSchema.ts
+4 -4
View File
@@ -7,18 +7,18 @@
* quantity:
* type: number
* title: quantity
* description: The return's quantity.
* description: The claim's quantity.
* internal_note:
* type: string
* title: internal_note
* description: The return's internal note.
* description: The claim's internal note.
* reason_id:
* type: string
* title: reason_id
* description: The return's reason id.
* description: The claim's reason id.
* metadata:
* type: object
* description: The return's metadata.
* description: The claim's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminPostReturnsRequestItemsReqSchema.ts
+1 -1
View File
@@ -6,7 +6,7 @@
* properties:
* items:
* type: array
* description: The return's items.
* description: The claim's items.
* items:
* type: object
* description: The item's items.
www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts
+22
View File
@@ -0,0 +1,22 @@
/**
* @schema AdminPostReturnsReturnReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostReturnsReturnReqSchema
* required:
* - metadata
* properties:
* location_id:
* type: string
* title: location_id
* description: The return's location id.
* no_notification:
* type: boolean
* title: no_notification
* description: The return's no notification.
* metadata:
* type: object
* description: The return's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts
+5 -5
View File
@@ -9,22 +9,22 @@
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The return's shipping option id.
* description: The claim's shipping option id.
* custom_price:
* type: number
* title: custom_price
* description: The return's custom price.
* description: The claim's custom price.
* description:
* type: string
* title: description
* description: The return's description.
* description: The claim's description.
* internal_note:
* type: string
* title: internal_note
* description: The return's internal note.
* description: The claim's internal note.
* metadata:
* type: object
* description: The return's metadata.
* description: The claim's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminProduct.ts
+3 -3
View File
@@ -83,13 +83,13 @@
* type: string
* title: id
* description: The parent's ID.
* metadata:
* type: object
* description: The parent's metadata.
* handle:
* type: string
* title: handle
* description: The parent's handle.
* metadata:
* type: object
* description: The parent's metadata.
* hs_code:
* type: string
* title: hs_code
www/utils/generated/oas-output/schemas/StoreProduct.ts
+3 -3
View File
@@ -66,13 +66,13 @@
* type: string
* title: id
* description: The product's ID.
* metadata:
* type: object
* description: The product's metadata.
* handle:
* type: string
* title: handle
* description: The product's handle.
* metadata:
* type: object
* description: The product's metadata.
* hs_code:
* type: string
* title: hs_code