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
parent 67f9429293
commit 4fb22e8ba5
122 changed files with 8682 additions and 3866 deletions
+28 -12
View File
@@ -4,14 +4,23 @@ description: >-
payment of an Order.
type: object
required:
- code
- value
- balance
- code
- created_at
- deleted_at
- ends_at
- id
- is_disabled
- metadata
- order_id
- region_id
- tax_rate
- updated_at
- value
properties:
id:
description: The gift card's ID
type: string
description: The cart's ID
example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
code:
description: >-
@@ -28,47 +37,54 @@ properties:
type: integer
example: 10
region_id:
type: string
description: The id of the Region in which the Gift Card is available.
type: string
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
region:
description: A region object. Available if the relation `region` is expanded.
type: object
nullable: true
$ref: ./Region.yaml
order_id:
type: string
description: The id of the Order that the Gift Card was purchased in.
nullable: true
type: string
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
order:
description: An order object. Available if the relation `order` is expanded.
nullable: true
type: object
is_disabled:
description: >-
Whether the Gift Card has been disabled. Disabled Gift Cards cannot be
applied to carts.
type: boolean
example: false
default: false
ends_at:
description: The time at which the Gift Card can no longer be used.
nullable: true
type: string
format: date-time
tax_rate:
description: The gift cards's tax rate that will be applied on calculating totals
description: The gift card's tax rate that will be applied on calculating totals
nullable: true
type: number
example: 0
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
nullable: true
type: object
example:
car: white