From 85c7bda515afa6783abc4992dfac1608bd0ad3cc Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Wed, 24 Apr 2024 13:03:59 +0000 Subject: [PATCH] Update generated code for v985 --- OPENAPI_VERSION | 2 +- types/EventTypes.d.ts | 22 +++++++++++----------- types/Events.d.ts | 8 ++++---- types/EventsResource.d.ts | 2 +- types/WebhookEndpoints.d.ts | 6 +++--- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index a040219e6e..8a5a8933c4 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v984 \ No newline at end of file +v985 \ No newline at end of file diff --git a/types/EventTypes.d.ts b/types/EventTypes.d.ts index 50d0e05fd0..10285b8bb1 100644 --- a/types/EventTypes.d.ts +++ b/types/EventTypes.d.ts @@ -725,7 +725,7 @@ declare module 'stripe' { } /** - * Occurs when funds are reinstated to your account after a dispute is closed. This includes [partially refunded payments](/docs/disputes#disputes-on-partially-refunded-payments). + * Occurs when funds are reinstated to your account after a dispute is closed. This includes [partially refunded payments](https://docs.stripe.com/disputes#disputes-on-partially-refunded-payments). */ interface ChargeDisputeFundsReinstatedEvent extends EventBase { type: 'charge.dispute.funds_reinstated'; @@ -1301,7 +1301,7 @@ declare module 'stripe' { } /** - * Occurs whenever collection is paused on a customer's subscription. Only applies when [payment collection](/docs/billing/subscriptions/pause) is paused, not when subscriptions enter `status=paused`. + * Occurs whenever collection is paused on a customer's subscription. Only applies when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is paused, not when subscriptions enter `status=paused`. */ interface CustomerSubscriptionCollectionPausedEvent extends EventBase { type: 'customer.subscription.collection_paused'; @@ -1317,7 +1317,7 @@ declare module 'stripe' { } /** - * Occurs whenever collection is resumed on a customer's subscription that is currently paused. Only applies when [payment collection](/docs/billing/subscriptions/pause) is resumed, not when subscriptions exit `status=paused`. + * Occurs whenever collection is resumed on a customer's subscription that is currently paused. Only applies when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is resumed, not when subscriptions exit `status=paused`. */ interface CustomerSubscriptionCollectionResumedEvent extends EventBase { type: 'customer.subscription.collection_resumed'; @@ -1349,7 +1349,7 @@ declare module 'stripe' { } /** - * An ad-hoc custom event that is sent based on user configured [Automation](/docs/billing/automations#send-custom-webhook-event-action). + * An ad-hoc custom event that is sent based on user configured [Automation](https://docs.stripe.com/billing/automations#send-custom-webhook-event-action). */ interface CustomerSubscriptionCustomEventEvent extends EventBase { type: 'customer.subscription.custom_event'; @@ -1381,7 +1381,7 @@ declare module 'stripe' { } /** - * Occurs whenever a customer's subscription is paused. Only applies when subscriptions enter `status=paused`, not when [payment collection](/docs/billing/subscriptions/pause) is paused. + * Occurs whenever a customer's subscription is paused. Only applies when subscriptions enter `status=paused`, not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is paused. */ interface CustomerSubscriptionPausedEvent extends EventBase { type: 'customer.subscription.paused'; @@ -1429,7 +1429,7 @@ declare module 'stripe' { } /** - * Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](/docs/api/subscriptions/resume), not when [payment collection](/docs/billing/subscriptions/pause) is resumed. + * Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](https://docs.stripe.com/api/subscriptions/resume), not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is resumed. */ interface CustomerSubscriptionResumedEvent extends EventBase { type: 'customer.subscription.resumed'; @@ -1836,7 +1836,7 @@ declare module 'stripe' { } /** - * Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see [Using Webhooks with Subscriptions](/docs/subscriptions/webhooks). + * Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see [Using Webhooks with Subscriptions](https://docs.stripe.com/subscriptions/webhooks). */ interface InvoiceCreatedEvent extends EventBase { type: 'invoice.created'; @@ -1868,7 +1868,7 @@ declare module 'stripe' { } /** - * Occurs whenever a draft invoice cannot be finalized. See the invoice’s [last finalization error](/docs/api/invoices/object#invoice_object-last_finalization_error) for details. + * Occurs whenever a draft invoice cannot be finalized. See the invoice’s [last finalization error](https://docs.stripe.com/api/invoices/object#invoice_object-last_finalization_error) for details. */ interface InvoiceFinalizationFailedEvent extends EventBase { type: 'invoice.finalization_failed'; @@ -2108,7 +2108,7 @@ declare module 'stripe' { } /** - * Represents a synchronous request for authorization, see [Using your integration to handle authorization requests](/docs/issuing/purchases/authorizations#authorization-handling). + * Represents a synchronous request for authorization, see [Using your integration to handle authorization requests](https://docs.stripe.com/issuing/purchases/authorizations#authorization-handling). */ interface IssuingAuthorizationRequestEvent extends EventBase { type: 'issuing_authorization.request'; @@ -2428,7 +2428,7 @@ declare module 'stripe' { } /** - * Occurs when a PaymentIntent has funds to be captured. Check the `amount_capturable` property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an `amount_to_capture` value up to the specified amount. [Learn more about capturing PaymentIntents.](https://stripe.com/docs/api/payment_intents/capture) + * Occurs when a PaymentIntent has funds to be captured. Check the `amount_capturable` property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an `amount_to_capture` value up to the specified amount. [Learn more about capturing PaymentIntents.](https://docs.stripe.com/api/payment_intents/capture) */ interface PaymentIntentAmountCapturableUpdatedEvent extends EventBase { type: 'payment_intent.amount_capturable_updated'; @@ -2636,7 +2636,7 @@ declare module 'stripe' { } /** - * Occurs whenever a payment method is updated via the [PaymentMethod update API](https://stripe.com/docs/api/payment_methods/update). + * Occurs whenever a payment method is updated via the [PaymentMethod update API](https://docs.stripe.com/api/payment_methods/update). */ interface PaymentMethodUpdatedEvent extends EventBase { type: 'payment_method.updated'; diff --git a/types/Events.d.ts b/types/Events.d.ts index 58c8826b63..57ebbdb82a 100644 --- a/types/Events.d.ts +++ b/types/Events.d.ts @@ -38,7 +38,7 @@ declare module 'stripe' { /** * The trigger name of the automation that triggered this action. - * Please visit [Revenue and retention automations](https://stripe.com/docs/billing/automations#choose-a-trigger) for all possible trigger names. + * Please visit [Revenue and retention automations](https://docs.stripe.com/billing/automations#choose-a-trigger) for all possible trigger names. */ trigger: string; @@ -367,10 +367,10 @@ declare module 'stripe' { * `Event` objects directly to an endpoint on your server. You can manage * webhooks in your * [account settings](https://dashboard.stripe.com/account/webhooks). Learn how - * to [listen for events](https://stripe.com/docs/webhooks) + * to [listen for events](https://docs.stripe.com/webhooks) * so that your integration can automatically trigger reactions. * - * When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications + * When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications * that occur in connected accounts. For these events, there's an * additional `account` attribute in the received `Event` object. * @@ -416,7 +416,7 @@ declare module 'stripe' { pending_webhooks: number; /** - * Information about the action that causes the event. Only present when the event is triggered by an API request or an [Automation](https://stripe.com/docs/billing/automations) action. + * Information about the action that causes the event. Only present when the event is triggered by an API request or an [Automation](https://docs.stripe.com/billing/automations) action. */ reason?: Event.Reason | null; diff --git a/types/EventsResource.d.ts b/types/EventsResource.d.ts index 91c67d7090..f82714f666 100644 --- a/types/EventsResource.d.ts +++ b/types/EventsResource.d.ts @@ -51,7 +51,7 @@ declare module 'stripe' { ): Promise>; /** - * List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://stripe.com/docs/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header). + * List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header). */ list( params?: EventListParams, diff --git a/types/WebhookEndpoints.d.ts b/types/WebhookEndpoints.d.ts index e905982b48..1e817a0cda 100644 --- a/types/WebhookEndpoints.d.ts +++ b/types/WebhookEndpoints.d.ts @@ -23,13 +23,13 @@ declare module 'stripe' { } /** - * You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be + * You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be * notified about events that happen in your Stripe account or connected * accounts. * * Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints. * - * Related guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure) + * Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure) */ interface WebhookEndpoint { /** @@ -83,7 +83,7 @@ declare module 'stripe' { metadata: Stripe.Metadata; /** - * The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. + * The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation. */ secret?: string;