@depup/stripe 21.0.0-depup.0

package/types/Events.d.ts

@@ -0,0 +1,373 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Event {
+      interface Data {
+        /**
+         * Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://api.stripe.com#invoice_object) as the value of the object key.
+         */
+        object: Data.Object;
+
+        /**
+         * Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.
+         */
+        previous_attributes?: Data.PreviousAttributes;
+      }
+
+      namespace Data {
+        interface Object {}
+
+        interface PreviousAttributes {}
+      }
+
+      interface Request {
+        /**
+         * ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
+         */
+        id: string | null;
+
+        /**
+         * The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
+         */
+        idempotency_key: string | null;
+      }
+
+      type Type =
+        | 'account.application.authorized'
+        | 'account.application.deauthorized'
+        | 'account.external_account.created'
+        | 'account.external_account.deleted'
+        | 'account.external_account.updated'
+        | 'account.updated'
+        | 'application_fee.created'
+        | 'application_fee.refund.updated'
+        | 'application_fee.refunded'
+        | 'balance.available'
+        | 'balance_settings.updated'
+        | 'billing.alert.triggered'
+        | 'billing.credit_grant.created'
+        | 'billing_portal.configuration.created'
+        | 'billing_portal.configuration.updated'
+        | 'billing_portal.session.created'
+        | 'capability.updated'
+        | 'cash_balance.funds_available'
+        | 'charge.captured'
+        | 'charge.dispute.closed'
+        | 'charge.dispute.created'
+        | 'charge.dispute.funds_reinstated'
+        | 'charge.dispute.funds_withdrawn'
+        | 'charge.dispute.updated'
+        | 'charge.expired'
+        | 'charge.failed'
+        | 'charge.pending'
+        | 'charge.refund.updated'
+        | 'charge.refunded'
+        | 'charge.succeeded'
+        | 'charge.updated'
+        | 'checkout.session.async_payment_failed'
+        | 'checkout.session.async_payment_succeeded'
+        | 'checkout.session.completed'
+        | 'checkout.session.expired'
+        | 'climate.order.canceled'
+        | 'climate.order.created'
+        | 'climate.order.delayed'
+        | 'climate.order.delivered'
+        | 'climate.order.product_substituted'
+        | 'climate.product.created'
+        | 'climate.product.pricing_updated'
+        | 'coupon.created'
+        | 'coupon.deleted'
+        | 'coupon.updated'
+        | 'credit_note.created'
+        | 'credit_note.updated'
+        | 'credit_note.voided'
+        | 'customer.created'
+        | 'customer.deleted'
+        | 'customer.discount.created'
+        | 'customer.discount.deleted'
+        | 'customer.discount.updated'
+        | 'customer.source.created'
+        | 'customer.source.deleted'
+        | 'customer.source.expiring'
+        | 'customer.source.updated'
+        | 'customer.subscription.created'
+        | 'customer.subscription.deleted'
+        | 'customer.subscription.paused'
+        | 'customer.subscription.pending_update_applied'
+        | 'customer.subscription.pending_update_expired'
+        | 'customer.subscription.resumed'
+        | 'customer.subscription.trial_will_end'
+        | 'customer.subscription.updated'
+        | 'customer.tax_id.created'
+        | 'customer.tax_id.deleted'
+        | 'customer.tax_id.updated'
+        | 'customer.updated'
+        | 'customer_cash_balance_transaction.created'
+        | 'entitlements.active_entitlement_summary.updated'
+        | 'file.created'
+        | 'financial_connections.account.account_numbers_updated'
+        | 'financial_connections.account.created'
+        | 'financial_connections.account.deactivated'
+        | 'financial_connections.account.disconnected'
+        | 'financial_connections.account.reactivated'
+        | 'financial_connections.account.refreshed_balance'
+        | 'financial_connections.account.refreshed_ownership'
+        | 'financial_connections.account.refreshed_transactions'
+        | 'financial_connections.account.upcoming_account_number_expiry'
+        | 'identity.verification_session.canceled'
+        | 'identity.verification_session.created'
+        | 'identity.verification_session.processing'
+        | 'identity.verification_session.redacted'
+        | 'identity.verification_session.requires_input'
+        | 'identity.verification_session.verified'
+        | 'invoice.created'
+        | 'invoice.deleted'
+        | 'invoice.finalization_failed'
+        | 'invoice.finalized'
+        | 'invoice.marked_uncollectible'
+        | 'invoice.overdue'
+        | 'invoice.overpaid'
+        | 'invoice.paid'
+        | 'invoice.payment_action_required'
+        | 'invoice.payment_attempt_required'
+        | 'invoice.payment_failed'
+        | 'invoice.payment_succeeded'
+        | 'invoice.sent'
+        | 'invoice.upcoming'
+        | 'invoice.updated'
+        | 'invoice.voided'
+        | 'invoice.will_be_due'
+        | 'invoice_payment.paid'
+        | 'invoiceitem.created'
+        | 'invoiceitem.deleted'
+        | 'issuing_authorization.created'
+        | 'issuing_authorization.request'
+        | 'issuing_authorization.updated'
+        | 'issuing_card.created'
+        | 'issuing_card.updated'
+        | 'issuing_cardholder.created'
+        | 'issuing_cardholder.updated'
+        | 'issuing_dispute.closed'
+        | 'issuing_dispute.created'
+        | 'issuing_dispute.funds_reinstated'
+        | 'issuing_dispute.funds_rescinded'
+        | 'issuing_dispute.submitted'
+        | 'issuing_dispute.updated'
+        | 'issuing_personalization_design.activated'
+        | 'issuing_personalization_design.deactivated'
+        | 'issuing_personalization_design.rejected'
+        | 'issuing_personalization_design.updated'
+        | 'issuing_token.created'
+        | 'issuing_token.updated'
+        | 'issuing_transaction.created'
+        | 'issuing_transaction.purchase_details_receipt_updated'
+        | 'issuing_transaction.updated'
+        | 'mandate.updated'
+        | 'payment_intent.amount_capturable_updated'
+        | 'payment_intent.canceled'
+        | 'payment_intent.created'
+        | 'payment_intent.partially_funded'
+        | 'payment_intent.payment_failed'
+        | 'payment_intent.processing'
+        | 'payment_intent.requires_action'
+        | 'payment_intent.succeeded'
+        | 'payment_link.created'
+        | 'payment_link.updated'
+        | 'payment_method.attached'
+        | 'payment_method.automatically_updated'
+        | 'payment_method.detached'
+        | 'payment_method.updated'
+        | 'payout.canceled'
+        | 'payout.created'
+        | 'payout.failed'
+        | 'payout.paid'
+        | 'payout.reconciliation_completed'
+        | 'payout.updated'
+        | 'person.created'
+        | 'person.deleted'
+        | 'person.updated'
+        | 'plan.created'
+        | 'plan.deleted'
+        | 'plan.updated'
+        | 'price.created'
+        | 'price.deleted'
+        | 'price.updated'
+        | 'product.created'
+        | 'product.deleted'
+        | 'product.updated'
+        | 'promotion_code.created'
+        | 'promotion_code.updated'
+        | 'quote.accepted'
+        | 'quote.canceled'
+        | 'quote.created'
+        | 'quote.finalized'
+        | 'radar.early_fraud_warning.created'
+        | 'radar.early_fraud_warning.updated'
+        | 'refund.created'
+        | 'refund.failed'
+        | 'refund.updated'
+        | 'reporting.report_run.failed'
+        | 'reporting.report_run.succeeded'
+        | 'reporting.report_type.updated'
+        | 'reserve.hold.created'
+        | 'reserve.hold.updated'
+        | 'reserve.plan.created'
+        | 'reserve.plan.disabled'
+        | 'reserve.plan.expired'
+        | 'reserve.plan.updated'
+        | 'reserve.release.created'
+        | 'review.closed'
+        | 'review.opened'
+        | 'setup_intent.canceled'
+        | 'setup_intent.created'
+        | 'setup_intent.requires_action'
+        | 'setup_intent.setup_failed'
+        | 'setup_intent.succeeded'
+        | 'sigma.scheduled_query_run.created'
+        | 'source.canceled'
+        | 'source.chargeable'
+        | 'source.failed'
+        | 'source.mandate_notification'
+        | 'source.refund_attributes_required'
+        | 'source.transaction.created'
+        | 'source.transaction.updated'
+        | 'subscription_schedule.aborted'
+        | 'subscription_schedule.canceled'
+        | 'subscription_schedule.completed'
+        | 'subscription_schedule.created'
+        | 'subscription_schedule.expiring'
+        | 'subscription_schedule.released'
+        | 'subscription_schedule.updated'
+        | 'tax.settings.updated'
+        | 'tax_rate.created'
+        | 'tax_rate.updated'
+        | 'terminal.reader.action_failed'
+        | 'terminal.reader.action_succeeded'
+        | 'terminal.reader.action_updated'
+        | 'test_helpers.test_clock.advancing'
+        | 'test_helpers.test_clock.created'
+        | 'test_helpers.test_clock.deleted'
+        | 'test_helpers.test_clock.internal_failure'
+        | 'test_helpers.test_clock.ready'
+        | 'topup.canceled'
+        | 'topup.created'
+        | 'topup.failed'
+        | 'topup.reversed'
+        | 'topup.succeeded'
+        | 'transfer.created'
+        | 'transfer.reversed'
+        | 'transfer.updated'
+        | 'treasury.credit_reversal.created'
+        | 'treasury.credit_reversal.posted'
+        | 'treasury.debit_reversal.completed'
+        | 'treasury.debit_reversal.created'
+        | 'treasury.debit_reversal.initial_credit_granted'
+        | 'treasury.financial_account.closed'
+        | 'treasury.financial_account.created'
+        | 'treasury.financial_account.features_status_updated'
+        | 'treasury.inbound_transfer.canceled'
+        | 'treasury.inbound_transfer.created'
+        | 'treasury.inbound_transfer.failed'
+        | 'treasury.inbound_transfer.succeeded'
+        | 'treasury.outbound_payment.canceled'
+        | 'treasury.outbound_payment.created'
+        | 'treasury.outbound_payment.expected_arrival_date_updated'
+        | 'treasury.outbound_payment.failed'
+        | 'treasury.outbound_payment.posted'
+        | 'treasury.outbound_payment.returned'
+        | 'treasury.outbound_payment.tracking_details_updated'
+        | 'treasury.outbound_transfer.canceled'
+        | 'treasury.outbound_transfer.created'
+        | 'treasury.outbound_transfer.expected_arrival_date_updated'
+        | 'treasury.outbound_transfer.failed'
+        | 'treasury.outbound_transfer.posted'
+        | 'treasury.outbound_transfer.returned'
+        | 'treasury.outbound_transfer.tracking_details_updated'
+        | 'treasury.received_credit.created'
+        | 'treasury.received_credit.failed'
+        | 'treasury.received_credit.succeeded'
+        | 'treasury.received_debit.created'
+        | 'billing.credit_balance_transaction.created'
+        | 'billing.credit_grant.updated'
+        | 'billing.meter.created'
+        | 'billing.meter.deactivated'
+        | 'billing.meter.reactivated'
+        | 'billing.meter.updated';
+    }
+
+    /**
+     * Snapshot events allow you to track and react to activity in your Stripe integration. When
+     * the state of another API resource changes, Stripe creates an `Event` object that contains
+     * all the relevant information associated with that action, including the affected API
+     * resource. For example, a successful payment triggers a `charge.succeeded` event, which
+     * contains the `Charge` in the event's data property. Some actions trigger multiple events.
+     * For example, if you create a new subscription for a customer, it triggers both a
+     * `customer.subscription.created` event and a `charge.succeeded` event.
+     *
+     * Configure an event destination in your account to listen for events that represent actions
+     * your integration needs to respond to. Additionally, you can retrieve an individual event or
+     * a list of events from the API.
+     *
+     * [Connect](https://docs.stripe.com/connect) platforms can also receive event notifications
+     * that occur in their connected accounts. These events include an account attribute that
+     * identifies the relevant connected account.
+     *
+     * You can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)
+     * for 30 days.
+     */
+    interface EventBase {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'event';
+
+      /**
+       * The connected account that originates the event.
+       */
+      account?: string;
+
+      /**
+       * The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.
+       */
+      api_version: string | null;
+
+      /**
+       * Authentication context needed to fetch the event or related object.
+       */
+      context?: string;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      data: Event.Data;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      /**
+       * Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
+       */
+      pending_webhooks: number;
+
+      /**
+       * Information on the API request that triggers the event.
+       */
+      request: Event.Request | null;
+
+      /**
+       * Description of the event (for example, `invoice.created` or `charge.refunded`).
+       */
+      type: Event.Type;
+    }
+  }
+}

package/types/EventsResource.d.ts

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface EventRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface EventListParams extends PaginationParams {
+      /**
+       * Only return events that were created during the given date interval.
+       */
+      created?: Stripe.RangeQueryParam | number;
+
+      /**
+       * Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
+       */
+      delivery_success?: boolean;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
+       */
+      type?: string;
+
+      /**
+       * An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.
+       */
+      types?: Array<string>;
+    }
+
+    class EventsResource {
+      /**
+       * Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
+       */
+      retrieve(
+        id: string,
+        params?: EventRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Event>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): 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://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
+       */
+      list(
+        params?: EventListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.Event>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.Event>;
+    }
+  }
+}

package/types/ExchangeRates.d.ts

@@ -0,0 +1,54 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * [Deprecated] The `ExchangeRate` APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.
+     *
+     * `ExchangeRate` objects allow you to determine the rates that Stripe is currently
+     * using to convert from one currency to another. Since this number is variable
+     * throughout the day, there are various reasons why you might want to know the current
+     * rate (for example, to dynamically price an item for a user with a default
+     * payment in a foreign currency).
+     *
+     * Please refer to our [Exchange Rates API](https://docs.stripe.com/fx-rates) guide for more details.
+     *
+     * *[Note: this integration path is supported but no longer recommended]* Additionally,
+     * you can guarantee that a charge is made with an exchange rate that you expect is
+     * current. To do so, you must pass in the exchange_rate to charges endpoints. If the
+     * value is no longer up to date, the charge won't go through. Please refer to our
+     * [Using with charges](https://docs.stripe.com/exchange-rates) guide for more details.
+     *
+     * -----
+     *
+     *  
+     *
+     * *This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*
+     *
+     * - *localize prices for processing payments on Stripe*
+     * - *reconcile Stripe transactions*
+     * - *determine how much money to send to a connected account*
+     * - *determine app fees to charge a connected account*
+     *
+     * *Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*
+     */
+    interface ExchangeRate {
+      /**
+       * Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'exchange_rate';
+
+      /**
+       * Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
+       */
+      rates: {
+        [key: string]: number;
+      };
+    }
+  }
+}

package/types/ExchangeRatesResource.d.ts

@@ -0,0 +1,49 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface ExchangeRateRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ExchangeRateListParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class ExchangeRatesResource {
+      /**
+       * [Deprecated] The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.
+       *
+       * Retrieves the exchange rates from the given currency to every supported currency.
+       * @deprecated
+       */
+      retrieve(
+        id: string,
+        params?: ExchangeRateRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ExchangeRate>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ExchangeRate>>;
+
+      /**
+       * [Deprecated] The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.
+       *
+       * Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
+       * @deprecated
+       */
+      list(
+        params?: ExchangeRateListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.ExchangeRate>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.ExchangeRate>;
+    }
+  }
+}

package/types/ExternalAccounts.d.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    type DeletedExternalAccount = DeletedBankAccount | DeletedCard;
+
+    type ExternalAccount = BankAccount | Card;
+  }
+}

package/types/FeeRefunds.d.ts

@@ -0,0 +1,54 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * `Application Fee Refund` objects allow you to refund an application fee that
+     * has previously been created but not yet refunded. Funds will be refunded to
+     * the Stripe account from which the fee was originally collected.
+     *
+     * Related guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee)
+     */
+    interface FeeRefund {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'fee_refund';
+
+      /**
+       * Amount, in cents (or local equivalent).
+       */
+      amount: number;
+
+      /**
+       * Balance transaction that describes the impact on your account balance.
+       */
+      balance_transaction: string | Stripe.BalanceTransaction | null;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+       */
+      currency: string;
+
+      /**
+       * ID of the application fee that was refunded.
+       */
+      fee: string | Stripe.ApplicationFee;
+
+      /**
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+       */
+      metadata: Stripe.Metadata | null;
+    }
+  }
+}

package/types/FileLinks.d.ts

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * To share the contents of a `File` object with non-Stripe users, you can
+     * create a `FileLink`. `FileLink`s contain a URL that you can use to
+     * retrieve the contents of the file without authentication.
+     */
+    interface FileLink {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'file_link';
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * Returns if the link is already expired.
+       */
+      expired: boolean;
+
+      /**
+       * Time that the link expires.
+       */
+      expires_at: number | null;
+
+      /**
+       * The file object this link points to.
+       */
+      file: string | Stripe.File;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      /**
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+       */
+      metadata: Stripe.Metadata;
+
+      /**
+       * The publicly accessible URL to download the file.
+       */
+      url: string | null;
+    }
+  }
+}