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

@@ -6,16 +6,25 @@ description: >-
Order, and enables resends.
type: object
required:
- created_at
- customer_id
- data
- event_name
- id
- parent_id
- provider_id
- resource_type
- resource_id
- to
- updated_at
properties:
id:
type: string
description: The notification's ID
type: string
example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
event_name:
description: The name of the event that the notification was sent for.
nullable: true
type: string
example: order.placed
resource_type:
@@ -28,11 +37,13 @@ properties:
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
customer_id:
description: The ID of the Customer that the Notification was sent to.
nullable: true
type: string
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
customer:
description: A customer object. Available if the relation `customer` is expanded.
type: object
nullable: true
$ref: ./Customer.yaml
to:
description: >-
The address that the Notification was sent to. This will usually be an
@@ -45,23 +56,36 @@ properties:
necessary for the Notification Provider to initiate a resend.
type: object
example: {}
parent_id:
description: The notification's parent ID
nullable: true
type: string
example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
parent_notification:
description: Available if the relation `parent_notification` is expanded.
nullable: true
$ref: ./Notification.yaml
resends:
description: The resends that have been completed after the original Notification.
description: >-
The resends that have been completed after the original Notification.
Available if the relation `resends` is expanded.
type: array
items:
$ref: ./NotificationResend.yaml
$ref: ./Notification.yaml
provider_id:
description: The id of the Notification Provider that handles the Notification.
nullable: true
type: string
example: sengrid
provider:
description: Available if the relation `provider` is expanded.
nullable: true
$ref: ./NotificationProvider.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