stripe 22.1.0 → 22.2.0-alpha.2

package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts

@@ -0,0 +1,320 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { PayoutMethod } from './PayoutMethods.js';
+import { RequestOptions, ApiListPromise, Response } from '../../../lib.js';
+export declare class OutboundSetupIntentResource extends StripeResource {
+    /**
+     * List the OutboundSetupIntent objects.
+     */
+    list(params?: V2.MoneyManagement.OutboundSetupIntentListParams, options?: RequestOptions): ApiListPromise<OutboundSetupIntent>;
+    /**
+     * Create an OutboundSetupIntent object.
+     * @throws Stripe.BlockedByStripeError
+     * @throws Stripe.InvalidPayoutMethodError
+     * @throws Stripe.QuotaExceededError
+     * @throws Stripe.ControlledByAlternateResourceError
+     */
+    create(params?: V2.MoneyManagement.OutboundSetupIntentCreateParams, options?: RequestOptions): Promise<Response<OutboundSetupIntent>>;
+    /**
+     * Retrieve an OutboundSetupIntent object.
+     */
+    retrieve(id: string, params?: V2.MoneyManagement.OutboundSetupIntentRetrieveParams, options?: RequestOptions): Promise<Response<OutboundSetupIntent>>;
+    /**
+     * Update an OutboundSetupIntent object.
+     * @throws Stripe.QuotaExceededError
+     * @throws Stripe.BlockedByStripeError
+     * @throws Stripe.InvalidPayoutMethodError
+     * @throws Stripe.ControlledByAlternateResourceError
+     */
+    update(id: string, params?: V2.MoneyManagement.OutboundSetupIntentUpdateParams, options?: RequestOptions): Promise<Response<OutboundSetupIntent>>;
+    /**
+     * Cancel an OutboundSetupIntent object.
+     */
+    cancel(id: string, params?: V2.MoneyManagement.OutboundSetupIntentCancelParams, options?: RequestOptions): Promise<Response<OutboundSetupIntent>>;
+}
+export interface OutboundSetupIntent {
+    /**
+     * ID of the outbound setup intent.
+     */
+    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.outbound_setup_intent';
+    /**
+     * Created timestamp.
+     */
+    created: 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;
+    /**
+     * Specifies which actions needs to be taken next to continue setup of the credential.
+     */
+    next_action?: V2.MoneyManagement.OutboundSetupIntent.NextAction;
+    /**
+     * Use the PayoutMethods API to list and interact with PayoutMethod objects.
+     */
+    payout_method: PayoutMethod;
+    /**
+     * Closed Enum. Status of the outbound setup intent.
+     */
+    status: V2.MoneyManagement.OutboundSetupIntent.Status;
+    /**
+     * The intended money movement flow this payout method should be set up for, specified in params.
+     */
+    usage_intent: V2.MoneyManagement.OutboundSetupIntent.UsageIntent;
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        namespace OutboundSetupIntent {
+            interface NextAction {
+                /**
+                 * Confirmation of Payee details.
+                 */
+                confirmation_of_payee?: NextAction.ConfirmationOfPayee;
+                /**
+                 * The type of next action.
+                 */
+                type: 'confirmation_of_payee';
+            }
+            type Status = 'canceled' | 'requires_action' | 'requires_payout_method' | 'succeeded';
+            type UsageIntent = 'payment' | 'transfer';
+            namespace NextAction {
+                interface ConfirmationOfPayee {
+                    /**
+                     * The type of the credential.
+                     */
+                    object: string;
+                    /**
+                     * The Confirmation of Payee status.
+                     */
+                    status: ConfirmationOfPayee.Status;
+                }
+                namespace ConfirmationOfPayee {
+                    type Status = 'awaiting_acknowledgement' | 'confirmed' | 'uninitiated';
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface OutboundSetupIntentCreateParams {
+            /**
+             * If provided, the existing payout method resource to link to this setup intent.
+             * Any payout_method_data provided is used to update information on this linked payout method resource.
+             */
+            payout_method?: string;
+            /**
+             * If no payout_method provided, used to create the underlying credential that is set up for outbound money movement.
+             * If a payout_method provided, used to update data on the credential linked to this setup intent.
+             */
+            payout_method_data?: OutboundSetupIntentCreateParams.PayoutMethodData;
+            /**
+             * Specify which type of outbound money movement this credential should be set up for (payment | transfer).
+             * If not provided, defaults to payment.
+             */
+            usage_intent?: OutboundSetupIntentCreateParams.UsageIntent;
+        }
+        namespace OutboundSetupIntentCreateParams {
+            interface PayoutMethodData {
+                /**
+                 * The type specific details of the bank account payout method.
+                 */
+                bank_account?: PayoutMethodData.BankAccount;
+                /**
+                 * The type specific details of the card payout method.
+                 */
+                card?: PayoutMethodData.Card;
+                /**
+                 * The type specific details of the crypto wallet payout method.
+                 */
+                crypto_wallet?: PayoutMethodData.CryptoWallet;
+                /**
+                 * Closed Enum. The type of payout method to be created.
+                 */
+                type: PayoutMethodData.Type;
+            }
+            type UsageIntent = 'payment' | 'transfer';
+            namespace PayoutMethodData {
+                interface BankAccount {
+                    /**
+                     * The account number or IBAN of the bank account.
+                     */
+                    account_number: string;
+                    /**
+                     * Closed Enum. The type of the bank account (checking or savings).
+                     */
+                    bank_account_type?: BankAccount.BankAccountType;
+                    /**
+                     * The branch number of the bank account, if present.
+                     */
+                    branch_number?: string;
+                    /**
+                     * The country code of the bank account.
+                     */
+                    country: string;
+                    /**
+                     * The currency of the bank account.
+                     */
+                    currency: string;
+                    /**
+                     * The routing number of the bank account, if present.
+                     */
+                    routing_number?: string;
+                    /**
+                     * The swift code of the bank account, if present.
+                     */
+                    swift_code?: string;
+                }
+                interface Card {
+                    /**
+                     * The currency of the card.
+                     */
+                    currency: string;
+                    /**
+                     * The expiration month of the card.
+                     */
+                    exp_month: string;
+                    /**
+                     * The expiration year of the card.
+                     */
+                    exp_year: string;
+                    /**
+                     * The card number.
+                     */
+                    number: string;
+                }
+                interface CryptoWallet {
+                    /**
+                     * Crypto wallet address.
+                     */
+                    address: string;
+                    /**
+                     * Optional field, required if network supports memos (only "stellar" currently).
+                     */
+                    memo?: string;
+                    /**
+                     * Which rail we should use to make an Outbound money movement to this wallet.
+                     */
+                    network: CryptoWallet.Network;
+                }
+                type Type = 'bank_account' | 'card' | 'crypto_wallet';
+                namespace BankAccount {
+                    type BankAccountType = 'checking' | 'futsu' | 'savings' | 'toza';
+                }
+                namespace CryptoWallet {
+                    type Network = 'arbitrum' | 'avalanche_c_chain' | 'base' | 'ethereum' | 'optimism' | 'polygon' | 'solana' | 'stellar' | 'tempo';
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface OutboundSetupIntentRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface OutboundSetupIntentUpdateParams {
+            /**
+             * If provided, the existing payout method resource to link to this outbound setup intent.
+             */
+            payout_method?: string;
+            /**
+             * If no payout_method provided, used to create the underlying credential that is set up for outbound money movement.
+             * If a payout_method provided, used to update data on the credential linked to this setup intent.
+             */
+            payout_method_data?: OutboundSetupIntentUpdateParams.PayoutMethodData;
+        }
+        namespace OutboundSetupIntentUpdateParams {
+            interface PayoutMethodData {
+                /**
+                 * The type specific details of the bank account payout method.
+                 */
+                bank_account?: PayoutMethodData.BankAccount;
+                /**
+                 * The type specific details of the card payout method.
+                 */
+                card?: PayoutMethodData.Card;
+                /**
+                 * Closed Enum. The type of payout method to be created/updated.
+                 */
+                type: PayoutMethodData.Type;
+            }
+            namespace PayoutMethodData {
+                interface BankAccount {
+                    /**
+                     * The account number or IBAN of the bank account.
+                     */
+                    account_number: string;
+                    /**
+                     * Closed Enum. The type of the bank account (checking or savings).
+                     */
+                    bank_account_type?: BankAccount.BankAccountType;
+                    /**
+                     * The branch number of the bank account, if present.
+                     */
+                    branch_number?: string;
+                    /**
+                     * The country code of the bank account.
+                     */
+                    country: string;
+                    /**
+                     * The currency of the bank account.
+                     */
+                    currency: string;
+                    /**
+                     * The routing number of the bank account, if present.
+                     */
+                    routing_number?: string;
+                    /**
+                     * The swift code of the bank account, if present.
+                     */
+                    swift_code?: string;
+                }
+                interface Card {
+                    /**
+                     * The currency of the card.
+                     */
+                    currency?: string;
+                    /**
+                     * The expiration month of the card.
+                     */
+                    exp_month?: string;
+                    /**
+                     * The expiration year of the card.
+                     */
+                    exp_year?: string;
+                    /**
+                     * The card number. This can only be passed when creating a new credential on an outbound setup intent in the requires_payout_method state.
+                     */
+                    number?: string;
+                }
+                type Type = 'bank_account' | 'card' | 'crypto_wallet';
+                namespace BankAccount {
+                    type BankAccountType = 'checking' | 'futsu' | 'savings' | 'toza';
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface OutboundSetupIntentListParams {
+            /**
+             * The page size.
+             */
+            limit?: number;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface OutboundSetupIntentCancelParams {
+        }
+    }
+}

package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js

@@ -0,0 +1,49 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutboundSetupIntentResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class OutboundSetupIntentResource extends StripeResource_js_1.StripeResource {
+    /**
+     * List the OutboundSetupIntent objects.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/money_management/outbound_setup_intents', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Create an OutboundSetupIntent object.
+     * @throws Stripe.BlockedByStripeError
+     * @throws Stripe.InvalidPayoutMethodError
+     * @throws Stripe.QuotaExceededError
+     * @throws Stripe.ControlledByAlternateResourceError
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/money_management/outbound_setup_intents', params, options);
+    }
+    /**
+     * Retrieve an OutboundSetupIntent object.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/money_management/outbound_setup_intents/${id}`, params, options);
+    }
+    /**
+     * Update an OutboundSetupIntent object.
+     * @throws Stripe.QuotaExceededError
+     * @throws Stripe.BlockedByStripeError
+     * @throws Stripe.InvalidPayoutMethodError
+     * @throws Stripe.ControlledByAlternateResourceError
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v2/money_management/outbound_setup_intents/${id}`, params, options);
+    }
+    /**
+     * Cancel an OutboundSetupIntent object.
+     */
+    cancel(id, params, options) {
+        return this._makeRequest('POST', `/v2/money_management/outbound_setup_intents/${id}/cancel`, params, options);
+    }
+}
+exports.OutboundSetupIntentResource = OutboundSetupIntentResource;
+//# sourceMappingURL=OutboundSetupIntents.js.map

package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutboundSetupIntents.js","sourceRoot":"","sources":["../../../../src/resources/V2/MoneyManagement/OutboundSetupIntents.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAI1D,MAAa,2BAA4B,SAAQ,kCAAc;IAC7D;;OAEG;IACH,IAAI,CACF,MAAyD,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,6CAA6C,EAC7C,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,MAAM,CACJ,MAA2D,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,6CAA6C,EAC7C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA6D,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,+CAA+C,EAAE,EAAE,EACnD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,MAAM,CACJ,EAAU,EACV,MAA2D,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,+CAA+C,EAAE,EAAE,EACnD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAA2D,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,+CAA+C,EAAE,SAAS,EAC1D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AArFD,kEAqFC"}