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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
co-authored by olivermrbl Shahed Nasser
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions
+31 -15
View File
@@ -1,5 +1,7 @@
title: Cart
description: Represents a user cart
description: >-
A cart represents a virtual shopping bag. It can be used to complete an order,
a swap, or a claim.
type: object
required:
- billing_address_id
@@ -35,7 +37,8 @@ properties:
type: string
example: addr_01G8ZH853YPY9B94857DY91YGW
billing_address:
description: Available if the relation `billing_address` is expanded.
description: The details of the billing address associated with the cart.
x-expandable: billing_address
nullable: true
$ref: ./Address.yaml
shipping_address_id:
@@ -44,12 +47,14 @@ properties:
type: string
example: addr_01G8ZH853YPY9B94857DY91YGW
shipping_address:
description: Available if the relation `shipping_address` is expanded.
description: The details of the shipping address associated with the cart.
x-expandable: shipping_address
nullable: true
$ref: ./Address.yaml
items:
description: Available if the relation `items` is expanded.
description: The line items added to the cart.
type: array
x-expandable: items
items:
$ref: ./LineItem.yaml
region_id:
@@ -57,17 +62,20 @@ properties:
type: string
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
region:
description: A region object. Available if the relation `region` is expanded.
description: The details of the region associated with the cart.
x-expandable: region
nullable: true
$ref: ./Region.yaml
discounts:
description: Available if the relation `discounts` is expanded.
description: An array of details of all discounts applied to the cart.
type: array
x-expandable: discounts
items:
$ref: ./Discount.yaml
gift_cards:
description: Available if the relation `gift_cards` is expanded.
description: An array of details of all gift cards applied to the cart.
type: array
x-expandable: gift_cards
items:
$ref: ./GiftCard.yaml
customer_id:
@@ -76,16 +84,19 @@ properties:
type: string
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
customer:
description: A customer object. Available if the relation `customer` is expanded.
description: The details of the customer the cart belongs to.
x-expandable: customer
nullable: true
type: object
payment_session:
description: The selected payment session in the cart.
description: The details of the selected payment session in the cart.
x-expandable: payment_session
nullable: true
type: object
payment_sessions:
description: The payment sessions created on the cart.
description: The details of all payment sessions created on the cart.
type: array
x-expandable: payment_sessions
items:
type: object
payment_id:
@@ -94,12 +105,14 @@ properties:
type: string
example: pay_01G8ZCC5W42ZNY842124G7P5R9
payment:
description: Available if the relation `payment` is expanded.
description: The details of the payment associated with the cart.
nullable: true
x-expandable: payment
type: object
shipping_methods:
description: The shipping methods added to the cart.
description: The details of the shipping methods added to the cart.
type: array
x-expandable: shipping_methods
items:
$ref: ./ShippingMethod.yaml
type:
@@ -144,10 +157,9 @@ properties:
type: string
example: null
sales_channel:
description: >-
A sales channel object. Available if the relation `sales_channel` is
expanded.
description: The details of the sales channel associated with the cart.
nullable: true
x-expandable: sales_channel
$ref: ./SalesChannel.yaml
created_at:
description: The date with timezone at which the resource was created.
@@ -168,6 +180,10 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
shipping_total:
description: The total of shipping
type: integer