stripe 19.4.0-alpha.1 → 20.0.0

package/types/ExternalAccountsResource.d.ts

@@ -1,304 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    interface ExternalAccountCreateParams {
-      /**
-       * Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's external account details (with the options shown below).
-       */
-      external_account:
-        | string
-        | ExternalAccountCreateParams.Card
-        | ExternalAccountCreateParams.BankAccount
-        | ExternalAccountCreateParams.CardToken;
-
-      /**
-       * When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
-       */
-      default_for_currency?: boolean;
-
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-
-      /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-       */
-      metadata?: Stripe.MetadataParam;
-    }
-
-    namespace ExternalAccountCreateParams {
-      interface BankAccount {
-        object: 'bank_account';
-
-        /**
-         * The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
-         */
-        account_holder_name?: string;
-
-        /**
-         * The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
-         */
-        account_holder_type?: BankAccount.AccountHolderType;
-
-        /**
-         * The account number for the bank account, in string form. Must be a checking account.
-         */
-        account_number: string;
-
-        /**
-         * The country in which the bank account is located.
-         */
-        country: string;
-
-        /**
-         * The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
-         */
-        currency?: string;
-
-        /**
-         * The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
-         */
-        routing_number?: string;
-      }
-
-      namespace BankAccount {
-        type AccountHolderType = 'company' | 'individual';
-      }
-
-      interface Card {
-        object: 'card';
-
-        address_city?: string;
-
-        address_country?: string;
-
-        address_line1?: string;
-
-        address_line2?: string;
-
-        address_state?: string;
-
-        address_zip?: string;
-
-        currency?: string;
-
-        cvc?: string;
-
-        exp_month: number;
-
-        exp_year: number;
-
-        name?: string;
-
-        number: string;
-
-        /**
-         * Set of [key-value pairs](https://stripe.com/docs/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.MetadataParam;
-      }
-
-      interface CardToken {
-        object: 'card';
-
-        currency?: string;
-
-        token: string;
-      }
-    }
-
-    interface ExternalAccountRetrieveParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
-    interface ExternalAccountUpdateParams {
-      /**
-       * The name of the person or business that owns the bank account.
-       */
-      account_holder_name?: string;
-
-      /**
-       * The type of entity that holds the account. This can be either `individual` or `company`.
-       */
-      account_holder_type?: Stripe.Emptyable<
-        ExternalAccountUpdateParams.AccountHolderType
-      >;
-
-      /**
-       * The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
-       */
-      account_type?: ExternalAccountUpdateParams.AccountType;
-
-      /**
-       * City/District/Suburb/Town/Village.
-       */
-      address_city?: string;
-
-      /**
-       * Billing address country, if provided when creating card.
-       */
-      address_country?: string;
-
-      /**
-       * Address line 1 (Street address/PO Box/Company name).
-       */
-      address_line1?: string;
-
-      /**
-       * Address line 2 (Apartment/Suite/Unit/Building).
-       */
-      address_line2?: string;
-
-      /**
-       * State/County/Province/Region.
-       */
-      address_state?: string;
-
-      /**
-       * ZIP or postal code.
-       */
-      address_zip?: string;
-
-      /**
-       * When set to true, this becomes the default external account for its currency.
-       */
-      default_for_currency?: boolean;
-
-      /**
-       * Documents that may be submitted to satisfy various informational requests.
-       */
-      documents?: ExternalAccountUpdateParams.Documents;
-
-      /**
-       * Two digit number representing the card's expiration month.
-       */
-      exp_month?: string;
-
-      /**
-       * Four digit number representing the card's expiration year.
-       */
-      exp_year?: string;
-
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-
-      /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-       */
-      metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
-
-      /**
-       * Cardholder name.
-       */
-      name?: string;
-    }
-
-    namespace ExternalAccountUpdateParams {
-      type AccountHolderType = 'company' | 'individual';
-
-      type AccountType = 'checking' | 'futsu' | 'savings' | 'toza';
-
-      interface Documents {
-        /**
-         * One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.
-         */
-        bank_account_ownership_verification?: Documents.BankAccountOwnershipVerification;
-      }
-
-      namespace Documents {
-        interface BankAccountOwnershipVerification {
-          /**
-           * One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
-           */
-          files?: Array<string>;
-        }
-      }
-    }
-
-    interface ExternalAccountListParams extends PaginationParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-
-      /**
-       * Filter external accounts according to a particular object type.
-       */
-      object?: ExternalAccountListParams.Object;
-    }
-
-    namespace ExternalAccountListParams {
-      type Object = 'bank_account' | 'card';
-    }
-
-    interface ExternalAccountDeleteParams {}
-
-    class ExternalAccountsResource {
-      /**
-       * Create an external account for a given connected account.
-       */
-      create(
-        params: ExternalAccountCreateParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
-
-      /**
-       * Retrieve a specified external account for a given account.
-       */
-      retrieve(
-        id: string,
-        params?: ExternalAccountRetrieveParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
-      retrieve(
-        id: string,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
-
-      /**
-       * Updates the metadata, account holder name, account holder type of a bank account belonging to
-       * a connected account and optionally sets it as the default for its currency. Other bank account
-       * details are not editable by design.
-       *
-       * You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
-       *
-       * You can re-enable a disabled bank account by performing an update call without providing any
-       * arguments or changes.
-       */
-      update(
-        id: string,
-        params?: ExternalAccountUpdateParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
-
-      /**
-       * List external accounts for an account.
-       */
-      list(
-        params?: ExternalAccountListParams,
-        options?: RequestOptions
-      ): ApiListPromise<Stripe.ExternalAccount>;
-      list(options?: RequestOptions): ApiListPromise<Stripe.ExternalAccount>;
-
-      /**
-       * Delete a specified external account for a given account.
-       */
-      del(
-        id: string,
-        params?: ExternalAccountDeleteParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.DeletedExternalAccount>>;
-      del(
-        id: string,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.DeletedExternalAccount>>;
-    }
-  }
-}

package/types/FinancialConnections/AccountInferredBalances.d.ts

@@ -1,38 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace FinancialConnections {
-      /**
-       * A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
-       */
-      interface AccountInferredBalance {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'financial_connections.account_inferred_balance';
-
-        /**
-         * The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
-         */
-        as_of: number;
-
-        /**
-         * The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.
-         *
-         * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
-         *
-         * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
-         */
-        current: {
-          [key: string]: number;
-        };
-      }
-    }
-  }
-}

package/types/FinancialConnections/Institutions.d.ts

@@ -1,98 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace FinancialConnections {
-      /**
-       * An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
-       */
-      interface Institution {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'financial_connections.institution';
-
-        /**
-         * The list of countries supported by this institution, formatted as ISO country codes.
-         */
-        countries: Array<string>;
-
-        features: Institution.Features;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * The name of this institution.
-         */
-        name: string;
-
-        /**
-         * A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
-         */
-        routing_numbers: Array<string>;
-
-        /**
-         * The status of this institution in the Financial Connections authentication flow.
-         */
-        status: Institution.Status;
-
-        /**
-         * A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
-         */
-        url: string | null;
-      }
-
-      namespace Institution {
-        interface Features {
-          balances: Features.Balances;
-
-          ownership: Features.Ownership;
-
-          payment_method: Features.PaymentMethod;
-
-          transactions: Features.Transactions;
-        }
-
-        namespace Features {
-          interface Balances {
-            /**
-             * Whether the given feature is supported by this institution.
-             */
-            supported: boolean;
-          }
-
-          interface Ownership {
-            /**
-             * Whether the given feature is supported by this institution.
-             */
-            supported: boolean;
-          }
-
-          interface PaymentMethod {
-            /**
-             * Whether the given feature is supported by this institution.
-             */
-            supported: boolean;
-          }
-
-          interface Transactions {
-            /**
-             * Whether the given feature is supported by this institution.
-             */
-            supported: boolean;
-          }
-        }
-
-        type Status = 'active' | 'degraded' | 'inactive';
-      }
-    }
-  }
-}

package/types/FinancialConnections/InstitutionsResource.d.ts

@@ -1,47 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace FinancialConnections {
-      interface InstitutionRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface InstitutionListParams extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class InstitutionsResource {
-        /**
-         * Retrieves the details of a Financial Connections Institution.
-         */
-        retrieve(
-          id: string,
-          params?: InstitutionRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
-
-        /**
-         * Returns a list of Financial Connections Institution objects.
-         */
-        list(
-          params?: InstitutionListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.FinancialConnections.Institution>;
-        list(
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.FinancialConnections.Institution>;
-      }
-    }
-  }
-}

package/types/FxQuotes.d.ts

@@ -1,155 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    /**
-     * The FX Quotes API provides three functions:
-     * - View Stripe's current exchange rate for any given currency pair.
-     * - Extend quoted rates for a 1-hour period or a 24-hour period, minimizing uncertainty from FX fluctuations.
-     * - Preview the FX fees Stripe will charge on your FX transaction, allowing you to anticipate specific settlement amounts before payment costs.
-     *
-     * [View the docs](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api)
-     */
-    interface FxQuote {
-      /**
-       * Unique identifier for the object.
-       */
-      id: string;
-
-      /**
-       * String representing the object's type. Objects of the same type share the same value.
-       */
-      object: 'fx_quote';
-
-      /**
-       * Time at which the quote was created, measured in seconds since the Unix epoch.
-       */
-      created: number;
-
-      /**
-       * The duration the exchange rate quote remains valid from creation time. Allowed values are none, hour, and day. Note that for the test mode API available in alpha, you can request an extended quote, but it won't be usable for any transactions.
-       */
-      lock_duration: FxQuote.LockDuration;
-
-      /**
-       * Time at which the quote will expire, measured in seconds since the Unix epoch.
-       *
-       * If lock_duration is set to ‘none' this field will be set to null.
-       */
-      lock_expires_at: number | null;
-
-      /**
-       * Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp.
-       *
-       * Can return value none, active, or expired.
-       */
-      lock_status: FxQuote.LockStatus;
-
-      /**
-       * Information about the rates.
-       */
-      rates: {
-        [key: string]: FxQuote.Rates;
-      };
-
-      /**
-       * The currency to convert into, typically this is the currency that you want to settle to your Stripe balance. Three-letter ISO currency code, in lowercase. Must be a supported currency.
-       */
-      to_currency: string;
-
-      usage: FxQuote.Usage;
-    }
-
-    namespace FxQuote {
-      type LockDuration = 'day' | 'five_minutes' | 'hour' | 'none';
-
-      type LockStatus = 'active' | 'expired' | 'none';
-
-      interface Rates {
-        /**
-         * The rate that includes the FX fee rate.
-         */
-        exchange_rate: number;
-
-        rate_details: Rates.RateDetails;
-      }
-
-      namespace Rates {
-        interface RateDetails {
-          /**
-           * The rate for the currency pair.
-           */
-          base_rate: number;
-
-          /**
-           * The fee for locking the conversion rates.
-           */
-          duration_premium: number;
-
-          /**
-           * The FX fee for the currency pair.
-           */
-          fx_fee_rate: number;
-
-          /**
-           * A reference rate for the currency pair provided by the reference rate provider.
-           */
-          reference_rate: number | null;
-
-          /**
-           * The reference rate provider.
-           */
-          reference_rate_provider: 'ecb' | null;
-        }
-      }
-
-      interface Usage {
-        /**
-         * The details required to use an FX Quote for a payment
-         */
-        payment: Usage.Payment | null;
-
-        /**
-         * The details required to use an FX Quote for a transfer
-         */
-        transfer: Usage.Transfer | null;
-
-        /**
-         * The transaction type for which the FX Quote will be used.
-         *
-         * Can be 'payment' or 'transfer'.
-         */
-        type: Usage.Type;
-      }
-
-      namespace Usage {
-        interface Payment {
-          /**
-           * The Stripe account ID that the funds will be transferred to.
-           *
-           * This field should match the account ID that would be used in the PaymentIntent's transfer_data[destination] field.
-           */
-          destination: string | null;
-
-          /**
-           * The Stripe account ID that these funds are intended for.
-           *
-           * This field must match the account ID that would be used in the PaymentIntent's on_behalf_of field.
-           */
-          on_behalf_of: string | null;
-        }
-
-        interface Transfer {
-          /**
-           * The Stripe account ID that the funds will be transferred to.
-           *
-           * This field should match the account ID that would be used in the Transfer's destination field.
-           */
-          destination: string;
-        }
-
-        type Type = 'payment' | 'transfer';
-      }
-    }
-  }
-}