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

View File

@@ -2,25 +2,32 @@ title: Payment Collection
description: Payment Collection
type: object
required:
- type
- status
- amount
- region_id
- currency_code
- authorized_amount
- created_at
- created_by
- currency_code
- deleted_at
- description
- id
- metadata
- region_id
- status
- type
- updated_at
properties:
id:
type: string
description: The payment collection's ID
type: string
example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
type:
type: string
description: The type of the payment collection
type: string
enum:
- order_edit
status:
type: string
description: The type of the payment collection
type: string
enum:
- not_paid
- awaiting
@@ -28,20 +35,23 @@ properties:
- partially_authorized
- canceled
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.
region_id:
nullable: true
type: string
amount:
description: Amount of the payment collection.
type: integer
authorized_amount:
description: Authorized amount of the payment collection.
nullable: true
type: integer
region_id:
description: The region's ID
type: string
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
region:
description: Available if the relation `region` is expanded.
nullable: true
$ref: ./Region.yaml
currency_code:
description: The 3 character ISO code for the currency.
@@ -52,34 +62,37 @@ properties:
description: See a list of codes.
currency:
description: Available if the relation `currency` is expanded.
nullable: true
$ref: ./Currency.yaml
payment_sessions:
type: array
description: Available if the relation `payment_sessions` is expanded.
type: array
items:
$ref: ./PaymentSession.yaml
payments:
type: array
description: Available if the relation `payments` is expanded.
type: array
items:
$ref: ./Payment.yaml
created_by:
type: string
description: The ID of the user that created the payment collection.
created_at:
type: string
created_at:
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