stripe 19.1.0 → 19.2.0-alpha.1

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

@@ -0,0 +1,110 @@
+// 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

@@ -0,0 +1,83 @@
+// 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

@@ -0,0 +1,148 @@
+// 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';
+        }
+      }
+    }
+  }
+}

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

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

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

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