Skip to content

Commit

Permalink
Update generated code for v985
Browse files Browse the repository at this point in the history
  • Loading branch information
stripe-openapi[bot] committed Apr 24, 2024
1 parent 3398ce9 commit 85c7bda
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion OPENAPI_VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v984
v985
22 changes: 11 additions & 11 deletions types/EventTypes.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand All @@ -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';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down
8 changes: 4 additions & 4 deletions types/Events.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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.
*
Expand Down Expand Up @@ -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;

Expand Down
2 changes: 1 addition & 1 deletion types/EventsResource.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ declare module 'stripe' {
): Promise<Stripe.Response<Stripe.Event>>;

/**
* 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,
Expand Down
6 changes: 3 additions & 3 deletions types/WebhookEndpoints.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/**
Expand Down Expand Up @@ -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;

Expand Down

0 comments on commit 85c7bda

Please sign in to comment.