Billing
6 months ago
Collection.php
6 months ago
Event.php
6 months ago
EventDestination.php
6 months ago
EventDestination.php
41 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace AmeliaVendor\Stripe\V2; |
| 6 | |
| 7 | /** |
| 8 | * Set up an event destination to receive events from Stripe across multiple destination types, including <a href="https://docs.stripe.com/webhooks">webhook endpoints</a> and <a href="https://docs.stripe.com/event-destinations/eventbridge">Amazon EventBridge</a>. Event destinations support receiving <a href="https://docs.stripe.com/api/v2/events">thin events</a> and <a href="https://docs.stripe.com/api/events">snapshot events</a>. |
| 9 | * |
| 10 | * @property string $id Unique identifier for the object. |
| 11 | * @property string $object String representing the object's type. Objects of the same type share the same value of the object field. |
| 12 | * @property null|(object{aws_account_id: string, aws_event_source_arn: string, aws_event_source_status: string}&\AmeliaVendor\Stripe\StripeObject) $amazon_eventbridge Amazon EventBridge configuration. |
| 13 | * @property int $created Time at which the object was created. |
| 14 | * @property string $description An optional description of what the event destination is used for. |
| 15 | * @property string[] $enabled_events The list of events to enable for this endpoint. |
| 16 | * @property string $event_payload Payload type of events being subscribed to. |
| 17 | * @property null|string[] $events_from Where events should be routed from. |
| 18 | * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode. |
| 19 | * @property null|\AmeliaVendor\Stripe\StripeObject $metadata Metadata. |
| 20 | * @property string $name Event destination name. |
| 21 | * @property null|string $snapshot_api_version If using the snapshot event payload, the API version events are rendered as. |
| 22 | * @property string $status Status. It can be set to either enabled or disabled. |
| 23 | * @property null|(object{disabled: null|(object{reason: string}&\AmeliaVendor\Stripe\StripeObject)}&\AmeliaVendor\Stripe\StripeObject) $status_details Additional information about event destination status. |
| 24 | * @property string $type Event destination type. |
| 25 | * @property int $updated Time at which the object was last updated. |
| 26 | * @property null|(object{signing_secret: null|string, url: null|string}&\AmeliaVendor\Stripe\StripeObject) $webhook_endpoint Webhook endpoint configuration. |
| 27 | */ |
| 28 | class EventDestination extends \AmeliaVendor\Stripe\ApiResource |
| 29 | { |
| 30 | const OBJECT_NAME = 'v2.core.event_destination'; |
| 31 | |
| 32 | const EVENT_PAYLOAD_SNAPSHOT = 'snapshot'; |
| 33 | const EVENT_PAYLOAD_THIN = 'thin'; |
| 34 | |
| 35 | const STATUS_DISABLED = 'disabled'; |
| 36 | const STATUS_ENABLED = 'enabled'; |
| 37 | |
| 38 | const TYPE_AMAZON_EVENTBRIDGE = 'amazon_eventbridge'; |
| 39 | const TYPE_WEBHOOK_ENDPOINT = 'webhook_endpoint'; |
| 40 | } |
| 41 |