stripe 22.3.0-alpha.4 → 22.3.0

package/esm/resources/Treasury/FinancialAccounts.d.ts

@@ -1,6 +1,6 @@
 import { StripeResource } from '../../StripeResource.js';
 import { FinancialAccountFeatures } from './FinancialAccountFeatures.js';
-import { Emptyable, MetadataParam, PaginationParams, RangeQueryParam, Metadata } from '../../shared.js';
+import { MetadataParam, Emptyable, PaginationParams, RangeQueryParam, Metadata } from '../../shared.js';
 import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
 export declare class FinancialAccountResource extends StripeResource {
     /**
@@ -44,11 +44,11 @@ export interface FinancialAccount {
     /**
      * The array of paths to active Features in the Features hash.
      */
-    active_features?: Array<Treasury.FinancialAccount.ActiveFeature>;
+    active_features?: Array<FinancialAccount.ActiveFeature>;
     /**
      * Balance information for the FinancialAccount
      */
-    balance: Treasury.FinancialAccount.Balance;
+    balance: FinancialAccount.Balance;
     /**
      * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
      */
@@ -57,10 +57,6 @@ export interface FinancialAccount {
      * Time at which the object was created. Measured in seconds since the Unix epoch.
      */
     created: number;
-    /**
-     * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
-     */
-    display_name?: string | null;
     /**
      * Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
      * Stripe or the platform can control Features via the requested field.
@@ -69,7 +65,7 @@ export interface FinancialAccount {
     /**
      * The set of credentials that resolve to a FinancialAccount.
      */
-    financial_addresses: Array<Treasury.FinancialAccount.FinancialAddress>;
+    financial_addresses: Array<FinancialAccount.FinancialAddress>;
     is_default?: boolean;
     /**
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
@@ -86,120 +82,118 @@ export interface FinancialAccount {
     /**
      * The array of paths to pending Features in the Features hash.
      */
-    pending_features?: Array<Treasury.FinancialAccount.PendingFeature>;
+    pending_features?: Array<FinancialAccount.PendingFeature>;
     /**
      * The set of functionalities that the platform can restrict on the FinancialAccount.
      */
-    platform_restrictions?: Treasury.FinancialAccount.PlatformRestrictions | null;
+    platform_restrictions?: FinancialAccount.PlatformRestrictions | null;
     /**
      * The array of paths to restricted Features in the Features hash.
      */
-    restricted_features?: Array<Treasury.FinancialAccount.RestrictedFeature>;
+    restricted_features?: Array<FinancialAccount.RestrictedFeature>;
     /**
      * Status of this FinancialAccount.
      */
-    status: Treasury.FinancialAccount.Status;
-    status_details: Treasury.FinancialAccount.StatusDetails;
+    status: FinancialAccount.Status;
+    status_details: FinancialAccount.StatusDetails;
     /**
      * The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
      */
     supported_currencies: Array<string>;
 }
-export declare namespace Treasury {
-    namespace FinancialAccount {
-        type ActiveFeature = 'card_issuing' | 'deposit_insurance' | 'financial_addresses.aba' | 'financial_addresses.aba.forwarding' | 'inbound_transfers.ach' | 'intra_stripe_flows' | 'outbound_payments.ach' | 'outbound_payments.us_domestic_wire' | 'outbound_transfers.ach' | 'outbound_transfers.us_domestic_wire' | 'remote_deposit_capture';
-        interface Balance {
-            /**
-             * Funds the user can spend right now.
-             */
-            cash: {
-                [key: string]: number;
-            };
-            /**
-             * Funds not spendable yet, but will become available at a later time.
-             */
-            inbound_pending: {
-                [key: string]: number;
-            };
-            /**
-             * Funds in the account, but not spendable because they are being held for pending outbound flows.
-             */
-            outbound_pending: {
-                [key: string]: number;
-            };
-        }
-        interface FinancialAddress {
+export declare namespace FinancialAccount {
+    type ActiveFeature = 'card_issuing' | 'deposit_insurance' | 'financial_addresses.aba' | 'financial_addresses.aba.forwarding' | 'inbound_transfers.ach' | 'intra_stripe_flows' | 'outbound_payments.ach' | 'outbound_payments.us_domestic_wire' | 'outbound_transfers.ach' | 'outbound_transfers.us_domestic_wire' | 'remote_deposit_capture';
+    interface Balance {
+        /**
+         * Funds the user can spend right now.
+         */
+        cash: {
+            [key: string]: number;
+        };
+        /**
+         * Funds not spendable yet, but will become available at a later time.
+         */
+        inbound_pending: {
+            [key: string]: number;
+        };
+        /**
+         * Funds in the account, but not spendable because they are being held for pending outbound flows.
+         */
+        outbound_pending: {
+            [key: string]: number;
+        };
+    }
+    interface FinancialAddress {
+        /**
+         * ABA Records contain U.S. bank account details per the ABA format.
+         */
+        aba?: FinancialAddress.Aba;
+        /**
+         * The list of networks that the address supports
+         */
+        supported_networks?: Array<FinancialAddress.SupportedNetwork>;
+        /**
+         * The type of financial address
+         */
+        type: 'aba';
+    }
+    type PendingFeature = 'card_issuing' | 'deposit_insurance' | 'financial_addresses.aba' | 'financial_addresses.aba.forwarding' | 'inbound_transfers.ach' | 'intra_stripe_flows' | 'outbound_payments.ach' | 'outbound_payments.us_domestic_wire' | 'outbound_transfers.ach' | 'outbound_transfers.us_domestic_wire' | 'remote_deposit_capture';
+    interface PlatformRestrictions {
+        /**
+         * Restricts all inbound money movement.
+         */
+        inbound_flows: PlatformRestrictions.InboundFlows | null;
+        /**
+         * Restricts all outbound money movement.
+         */
+        outbound_flows: PlatformRestrictions.OutboundFlows | null;
+    }
+    type RestrictedFeature = 'card_issuing' | 'deposit_insurance' | 'financial_addresses.aba' | 'financial_addresses.aba.forwarding' | 'inbound_transfers.ach' | 'intra_stripe_flows' | 'outbound_payments.ach' | 'outbound_payments.us_domestic_wire' | 'outbound_transfers.ach' | 'outbound_transfers.us_domestic_wire' | 'remote_deposit_capture';
+    type Status = 'closed' | 'open';
+    interface StatusDetails {
+        /**
+         * Details related to the closure of this FinancialAccount
+         */
+        closed: StatusDetails.Closed | null;
+    }
+    namespace FinancialAddress {
+        interface Aba {
             /**
-             * ABA Records contain U.S. bank account details per the ABA format.
+             * The name of the person or business that owns the bank account.
              */
-            aba?: FinancialAddress.Aba;
+            account_holder_name: string;
             /**
-             * The list of networks that the address supports
+             * The account number.
              */
-            supported_networks?: Array<FinancialAddress.SupportedNetwork>;
+            account_number?: string | null;
             /**
-             * The type of financial address
+             * The last four characters of the account number.
              */
-            type: 'aba';
-        }
-        type PendingFeature = 'card_issuing' | 'deposit_insurance' | 'financial_addresses.aba' | 'financial_addresses.aba.forwarding' | 'inbound_transfers.ach' | 'intra_stripe_flows' | 'outbound_payments.ach' | 'outbound_payments.us_domestic_wire' | 'outbound_transfers.ach' | 'outbound_transfers.us_domestic_wire' | 'remote_deposit_capture';
-        interface PlatformRestrictions {
+            account_number_last4: string;
             /**
-             * Restricts all inbound money movement.
+             * Name of the bank.
              */
-            inbound_flows: PlatformRestrictions.InboundFlows | null;
+            bank_name: string;
             /**
-             * Restricts all outbound money movement.
+             * Routing number for the account.
              */
-            outbound_flows: PlatformRestrictions.OutboundFlows | null;
+            routing_number: string;
         }
-        type RestrictedFeature = 'card_issuing' | 'deposit_insurance' | 'financial_addresses.aba' | 'financial_addresses.aba.forwarding' | 'inbound_transfers.ach' | 'intra_stripe_flows' | 'outbound_payments.ach' | 'outbound_payments.us_domestic_wire' | 'outbound_transfers.ach' | 'outbound_transfers.us_domestic_wire' | 'remote_deposit_capture';
-        type Status = 'closed' | 'open';
-        interface StatusDetails {
+        type SupportedNetwork = 'ach' | 'us_domestic_wire';
+    }
+    namespace PlatformRestrictions {
+        type InboundFlows = 'restricted' | 'unrestricted';
+        type OutboundFlows = 'restricted' | 'unrestricted';
+    }
+    namespace StatusDetails {
+        interface Closed {
             /**
-             * Details related to the closure of this FinancialAccount
+             * The array that contains reasons for a FinancialAccount closure.
              */
-            closed: StatusDetails.Closed | null;
-        }
-        namespace FinancialAddress {
-            interface Aba {
-                /**
-                 * The name of the person or business that owns the bank account.
-                 */
-                account_holder_name: string;
-                /**
-                 * The account number.
-                 */
-                account_number?: string | null;
-                /**
-                 * The last four characters of the account number.
-                 */
-                account_number_last4: string;
-                /**
-                 * Name of the bank.
-                 */
-                bank_name: string;
-                /**
-                 * Routing number for the account.
-                 */
-                routing_number: string;
-            }
-            type SupportedNetwork = 'ach' | 'us_domestic_wire';
-        }
-        namespace PlatformRestrictions {
-            type InboundFlows = 'restricted' | 'unrestricted';
-            type OutboundFlows = 'restricted' | 'unrestricted';
+            reasons: Array<Closed.Reason>;
         }
-        namespace StatusDetails {
-            interface Closed {
-                /**
-                 * The array that contains reasons for a FinancialAccount closure.
-                 */
-                reasons: Array<Closed.Reason>;
-            }
-            namespace Closed {
-                type Reason = 'account_rejected' | 'closed_by_platform' | 'other';
-            }
+        namespace Closed {
+            type Reason = 'account_rejected' | 'closed_by_platform' | 'other';
         }
     }
 }
@@ -209,10 +203,6 @@ export declare namespace Treasury {
          * The currencies the FinancialAccount can hold a balance in.
          */
         supported_currencies: Array<string>;
-        /**
-         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
-         */
-        display_name?: Emptyable<string>;
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -328,18 +318,11 @@ export declare namespace Treasury {
             }
             namespace FinancialAddresses {
                 interface Aba {
-                    /**
-                     * Requested bank partner
-                     */
-                    bank?: Aba.Bank;
                     /**
                      * Whether the FinancialAccount should have the Feature.
                      */
                     requested: boolean;
                 }
-                namespace Aba {
-                    type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
-                }
             }
             namespace InboundTransfers {
                 interface Ach {
@@ -394,10 +377,6 @@ export declare namespace Treasury {
 }
 export declare namespace Treasury {
     interface FinancialAccountUpdateParams {
-        /**
-         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
-         */
-        display_name?: Emptyable<string>;
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -531,18 +510,11 @@ export declare namespace Treasury {
             }
             namespace FinancialAddresses {
                 interface Aba {
-                    /**
-                     * Requested bank partner
-                     */
-                    bank?: Aba.Bank;
                     /**
                      * Whether the FinancialAccount should have the Feature.
                      */
                     requested: boolean;
                 }
-                namespace Aba {
-                    type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
-                }
             }
             namespace InboundTransfers {
                 interface Ach {
@@ -736,18 +708,11 @@ export declare namespace Treasury {
         }
         namespace FinancialAddresses {
             interface Aba {
-                /**
-                 * Requested bank partner
-                 */
-                bank?: Aba.Bank;
                 /**
                  * Whether the FinancialAccount should have the Feature.
                  */
                 requested: boolean;
             }
-            namespace Aba {
-                type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
-            }
         }
         namespace InboundTransfers {
             interface Ach {

package/esm/resources/Treasury/InboundTransfers.d.ts

@@ -53,7 +53,7 @@ export interface InboundTransfer {
     /**
      * Details about this InboundTransfer's failure. Only set when status is `failed`.
      */
-    failure_details: Treasury.InboundTransfer.FailureDetails | null;
+    failure_details: InboundTransfer.FailureDetails | null;
     /**
      * The FinancialAccount that received the funds.
      */
@@ -62,7 +62,7 @@ export interface InboundTransfer {
      * A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
      */
     hosted_regulatory_receipt_url: string | null;
-    linked_flows: Treasury.InboundTransfer.LinkedFlows;
+    linked_flows: InboundTransfer.LinkedFlows;
     /**
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
      */
@@ -78,7 +78,7 @@ export interface InboundTransfer {
     /**
      * Details about the PaymentMethod for an InboundTransfer.
      */
-    origin_payment_method_details: Treasury.InboundTransfer.OriginPaymentMethodDetails | null;
+    origin_payment_method_details: InboundTransfer.OriginPaymentMethodDetails | null;
     /**
      * Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.
      */
@@ -90,103 +90,101 @@ export interface InboundTransfer {
     /**
      * Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.
      */
-    status: Treasury.InboundTransfer.Status;
-    status_transitions: Treasury.InboundTransfer.StatusTransitions;
+    status: InboundTransfer.Status;
+    status_transitions: InboundTransfer.StatusTransitions;
     /**
      * The Transaction associated with this object.
      */
     transaction: string | Transaction | null;
 }
-export declare namespace Treasury {
-    namespace InboundTransfer {
-        interface FailureDetails {
+export declare namespace InboundTransfer {
+    interface FailureDetails {
+        /**
+         * Reason for the failure.
+         */
+        code: FailureDetails.Code;
+    }
+    interface LinkedFlows {
+        /**
+         * If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.
+         */
+        received_debit: string | null;
+    }
+    interface OriginPaymentMethodDetails {
+        billing_details: OriginPaymentMethodDetails.BillingDetails;
+        /**
+         * The type of the payment method used in the InboundTransfer.
+         */
+        type: 'us_bank_account';
+        us_bank_account?: OriginPaymentMethodDetails.UsBankAccount;
+    }
+    type Status = 'canceled' | 'failed' | 'processing' | 'succeeded';
+    interface StatusTransitions {
+        /**
+         * Timestamp describing when an InboundTransfer changed status to `canceled`.
+         */
+        canceled_at?: number | null;
+        /**
+         * Timestamp describing when an InboundTransfer changed status to `failed`.
+         */
+        failed_at: number | null;
+        /**
+         * Timestamp describing when an InboundTransfer changed status to `succeeded`.
+         */
+        succeeded_at: number | null;
+    }
+    namespace FailureDetails {
+        type Code = 'account_closed' | 'account_frozen' | 'bank_account_restricted' | 'bank_ownership_changed' | 'debit_not_authorized' | 'incorrect_account_holder_address' | 'incorrect_account_holder_name' | 'incorrect_account_holder_tax_id' | 'insufficient_funds' | 'invalid_account_number' | 'invalid_currency' | 'no_account' | 'other';
+    }
+    namespace OriginPaymentMethodDetails {
+        interface BillingDetails {
+            address: Address;
             /**
-             * Reason for the failure.
+             * Email address.
              */
-            code: FailureDetails.Code;
-        }
-        interface LinkedFlows {
+            email: string | null;
             /**
-             * If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.
+             * Full name.
              */
-            received_debit: string | null;
+            name: string | null;
         }
-        interface OriginPaymentMethodDetails {
-            billing_details: OriginPaymentMethodDetails.BillingDetails;
+        interface UsBankAccount {
             /**
-             * The type of the payment method used in the InboundTransfer.
+             * Account holder type: individual or company.
              */
-            type: 'us_bank_account';
-            us_bank_account?: OriginPaymentMethodDetails.UsBankAccount;
-        }
-        type Status = 'canceled' | 'failed' | 'processing' | 'succeeded';
-        interface StatusTransitions {
+            account_holder_type: UsBankAccount.AccountHolderType | null;
             /**
-             * Timestamp describing when an InboundTransfer changed status to `canceled`.
+             * Account type: checkings or savings. Defaults to checking if omitted.
              */
-            canceled_at?: number | null;
+            account_type: UsBankAccount.AccountType | null;
             /**
-             * Timestamp describing when an InboundTransfer changed status to `failed`.
+             * Name of the bank associated with the bank account.
              */
-            failed_at: number | null;
+            bank_name: string | null;
             /**
-             * Timestamp describing when an InboundTransfer changed status to `succeeded`.
+             * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
              */
-            succeeded_at: number | null;
-        }
-        namespace FailureDetails {
-            type Code = 'account_closed' | 'account_frozen' | 'bank_account_restricted' | 'bank_ownership_changed' | 'debit_not_authorized' | 'incorrect_account_holder_address' | 'incorrect_account_holder_name' | 'incorrect_account_holder_tax_id' | 'insufficient_funds' | 'invalid_account_number' | 'invalid_currency' | 'no_account' | 'other';
+            fingerprint: string | null;
+            /**
+             * Last four digits of the bank account number.
+             */
+            last4: string | null;
+            /**
+             * ID of the mandate used to make this payment.
+             */
+            mandate?: string | Mandate;
+            /**
+             * The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
+             */
+            network: 'ach';
+            /**
+             * Routing number of the bank account.
+             */
+            routing_number: string | null;
         }
-        namespace OriginPaymentMethodDetails {
-            interface BillingDetails {
-                address: Address;
-                /**
-                 * Email address.
-                 */
-                email: string | null;
-                /**
-                 * Full name.
-                 */
-                name: string | null;
-            }
-            interface UsBankAccount {
-                /**
-                 * Account holder type: individual or company.
-                 */
-                account_holder_type: UsBankAccount.AccountHolderType | null;
-                /**
-                 * Account type: checkings or savings. Defaults to checking if omitted.
-                 */
-                account_type: UsBankAccount.AccountType | null;
-                /**
-                 * Name of the bank associated with the bank account.
-                 */
-                bank_name: string | null;
-                /**
-                 * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
-                 */
-                fingerprint: string | null;
-                /**
-                 * Last four digits of the bank account number.
-                 */
-                last4: string | null;
-                /**
-                 * ID of the mandate used to make this payment.
-                 */
-                mandate?: string | Mandate;
-                /**
-                 * The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
-                 */
-                network: 'ach';
-                /**
-                 * Routing number of the bank account.
-                 */
-                routing_number: string | null;
-            }
-            namespace UsBankAccount {
-                type AccountHolderType = 'company' | 'individual';
-                type AccountType = 'checking' | 'savings';
-            }
+        namespace UsBankAccount {
+            type AccountHolderType = 'company' | 'individual';
+            type AccountType = 'checking' | 'savings';
         }
     }
 }