stripe 18.3.0 → 18.4.0-beta.2

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

@@ -0,0 +1,289 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface FinancialAddressCreateParams {
+          /**
+           * Open Enum. The currency the FinancialAddress should support. Currently, only the `usd` and `gbp` values are supported.
+           */
+          currency: FinancialAddressCreateParams.Currency;
+
+          /**
+           * The ID of the FinancialAccount the new FinancialAddress should be associated with.
+           */
+          financial_account: string;
+        }
+
+        namespace FinancialAddressCreateParams {
+          type Currency =
+            | 'aed'
+            | 'afn'
+            | 'all'
+            | 'amd'
+            | 'ang'
+            | 'aoa'
+            | 'ars'
+            | 'aud'
+            | 'awg'
+            | 'azn'
+            | 'bam'
+            | 'bbd'
+            | 'bdt'
+            | 'bgn'
+            | 'bhd'
+            | 'bif'
+            | 'bmd'
+            | 'bnd'
+            | 'bob'
+            | 'bov'
+            | 'brl'
+            | 'bsd'
+            | 'btn'
+            | 'bwp'
+            | 'byn'
+            | 'byr'
+            | 'bzd'
+            | 'cad'
+            | 'cdf'
+            | 'che'
+            | 'chf'
+            | 'chw'
+            | 'clf'
+            | 'clp'
+            | 'cny'
+            | 'cop'
+            | 'cou'
+            | 'crc'
+            | 'cuc'
+            | 'cup'
+            | 'cve'
+            | 'czk'
+            | 'djf'
+            | 'dkk'
+            | 'dop'
+            | 'dzd'
+            | 'eek'
+            | 'egp'
+            | 'ern'
+            | 'etb'
+            | 'eur'
+            | 'fjd'
+            | 'fkp'
+            | 'gbp'
+            | 'gel'
+            | 'ghc'
+            | 'ghs'
+            | 'gip'
+            | 'gmd'
+            | 'gnf'
+            | 'gtq'
+            | 'gyd'
+            | 'hkd'
+            | 'hnl'
+            | 'hrk'
+            | 'htg'
+            | 'huf'
+            | 'idr'
+            | 'ils'
+            | 'inr'
+            | 'iqd'
+            | 'irr'
+            | 'isk'
+            | 'jmd'
+            | 'jod'
+            | 'jpy'
+            | 'kes'
+            | 'kgs'
+            | 'khr'
+            | 'kmf'
+            | 'kpw'
+            | 'krw'
+            | 'kwd'
+            | 'kyd'
+            | 'kzt'
+            | 'lak'
+            | 'lbp'
+            | 'lkr'
+            | 'lrd'
+            | 'lsl'
+            | 'ltl'
+            | 'lvl'
+            | 'lyd'
+            | 'mad'
+            | 'mdl'
+            | 'mga'
+            | 'mkd'
+            | 'mmk'
+            | 'mnt'
+            | 'mop'
+            | 'mro'
+            | 'mru'
+            | 'mur'
+            | 'mvr'
+            | 'mwk'
+            | 'mxn'
+            | 'mxv'
+            | 'myr'
+            | 'mzn'
+            | 'nad'
+            | 'ngn'
+            | 'nio'
+            | 'nok'
+            | 'npr'
+            | 'nzd'
+            | 'omr'
+            | 'pab'
+            | 'pen'
+            | 'pgk'
+            | 'php'
+            | 'pkr'
+            | 'pln'
+            | 'pyg'
+            | 'qar'
+            | 'ron'
+            | 'rsd'
+            | 'rub'
+            | 'rwf'
+            | 'sar'
+            | 'sbd'
+            | 'scr'
+            | 'sdg'
+            | 'sek'
+            | 'sgd'
+            | 'shp'
+            | 'sle'
+            | 'sll'
+            | 'sos'
+            | 'srd'
+            | 'ssp'
+            | 'std'
+            | 'stn'
+            | 'svc'
+            | 'syp'
+            | 'szl'
+            | 'thb'
+            | 'tjs'
+            | 'tmt'
+            | 'tnd'
+            | 'top'
+            | 'try'
+            | 'ttd'
+            | 'twd'
+            | 'tzs'
+            | 'uah'
+            | 'ugx'
+            | 'usd'
+            | 'usdb'
+            | 'usdc'
+            | 'usn'
+            | 'uyi'
+            | 'uyu'
+            | 'uzs'
+            | 'vef'
+            | 'ves'
+            | 'vnd'
+            | 'vuv'
+            | 'wst'
+            | 'xaf'
+            | 'xcd'
+            | 'xcg'
+            | 'xof'
+            | 'xpf'
+            | 'yer'
+            | 'zar'
+            | 'zmk'
+            | 'zmw'
+            | 'zwd'
+            | 'zwg'
+            | 'zwl';
+        }
+      }
+
+      namespace MoneyManagement {
+        interface FinancialAddressRetrieveParams {
+          /**
+           * Open Enum. A list of fields to reveal in the FinancialAddresses returned.
+           */
+          include?: Array<FinancialAddressRetrieveParams.Include>;
+        }
+
+        namespace FinancialAddressRetrieveParams {
+          type Include =
+            | 'credentials.gb_bank_account.account_number'
+            | 'credentials.us_bank_account.account_number';
+        }
+      }
+
+      namespace MoneyManagement {
+        interface FinancialAddressListParams {
+          /**
+           * The ID of the FinancialAccount for which FinancialAddresses are to be returned.
+           */
+          financial_account?: string;
+
+          /**
+           * Open Enum. A list of fields to reveal in the FinancialAddresses returned.
+           */
+          include?: Array<FinancialAddressListParams.Include>;
+
+          /**
+           * The page limit.
+           */
+          limit?: number;
+        }
+
+        namespace FinancialAddressListParams {
+          type Include =
+            | 'credentials.gb_bank_account.account_number'
+            | 'credentials.us_bank_account.account_number';
+        }
+      }
+
+      namespace MoneyManagement {
+        class FinancialAddressesResource {
+          /**
+           * Create a new FinancialAddress for a FinancialAccount.
+           * @throws Stripe.FinancialAccountNotOpenError
+           * @throws Stripe.FeatureNotEnabledError
+           */
+          create(
+            params: FinancialAddressCreateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAddress>
+          >;
+
+          /**
+           * Retrieve a FinancialAddress. By default, the FinancialAddress will be returned in its unexpanded state, revealing only the last 4 digits of the account number.
+           */
+          retrieve(
+            id: string,
+            params?: FinancialAddressRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAddress>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAddress>
+          >;
+
+          /**
+           * List all FinancialAddresses for a FinancialAccount.
+           */
+          list(
+            params?: FinancialAddressListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAddress>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAddress>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,206 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * An InboundTransfer object, representing a money movement from a
+         * user owned PaymentMethod to a FinancialAccount belonging to the same user.
+         */
+        interface InboundTransfer {
+          /**
+           * Unique identifier for the InboundTransfer.
+           */
+          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.inbound_transfer';
+
+          /**
+           * The amount in specified currency that will land in the FinancialAccount balance.
+           */
+          amount: Amount;
+
+          /**
+           * Creation time of the InboundTransfer. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          created: string;
+
+          /**
+           * A freeform text field provided by user, containing metadata.
+           */
+          description: string;
+
+          /**
+           * A nested object containing information about the origin of the InboundTransfer.
+           */
+          from: InboundTransfer.From;
+
+          /**
+           * 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 hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+           */
+          receipt_url: string | null;
+
+          /**
+           * A nested object containing information about the destination of the InboundTransfer.
+           */
+          to: InboundTransfer.To;
+
+          /**
+           * A list of history objects, representing changes in the state of the InboundTransfer.
+           */
+          transfer_history: Array<InboundTransfer.TransferHistory>;
+        }
+
+        namespace InboundTransfer {
+          interface From {
+            /**
+             * The amount in specified currency that was debited from the Payment Method.
+             */
+            debited: Amount;
+
+            /**
+             * The Payment Method object used to create the InboundTransfer.
+             */
+            payment_method: From.PaymentMethod;
+          }
+
+          namespace From {
+            interface PaymentMethod {
+              /**
+               * The type of object this destination represents. For a us bank account, we expect us_bank_account.
+               */
+              type: string;
+
+              /**
+               * The destination US bank account identifier. eg "usba_***".
+               */
+              us_bank_account: string | null;
+            }
+          }
+
+          interface To {
+            /**
+             * The amount by which the FinancialAccount balance is credited.
+             */
+            credited: Amount;
+
+            /**
+             * The FinancialAccount that funds will land in.
+             */
+            financial_account: string;
+          }
+
+          interface TransferHistory {
+            /**
+             * Creation time of the HistoryEntry in RFC 3339 format and UTC.
+             */
+            created: string;
+
+            /**
+             * Effective at time of the HistoryEntry in RFC 3339 format and UTC.
+             */
+            effective_at: string;
+
+            /**
+             * A unique ID for the HistoryEntry.
+             */
+            id: string;
+
+            /**
+             * Open Enum. The Level of the HistoryEntry.
+             */
+            level: TransferHistory.Level;
+
+            /**
+             * Open Enum. The type of the HistoryEntry.
+             */
+            type: TransferHistory.Type;
+
+            /**
+             * The history entry for a failed InboundTransfer.
+             */
+            bank_debit_failed: TransferHistory.BankDebitFailed | null;
+
+            /**
+             * The history entry for a processing InboundTransfer.
+             */
+            bank_debit_processing: TransferHistory.BankDebitProcessing | null;
+
+            /**
+             * The history entry for a queued InboundTransfer.
+             */
+            bank_debit_queued: TransferHistory.BankDebitQueued | null;
+
+            /**
+             * The history entry for a returned InboundTransfer.
+             */
+            bank_debit_returned: TransferHistory.BankDebitReturned | null;
+
+            /**
+             * The history entry for a succeeded InboundTransfer.
+             */
+            bank_debit_succeeded: TransferHistory.BankDebitSucceeded | null;
+          }
+
+          namespace TransferHistory {
+            interface BankDebitFailed {
+              /**
+               * Open Enum. The return reason for the failed InboundTransfer.
+               */
+              failure_reason: BankDebitFailed.FailureReason;
+            }
+
+            namespace BankDebitFailed {
+              type FailureReason =
+                | 'bank_account_closed'
+                | 'bank_account_not_found'
+                | 'bank_debit_could_not_be_processed'
+                | 'bank_debit_not_authorized'
+                | 'insufficient_funds';
+            }
+
+            interface BankDebitProcessing {}
+
+            interface BankDebitQueued {}
+
+            interface BankDebitReturned {
+              /**
+               * Open Enum. The return reason for the returned InboundTransfer.
+               */
+              return_reason: BankDebitReturned.ReturnReason;
+            }
+
+            namespace BankDebitReturned {
+              type ReturnReason =
+                | 'bank_account_closed'
+                | 'bank_account_not_found'
+                | 'bank_debit_could_not_be_processed'
+                | 'bank_debit_not_authorized'
+                | 'insufficient_funds';
+            }
+
+            interface BankDebitSucceeded {}
+
+            type Level = 'canonical' | 'debug';
+
+            type Type =
+              | 'bank_debit_failed'
+              | 'bank_debit_processing'
+              | 'bank_debit_queued'
+              | 'bank_debit_returned'
+              | 'bank_debit_succeeded';
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,144 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface InboundTransferCreateParams {
+          /**
+           * The amount, in specified currency, by which the FinancialAccount balance will increase due to the InboundTransfer.
+           */
+          amount: Amount;
+
+          /**
+           * Object containing details about where the funds will originate from.
+           */
+          from: InboundTransferCreateParams.From;
+
+          /**
+           * Object containing details about where the funds will land.
+           */
+          to: InboundTransferCreateParams.To;
+
+          /**
+           * An optional, freeform description field intended to store metadata.
+           */
+          description?: string;
+        }
+
+        namespace InboundTransferCreateParams {
+          interface From {
+            /**
+             * An optional currency field used to specify which currency is debited from the Payment Method.
+             * Since many Payment Methods support only one currency, this field is optional.
+             */
+            currency?: string;
+
+            /**
+             * ID of the Payment Method using which IBT will be made.
+             */
+            payment_method: string;
+          }
+
+          interface To {
+            /**
+             * The currency in which funds will land in.
+             */
+            currency: string;
+
+            /**
+             * The FinancialAccount that funds will land in.
+             */
+            financial_account: string;
+          }
+        }
+      }
+
+      namespace MoneyManagement {
+        interface InboundTransferRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface InboundTransferListParams {
+          /**
+           * 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 InboundTransfersResource {
+          /**
+           * InboundTransfers APIs are used to create, retrieve or list InboundTransfers.
+           * @throws Stripe.BlockedByStripeError
+           */
+          create(
+            params: InboundTransferCreateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.InboundTransfer>
+          >;
+
+          /**
+           * Retrieve an InboundTransfer by ID.
+           */
+          retrieve(
+            id: string,
+            params?: InboundTransferRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.InboundTransfer>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.InboundTransfer>
+          >;
+
+          /**
+           * Retrieves a list of InboundTransfers.
+           */
+          list(
+            params?: InboundTransferListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.InboundTransfer>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.InboundTransfer>;
+        }
+      }
+    }
+  }
+}