stripe 19.4.0-alpha.1 → 20.0.0

package/types/V2/Core/Vault/UsBankAccountsResource.d.ts

@@ -1,198 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountCreateParams {
-            /**
-             * The account number of the bank account.
-             */
-            account_number: string;
-
-            /**
-             * Closed Enum. The type of the bank account (checking or savings).
-             */
-            bank_account_type?: UsBankAccountCreateParams.BankAccountType;
-
-            /**
-             * The fedwire routing number of the bank account. Note that certain banks have the same ACH and wire routing number.
-             */
-            fedwire_routing_number?: string;
-
-            /**
-             * The ACH routing number of the bank account. Note that certain banks have the same ACH and wire routing number.
-             */
-            routing_number?: string;
-          }
-
-          namespace UsBankAccountCreateParams {
-            type BankAccountType = 'checking' | 'savings';
-          }
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountRetrieveParams {}
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountUpdateParams {
-            /**
-             * The bank account's fedwire routing number can be provided for update it was were empty previously.
-             */
-            fedwire_routing_number?: string;
-
-            /**
-             * The bank account's ACH routing number can be provided for update if it was empty previously.
-             */
-            routing_number?: string;
-          }
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountListParams {
-            /**
-             * Optionally set the maximum number of results per page. Defaults to 10.
-             */
-            limit?: number;
-
-            /**
-             * Optionally filter by verification status. Mutually exclusive with `unverified`, `verified`, `awaiting_verification`, and `verification_failed`.
-             */
-            verification_status?: string;
-          }
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountArchiveParams {}
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountConfirmMicrodepositsParams {
-            /**
-             * Two amounts received through Send Microdeposits must match the input to Confirm Microdeposits to verify US Bank Account.
-             */
-            amounts?: Array<number>;
-
-            /**
-             * Descriptor code received through Send Microdeposits must match the input to Confirm Microdeposits to verify US Bank Account.
-             */
-            descriptor_code?: string;
-          }
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          interface UsBankAccountSendMicrodepositsParams {}
-        }
-      }
-
-      namespace Core {
-        namespace Vault {
-          class UsBankAccountsResource {
-            /**
-             * Create a USBankAccount object.
-             * @throws Stripe.BlockedByStripeError
-             * @throws Stripe.InvalidPaymentMethodError
-             * @throws Stripe.QuotaExceededError
-             */
-            create(
-              params: UsBankAccountCreateParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-
-            /**
-             * Retrieve a USBankAccount object.
-             */
-            retrieve(
-              id: string,
-              params?: UsBankAccountRetrieveParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-            retrieve(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-
-            /**
-             * Update a USBankAccount object. This is limited to supplying a previously empty routing_number field.
-             * @throws Stripe.BlockedByStripeError
-             * @throws Stripe.InvalidPaymentMethodError
-             * @throws Stripe.QuotaExceededError
-             */
-            update(
-              id: string,
-              params?: UsBankAccountUpdateParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-
-            /**
-             * List USBankAccount objects. Optionally filter by verification status.
-             */
-            list(
-              params?: UsBankAccountListParams,
-              options?: RequestOptions
-            ): ApiListPromise<Stripe.V2.Core.Vault.UsBankAccount>;
-            list(
-              options?: RequestOptions
-            ): ApiListPromise<Stripe.V2.Core.Vault.UsBankAccount>;
-
-            /**
-             * Archive a USBankAccount object. USBankAccount objects will not be automatically archived by Stripe.
-             * Archived USBankAccount objects cannot be used as outbound destinations
-             * and will not appear in the outbound destination list.
-             * @throws Stripe.ControlledByDashboardError
-             */
-            archive(
-              id: string,
-              params?: UsBankAccountArchiveParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-            archive(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-
-            /**
-             * Confirm microdeposits amounts or descriptor code that you have received from the Send Microdeposits request. Once you correctly confirm this, this US Bank Account will be verified and eligible to transfer funds with.
-             */
-            confirmMicrodeposits(
-              id: string,
-              params?: UsBankAccountConfirmMicrodepositsParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-            confirmMicrodeposits(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-
-            /**
-             * Send microdeposits in order to verify your US Bank Account so it is eligible to transfer funds. This will start the verification process and you must Confirm Microdeposits to successfully verify your US Bank Account.
-             */
-            sendMicrodeposits(
-              id: string,
-              params?: UsBankAccountSendMicrodepositsParams,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-            sendMicrodeposits(
-              id: string,
-              options?: RequestOptions
-            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
-          }
-        }
-      }
-    }
-  }
-}

package/types/V2/FinancialAddressCreditSimulations.d.ts

@@ -1,27 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      /**
-       * The FinancialAddressCreditSimulation object.
-       */
-      interface FinancialAddressCreditSimulation {
-        /**
-         * String representing the object's type. Objects of the same type share the same value of the object field.
-         */
-        object: 'financial_address_credit_simulation';
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * The status of the request, signifying whether a simulated credit was initiated.
-         */
-        status: string;
-      }
-    }
-  }
-}

package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts

@@ -1,32 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      /**
-       * The FinancialAddressGeneratedMicrodeposits object.
-       */
-      interface FinancialAddressGeneratedMicrodeposits {
-        /**
-         * String representing the object's type. Objects of the same type share the same value of the object field.
-         */
-        object: 'financial_address_generated_microdeposits';
-
-        /**
-         * The amounts of the microdeposits that were generated.
-         */
-        amounts: Array<Amount>;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * Closed Enum. The status of the request.
-         */
-        status: 'accepted';
-      }
-    }
-  }
-}

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

@@ -1,110 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace MoneyManagement {
-        /**
-         * Adjustments represent Stripe-initiated credits or debits to a user balance. They might be used to amend balances due to technical or operational error.
-         */
-        interface Adjustment {
-          /**
-           * 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.adjustment';
-
-          /**
-           * If applicable, contains information about the original flow linked to this Adjustment.
-           */
-          adjusted_flow?: Adjustment.AdjustedFlow;
-
-          /**
-           * The amount of the Adjustment.
-           */
-          amount: Amount;
-
-          /**
-           * Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
-           */
-          created: string;
-
-          /**
-           * Description of the Adjustment and what it was used for.
-           */
-          description?: string;
-
-          /**
-           * The FinancialAccount that this adjustment is for.
-           */
-          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;
-
-          /**
-           * A link to the Stripe-hosted receipt that is provided when money movement is considered regulated under Stripe's money transmission licenses. The receipt link remains active for 60 days from the Adjustment creation date. After this period, the link will expire and the receipt url value will be null.
-           */
-          receipt_url?: string;
-        }
-
-        namespace Adjustment {
-          interface AdjustedFlow {
-            /**
-             * Closed Enum. If applicable, the type of flow linked to this Adjustment. The field matching this value will contain the ID of the flow.
-             */
-            type: AdjustedFlow.Type;
-
-            /**
-             * If applicable, the ID of the Adjustment linked to this Adjustment.
-             */
-            adjustment?: string;
-
-            /**
-             * If applicable, the ID of the InboundTransfer linked to this Adjustment.
-             */
-            inbound_transfer?: string;
-
-            /**
-             * If applicable, the ID of the OutboundPayment linked to this Adjustment.
-             */
-            outbound_payment?: string;
-
-            /**
-             * If applicable, the ID of the OutboundTransfer linked to this Adjustment.
-             */
-            outbound_transfer?: string;
-
-            /**
-             * If applicable, the ID of the ReceivedCredit linked to this Adjustment.
-             */
-            received_credit?: string;
-
-            /**
-             * If applicable, the ID of the ReceivedDebit linked to this Adjustment.
-             */
-            received_debit?: string;
-          }
-
-          namespace AdjustedFlow {
-            type Type =
-              | 'adjustment'
-              | 'balance_exchange'
-              | 'inbound_payment'
-              | 'inbound_transfer'
-              | 'outbound_payment'
-              | 'outbound_transfer'
-              | 'received_credit'
-              | 'received_debit';
-          }
-        }
-      }
-    }
-  }
-}

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

@@ -1,83 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace MoneyManagement {
-        interface AdjustmentRetrieveParams {}
-      }
-
-      namespace MoneyManagement {
-        interface AdjustmentListParams {
-          /**
-           * Filter for Adjustments linked to a Flow.
-           */
-          adjusted_flow?: string;
-
-          /**
-           * Filter for objects created at the specified timestamp.
-           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
-           */
-          created?: string;
-
-          /**
-           * Filter for objects created after the specified timestamp.
-           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
-           */
-          created_gt?: string;
-
-          /**
-           * Filter for objects created on or after the specified timestamp.
-           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
-           */
-          created_gte?: string;
-
-          /**
-           * Filter for objects created before the specified timestamp.
-           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
-           */
-          created_lt?: string;
-
-          /**
-           * Filter for objects created on or before the specified timestamp.
-           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
-           */
-          created_lte?: string;
-
-          /**
-           * The page limit.
-           */
-          limit?: number;
-        }
-      }
-
-      namespace MoneyManagement {
-        class AdjustmentsResource {
-          /**
-           * Retrieves the details of an Adjustment by ID.
-           */
-          retrieve(
-            id: string,
-            params?: AdjustmentRetrieveParams,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.Adjustment>>;
-          retrieve(
-            id: string,
-            options?: RequestOptions
-          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.Adjustment>>;
-
-          /**
-           * Returns a list of Adjustments that match the provided filters.
-           */
-          list(
-            params?: AdjustmentListParams,
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.MoneyManagement.Adjustment>;
-          list(
-            options?: RequestOptions
-          ): ApiListPromise<Stripe.V2.MoneyManagement.Adjustment>;
-        }
-      }
-    }
-  }
-}

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

@@ -1,148 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace V2 {
-      namespace MoneyManagement {
-        /**
-         * A FinancialAccount represents a balance and can be used as the source or destination for the money management (`/v2/money_management`) APIs.
-         */
-        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: 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?: Stripe.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?: 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: FinancialAccount.Status;
-
-          status_details?: FinancialAccount.StatusDetails;
-
-          /**
-           * If this is a `storage` FinancialAccount, this hash includes details specific to `storage` FinancialAccounts.
-           */
-          storage?: 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: FinancialAccount.Type;
-        }
-
-        namespace FinancialAccount {
-          interface Balance {
-            /**
-             * Balance that can be used for money movement.
-             */
-            available: {
-              [key: string]: Amount;
-            };
-
-            /**
-             * Balance of inbound funds that will later transition to the `available` balance.
-             */
-            inbound_pending: {
-              [key: string]: Amount;
-            };
-
-            /**
-             * Balance of funds that are being used for a pending outbound money movement.
-             */
-            outbound_pending: {
-              [key: string]: Amount;
-            };
-          }
-
-          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 {
-            closed?: StatusDetails.Closed;
-          }
-
-          namespace StatusDetails {
-            interface Closed {
-              forwarding_settings?: Closed.ForwardingSettings;
-
-              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';
-            }
-          }
-
-          interface Storage {
-            /**
-             * The currencies that this FinancialAccount can hold.
-             */
-            holds_currencies: Array<string>;
-          }
-
-          type Type = 'other' | 'storage';
-        }
-      }
-    }
-  }
-}