stripe 22.3.0-beta.1 → 22.3.0

package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts

@@ -1,244 +0,0 @@
-import { StripeResource } from '../../../StripeResource.js';
-import { V2Amount } from './../V2Amounts.js';
-import { MetadataParam, Metadata } from '../../../shared.js';
-import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
-export declare class FinancialAccountResource extends StripeResource {
-    /**
-     * Lists FinancialAccounts in this compartment.
-     */
-    list(params?: V2.MoneyManagement.FinancialAccountListParams, options?: RequestOptions): V2ListPromise<FinancialAccount>;
-    /**
-     * Creates a new FinancialAccount.
-     * @throws Stripe.AlreadyExistsError
-     * @throws Stripe.FeatureNotEnabledError
-     */
-    create(params: V2.MoneyManagement.FinancialAccountCreateParams, options?: RequestOptions): Promise<Response<FinancialAccount>>;
-    /**
-     * Retrieves the details of an existing FinancialAccount.
-     */
-    retrieve(id: string, params?: V2.MoneyManagement.FinancialAccountRetrieveParams, options?: RequestOptions): Promise<Response<FinancialAccount>>;
-    /**
-     * Updates an existing FinancialAccount.
-     */
-    update(id: string, params?: V2.MoneyManagement.FinancialAccountUpdateParams, options?: RequestOptions): Promise<Response<FinancialAccount>>;
-    /**
-     * Closes a FinancialAccount with or without forwarding settings.
-     * @throws Stripe.NonZeroBalanceError
-     */
-    close(id: string, params?: V2.MoneyManagement.FinancialAccountCloseParams, options?: RequestOptions): Promise<Response<FinancialAccount>>;
-}
-export interface FinancialAccount {
-    /**
-     * Unique identifier for the object.
-     */
-    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_account';
-    /**
-     * Multi-currency balance of this FinancialAccount, split by availability state. Each balance is represented as a hash where the key is the three-letter ISO currency code, in lowercase, and the value is the amount for that currency.
-     */
-    balance: V2.MoneyManagement.FinancialAccount.Balance;
-    /**
-     * Open Enum. Two-letter country code that represents the country where the LegalEntity associated with the FinancialAccount is based in.
-     */
-    country: string;
-    /**
-     * Time at which the object was created.
-     */
-    created: string;
-    /**
-     * 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;
-    /**
-     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-     */
-    livemode: boolean;
-    /**
-     * Metadata associated with the FinancialAccount.
-     */
-    metadata?: Metadata;
-    /**
-     * If this is a `other` FinancialAccount, this hash indicates what the actual type is. Upgrade your API version to see it reflected in `type`.
-     */
-    other?: V2.MoneyManagement.FinancialAccount.Other;
-    /**
-     * Closed Enum. An enum representing the status of the FinancialAccount. This indicates whether or not the FinancialAccount can be used for any money movement flows.
-     */
-    status: V2.MoneyManagement.FinancialAccount.Status;
-    /**
-     * Additional details related to the status of the FinancialAccount.
-     */
-    status_details?: V2.MoneyManagement.FinancialAccount.StatusDetails;
-    /**
-     * If this is a `storage` FinancialAccount, this hash includes details specific to `storage` FinancialAccounts.
-     */
-    storage?: V2.MoneyManagement.FinancialAccount.Storage;
-    /**
-     * Type of the FinancialAccount. An additional hash is included on the FinancialAccount with a name matching this value.
-     * It contains additional information specific to the FinancialAccount type.
-     */
-    type: V2.MoneyManagement.FinancialAccount.Type;
-}
-export declare namespace V2 {
-    namespace MoneyManagement {
-        namespace FinancialAccount {
-            interface Balance {
-                /**
-                 * Balance that can be used for money movement.
-                 */
-                available: {
-                    [key: string]: V2Amount;
-                };
-                /**
-                 * Balance of inbound funds that will later transition to the `available` balance.
-                 */
-                inbound_pending: {
-                    [key: string]: V2Amount;
-                };
-                /**
-                 * Balance of funds that are being used for a pending outbound money movement.
-                 */
-                outbound_pending: {
-                    [key: string]: V2Amount;
-                };
-            }
-            interface Other {
-                /**
-                 * The type of the FinancialAccount, represented as a string. Upgrade your API version to see the type reflected in `financial_account.type`.
-                 */
-                type: string;
-            }
-            type Status = 'closed' | 'open' | 'pending';
-            interface StatusDetails {
-                /**
-                 * Details related to the closed state of the FinancialAccount.
-                 */
-                closed?: StatusDetails.Closed;
-            }
-            interface Storage {
-                /**
-                 * The currencies that this FinancialAccount can hold.
-                 */
-                holds_currencies: Array<string>;
-            }
-            type Type = 'other' | 'storage';
-            namespace StatusDetails {
-                interface Closed {
-                    /**
-                     * The forwarding settings for the closed FinancialAccount.
-                     */
-                    forwarding_settings?: Closed.ForwardingSettings;
-                    /**
-                     * The reason the FinancialAccount was closed.
-                     */
-                    reason: Closed.Reason;
-                }
-                namespace Closed {
-                    interface ForwardingSettings {
-                        /**
-                         * The address to send forwarded payments to.
-                         */
-                        payment_method?: string;
-                        /**
-                         * The address to send forwarded payouts to.
-                         */
-                        payout_method?: string;
-                    }
-                    type Reason = 'account_closed' | 'closed_by_platform' | 'other';
-                }
-            }
-        }
-    }
-}
-export declare 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?: 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>;
-            }
-        }
-    }
-}
-export declare namespace V2 {
-    namespace MoneyManagement {
-        interface FinancialAccountRetrieveParams {
-        }
-    }
-}
-export declare namespace V2 {
-    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?: MetadataParam;
-        }
-    }
-}
-export declare namespace V2 {
-    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';
-        }
-    }
-}
-export declare namespace V2 {
-    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;
-            }
-        }
-    }
-}

package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js

@@ -1,44 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FinancialAccountResource = void 0;
-const StripeResource_js_1 = require("../../../StripeResource.js");
-class FinancialAccountResource extends StripeResource_js_1.StripeResource {
-    /**
-     * Lists FinancialAccounts in this compartment.
-     */
-    list(params, options) {
-        return this._makeRequest('GET', '/v2/money_management/financial_accounts', params, options, {
-            methodType: 'list',
-        });
-    }
-    /**
-     * Creates a new FinancialAccount.
-     * @throws Stripe.AlreadyExistsError
-     * @throws Stripe.FeatureNotEnabledError
-     */
-    create(params, options) {
-        return this._makeRequest('POST', '/v2/money_management/financial_accounts', params, options);
-    }
-    /**
-     * Retrieves the details of an existing FinancialAccount.
-     */
-    retrieve(id, params, options) {
-        return this._makeRequest('GET', `/v2/money_management/financial_accounts/${id}`, params, options);
-    }
-    /**
-     * Updates an existing FinancialAccount.
-     */
-    update(id, params, options) {
-        return this._makeRequest('POST', `/v2/money_management/financial_accounts/${id}`, params, options);
-    }
-    /**
-     * Closes a FinancialAccount with or without forwarding settings.
-     * @throws Stripe.NonZeroBalanceError
-     */
-    close(id, params, options) {
-        return this._makeRequest('POST', `/v2/money_management/financial_accounts/${id}/close`, params, options);
-    }
-}
-exports.FinancialAccountResource = FinancialAccountResource;
-//# sourceMappingURL=FinancialAccounts.js.map

package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FinancialAccounts.js","sourceRoot":"","sources":["../../../../src/resources/V2/MoneyManagement/FinancialAccounts.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAK1D,MAAa,wBAAyB,SAAQ,kCAAc;IAC1D;;OAEG;IACH,IAAI,CACF,MAAsD,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,yCAAyC,EACzC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,MAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,yCAAyC,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA0D,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,2CAA2C,EAAE,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAwD,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,2CAA2C,EAAE,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,KAAK,CACH,EAAU,EACV,MAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,2CAA2C,EAAE,QAAQ,EACrD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAhFD,4DAgFC"}

package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts

@@ -1,215 +0,0 @@
-import { StripeResource } from '../../../StripeResource.js';
-import { JapanAddress } from '../../../shared.js';
-import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
-export declare class FinancialAddressResource extends StripeResource {
-    /**
-     * List all FinancialAddresses for a FinancialAccount.
-     */
-    list(params?: V2.MoneyManagement.FinancialAddressListParams, options?: RequestOptions): V2ListPromise<FinancialAddress>;
-    /**
-     * Create a new FinancialAddress for a FinancialAccount.
-     * @throws Stripe.FinancialAccountNotOpenError
-     * @throws Stripe.FeatureNotEnabledError
-     */
-    create(params: V2.MoneyManagement.FinancialAddressCreateParams, options?: RequestOptions): Promise<Response<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?: V2.MoneyManagement.FinancialAddressRetrieveParams, options?: RequestOptions): Promise<Response<FinancialAddress>>;
-}
-export 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?: V2.MoneyManagement.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: V2.MoneyManagement.FinancialAddress.Status;
-}
-export declare namespace V2 {
-    namespace MoneyManagement {
-        namespace FinancialAddress {
-            interface Credentials {
-                /**
-                 * 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;
-                /**
-                 * Open Enum. The type of Credentials that are provisioned for the FinancialAddress.
-                 */
-                type: Credentials.Type;
-                /**
-                 * 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;
-            }
-            type Status = 'active' | 'archived' | 'failed' | 'pending';
-            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' | 'us_bank_account';
-                interface UsBankAccount {
-                    /**
-                     * The address of the account holder.
-                     */
-                    account_holder_address?: JapanAddress;
-                    /**
-                     * The name of the account holder.
-                     */
-                    account_holder_name?: string;
-                    /**
-                     * 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;
-                }
-            }
-        }
-    }
-}
-export declare 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;
-        }
-        namespace FinancialAddressCreateParams {
-            type Type = 'gb_bank_account' | 'us_bank_account';
-        }
-    }
-}
-export declare namespace V2 {
-    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.us_bank_account.account_number';
-        }
-    }
-}
-export declare namespace V2 {
-    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.us_bank_account.account_number';
-        }
-    }
-}

package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js

@@ -1,31 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FinancialAddressResource = void 0;
-const StripeResource_js_1 = require("../../../StripeResource.js");
-class FinancialAddressResource extends StripeResource_js_1.StripeResource {
-    /**
-     * List all FinancialAddresses for a FinancialAccount.
-     */
-    list(params, options) {
-        return this._makeRequest('GET', '/v2/money_management/financial_addresses', params, options, {
-            methodType: 'list',
-        });
-    }
-    /**
-     * Create a new FinancialAddress for a FinancialAccount.
-     * @throws Stripe.FinancialAccountNotOpenError
-     * @throws Stripe.FeatureNotEnabledError
-     */
-    create(params, options) {
-        return this._makeRequest('POST', '/v2/money_management/financial_addresses', params, options);
-    }
-    /**
-     * 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, params, options) {
-        return this._makeRequest('GET', `/v2/money_management/financial_addresses/${id}`, params, options);
-    }
-}
-exports.FinancialAddressResource = FinancialAddressResource;
-//# sourceMappingURL=FinancialAddresses.js.map

package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FinancialAddresses.js","sourceRoot":"","sources":["../../../../src/resources/V2/MoneyManagement/FinancialAddresses.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAI1D,MAAa,wBAAyB,SAAQ,kCAAc;IAC1D;;OAEG;IACH,IAAI,CACF,MAAsD,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,0CAA0C,EAC1C,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,MAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,0CAA0C,EAC1C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA0D,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,4CAA4C,EAAE,EAAE,EAChD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAjDD,4DAiDC"}