stripe 18.2.0 → 18.3.0-beta.1

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

@@ -0,0 +1,207 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface OutboundTransferCreateParams {
+          /**
+           * The "presentment amount" for the OutboundPayment.
+           */
+          amount: Amount;
+
+          /**
+           * The FinancialAccount to pull funds from.
+           */
+          from: OutboundTransferCreateParams.From;
+
+          /**
+           * To which payout method to send the OutboundTransfer.
+           */
+          to: OutboundTransferCreateParams.To;
+
+          /**
+           * Delivery options to be used to send the OutboundTransfer.
+           */
+          delivery_options?: OutboundTransferCreateParams.DeliveryOptions;
+
+          /**
+           * An arbitrary string attached to the OutboundTransfer. Often useful for displaying to users.
+           */
+          description?: string;
+
+          /**
+           * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+           */
+          metadata?: Stripe.MetadataParam;
+        }
+
+        namespace OutboundTransferCreateParams {
+          interface DeliveryOptions {
+            /**
+             * Open Enum. Method for bank account.
+             */
+            bank_account?: DeliveryOptions.BankAccount;
+          }
+
+          namespace DeliveryOptions {
+            type BankAccount = 'automatic' | 'local' | 'wire';
+          }
+
+          interface From {
+            /**
+             * Describes the FinancialAmount's currency drawn from.
+             */
+            currency: string;
+
+            /**
+             * The FinancialAccount that funds were pulled from.
+             */
+            financial_account: string;
+          }
+
+          interface To {
+            /**
+             * Describes the currency to send to the recipient.
+             * If included, this currency must match a currency supported by the destination.
+             * Can be omitted in the following cases:
+             * - destination only supports one currency
+             * - destination supports multiple currencies and one of the currencies matches the FA currency
+             * - destination supports multiple currencies and one of the currencies matches the presentment currency
+             * Note - when both FA currency and presentment currency are supported, we pick the FA currency to minimize FX.
+             */
+            currency?: string;
+
+            /**
+             * The payout method which the OutboundTransfer uses to send payout.
+             */
+            payout_method: string;
+          }
+        }
+      }
+
+      namespace MoneyManagement {
+        interface OutboundTransferRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface OutboundTransferListParams {
+          /**
+           * 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 maximum number of results to return.
+           */
+          limit?: number;
+
+          /**
+           * Closed Enum. Only return OutboundTransfers with this status.
+           */
+          status?: Array<OutboundTransferListParams.Status>;
+        }
+
+        namespace OutboundTransferListParams {
+          type Status =
+            | 'canceled'
+            | 'failed'
+            | 'posted'
+            | 'processing'
+            | 'returned';
+        }
+      }
+
+      namespace MoneyManagement {
+        interface OutboundTransferCancelParams {}
+      }
+
+      namespace MoneyManagement {
+        class OutboundTransfersResource {
+          /**
+           * Creates an OutboundTransfer.
+           * @throws Stripe.InsufficientFundsError
+           */
+          create(
+            params: OutboundTransferCreateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundTransfer>
+          >;
+
+          /**
+           * Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundPayment create or list response.
+           */
+          retrieve(
+            id: string,
+            params?: OutboundTransferRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundTransfer>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundTransfer>
+          >;
+
+          /**
+           * Returns a list of OutboundTransfers that match the provided filters.
+           */
+          list(
+            params?: OutboundTransferListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.OutboundTransfer>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.OutboundTransfer>;
+
+          /**
+           * Cancels an OutboundTransfer. Only processing OutboundTransfers can be canceled.
+           * @throws Stripe.AlreadyCanceledError
+           * @throws Stripe.NotCancelableError
+           */
+          cancel(
+            id: string,
+            params?: OutboundTransferCancelParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundTransfer>
+          >;
+          cancel(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundTransfer>
+          >;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,151 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * Use the PayoutMethods API to list and interact with PayoutMethod objects.
+         */
+        interface PayoutMethod {
+          /**
+           * ID of the PayoutMethod 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.payout_method';
+
+          /**
+           * A set of available payout speeds for this payout method.
+           */
+          available_payout_speeds: Array<PayoutMethod.AvailablePayoutSpeed>;
+
+          /**
+           * The PayoutMethodBankAccount object details.
+           */
+          bank_account: PayoutMethod.BankAccount | null;
+
+          /**
+           * The PayoutMethodCard object details.
+           */
+          card: PayoutMethod.Card | null;
+
+          /**
+           * Created timestamp.
+           */
+          created: string;
+
+          /**
+           * ID of the underlying active OutboundSetupIntent object, if any.
+           */
+          latest_outbound_setup_intent: string | null;
+
+          /**
+           * 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 type of payout method.
+           */
+          type: PayoutMethod.Type;
+
+          /**
+           * Indicates whether the payout method has met the necessary requirements for outbound money movement.
+           */
+          usage_status: PayoutMethod.UsageStatus;
+        }
+
+        namespace PayoutMethod {
+          type AvailablePayoutSpeed = 'instant' | 'standard';
+
+          interface BankAccount {
+            /**
+             * Whether this PayoutMethodBankAccount object was archived. PayoutMethodBankAccount objects can be archived through
+             * the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodBankAccount objects
+             * cannot be used as payout methods and will not appear in the payout method list.
+             */
+            archived: boolean;
+
+            /**
+             * The name of the bank this bank account is in. This field is populated automatically by Stripe.
+             */
+            bank_name: string;
+
+            /**
+             * The country code of the bank account.
+             */
+            country: string;
+
+            /**
+             * List of enabled flows for this bank account (wire or local).
+             */
+            enabled_delivery_options: Array<string>;
+
+            /**
+             * The last 4 digits of the account number.
+             */
+            last4: string;
+
+            /**
+             * The routing number of the bank account, if present.
+             */
+            routing_number: string | null;
+
+            /**
+             * The list of currencies supported by this bank account.
+             */
+            supported_currencies: Array<string>;
+          }
+
+          interface Card {
+            /**
+             * Whether the PayoutMethodCard object was archived. PayoutMethodCard objects can be archived through
+             * the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodCard objects
+             * cannot be used as payout methods and will not appear in the payout method list.
+             */
+            archived: boolean;
+
+            /**
+             * The month the card expires.
+             */
+            exp_month: string;
+
+            /**
+             * The year the card expires.
+             */
+            exp_year: string;
+
+            /**
+             * The last 4 digits of the card number.
+             */
+            last4: string;
+          }
+
+          type Type = 'bank_account' | 'card';
+
+          interface UsageStatus {
+            /**
+             * Payments status - used when sending OutboundPayments (sending funds to recipients).
+             */
+            payments: UsageStatus.Payments;
+
+            /**
+             * Transfers status - used when making an OutboundTransfer (sending funds to yourself).
+             */
+            transfers: UsageStatus.Transfers;
+          }
+
+          namespace UsageStatus {
+            type Payments = 'eligible' | 'invalid' | 'requires_action';
+
+            type Transfers = 'eligible' | 'invalid' | 'requires_action';
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,41 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface PayoutMethodsBankAccountSpecRetrieveParams {
+          /**
+           * The countries to fetch the bank account spec for.
+           */
+          countries?: Array<string>;
+        }
+      }
+
+      namespace MoneyManagement {
+        class PayoutMethodsBankAccountSpecResource {
+          /**
+           * Fetch the specifications for a set of countries to know which
+           * credential fields are required, the validations for each fields, and how to translate these
+           * country-specific fields to the generic fields in the PayoutMethodBankAccount type.
+           */
+          retrieve(
+            params?: PayoutMethodsBankAccountSpecRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<
+              Stripe.V2.MoneyManagement.PayoutMethodsBankAccountSpec
+            >
+          >;
+          retrieve(
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<
+              Stripe.V2.MoneyManagement.PayoutMethodsBankAccountSpec
+            >
+          >;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,87 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * The PayoutMethodsBankAccountSpec object.
+         */
+        interface PayoutMethodsBankAccountSpec {
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.money_management.payout_methods_bank_account_spec';
+
+          /**
+           * The list of specs by country.
+           */
+          countries: {
+            [key: string]: PayoutMethodsBankAccountSpec.Countries;
+          };
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+        }
+
+        namespace PayoutMethodsBankAccountSpec {
+          interface Countries {
+            /**
+             * The list of fields for a country, along with associated information.
+             */
+            fields: Array<Countries.Field>;
+          }
+
+          namespace Countries {
+            interface Field {
+              /**
+               * The local name of the field.
+               */
+              local_name: string;
+
+              /**
+               * The human readable local name of the field.
+               */
+              local_name_human: Field.LocalNameHuman;
+
+              /**
+               * The maximum length of the field.
+               */
+              max_length: number;
+
+              /**
+               * THe minimum length of the field.
+               */
+              min_length: number;
+
+              /**
+               * The placeholder value of the field.
+               */
+              placeholder: string;
+
+              /**
+               * The stripe name of the field.
+               */
+              stripe_name: string;
+
+              /**
+               * The validation regex of the field.
+               */
+              validation_regex: string;
+            }
+
+            namespace Field {
+              interface LocalNameHuman {
+                content: string;
+
+                localization_key: string;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,113 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface PayoutMethodRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface PayoutMethodListParams {
+          /**
+           * The page size.
+           */
+          limit?: number;
+
+          /**
+           * Usage status filter.
+           */
+          usage_status?: PayoutMethodListParams.UsageStatus;
+        }
+
+        namespace PayoutMethodListParams {
+          interface UsageStatus {
+            /**
+             * List of payments status to filter by.
+             */
+            payments?: Array<UsageStatus.Payment>;
+
+            /**
+             * List of transfers status to filter by.
+             */
+            transfers?: Array<UsageStatus.Transfer>;
+          }
+
+          namespace UsageStatus {
+            type Payment = 'eligible' | 'invalid' | 'requires_action';
+
+            type Transfer = 'eligible' | 'invalid' | 'requires_action';
+          }
+        }
+      }
+
+      namespace MoneyManagement {
+        interface PayoutMethodArchiveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface PayoutMethodUnarchiveParams {}
+      }
+
+      namespace MoneyManagement {
+        class PayoutMethodsResource {
+          /**
+           * Retrieve a PayoutMethod object.
+           * @throws Stripe.InvalidPayoutMethodError
+           */
+          retrieve(
+            id: string,
+            params?: PayoutMethodRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+
+          /**
+           * List objects that adhere to the PayoutMethod interface.
+           */
+          list(
+            params?: PayoutMethodListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.PayoutMethod>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.PayoutMethod>;
+
+          /**
+           * Archive a PayoutMethod object. Archived objects cannot be used as payout methods
+           * and will not appear in the payout method list.
+           * @throws Stripe.ControlledByDashboardError
+           * @throws Stripe.InvalidPayoutMethodError
+           */
+          archive(
+            id: string,
+            params?: PayoutMethodArchiveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+          archive(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+
+          /**
+           * Unarchive an PayoutMethod object.
+           * @throws Stripe.ControlledByDashboardError
+           * @throws Stripe.InvalidPayoutMethodError
+           */
+          unarchive(
+            id: string,
+            params?: PayoutMethodUnarchiveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+          unarchive(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+        }
+      }
+    }
+  }
+}