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

chore(docs): Generated API Reference (#2572)

Browse Source 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andshahednasser authored and GitHub committed 2022-11-09 18:30:06 +02:00
1 parent 884322447e
commit 325b1e9017
63 files changed
+2971 -248
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/store-spec3.json
+169 -18
View File
@@ -2617,7 +2617,7 @@ paths:
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
3 })
medusa.orderEdit.complete(orderEditId)
medusa.orderEdits.complete(order_edit_id)
.then(({ order_edit }) => {
console.log(order_edit.id)
})
@@ -2674,7 +2674,7 @@ paths:
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
3 })
medusa.orderEdit.decline(orderEditId)
medusa.orderEdits.decline(order_edit_id)
.then(({ order_edit }) => {
console.log(order_edit.id);
})
@@ -2723,7 +2723,7 @@ paths:
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
3 })
medusa.orderEdit.retrieve(orderEditId)
medusa.orderEdits.retrieve(order_edit_id)
.then(({ order_edit }) => {
console.log(order_edit.id);
@@ -3047,6 +3047,15 @@ paths:
- type: array
items:
type: string
- in: query
name: sales_channel_id
style: form
explode: false
description: an array of sales channel IDs to filter the retrieved products by.
schema:
type: array
items:
type: string
- in: query
name: collection_id
style: form
@@ -3056,6 +3065,15 @@ paths:
type: array
items:
type: string
- in: query
name: type_id
style: form
explode: false
description: Type IDs to search for
schema:
type: array
items:
type: string
- in: query
name: tags
style: form
@@ -3085,11 +3103,6 @@ paths:
description: Search for giftcards using is_giftcard=true.
schema:
type: boolean
- in: query
name: type
description: type to search for.
schema:
type: string
- in: query
name: created_at
description: Date comparison for when resulting products were created.
@@ -3613,8 +3626,8 @@ paths:
]
})
.then(({ return }) => {
console.log(return.id);
.then((data) => {
console.log(data.return.id);
});
- lang: Shell
label: cURL
@@ -6871,11 +6884,11 @@ components:
description: The ID of the order that is edited
example: order_01G2SG30J8C85S4A5CHM2S1NS2
order:
description: Order object
description: Available if the relation `order` is expanded.
$ref: '#/components/schemas/order'
changes:
type: array
description: Line item changes array.
description: Available if the relation `changes` is expanded.
items:
$ref: '#/components/schemas/order_item_change'
internal_note:
@@ -6951,11 +6964,35 @@ components:
The difference between the total amount of the order and total
amount of edited order.
example: 8200
status:
type: string
description: The status of the order edit.
enum:
- confirmed
- declined
- requested
- created
- canceled
items:
type: array
description: Computed line items from the changes.
description: Available if the relation `items` is expanded.
items:
$ref: '#/components/schemas/line_item'
payment_collection_id:
type: string
description: The ID of the payment collection
example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
payment_collection:
description: Available if the relation `payment_collection` is expanded.
$ref: '#/components/schemas/payment_collection'
created_at:
type: string
description: The date with timezone at which the resource was created.
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
format: date-time
order_item_change:
title: Order Item Change
description: Represents an order edit item change
@@ -6970,7 +7007,7 @@ components:
example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK
type:
type: string
description: The order's status
description: The order item change's status
enum:
- item_add
- item_remove
@@ -6980,22 +7017,39 @@ components:
description: The ID of the order edit
example: oe_01G2SG30J8C85S4A5CHM2S1NS2
order_edit:
description: Order edit object
description: Available if the relation `order_edit` is expanded.
$ref: '#/components/schemas/order_edit'
original_line_item_id:
type: string
description: The ID of the original line item in the order
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
original_line_item:
description: Original line item object.
description: Available if the relation `original_line_item` is expanded.
$ref: '#/components/schemas/line_item'
line_item_id:
type: string
description: The ID of the cloned line item.
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
line_item:
description: Line item object.
description: Available if the relation `line_item` is expanded.
$ref: '#/components/schemas/line_item'
created_at:
type: string
description: The date with timezone at which the resource was created.
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
example:
car: white
order:
title: Order
description: Represents an order
@@ -7274,6 +7328,103 @@ components:
type: integer
description: The total of gift cards with taxes
example: 0
payment_collection:
title: Payment Collection
description: Payment Collection
x-resourceId: payment_collection
required:
- type
- status
- amount
- region_id
- currency_code
- created_by
properties:
id:
type: string
description: The payment collection's ID
example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
type:
type: string
description: The type of the payment collection
enum:
- order_edit
status:
type: string
description: The type of the payment collection
enum:
- not_paid
- awaiting
- authorized
- partially_authorized
- captured
- partially_captured
- refunded
- partially_refunded
- canceled
- requires_action
description:
type: string
description: Description of the payment collection
amount:
type: number
description: Amount of the payment collection.
authorized_amount:
type: number
description: Authorized amount of the payment collection.
captured_amount:
type: number
description: Captured amount of the payment collection.
refunded_amount:
type: number
description: Refunded amount of the payment collection.
region_id:
type: string
description: The region's ID
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
region:
description: Available if the relation `region` is expanded.
$ref: '#/components/schemas/region'
currency_code:
description: The 3 character ISO code for the currency.
type: string
example: usd
externalDocs:
url: 'https://en.wikipedia.org/wiki/ISO_4217#Active_codes'
description: See a list of codes.
currency:
description: Available if the relation `currency` is expanded.
$ref: '#/components/schemas/currency'
payment_sessions:
type: array
description: Available if the relation `payment_sessions` is expanded.
items:
$ref: '#/components/schemas/payment_session'
payments:
type: array
description: Available if the relation `payments` is expanded.
items:
$ref: '#/components/schemas/payment'
created_by:
type: string
description: The ID of the user that created the payment collection.
created_at:
type: string
description: The date with timezone at which the resource was created.
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
example:
car: white
payment_provider:
title: Payment Provider
description: Represents a Payment Provider plugin and holds its installation status.
@@ -8312,7 +8463,7 @@ components:
properties:
id:
type: string
description: The cart's ID
description: The region's ID
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
name:
description: >-