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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-14 20:32:28 +02:00
committed by GitHub
co-authored by olivermrbl
parent 67f9429293
commit 4fb22e8ba5
122 changed files with 8682 additions and 3866 deletions
@@ -7,12 +7,21 @@ description: >-
the amount will be in the currency defined for the Reigon.
type: object
required:
- currency_code
- amount
- created_at
- currency_code
- deleted_at
- id
- max_quantity
- min_quantity
- price_list_id
- region_id
- updated_at
- variant_id
properties:
id:
type: string
description: The money amount's ID
type: string
example: ma_01F0YESHRFQNH5S8Q0PK84YYZN
currency_code:
description: The 3 character currency code that the Money Amount is given in.
@@ -23,6 +32,7 @@ properties:
description: See a list of codes.
currency:
description: Available if the relation `currency` is expanded.
nullable: true
$ref: ./Currency.yaml
amount:
description: >-
@@ -34,51 +44,55 @@ properties:
description: >-
The minimum quantity that the Money Amount applies to. If this value is
not set, the Money Amount applies to all quantities.
nullable: true
type: integer
example: 1
max_quantity:
description: >-
The maximum quantity that the Money Amount applies to. If this value is
not set, the Money Amount applies to all quantities.
nullable: true
type: integer
example: 1
price_list_id:
type: string
description: The ID of the price list associated with the money amount
nullable: true
type: string
example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
price_list:
description: Available if the relation `price_list` is expanded.
nullable: true
$ref: ./PriceList.yaml
variant_id:
description: The id of the Product Variant contained in the Line Item.
nullable: true
type: string
example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
variant:
description: >-
The Product Variant contained in the Line Item. Available if the relation
`variant` is expanded.
type: object
nullable: true
$ref: ./ProductVariant.yaml
region_id:
type: string
description: The region's ID
nullable: true
type: string
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
region:
description: A region object. Available if the relation `region` is expanded.
type: object
nullable: true
$ref: ./Region.yaml
created_at:
type: string
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
type: string
description: The date with timezone at which the resource was updated.
type: string
format: date-time
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
example:
car: white