chore(docs): Generated API Reference (#2882)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
233d6904f8
commit
4814045036
61
docs/api/admin/components/schemas/NotificationResend.yaml
Normal file
61
docs/api/admin/components/schemas/NotificationResend.yaml
Normal file
@@ -0,0 +1,61 @@
|
||||
title: Notification Resend
|
||||
description: A resend of a Notification.
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
description: The notification resend's ID
|
||||
type: string
|
||||
example: noti_01F0YET45G9NHP08Z66CE4QKBS
|
||||
event_name:
|
||||
description: The name of the event that the notification was sent for.
|
||||
type: string
|
||||
example: order.placed
|
||||
resource_type:
|
||||
description: The type of resource that the Notification refers to.
|
||||
type: string
|
||||
example: order
|
||||
resource_id:
|
||||
description: The ID of the resource that the Notification refers to.
|
||||
type: string
|
||||
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
customer_id:
|
||||
description: The ID of the Customer that the Notification was sent to.
|
||||
type: string
|
||||
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
|
||||
customer:
|
||||
description: A customer object. Available if the relation `customer` is expanded.
|
||||
type: object
|
||||
to:
|
||||
description: >-
|
||||
The address that the Notification was sent to. This will usually be an
|
||||
email address, but represent other addresses such as a chat bot user id
|
||||
type: string
|
||||
example: user@example.com
|
||||
data:
|
||||
description: >-
|
||||
The data that the Notification was sent with. This contains all the data
|
||||
necessary for the Notification Provider to initiate a resend.
|
||||
type: object
|
||||
example: {}
|
||||
parent_id:
|
||||
description: The ID of the Notification that was originally sent.
|
||||
type: string
|
||||
example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
|
||||
parent_notification:
|
||||
description: Available if the relation `parent_notification` is expanded.
|
||||
$ref: ./Notification.yaml
|
||||
provider_id:
|
||||
description: The ID of the Notification Provider that handles the Notification.
|
||||
type: string
|
||||
example: sengrid
|
||||
provider:
|
||||
description: Available if the relation `provider` is expanded.
|
||||
$ref: ./NotificationProvider.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
format: date-time
|
||||
Reference in New Issue
Block a user