stripe 19.4.0-alpha.1 → 20.0.0

package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts

@@ -1,172 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace MoneyManagement {
-        interface FinancialAccountCreateParams {
-          /**
-           * The type of FinancialAccount to create.
-           */
-          type: 'storage';
-
-          /**
-           * A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
-           */
-          display_name?: string;
-
-          /**
-           * Metadata associated with the FinancialAccount.
-           */
-          metadata?: Stripe.MetadataParam;
-
-          /**
-           * Parameters specific to creating `storage` type FinancialAccounts.
-           */
-          storage?: FinancialAccountCreateParams.Storage;
-        }
-
-        namespace FinancialAccountCreateParams {
-          interface Storage {
-            /**
-             * The currencies that this FinancialAccount can hold.
-             */
-            holds_currencies: Array<string>;
-          }
-        }
-      }
-
-      namespace MoneyManagement {
-        interface FinancialAccountRetrieveParams {}
-      }
-
-      namespace MoneyManagement {
-        interface FinancialAccountUpdateParams {
-          /**
-           * A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
-           */
-          display_name?: string;
-
-          /**
-           * Metadata associated with the FinancialAccount.
-           */
-          metadata?: Stripe.MetadataParam;
-        }
-      }
-
-      namespace MoneyManagement {
-        interface FinancialAccountListParams {
-          /**
-           * The page limit.
-           */
-          limit?: number;
-
-          /**
-           * The status of the FinancialAccount to filter by. By default, closed FinancialAccounts are not returned.
-           */
-          status?: FinancialAccountListParams.Status;
-        }
-
-        namespace FinancialAccountListParams {
-          type Status = 'closed' | 'open' | 'pending';
-        }
-      }
-
-      namespace MoneyManagement {
-        interface FinancialAccountCloseParams {
-          /**
-           * The addresses to forward any incoming transactions to.
-           */
-          forwarding_settings?: FinancialAccountCloseParams.ForwardingSettings;
-        }
-
-        namespace FinancialAccountCloseParams {
-          interface ForwardingSettings {
-            /**
-             * The address to send forwarded payments to.
-             */
-            payment_method?: string;
-
-            /**
-             * The address to send forwarded payouts to.
-             */
-            payout_method?: string;
-          }
-        }
-      }
-
-      namespace MoneyManagement {
-        class FinancialAccountsResource {
-          /**
-           * Creates a new FinancialAccount.
-           * @throws Stripe.AlreadyExistsError
-           * @throws Stripe.FeatureNotEnabledError
-           */
-          create(
-            params: FinancialAccountCreateParams,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
-          >;
-
-          /**
-           * Retrieves the details of an existing FinancialAccount.
-           */
-          retrieve(
-            id: string,
-            params?: FinancialAccountRetrieveParams,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
-          >;
-          retrieve(
-            id: string,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
-          >;
-
-          /**
-           * Updates an existing FinancialAccount.
-           */
-          update(
-            id: string,
-            params?: FinancialAccountUpdateParams,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
-          >;
-
-          /**
-           * Lists FinancialAccounts in this compartment.
-           */
-          list(
-            params?: FinancialAccountListParams,
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAccount>;
-          list(
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAccount>;
-
-          /**
-           * Closes a FinancialAccount with or without forwarding settings.
-           * @throws Stripe.NonZeroBalanceError
-           */
-          close(
-            id: string,
-            params?: FinancialAccountCloseParams,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
-          >;
-          close(
-            id: string,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
-          >;
-        }
-      }
-    }
-  }
-}

package/types/V2/MoneyManagement/FinancialAddresses.d.ts

@@ -1,178 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace MoneyManagement {
-        /**
-         * A FinancialAddress contains information needed to transfer money to a Financial Account. A Financial Account can have more than one Financial Address.
-         */
-        interface FinancialAddress {
-          /**
-           * The ID of a FinancialAddress.
-           */
-          id: string;
-
-          /**
-           * String representing the object's type. Objects of the same type share the same value of the object field.
-           */
-          object: 'v2.money_management.financial_address';
-
-          /**
-           * The creation timestamp of the FinancialAddress.
-           */
-          created: string;
-
-          /**
-           * Object indicates the type of credentials that have been allocated and attached to the FinancialAddress.
-           * It contains all necessary banking details with which to perform money movements with the FinancialAddress.
-           * This field is only available for FinancialAddresses with an active status.
-           */
-          credentials?: FinancialAddress.Credentials;
-
-          /**
-           * Open Enum. The currency the FinancialAddress supports.
-           */
-          currency: string;
-
-          /**
-           * A ID of the FinancialAccount this FinancialAddress corresponds to.
-           */
-          financial_account: string;
-
-          /**
-           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-           */
-          livemode: boolean;
-
-          /**
-           * Open Enum. The currency the FinancialAddress settles into the FinancialAccount.
-           */
-          settlement_currency?: string;
-
-          /**
-           * Closed Enum. An enum representing the status of the FinancialAddress. This indicates whether or not the FinancialAddress can be used for any money movement flows.
-           */
-          status: FinancialAddress.Status;
-        }
-
-        namespace FinancialAddress {
-          interface Credentials {
-            /**
-             * Open Enum. The type of Credentials that are provisioned for the FinancialAddress.
-             */
-            type: Credentials.Type;
-
-            /**
-             * The credentials of the UK Bank Account for the FinancialAddress. This contains unique banking details such as the sort code, account number, etc. of a UK bank account.
-             */
-            gb_bank_account?: Credentials.GbBankAccount;
-
-            /**
-             * The credentials of the SEPA Bank Account for the FinancialAddress. This contains unique banking details such as the IBAN, BIC, etc. of a SEPA bank account.
-             */
-            sepa_bank_account?: Credentials.SepaBankAccount;
-
-            /**
-             * The credentials of the US Bank Account for the FinancialAddress. This contains unique banking details such as the routing number, account number, etc. of a US bank account.
-             */
-            us_bank_account?: Credentials.UsBankAccount;
-          }
-
-          namespace Credentials {
-            interface GbBankAccount {
-              /**
-               * The account holder name to be used during bank transference.
-               */
-              account_holder_name: string;
-
-              /**
-               * The account number of the UK Bank Account.
-               */
-              account_number?: string;
-
-              /**
-               * The last four digits of the UK Bank Account number. This will always be returned.
-               * To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
-               */
-              last4: string;
-
-              /**
-               * The sort code of the UK Bank Account.
-               */
-              sort_code: string;
-            }
-
-            interface SepaBankAccount {
-              /**
-               * The account holder name to be used during bank transfers.
-               */
-              account_holder_name: string;
-
-              /**
-               * The name of the Bank.
-               */
-              bank_name: string;
-
-              /**
-               * The BIC of the SEPA Bank Account.
-               */
-              bic: string;
-
-              /**
-               * The originating country of the SEPA Bank account.
-               */
-              country: string;
-
-              /**
-               * The IBAN of the SEPA Bank Account.
-               */
-              iban: string;
-
-              /**
-               * The last four digits of the SEPA Bank Account number. This will always be returned.
-               * To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
-               */
-              last4: string;
-            }
-
-            type Type =
-              | 'gb_bank_account'
-              | 'sepa_bank_account'
-              | 'us_bank_account';
-
-            interface UsBankAccount {
-              /**
-               * The account number of the US Bank Account.
-               */
-              account_number?: string;
-
-              /**
-               * The name of the Bank.
-               */
-              bank_name?: string;
-
-              /**
-               * The last four digits of the US Bank Account number. This will always be returned.
-               * To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
-               */
-              last4: string;
-
-              /**
-               * The routing number of the US Bank Account.
-               */
-              routing_number: string;
-
-              /**
-               * The swift code of the bank or financial institution.
-               */
-              swift_code?: string;
-            }
-          }
-
-          type Status = 'active' | 'archived' | 'failed' | 'pending';
-        }
-      }
-    }
-  }
-}

package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts

@@ -1,126 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace MoneyManagement {
-        interface FinancialAddressCreateParams {
-          /**
-           * The ID of the FinancialAccount the new FinancialAddress should be associated with.
-           */
-          financial_account: string;
-
-          /**
-           * The type of FinancialAddress details to provision.
-           */
-          type: FinancialAddressCreateParams.Type;
-
-          /**
-           * Optional SEPA Bank account options, used to configure the type of SEPA Bank account to create, such as the originating country.
-           */
-          sepa_bank_account?: FinancialAddressCreateParams.SepaBankAccount;
-        }
-
-        namespace FinancialAddressCreateParams {
-          interface SepaBankAccount {
-            /**
-             * The originating country of the SEPA Bank account.
-             */
-            country: string;
-          }
-
-          type Type =
-            | 'gb_bank_account'
-            | 'sepa_bank_account'
-            | 'us_bank_account';
-        }
-      }
-
-      namespace MoneyManagement {
-        interface FinancialAddressRetrieveParams {
-          /**
-           * Open Enum. A list of fields to reveal in the FinancialAddresses returned.
-           */
-          include?: Array<FinancialAddressRetrieveParams.Include>;
-        }
-
-        namespace FinancialAddressRetrieveParams {
-          type Include =
-            | 'credentials.gb_bank_account.account_number'
-            | 'credentials.sepa_bank_account.iban'
-            | 'credentials.us_bank_account.account_number';
-        }
-      }
-
-      namespace MoneyManagement {
-        interface FinancialAddressListParams {
-          /**
-           * The ID of the FinancialAccount for which FinancialAddresses are to be returned.
-           */
-          financial_account?: string;
-
-          /**
-           * Open Enum. A list of fields to reveal in the FinancialAddresses returned.
-           */
-          include?: Array<FinancialAddressListParams.Include>;
-
-          /**
-           * The page limit.
-           */
-          limit?: number;
-        }
-
-        namespace FinancialAddressListParams {
-          type Include =
-            | 'credentials.gb_bank_account.account_number'
-            | 'credentials.sepa_bank_account.iban'
-            | 'credentials.us_bank_account.account_number';
-        }
-      }
-
-      namespace MoneyManagement {
-        class FinancialAddressesResource {
-          /**
-           * Create a new FinancialAddress for a FinancialAccount.
-           * @throws Stripe.FinancialAccountNotOpenError
-           * @throws Stripe.FeatureNotEnabledError
-           */
-          create(
-            params: FinancialAddressCreateParams,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAddress>
-          >;
-
-          /**
-           * Retrieve a FinancialAddress. By default, the FinancialAddress will be returned in its unexpanded state, revealing only the last 4 digits of the account number.
-           */
-          retrieve(
-            id: string,
-            params?: FinancialAddressRetrieveParams,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAddress>
-          >;
-          retrieve(
-            id: string,
-            options?: RequestOptions
-          ): Promise<
-            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAddress>
-          >;
-
-          /**
-           * List all FinancialAddresses for a FinancialAccount.
-           */
-          list(
-            params?: FinancialAddressListParams,
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAddress>;
-          list(
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAddress>;
-        }
-      }
-    }
-  }
-}

package/types/V2/MoneyManagement/InboundTransfers.d.ts

@@ -1,212 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace MoneyManagement {
-        /**
-         * An InboundTransfer object, representing a money movement from a
-         * user owned PaymentMethod to a FinancialAccount belonging to the same user.
-         */
-        interface InboundTransfer {
-          /**
-           * Unique identifier for the InboundTransfer.
-           */
-          id: string;
-
-          /**
-           * String representing the object's type. Objects of the same type share the same value of the object field.
-           */
-          object: 'v2.money_management.inbound_transfer';
-
-          /**
-           * The amount in specified currency that will land in the FinancialAccount balance.
-           */
-          amount: Amount;
-
-          /**
-           * Creation time of the InboundTransfer. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
-           */
-          created: string;
-
-          /**
-           * A freeform text field provided by user, containing metadata.
-           */
-          description: string;
-
-          /**
-           * A nested object containing information about the origin of the InboundTransfer.
-           */
-          from: InboundTransfer.From;
-
-          /**
-           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-           */
-          livemode: boolean;
-
-          /**
-           * A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
-           */
-          receipt_url?: string;
-
-          /**
-           * A nested object containing information about the destination of the InboundTransfer.
-           */
-          to: InboundTransfer.To;
-
-          /**
-           * A list of history objects, representing changes in the state of the InboundTransfer.
-           */
-          transfer_history: Array<InboundTransfer.TransferHistory>;
-        }
-
-        namespace InboundTransfer {
-          interface From {
-            /**
-             * The amount in specified currency that was debited from the Payment Method.
-             */
-            debited: Amount;
-
-            /**
-             * The Payment Method object used to create the InboundTransfer.
-             */
-            payment_method: From.PaymentMethod;
-          }
-
-          namespace From {
-            interface PaymentMethod {
-              /**
-               * The type of object this destination represents. For a us bank account, we expect us_bank_account.
-               */
-              type: string;
-
-              /**
-               * The destination US bank account identifier. eg "usba_***".
-               */
-              us_bank_account?: string;
-            }
-          }
-
-          interface To {
-            /**
-             * The amount by which the FinancialAccount balance is credited.
-             */
-            credited: Amount;
-
-            /**
-             * The FinancialAccount that funds will land in.
-             */
-            financial_account: string;
-          }
-
-          interface TransferHistory {
-            /**
-             * Creation time of the HistoryEntry in RFC 3339 format and UTC.
-             */
-            created: string;
-
-            /**
-             * Effective at time of the HistoryEntry in RFC 3339 format and UTC.
-             */
-            effective_at: string;
-
-            /**
-             * A unique ID for the HistoryEntry.
-             */
-            id: string;
-
-            /**
-             * Open Enum. The Level of the HistoryEntry.
-             */
-            level: TransferHistory.Level;
-
-            /**
-             * Open Enum. The type of the HistoryEntry.
-             */
-            type: TransferHistory.Type;
-
-            /**
-             * The history entry for a failed InboundTransfer.
-             */
-            bank_debit_failed?: TransferHistory.BankDebitFailed;
-
-            /**
-             * The history entry for a processing InboundTransfer.
-             */
-            bank_debit_processing?: TransferHistory.BankDebitProcessing;
-
-            /**
-             * The history entry for a queued InboundTransfer.
-             */
-            bank_debit_queued?: TransferHistory.BankDebitQueued;
-
-            /**
-             * The history entry for a returned InboundTransfer.
-             */
-            bank_debit_returned?: TransferHistory.BankDebitReturned;
-
-            /**
-             * The history entry for a succeeded InboundTransfer.
-             */
-            bank_debit_succeeded?: TransferHistory.BankDebitSucceeded;
-          }
-
-          namespace TransferHistory {
-            interface BankDebitFailed {
-              /**
-               * Open Enum. The return reason for the failed InboundTransfer.
-               */
-              failure_reason: BankDebitFailed.FailureReason;
-            }
-
-            namespace BankDebitFailed {
-              type FailureReason =
-                | 'bank_account_closed'
-                | 'bank_account_not_found'
-                | 'bank_debit_could_not_be_processed'
-                | 'bank_debit_not_authorized'
-                | 'insufficient_funds';
-            }
-
-            type BankDebitProcessing = {
-              [key: string]: unknown;
-            };
-
-            type BankDebitQueued = {
-              [key: string]: unknown;
-            };
-
-            interface BankDebitReturned {
-              /**
-               * Open Enum. The return reason for the returned InboundTransfer.
-               */
-              return_reason: BankDebitReturned.ReturnReason;
-            }
-
-            namespace BankDebitReturned {
-              type ReturnReason =
-                | 'bank_account_closed'
-                | 'bank_account_not_found'
-                | 'bank_debit_could_not_be_processed'
-                | 'bank_debit_not_authorized'
-                | 'insufficient_funds';
-            }
-
-            type BankDebitSucceeded = {
-              [key: string]: unknown;
-            };
-
-            type Level = 'canonical' | 'debug';
-
-            type Type =
-              | 'bank_debit_failed'
-              | 'bank_debit_processing'
-              | 'bank_debit_queued'
-              | 'bank_debit_returned'
-              | 'bank_debit_succeeded';
-          }
-        }
-      }
-    }
-  }
-}