stripe 22.2.0 → 22.3.0-alpha.2

package/cjs/resources/V2/Core/FeeBatches.d.ts

@@ -0,0 +1,172 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { V2Amount } from './../V2Amounts.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
+export declare class FeeBatchResource extends StripeResource {
+    /**
+     * List FeeBatches optionally filtered by collection_record.
+     */
+    list(params?: V2.Core.FeeBatchListParams, options?: RequestOptions): V2ListPromise<FeeBatch>;
+    /**
+     * Retrieve a FeeBatch by id.
+     */
+    retrieve(id: string, params?: V2.Core.FeeBatchRetrieveParams, options?: RequestOptions): Promise<Response<FeeBatch>>;
+}
+export interface FeeBatch {
+    /**
+     * Unique identifier for the FeeBatch.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.core.fee_batch';
+    /**
+     * Adjustments applied to this batch.
+     */
+    adjustments?: V2.Core.FeeBatch.Adjustments;
+    /**
+     * The total fee amount billed in this batch.
+     */
+    amount: V2Amount;
+    /**
+     * The entity that collected this batch.
+     */
+    collected_by: V2.Core.FeeBatch.CollectedBy;
+    /**
+     * The money movement records associated with collecting this batch.
+     */
+    collection_records: Array<V2.Core.FeeBatch.CollectionRecord>;
+    /**
+     * Timestamp of when this batch was created.
+     */
+    created: string;
+    /**
+     * Has the value `true` if the object exists in live mode, or `false` if in test mode.
+     */
+    livemode: boolean;
+    /**
+     * The current state of this batch.
+     */
+    status: V2.Core.FeeBatch.Status;
+    /**
+     * Timestamps for each status transition.
+     */
+    status_transitions: V2.Core.FeeBatch.StatusTransitions;
+    /**
+     * The tax amount included in this batch.
+     */
+    tax?: V2.Core.FeeBatch.Tax;
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace FeeBatch {
+            interface Adjustments {
+                /**
+                 * The amount of tax adjusted for this batch.
+                 */
+                tax_adjustment?: V2Amount;
+            }
+            interface CollectedBy {
+                /**
+                 * The type of entity that collected this batch.
+                 */
+                type: CollectedBy.Type;
+            }
+            interface CollectionRecord {
+                /**
+                 * The fee amount collected via this record.
+                 */
+                amount: V2Amount;
+                /**
+                 * The ID of the associated v1 balance transaction.
+                 */
+                balance_transaction?: string;
+                /**
+                 * The ID of the associated credit transaction.
+                 */
+                credit_transaction?: string;
+                /**
+                 * The ID of the associated v2 money management transaction.
+                 */
+                money_management_transaction?: string;
+                /**
+                 * The ID of the associated accounts-receivable invoice.
+                 */
+                payable_invoice?: string;
+                /**
+                 * The tax amount collected via this record.
+                 */
+                tax?: CollectionRecord.Tax;
+                /**
+                 * The type of money movement object.
+                 */
+                type: CollectionRecord.Type;
+            }
+            type Status = 'billed' | 'pending';
+            interface StatusTransitions {
+                /**
+                 * Timestamp of when the batch transitioned to BILLED, if applicable.
+                 */
+                billed_at?: string;
+            }
+            interface Tax {
+                /**
+                 * The tax amount included in this batch.
+                 */
+                amount: V2Amount;
+            }
+            namespace CollectedBy {
+                type Type = 'application' | 'network' | 'stripe';
+            }
+            namespace CollectionRecord {
+                interface Tax {
+                    /**
+                     * The tax amount collected via this record.
+                     */
+                    amount: V2Amount;
+                }
+                type Type = 'balance_transaction' | 'credit_transaction' | 'money_management_transaction' | 'payable_invoice';
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        interface FeeBatchRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        interface FeeBatchListParams {
+            /**
+             * Filter to return only FeeBatches associated with this collection record ID.
+             */
+            collection_record?: string;
+            /**
+             * Filter for FeeBatches created at the exact specified timestamp.
+             */
+            created?: string;
+            /**
+             * Filter for FeeBatches created after the specified timestamp (exclusive).
+             */
+            created_gt?: string;
+            /**
+             * Filter for FeeBatches created at or after the specified timestamp (inclusive).
+             */
+            created_gte?: string;
+            /**
+             * Filter for FeeBatches created before the specified timestamp (exclusive).
+             */
+            created_lt?: string;
+            /**
+             * Filter for FeeBatches created at or before the specified timestamp (inclusive).
+             */
+            created_lte?: string;
+            /**
+             * Maximum number of results to return per page. Defaults to 20.
+             */
+            limit?: number;
+        }
+    }
+}

package/cjs/resources/V2/Core/FeeBatches.js

@@ -0,0 +1,23 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeeBatchResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class FeeBatchResource extends StripeResource_js_1.StripeResource {
+    /**
+     * List FeeBatches optionally filtered by collection_record.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/core/fee_batches', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Retrieve a FeeBatch by id.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/core/fee_batches/${id}`, params, options);
+    }
+}
+exports.FeeBatchResource = FeeBatchResource;
+//# sourceMappingURL=FeeBatches.js.map

package/cjs/resources/V2/Core/FeeBatches.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FeeBatches.js","sourceRoot":"","sources":["../../../../src/resources/V2/Core/FeeBatches.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAI1D,MAAa,gBAAiB,SAAQ,kCAAc;IAClD;;OAEG;IACH,IAAI,CACF,MAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,sBAAsB,EAAE,MAAM,EAAE,OAAO,EAAE;YACvE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,wBAAwB,EAAE,EAAE,EAC5B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AA3BD,4CA2BC"}

package/cjs/resources/V2/Core/FeeEntries.d.ts

@@ -0,0 +1,178 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { V2Amount } from './../V2Amounts.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
+export declare class FeeEntryResource extends StripeResource {
+    /**
+     * List FeeEntries optionally filtered by incurred_by, fee_batch, or collection_record (at most one filter at a time).
+     */
+    list(params?: V2.Core.FeeEntryListParams, options?: RequestOptions): V2ListPromise<FeeEntry>;
+    /**
+     * Retrieve a FeeEntry by id.
+     */
+    retrieve(id: string, params?: V2.Core.FeeEntryRetrieveParams, options?: RequestOptions): Promise<Response<FeeEntry>>;
+}
+export interface FeeEntry {
+    /**
+     * Unique identifier for the FeeEntry.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.core.fee_entry';
+    /**
+     * The fee amount.
+     */
+    amount: V2Amount;
+    /**
+     * The entity that assessed this fee.
+     */
+    charged_by: V2.Core.FeeEntry.ChargedBy;
+    /**
+     * Timestamp of when this fee entry was created.
+     */
+    created: string;
+    /**
+     * The ID of the FeeBatch that collected this fee, if any.
+     */
+    fee_batch?: string;
+    /**
+     * The usage event that caused this fee to be assessed.
+     */
+    incurred_by: V2.Core.FeeEntry.IncurredBy;
+    /**
+     * Has the value `true` if the object exists in live mode, or `false` if in test mode.
+     */
+    livemode: boolean;
+    /**
+     * The reason this fee entry was created.
+     */
+    reason: V2.Core.FeeEntry.Reason;
+    /**
+     * The tax portion of the fee, if applicable.
+     */
+    tax?: V2.Core.FeeEntry.Tax;
+    /**
+     * The category of this fee.
+     */
+    type: V2.Core.FeeEntry.Type;
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace FeeEntry {
+            interface ChargedBy {
+                /**
+                 * Details for a fee charged by a Connect application.
+                 */
+                application?: ChargedBy.Application;
+                /**
+                 * Details for a fee charged by the payment network.
+                 */
+                network?: ChargedBy.Network;
+                /**
+                 * Details for a fee charged by Stripe.
+                 */
+                stripe?: ChargedBy.Stripe;
+                /**
+                 * The type of entity that charged this fee.
+                 */
+                type: ChargedBy.Type;
+            }
+            interface IncurredBy {
+                /**
+                 * The account that incurred the usage (may differ from the billing account).
+                 */
+                account?: string;
+                /**
+                 * Public API object id, e.g. ch_xxx.
+                 */
+                id: string;
+                /**
+                 * Timestamp of when the usage event occurred.
+                 */
+                occurred_at?: string;
+                /**
+                 * Public API object type: "charge", "payment", "refund", "dispute", "payout", etc.
+                 */
+                type: string;
+            }
+            type Reason = 'other' | 'processing_fee' | 'refund' | 'refund_failure' | 'reprice' | 'tier_true_up';
+            interface Tax {
+                /**
+                 * The tax amount calculated for this fee.
+                 */
+                amount: V2Amount;
+            }
+            type Type = 'application_fee' | 'passthrough_fee' | 'stripe_fee';
+            namespace ChargedBy {
+                interface Application {
+                    /**
+                     * Human-readable product name, e.g. "Card payments - Stripe fee".
+                     */
+                    feature_name?: string;
+                }
+                interface Network {
+                    /**
+                     * Human-readable product name, e.g. "Card payments - Stripe fee".
+                     */
+                    feature_name?: string;
+                }
+                interface Stripe {
+                    /**
+                     * Human-readable product name, e.g. "Card payments - Stripe fee".
+                     */
+                    feature_name?: string;
+                }
+                type Type = 'application' | 'network' | 'stripe';
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        interface FeeEntryRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        interface FeeEntryListParams {
+            /**
+             * Filter by money movement id (e.g. txn_xxx, bt_xxx).
+             */
+            collection_record?: string;
+            /**
+             * Filter for FeeEntries created at the exact specified timestamp.
+             */
+            created?: string;
+            /**
+             * Filter for FeeEntries created after the specified timestamp (exclusive).
+             */
+            created_gt?: string;
+            /**
+             * Filter for FeeEntries created at or after the specified timestamp (inclusive).
+             */
+            created_gte?: string;
+            /**
+             * Filter for FeeEntries created before the specified timestamp (exclusive).
+             */
+            created_lt?: string;
+            /**
+             * Filter for FeeEntries created at or before the specified timestamp (inclusive).
+             */
+            created_lte?: string;
+            /**
+             * Filter by fee batch id (fb_xxx).
+             */
+            fee_batch?: string;
+            /**
+             * Filter by usage object id (e.g. ch_xxx, py_xxx).
+             */
+            incurred_by?: string;
+            /**
+             * Maximum number of results to return per page. Defaults to 20.
+             */
+            limit?: number;
+        }
+    }
+}

package/cjs/resources/V2/Core/FeeEntries.js

@@ -0,0 +1,23 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeeEntryResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class FeeEntryResource extends StripeResource_js_1.StripeResource {
+    /**
+     * List FeeEntries optionally filtered by incurred_by, fee_batch, or collection_record (at most one filter at a time).
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/core/fee_entries', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Retrieve a FeeEntry by id.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/core/fee_entries/${id}`, params, options);
+    }
+}
+exports.FeeEntryResource = FeeEntryResource;
+//# sourceMappingURL=FeeEntries.js.map

package/cjs/resources/V2/Core/FeeEntries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FeeEntries.js","sourceRoot":"","sources":["../../../../src/resources/V2/Core/FeeEntries.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAI1D,MAAa,gBAAiB,SAAQ,kCAAc;IAClD;;OAEG;IACH,IAAI,CACF,MAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,sBAAsB,EAAE,MAAM,EAAE,OAAO,EAAE;YACvE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,wBAAwB,EAAE,EAAE,EAC5B,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AA3BD,4CA2BC"}

package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts

@@ -0,0 +1,285 @@
+import { StripeResource } from '../../../../StripeResource.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../../lib.js';
+export declare class GbBankAccountResource extends StripeResource {
+    /**
+     * List objects that can be used as destinations for outbound money movement via OutboundPayment.
+     */
+    list(params?: V2.Core.Vault.GbBankAccountListParams, options?: RequestOptions): V2ListPromise<GbBankAccount>;
+    /**
+     * Create a GB bank account.
+     */
+    create(params: V2.Core.Vault.GbBankAccountCreateParams, options?: RequestOptions): Promise<Response<GbBankAccount>>;
+    /**
+     * Retrieve a GB bank account.
+     */
+    retrieve(id: string, params?: V2.Core.Vault.GbBankAccountRetrieveParams, options?: RequestOptions): Promise<Response<GbBankAccount>>;
+    /**
+     * Confirm that you have received the result of the Confirmation of Payee request, and that you are okay with
+     * proceeding to pay out to this bank account despite the account not matching, partially matching, or the service
+     * being unavailable. Once you confirm this, you will be able to send OutboundPayments, but this may lead to
+     * funds being sent to the wrong account, which we might not be able to recover.
+     */
+    acknowledgeConfirmationOfPayee(id: string, params?: V2.Core.Vault.GbBankAccountAcknowledgeConfirmationOfPayeeParams, options?: RequestOptions): Promise<Response<GbBankAccount>>;
+    /**
+     * Archive a GBBankAccount object. Archived GBBankAccount objects cannot be used as outbound destinations
+     * and will not appear in the outbound destination list.
+     */
+    archive(id: string, params?: V2.Core.Vault.GbBankAccountArchiveParams, options?: RequestOptions): Promise<Response<GbBankAccount>>;
+    /**
+     * Initiate Confirmation of Payee (CoP) in order to verify that the owner of a UK bank account matches
+     * who you expect. This must be done on all UK bank accounts before sending domestic OutboundPayments. If
+     * the result is a partial match or a non match, explicit acknowledgement using AcknowledgeConfirmationOfPayee
+     * is required before sending funds.
+     */
+    initiateConfirmationOfPayee(id: string, params?: V2.Core.Vault.GbBankAccountInitiateConfirmationOfPayeeParams, options?: RequestOptions): Promise<Response<GbBankAccount>>;
+}
+export interface GbBankAccount {
+    /**
+     * The ID of the GBBankAccount object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.core.vault.gb_bank_account';
+    /**
+     * The alternative reference for this payout method, if it's a projected payout method.
+     */
+    alternative_reference?: V2.Core.Vault.GbBankAccount.AlternativeReference;
+    /**
+     * Whether this bank account object was archived. Bank account objects can be archived through
+     * the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects
+     * cannot be used as outbound destinations and will not appear in the outbound destination list.
+     */
+    archived: boolean;
+    /**
+     * Closed Enum. The type of the bank account (checking or savings).
+     */
+    bank_account_type: V2.Core.Vault.GbBankAccount.BankAccountType;
+    /**
+     * The name of the bank.
+     */
+    bank_name: string;
+    /**
+     * Information around the status of Confirmation of Payee matching done on this bank account.
+     * Confirmation of Payee is a name matching service that must be done before making OutboundPayments in the UK.
+     */
+    confirmation_of_payee: V2.Core.Vault.GbBankAccount.ConfirmationOfPayee;
+    /**
+     * Creation time.
+     */
+    created: string;
+    /**
+     * The last 4 digits of the account number or IBAN.
+     */
+    last4: 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;
+    /**
+     * The Sort Code of the bank account.
+     */
+    sort_code?: string;
+    /**
+     * The list of currencies supported by this bank account.
+     */
+    supported_currencies: Array<string>;
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace Vault {
+            namespace GbBankAccount {
+                interface AlternativeReference {
+                    /**
+                     * The ID of the alternative resource being referenced.
+                     */
+                    id: string;
+                    /**
+                     * The type of the alternative reference (e.g., external_account for V1 external accounts).
+                     */
+                    type: AlternativeReference.Type;
+                }
+                type BankAccountType = 'checking' | 'futsu' | 'savings' | 'toza';
+                interface ConfirmationOfPayee {
+                    /**
+                     * The result of the Confirmation of Payee check, once the check has been initiated. Closed enum.
+                     */
+                    result: ConfirmationOfPayee.Result;
+                    /**
+                     * The current state of Confirmation of Payee on this bank account. Closed enum.
+                     */
+                    status: ConfirmationOfPayee.Status;
+                }
+                namespace AlternativeReference {
+                    type Type = 'external_account' | 'payment_method';
+                }
+                namespace ConfirmationOfPayee {
+                    interface Result {
+                        /**
+                         * When the CoP result was created.
+                         */
+                        created: string;
+                        /**
+                         * Whether or not the information of the bank account matches what you have provided. Closed enum.
+                         */
+                        match_result: Result.MatchResult;
+                        /**
+                         * The fields that CoP service matched against. Only has value if MATCH or PARTIAL_MATCH, empty otherwise.
+                         */
+                        matched: Result.Matched;
+                        /**
+                         * Human-readable message describing the match result.
+                         */
+                        message: string;
+                        /**
+                         * The fields that are matched against what the network has on file.
+                         */
+                        provided: Result.Provided;
+                    }
+                    type Status = 'awaiting_acknowledgement' | 'confirmed' | 'uninitiated';
+                    namespace Result {
+                        type MatchResult = 'match' | 'mismatch' | 'partial_match' | 'unavailable';
+                        interface Matched {
+                            /**
+                             * The business type given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
+                             * Closed enum.
+                             */
+                            business_type?: Matched.BusinessType;
+                            /**
+                             * The name given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
+                             */
+                            name?: string;
+                        }
+                        interface Provided {
+                            /**
+                             * The provided or Legal Entity business type to match against the CoP service. Closed enum.
+                             */
+                            business_type: Provided.BusinessType;
+                            /**
+                             * The provided or Legal Entity name to match against the CoP service.
+                             */
+                            name: string;
+                        }
+                        namespace Matched {
+                            type BusinessType = 'business' | 'personal';
+                        }
+                        namespace Provided {
+                            type BusinessType = 'business' | 'personal';
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace Vault {
+            interface GbBankAccountCreateParams {
+                /**
+                 * The currency of the bank account.
+                 */
+                currency: string;
+                /**
+                 * The Account Number of the bank account.
+                 */
+                account_number?: string;
+                /**
+                 * Closed Enum. The type of the bank account (checking or savings).
+                 */
+                bank_account_type?: GbBankAccountCreateParams.BankAccountType;
+                /**
+                 * Whether or not to automatically perform Confirmation of Payee to verify the users information
+                 * against what was provided by the bank. Doing so is required for all bank accounts not owned
+                 * by you before making domestic UK OutboundPayments.
+                 */
+                confirmation_of_payee?: GbBankAccountCreateParams.ConfirmationOfPayee;
+                /**
+                 * The IBAN of the bank account.
+                 */
+                iban?: string;
+                /**
+                 * The Sort Code of the bank account.
+                 */
+                sort_code?: string;
+            }
+            namespace GbBankAccountCreateParams {
+                type BankAccountType = 'checking' | 'futsu' | 'savings' | 'toza';
+                interface ConfirmationOfPayee {
+                    /**
+                     * The business type to be checked against. Legal entity information will be used if unspecified.
+                     * Closed enum.
+                     */
+                    business_type?: ConfirmationOfPayee.BusinessType;
+                    /**
+                     * User specifies whether Confirmation of Payee is automatically initiated when creating the bank account.
+                     */
+                    initiate: boolean;
+                    /**
+                     * The name to be checked against. Legal entity information will be used if unspecified.
+                     */
+                    name?: string;
+                }
+                namespace ConfirmationOfPayee {
+                    type BusinessType = 'business' | 'personal';
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace Vault {
+            interface GbBankAccountRetrieveParams {
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace Vault {
+            interface GbBankAccountListParams {
+                /**
+                 * Optionally set the maximum number of results per page. Defaults to 10.
+                 */
+                limit?: number;
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace Vault {
+            interface GbBankAccountAcknowledgeConfirmationOfPayeeParams {
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace Vault {
+            interface GbBankAccountArchiveParams {
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Core {
+        namespace Vault {
+            interface GbBankAccountInitiateConfirmationOfPayeeParams {
+                /**
+                 * The business type to be checked against. Legal entity information will be used if unspecified.
+                 */
+                business_type?: GbBankAccountInitiateConfirmationOfPayeeParams.BusinessType;
+                /**
+                 * The name of the user to be checked against. Legal entity information will be used if unspecified.
+                 */
+                name?: string;
+            }
+            namespace GbBankAccountInitiateConfirmationOfPayeeParams {
+                type BusinessType = 'business' | 'personal';
+            }
+        }
+    }
+}