stripe 22.3.0-alpha.4 → 22.3.0

package/cjs/resources/Treasury/ReceivedCredits.d.ts

@@ -44,7 +44,7 @@ export interface ReceivedCredit {
     /**
      * Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
      */
-    failure_code: Treasury.ReceivedCredit.FailureCode | null;
+    failure_code: ReceivedCredit.FailureCode | null;
     /**
      * The FinancialAccount that received the funds.
      */
@@ -53,8 +53,8 @@ export interface ReceivedCredit {
      * 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;
-    initiating_payment_method_details: Treasury.ReceivedCredit.InitiatingPaymentMethodDetails;
-    linked_flows: Treasury.ReceivedCredit.LinkedFlows;
+    initiating_payment_method_details: ReceivedCredit.InitiatingPaymentMethodDetails;
+    linked_flows: ReceivedCredit.LinkedFlows;
     /**
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
      */
@@ -62,184 +62,160 @@ export interface ReceivedCredit {
     /**
      * The rails used to send the funds.
      */
-    network: Treasury.ReceivedCredit.Network;
-    /**
-     * Details specific to the money movement rails.
-     */
-    network_details?: Treasury.ReceivedCredit.NetworkDetails | null;
+    network: ReceivedCredit.Network;
     /**
      * Details describing when a ReceivedCredit may be reversed.
      */
-    reversal_details: Treasury.ReceivedCredit.ReversalDetails | null;
+    reversal_details: ReceivedCredit.ReversalDetails | null;
     /**
      * Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.
      */
-    status: Treasury.ReceivedCredit.Status;
+    status: ReceivedCredit.Status;
     /**
      * The Transaction associated with this object.
      */
     transaction: string | Transaction | null;
 }
-export declare namespace Treasury {
-    namespace ReceivedCredit {
-        type FailureCode = 'account_closed' | 'account_frozen' | 'international_transaction' | 'other';
-        interface InitiatingPaymentMethodDetails {
-            /**
-             * Set when `type` is `balance`.
-             */
-            balance?: 'payments';
-            billing_details: InitiatingPaymentMethodDetails.BillingDetails;
-            financial_account?: InitiatingPaymentMethodDetails.FinancialAccount;
+export declare namespace ReceivedCredit {
+    type FailureCode = 'account_closed' | 'account_frozen' | 'international_transaction' | 'other';
+    interface InitiatingPaymentMethodDetails {
+        /**
+         * Set when `type` is `balance`.
+         */
+        balance?: 'payments';
+        billing_details: InitiatingPaymentMethodDetails.BillingDetails;
+        financial_account?: InitiatingPaymentMethodDetails.FinancialAccount;
+        /**
+         * Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID.
+         */
+        issuing_card?: string;
+        /**
+         * Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
+         */
+        type: InitiatingPaymentMethodDetails.Type;
+        us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
+    }
+    interface LinkedFlows {
+        /**
+         * The CreditReversal created as a result of this ReceivedCredit being reversed.
+         */
+        credit_reversal: string | null;
+        /**
+         * Set if the ReceivedCredit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object.
+         */
+        issuing_authorization: string | null;
+        /**
+         * Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://api.stripe.com#issuing_transactions) object.
+         */
+        issuing_transaction: string | null;
+        /**
+         * ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.
+         */
+        source_flow: string | null;
+        /**
+         * The expandable object of the source flow.
+         */
+        source_flow_details?: LinkedFlows.SourceFlowDetails | null;
+        /**
+         * The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).
+         */
+        source_flow_type: string | null;
+    }
+    type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
+    interface ReversalDetails {
+        /**
+         * Time before which a ReceivedCredit can be reversed.
+         */
+        deadline: number | null;
+        /**
+         * Set if a ReceivedCredit cannot be reversed.
+         */
+        restricted_reason: ReversalDetails.RestrictedReason | null;
+    }
+    type Status = 'failed' | 'succeeded';
+    namespace InitiatingPaymentMethodDetails {
+        interface BillingDetails {
+            address: Address;
             /**
-             * Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID.
+             * Email address.
              */
-            issuing_card?: string;
+            email: string | null;
             /**
-             * Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
+             * Full name.
              */
-            type: InitiatingPaymentMethodDetails.Type;
-            us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
+            name: string | null;
         }
-        interface LinkedFlows {
+        interface FinancialAccount {
             /**
-             * The CreditReversal created as a result of this ReceivedCredit being reversed.
+             * The FinancialAccount ID.
              */
-            credit_reversal: string | null;
+            id: string;
             /**
-             * Set if the ReceivedCredit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object.
+             * The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
              */
-            issuing_authorization: string | null;
+            network: 'stripe';
+        }
+        type Type = 'balance' | 'financial_account' | 'issuing_card' | 'stripe' | 'us_bank_account';
+        interface UsBankAccount {
             /**
-             * Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://api.stripe.com#issuing_transactions) object.
+             * Bank name.
              */
-            issuing_transaction: string | null;
+            bank_name: string | null;
             /**
-             * ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.
+             * The last four digits of the bank account number.
              */
-            source_flow: string | null;
+            last4: string | null;
             /**
-             * The expandable object of the source flow.
+             * The routing number for the bank account.
              */
-            source_flow_details?: LinkedFlows.SourceFlowDetails | null;
+            routing_number: string | null;
+        }
+    }
+    namespace LinkedFlows {
+        interface SourceFlowDetails {
             /**
-             * The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).
+             * You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
              */
-            source_flow_type: string | null;
-        }
-        type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
-        interface NetworkDetails {
+            credit_reversal?: CreditReversal;
             /**
-             * Details about an ACH transaction.
+             * Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers).
+             *
+             * Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
+             *
+             * Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
              */
-            ach?: NetworkDetails.Ach | null;
+            outbound_payment?: OutboundPayment;
             /**
-             * The type of flow that originated the ReceivedCredit.
+             * Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
+             *
+             * Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
+             *
+             * Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
              */
-            type: 'ach';
-        }
-        interface ReversalDetails {
+            outbound_transfer?: OutboundTransfer;
             /**
-             * Time before which a ReceivedCredit can be reversed.
+             * A `Payout` object is created when you receive funds from Stripe, or when you
+             * initiate a payout to either a bank account or debit card of a [connected
+             * Stripe account](https://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
+             * and list all payouts. Payouts are made on [varying
+             * schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and
+             * industry.
+             *
+             * Related guide: [Receiving payouts](https://docs.stripe.com/payouts)
              */
-            deadline: number | null;
+            payout?: Payout;
             /**
-             * Set if a ReceivedCredit cannot be reversed.
+             * The type of the source flow that originated the ReceivedCredit.
              */
-            restricted_reason: ReversalDetails.RestrictedReason | null;
-        }
-        type Status = 'failed' | 'succeeded';
-        namespace InitiatingPaymentMethodDetails {
-            interface BillingDetails {
-                address: Address;
-                /**
-                 * Email address.
-                 */
-                email: string | null;
-                /**
-                 * Full name.
-                 */
-                name: string | null;
-            }
-            interface FinancialAccount {
-                /**
-                 * The FinancialAccount ID.
-                 */
-                id: string;
-                /**
-                 * The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
-                 */
-                network: 'stripe';
-            }
-            type Type = 'balance' | 'financial_account' | 'issuing_card' | 'stripe' | 'us_bank_account';
-            interface UsBankAccount {
-                /**
-                 * Bank name.
-                 */
-                bank_name: string | null;
-                /**
-                 * The last four digits of the bank account number.
-                 */
-                last4: string | null;
-                /**
-                 * The routing number for the bank account.
-                 */
-                routing_number: string | null;
-            }
-        }
-        namespace LinkedFlows {
-            interface SourceFlowDetails {
-                /**
-                 * You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
-                 */
-                credit_reversal?: CreditReversal;
-                /**
-                 * Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers).
-                 *
-                 * Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
-                 *
-                 * Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
-                 */
-                outbound_payment?: OutboundPayment;
-                /**
-                 * Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
-                 *
-                 * Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
-                 *
-                 * Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
-                 */
-                outbound_transfer?: OutboundTransfer;
-                /**
-                 * A `Payout` object is created when you receive funds from Stripe, or when you
-                 * initiate a payout to either a bank account or debit card of a [connected
-                 * Stripe account](https://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
-                 * and list all payouts. Payouts are made on [varying
-                 * schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and
-                 * industry.
-                 *
-                 * Related guide: [Receiving payouts](https://docs.stripe.com/payouts)
-                 */
-                payout?: Payout;
-                /**
-                 * The type of the source flow that originated the ReceivedCredit.
-                 */
-                type: SourceFlowDetails.Type;
-            }
-            namespace SourceFlowDetails {
-                type Type = 'credit_reversal' | 'other' | 'outbound_payment' | 'outbound_transfer' | 'payout';
-            }
+            type: SourceFlowDetails.Type;
         }
-        namespace NetworkDetails {
-            interface Ach {
-                /**
-                 * ACH Addenda record
-                 */
-                addenda: string | null;
-            }
-        }
-        namespace ReversalDetails {
-            type RestrictedReason = 'already_reversed' | 'deadline_passed' | 'network_restricted' | 'other' | 'source_flow_restricted';
+        namespace SourceFlowDetails {
+            type Type = 'credit_reversal' | 'other' | 'outbound_payment' | 'outbound_transfer' | 'payout';
         }
     }
+    namespace ReversalDetails {
+        type RestrictedReason = 'already_reversed' | 'deadline_passed' | 'network_restricted' | 'other' | 'source_flow_restricted';
+    }
 }
 export declare namespace Treasury {
     interface ReceivedCreditRetrieveParams {

package/cjs/resources/Treasury/ReceivedDebits.d.ts

@@ -40,7 +40,7 @@ export interface ReceivedDebit {
     /**
      * Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.
      */
-    failure_code: Treasury.ReceivedDebit.FailureCode | null;
+    failure_code: ReceivedDebit.FailureCode | null;
     /**
      * The FinancialAccount that funds were pulled from.
      */
@@ -49,8 +49,8 @@ export interface ReceivedDebit {
      * 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;
-    initiating_payment_method_details?: Treasury.ReceivedDebit.InitiatingPaymentMethodDetails;
-    linked_flows: Treasury.ReceivedDebit.LinkedFlows;
+    initiating_payment_method_details?: ReceivedDebit.InitiatingPaymentMethodDetails;
+    linked_flows: ReceivedDebit.LinkedFlows;
     /**
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
      */
@@ -58,146 +58,118 @@ export interface ReceivedDebit {
     /**
      * The network used for the ReceivedDebit.
      */
-    network: Treasury.ReceivedDebit.Network;
-    /**
-     * Details specific to the money movement rails.
-     */
-    network_details?: Treasury.ReceivedDebit.NetworkDetails | null;
+    network: ReceivedDebit.Network;
     /**
      * Details describing when a ReceivedDebit might be reversed.
      */
-    reversal_details: Treasury.ReceivedDebit.ReversalDetails | null;
+    reversal_details: ReceivedDebit.ReversalDetails | null;
     /**
      * Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.
      */
-    status: Treasury.ReceivedDebit.Status;
+    status: ReceivedDebit.Status;
     /**
      * The Transaction associated with this object.
      */
     transaction: string | Transaction | null;
 }
-export declare namespace Treasury {
-    namespace ReceivedDebit {
-        type FailureCode = 'account_closed' | 'account_frozen' | 'insufficient_funds' | 'international_transaction' | 'other';
-        interface InitiatingPaymentMethodDetails {
-            /**
-             * Set when `type` is `balance`.
-             */
-            balance?: 'payments';
-            billing_details: InitiatingPaymentMethodDetails.BillingDetails;
-            financial_account?: InitiatingPaymentMethodDetails.FinancialAccount;
+export declare namespace ReceivedDebit {
+    type FailureCode = 'account_closed' | 'account_frozen' | 'insufficient_funds' | 'international_transaction' | 'other';
+    interface InitiatingPaymentMethodDetails {
+        /**
+         * Set when `type` is `balance`.
+         */
+        balance?: 'payments';
+        billing_details: InitiatingPaymentMethodDetails.BillingDetails;
+        financial_account?: InitiatingPaymentMethodDetails.FinancialAccount;
+        /**
+         * Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID.
+         */
+        issuing_card?: string;
+        /**
+         * Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
+         */
+        type: InitiatingPaymentMethodDetails.Type;
+        us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
+    }
+    interface LinkedFlows {
+        /**
+         * The DebitReversal created as a result of this ReceivedDebit being reversed.
+         */
+        debit_reversal: string | null;
+        /**
+         * Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.
+         */
+        inbound_transfer: string | null;
+        /**
+         * Set if the ReceivedDebit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object.
+         */
+        issuing_authorization: string | null;
+        /**
+         * Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://api.stripe.com#issuing_disputes) object.
+         */
+        issuing_transaction: string | null;
+        /**
+         * Set if the ReceivedDebit was created due to a [Payout](https://api.stripe.com#payouts) object.
+         */
+        payout: string | null;
+        /**
+         * Set if the ReceivedDebit was created due to a [Topup](https://api.stripe.com#topups) object.
+         */
+        topup: string | null;
+    }
+    type Network = 'ach' | 'card' | 'stripe';
+    interface ReversalDetails {
+        /**
+         * Time before which a ReceivedDebit can be reversed.
+         */
+        deadline: number | null;
+        /**
+         * Set if a ReceivedDebit can't be reversed.
+         */
+        restricted_reason: ReversalDetails.RestrictedReason | null;
+    }
+    type Status = 'failed' | 'succeeded';
+    namespace InitiatingPaymentMethodDetails {
+        interface BillingDetails {
+            address: Address;
             /**
-             * Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID.
+             * Email address.
              */
-            issuing_card?: string;
+            email: string | null;
             /**
-             * Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
+             * Full name.
              */
-            type: InitiatingPaymentMethodDetails.Type;
-            us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
+            name: string | null;
         }
-        interface LinkedFlows {
-            /**
-             * The DebitReversal created as a result of this ReceivedDebit being reversed.
-             */
-            debit_reversal: string | null;
-            /**
-             * Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.
-             */
-            inbound_transfer: string | null;
-            /**
-             * Set if the ReceivedDebit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object.
-             */
-            issuing_authorization: string | null;
+        interface FinancialAccount {
             /**
-             * Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://api.stripe.com#issuing_disputes) object.
+             * The FinancialAccount ID.
              */
-            issuing_transaction: string | null;
+            id: string;
             /**
-             * Set if the ReceivedDebit was created due to a [Payout](https://api.stripe.com#payouts) object.
+             * The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
              */
-            payout: string | null;
-            /**
-             * The ReceivedCredit that Capital withheld from
-             */
-            received_credit_capital_withholding?: string | null;
-            /**
-             * Set if the ReceivedDebit was created due to a [Topup](https://api.stripe.com#topups) object.
-             */
-            topup: string | null;
+            network: 'stripe';
         }
-        type Network = 'ach' | 'card' | 'stripe';
-        interface NetworkDetails {
-            /**
-             * Details about an ACH transaction.
-             */
-            ach?: NetworkDetails.Ach | null;
+        type Type = 'balance' | 'financial_account' | 'issuing_card' | 'stripe' | 'us_bank_account';
+        interface UsBankAccount {
             /**
-             * The type of flow that originated the ReceivedDebit.
+             * Bank name.
              */
-            type: 'ach';
-        }
-        interface ReversalDetails {
+            bank_name: string | null;
             /**
-             * Time before which a ReceivedDebit can be reversed.
+             * The last four digits of the bank account number.
              */
-            deadline: number | null;
+            last4: string | null;
             /**
-             * Set if a ReceivedDebit can't be reversed.
+             * The routing number for the bank account.
              */
-            restricted_reason: ReversalDetails.RestrictedReason | null;
-        }
-        type Status = 'failed' | 'succeeded';
-        namespace InitiatingPaymentMethodDetails {
-            interface BillingDetails {
-                address: Address;
-                /**
-                 * Email address.
-                 */
-                email: string | null;
-                /**
-                 * Full name.
-                 */
-                name: string | null;
-            }
-            interface FinancialAccount {
-                /**
-                 * The FinancialAccount ID.
-                 */
-                id: string;
-                /**
-                 * The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
-                 */
-                network: 'stripe';
-            }
-            type Type = 'balance' | 'financial_account' | 'issuing_card' | 'stripe' | 'us_bank_account';
-            interface UsBankAccount {
-                /**
-                 * Bank name.
-                 */
-                bank_name: string | null;
-                /**
-                 * The last four digits of the bank account number.
-                 */
-                last4: string | null;
-                /**
-                 * The routing number for the bank account.
-                 */
-                routing_number: string | null;
-            }
-        }
-        namespace NetworkDetails {
-            interface Ach {
-                /**
-                 * ACH Addenda record
-                 */
-                addenda: string | null;
-            }
-        }
-        namespace ReversalDetails {
-            type RestrictedReason = 'already_reversed' | 'deadline_passed' | 'network_restricted' | 'other' | 'source_flow_restricted';
+            routing_number: string | null;
         }
     }
+    namespace ReversalDetails {
+        type RestrictedReason = 'already_reversed' | 'deadline_passed' | 'network_restricted' | 'other' | 'source_flow_restricted';
+    }
 }
 export declare namespace Treasury {
     interface ReceivedDebitRetrieveParams {