stripe 22.3.0 → 22.4.0-beta.1

package/esm/resources/ExternalAccounts.d.ts

@@ -1,4 +1,215 @@
-import { BankAccount, DeletedBankAccount } from './BankAccounts.js';
+import { StripeResource } from '../StripeResource.js';
 import { Card, DeletedCard } from './Cards.js';
+import { BankAccount, DeletedBankAccount } from './BankAccounts.js';
+import { MetadataParam, Emptyable, PaginationParams } from '../shared.js';
+import { RequestOptions, Response, ApiListPromise } from '../lib.js';
+export declare class ExternalAccountResource extends StripeResource {
+    /**
+     * Delete a specified external account for a given account.
+     */
+    del(id: string, params?: ExternalAccountDeleteParams, options?: RequestOptions): Promise<Response<DeletedExternalAccount>>;
+    /**
+     * Retrieve a specified external account for a given account.
+     */
+    retrieve(id: string, params?: ExternalAccountRetrieveParams, options?: RequestOptions): Promise<Response<ExternalAccount>>;
+    /**
+     * Updates the metadata, account holder name, account holder type of a bank account belonging to
+     * a connected account and optionally sets it as the default for its currency. Other bank account
+     * details are not editable by design.
+     *
+     * You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
+     *
+     * You can re-enable a disabled bank account by performing an update call without providing any
+     * arguments or changes.
+     */
+    update(id: string, params?: ExternalAccountUpdateParams, options?: RequestOptions): Promise<Response<ExternalAccount>>;
+    /**
+     * List external accounts for an account.
+     */
+    list(params?: ExternalAccountListParams, options?: RequestOptions): ApiListPromise<ExternalAccount>;
+    /**
+     * Create an external account for a given connected account.
+     */
+    create(params: ExternalAccountCreateParams, options?: RequestOptions): Promise<Response<ExternalAccount>>;
+}
 export type ExternalAccount = BankAccount | Card;
 export type DeletedExternalAccount = DeletedBankAccount | DeletedCard;
+export interface ExternalAccountCreateParams {
+    /**
+     * Either a token, like the ones returned by [Stripe.js](https://docs.stripe.com/js), or a dictionary containing a user's external account details (with the options shown below).
+     */
+    external_account: string | ExternalAccountCreateParams.Card | ExternalAccountCreateParams.BankAccount | ExternalAccountCreateParams.CardToken;
+    /**
+     * When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
+     */
+    default_for_currency?: boolean;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+     */
+    metadata?: MetadataParam;
+}
+export declare namespace ExternalAccountCreateParams {
+    interface Card {
+        object: 'card';
+        address_city?: string;
+        address_country?: string;
+        address_line1?: string;
+        address_line2?: string;
+        address_state?: string;
+        address_zip?: string;
+        currency?: string;
+        cvc?: string;
+        exp_month: number;
+        exp_year: number;
+        /**
+         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+         */
+        metadata?: MetadataParam;
+        name?: string;
+        number: string;
+    }
+    interface BankAccount {
+        object: 'bank_account';
+        /**
+         * The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
+         */
+        account_holder_name?: string;
+        /**
+         * The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
+         */
+        account_holder_type?: BankAccount.AccountHolderType;
+        /**
+         * The account number for the bank account, in string form. Must be a checking account.
+         */
+        account_number: string;
+        /**
+         * The country in which the bank account is located.
+         */
+        country: string;
+        /**
+         * The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
+         */
+        currency?: string;
+        /**
+         * The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
+         */
+        routing_number?: string;
+    }
+    interface CardToken {
+        object: 'card';
+        currency?: string;
+        token: string;
+    }
+    namespace BankAccount {
+        type AccountHolderType = 'company' | 'individual';
+    }
+}
+export interface ExternalAccountRetrieveParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
+export interface ExternalAccountUpdateParams {
+    /**
+     * The name of the person or business that owns the bank account.
+     */
+    account_holder_name?: string;
+    /**
+     * The type of entity that holds the account. This can be either `individual` or `company`.
+     */
+    account_holder_type?: Emptyable<ExternalAccountUpdateParams.AccountHolderType>;
+    /**
+     * The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
+     */
+    account_type?: ExternalAccountUpdateParams.AccountType;
+    /**
+     * City/District/Suburb/Town/Village.
+     */
+    address_city?: string;
+    /**
+     * Billing address country, if provided when creating card.
+     */
+    address_country?: string;
+    /**
+     * Address line 1 (Street address/PO Box/Company name).
+     */
+    address_line1?: string;
+    /**
+     * Address line 2 (Apartment/Suite/Unit/Building).
+     */
+    address_line2?: string;
+    /**
+     * State/County/Province/Region.
+     */
+    address_state?: string;
+    /**
+     * ZIP or postal code.
+     */
+    address_zip?: string;
+    /**
+     * When set to true, this becomes the default external account for its currency.
+     */
+    default_for_currency?: boolean;
+    /**
+     * Documents that may be submitted to satisfy various informational requests.
+     */
+    documents?: ExternalAccountUpdateParams.Documents;
+    /**
+     * Two digit number representing the card's expiration month.
+     */
+    exp_month?: string;
+    /**
+     * Four digit number representing the card's expiration year.
+     */
+    exp_year?: string;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+     */
+    metadata?: Emptyable<MetadataParam>;
+    /**
+     * Cardholder name.
+     */
+    name?: string;
+}
+export declare namespace ExternalAccountUpdateParams {
+    type AccountHolderType = 'company' | 'individual';
+    type AccountType = 'checking' | 'futsu' | 'savings' | 'toza';
+    interface Documents {
+        /**
+         * One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.
+         */
+        bank_account_ownership_verification?: Documents.BankAccountOwnershipVerification;
+    }
+    namespace Documents {
+        interface BankAccountOwnershipVerification {
+            /**
+             * One or more document ids returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `account_requirement`.
+             */
+            files?: Array<string>;
+        }
+    }
+}
+export interface ExternalAccountListParams extends PaginationParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Filter external accounts according to a particular object type.
+     */
+    object?: ExternalAccountListParams.Object;
+}
+export declare namespace ExternalAccountListParams {
+    type Object = 'bank_account' | 'card';
+}
+export interface ExternalAccountDeleteParams {
+}

package/esm/resources/ExternalAccounts.js

@@ -1,3 +1,44 @@
 // File generated from our OpenAPI spec
-export {};
+import { StripeResource } from '../StripeResource.js';
+export class ExternalAccountResource extends StripeResource {
+    /**
+     * Delete a specified external account for a given account.
+     */
+    del(id, params, options) {
+        return this._makeRequest('DELETE', `/v1/external_accounts/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Retrieve a specified external account for a given account.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/external_accounts/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Updates the metadata, account holder name, account holder type of a bank account belonging to
+     * a connected account and optionally sets it as the default for its currency. Other bank account
+     * details are not editable by design.
+     *
+     * You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
+     *
+     * You can re-enable a disabled bank account by performing an update call without providing any
+     * arguments or changes.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v1/external_accounts/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * List external accounts for an account.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/external_accounts', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Create an external account for a given connected account.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/external_accounts', params, options);
+    }
+}
 //# sourceMappingURL=ExternalAccounts.js.map

package/esm/resources/ExternalAccounts.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExternalAccounts.js","sourceRoot":"","sources":["../../src/resources/ExternalAccounts.ts"],"names":[],"mappings":"AAAA,uCAAuC"}
+{"version":3,"file":"ExternalAccounts.js","sourceRoot":"","sources":["../../src/resources/ExternalAccounts.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAMpD,MAAM,OAAO,uBAAwB,SAAQ,cAAc;IACzD;;OAEG;IACH,GAAG,CACD,EAAU,EACV,MAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,QAAQ,EACR,yBAAyB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACjD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,yBAAyB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACjD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,MAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,yBAAyB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACjD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,IAAI,CACF,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,uBAAuB,EAAE,MAAM,EAAE,OAAO,EAAE;YACxE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,EACvB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}

package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts

@@ -0,0 +1,24 @@
+export interface AccountInferredBalance {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'financial_connections.account_inferred_balance';
+    /**
+     * The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
+     */
+    as_of: number;
+    /**
+     * The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.
+     *
+     * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+     *
+     * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+     */
+    current: {
+        [key: string]: number;
+    };
+}

package/esm/resources/FinancialConnections/AccountInferredBalances.js

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec
+export {};
+//# sourceMappingURL=AccountInferredBalances.js.map

package/esm/resources/FinancialConnections/AccountInferredBalances.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountInferredBalances.js","sourceRoot":"","sources":["../../../src/resources/FinancialConnections/AccountInferredBalances.ts"],"names":[],"mappings":"AAAA,uCAAuC"}

package/esm/resources/FinancialConnections/Accounts.d.ts

@@ -1,5 +1,7 @@
 import { StripeResource } from '../../StripeResource.js';
+import { AccountInferredBalance } from './AccountInferredBalances.js';
 import { AccountOwner } from './AccountOwners.js';
+import { Institution } from './Institutions.js';
 import { AccountOwnership } from './AccountOwnerships.js';
 import { Customer } from './../Customers.js';
 import { PaginationParams } from '../../shared.js';
@@ -29,6 +31,10 @@ export declare class AccountResource extends StripeResource {
      * Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
      */
     unsubscribe(id: string, params: FinancialConnections.AccountUnsubscribeParams, options?: RequestOptions): Promise<Response<Account>>;
+    /**
+     * Lists the recorded inferred balances for a Financial Connections Account.
+     */
+    listInferredBalances(id: string, params?: FinancialConnections.AccountListInferredBalancesParams, options?: RequestOptions): ApiListPromise<AccountInferredBalance>;
     /**
      * Lists all owners for a given Account
      */
@@ -51,6 +57,10 @@ export interface Account {
      * Details about the account numbers.
      */
     account_numbers: Array<Account.AccountNumber> | null;
+    /**
+     * The ID of the Financial Connections Authorization this account belongs to.
+     */
+    authorization?: string;
     /**
      * The most recent information about the account's balance.
      */
@@ -71,6 +81,14 @@ export interface Account {
      * A human-readable name that has been assigned to this account, either by the account holder or by the institution.
      */
     display_name: string | null;
+    /**
+     * The state of the most recent attempt to refresh the account's inferred balance history.
+     */
+    inferred_balances_refresh?: Account.InferredBalancesRefresh | null;
+    /**
+     * The ID of the Financial Connections Institution this account belongs to. Note that this relationship may sometimes change in rare circumstances (e.g. institution mergers).
+     */
+    institution?: string | Institution | null;
     /**
      * The name of the institution that holds this account.
      */
@@ -120,7 +138,7 @@ export interface Account {
     /**
      * The list of data refresh subscriptions requested on this account.
      */
-    subscriptions: Array<'transactions'> | null;
+    subscriptions: Array<Account.Subscription> | null;
     /**
      * The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
      */
@@ -201,6 +219,20 @@ export declare namespace Account {
         status: BalanceRefresh.Status;
     }
     type Category = 'cash' | 'credit' | 'investment' | 'other';
+    interface InferredBalancesRefresh {
+        /**
+         * The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
+         */
+        last_attempted_at: number;
+        /**
+         * Time at which the next inferred balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
+         */
+        next_refresh_available_at: number | null;
+        /**
+         * The status of the last refresh attempt.
+         */
+        status: InferredBalancesRefresh.Status;
+    }
     interface OwnershipRefresh {
         /**
          * The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
@@ -219,8 +251,10 @@ export declare namespace Account {
     type Status = 'active' | 'disconnected' | 'inactive';
     interface StatusDetails {
         active?: StatusDetails.Active;
+        inactive?: StatusDetails.Inactive;
     }
     type Subcategory = 'checking' | 'credit_card' | 'line_of_credit' | 'mortgage' | 'other' | 'savings';
+    type Subscription = 'balance' | 'inferred_balances' | 'transactions';
     type SupportedPaymentMethodType = 'link' | 'us_bank_account';
     interface TransactionRefresh {
         /**
@@ -277,6 +311,9 @@ export declare namespace Account {
     namespace BalanceRefresh {
         type Status = 'failed' | 'pending' | 'succeeded';
     }
+    namespace InferredBalancesRefresh {
+        type Status = 'failed' | 'pending' | 'succeeded';
+    }
     namespace OwnershipRefresh {
         type Status = 'failed' | 'pending' | 'succeeded';
     }
@@ -295,10 +332,24 @@ export declare namespace Account {
              */
             expected_deactivation_date: number;
         }
+        interface Inactive {
+            /**
+             * The action (if any) to relink the inactive Account.
+             */
+            action: Inactive.Action;
+            /**
+             * The underlying cause of the Account being inactive.
+             */
+            cause: Inactive.Cause;
+        }
         namespace Active {
             type Action = 'none' | 'relink_required';
             type Cause = 'access_expired' | 'institution_requirement' | 'unspecified';
         }
+        namespace Inactive {
+            type Action = 'none' | 'relink_required';
+            type Cause = 'access_denied' | 'access_expired' | 'account_closed' | 'account_unavailable' | 'institution_requirement' | 'unspecified';
+        }
     }
     namespace TransactionRefresh {
         type Status = 'failed' | 'pending' | 'succeeded';
@@ -352,6 +403,14 @@ export declare namespace FinancialConnections {
         expand?: Array<string>;
     }
 }
+export declare namespace FinancialConnections {
+    interface AccountListInferredBalancesParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}
 export declare namespace FinancialConnections {
     interface AccountListOwnersParams extends PaginationParams {
         /**
@@ -376,7 +435,7 @@ export declare namespace FinancialConnections {
         expand?: Array<string>;
     }
     namespace AccountRefreshParams {
-        type Feature = 'balance' | 'ownership' | 'transactions';
+        type Feature = 'balance' | 'inferred_balances' | 'ownership' | 'transactions';
     }
 }
 export declare namespace FinancialConnections {
@@ -384,22 +443,28 @@ export declare namespace FinancialConnections {
         /**
          * The list of account features to which you would like to subscribe.
          */
-        features: Array<'transactions'>;
+        features: Array<AccountSubscribeParams.Feature>;
         /**
          * Specifies which fields in the response should be expanded.
          */
         expand?: Array<string>;
     }
+    namespace AccountSubscribeParams {
+        type Feature = 'balance' | 'inferred_balances' | 'transactions';
+    }
 }
 export declare namespace FinancialConnections {
     interface AccountUnsubscribeParams {
         /**
          * The list of account features from which you would like to unsubscribe.
          */
-        features: Array<'transactions'>;
+        features: Array<AccountUnsubscribeParams.Feature>;
         /**
          * Specifies which fields in the response should be expanded.
          */
         expand?: Array<string>;
     }
+    namespace AccountUnsubscribeParams {
+        type Feature = 'balance' | 'inferred_balances' | 'transactions';
+    }
 }

package/esm/resources/FinancialConnections/Accounts.js

@@ -39,6 +39,14 @@ export class AccountResource extends StripeResource {
     unsubscribe(id, params, options) {
         return this._makeRequest('POST', `/v1/financial_connections/accounts/${encodeURIComponent(id)}/unsubscribe`, params, options);
     }
+    /**
+     * Lists the recorded inferred balances for a Financial Connections Account.
+     */
+    listInferredBalances(id, params, options) {
+        return this._makeRequest('GET', `/v1/financial_connections/accounts/${encodeURIComponent(id)}/inferred_balances`, params, options, {
+            methodType: 'list',
+        });
+    }
     /**
      * Lists all owners for a given Account
      */

package/esm/resources/FinancialConnections/Accounts.js.map

@@ -1 +1 @@
-{"version":3,"file":"Accounts.js","sourceRoot":"","sources":["../../../src/resources/FinancialConnections/Accounts.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAOvD,MAAM,OAAO,eAAgB,SAAQ,cAAc;IACjD;;OAEG;IACH,IAAI,CACF,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,oCAAoC,EACpC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAmD,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC9D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,UAAU,CACR,EAAU,EACV,MAAqD,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,aAAa,EACzE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,OAAO,CACL,EAAU,EACV,MAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACtE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,SAAS,CACP,EAAU,EACV,MAAmD,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,YAAY,EACxE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,WAAW,CACT,EAAU,EACV,MAAqD,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,sCAAsC,kBAAkB,CACtD,EAAE,CACH,cAAc,EACf,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,UAAU,CACR,EAAU,EACV,MAAoD,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACrE,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;CACF"}
+{"version":3,"file":"Accounts.js","sourceRoot":"","sources":["../../../src/resources/FinancialConnections/Accounts.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AASvD,MAAM,OAAO,eAAgB,SAAQ,cAAc;IACjD;;OAEG;IACH,IAAI,CACF,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,oCAAoC,EACpC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAmD,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC9D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,UAAU,CACR,EAAU,EACV,MAAqD,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,aAAa,EACzE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,OAAO,CACL,EAAU,EACV,MAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACtE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,SAAS,CACP,EAAU,EACV,MAAmD,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,YAAY,EACxE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,WAAW,CACT,EAAU,EACV,MAAqD,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,sCAAsC,kBAAkB,CACtD,EAAE,CACH,cAAc,EACf,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,oBAAoB,CAClB,EAAU,EACV,MAA+D,EAC/D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,sCAAsC,kBAAkB,CACtD,EAAE,CACH,oBAAoB,EACrB,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,UAAU,CACR,EAAU,EACV,MAAoD,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,sCAAsC,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACrE,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;CACF"}

package/esm/resources/FinancialConnections/Authorizations.d.ts

@@ -0,0 +1,99 @@
+import { StripeResource } from '../../StripeResource.js';
+import { Institution } from './Institutions.js';
+import { Account } from './../Accounts.js';
+import { Customer } from './../Customers.js';
+import { RequestOptions, Response } from '../../lib.js';
+export declare class AuthorizationResource extends StripeResource {
+    /**
+     * Retrieves the details of an Financial Connections Authorization.
+     */
+    retrieve(id: string, params?: FinancialConnections.AuthorizationRetrieveParams, options?: RequestOptions): Promise<Response<Authorization>>;
+}
+export interface Authorization {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'financial_connections.authorization';
+    /**
+     * The account holder that this authorization belongs to.
+     */
+    account_holder?: Authorization.AccountHolder | null;
+    /**
+     * The ID of the Financial Connections Institution this account belongs to. Note that this relationship may sometimes change in rare circumstances (e.g. institution mergers).
+     */
+    institution?: string | Institution | null;
+    /**
+     * The name of the institution that this authorization belongs to.
+     */
+    institution_name: string;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * The status of the connection to the Authorization.
+     */
+    status: Authorization.Status;
+    status_details: Authorization.StatusDetails;
+}
+export declare namespace Authorization {
+    interface AccountHolder {
+        /**
+         * The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`.
+         */
+        account?: string | Account;
+        /**
+         * The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`.
+         */
+        customer?: string | Customer;
+        customer_account?: string;
+        /**
+         * Type of account holder that this account belongs to.
+         */
+        type: AccountHolder.Type;
+    }
+    type Status = 'active' | 'disconnected' | 'inactive';
+    interface StatusDetails {
+        active?: StatusDetails.Active;
+        inactive?: StatusDetails.Inactive;
+    }
+    namespace AccountHolder {
+        type Type = 'account' | 'customer';
+    }
+    namespace StatusDetails {
+        interface Active {
+            /**
+             * The action (if any) to proactively relink the Authorization.
+             */
+            action: Active.Action;
+            /**
+             * When the Authorization is expected to become inactive, if applicable.
+             */
+            expected_deactivation_date: number;
+        }
+        interface Inactive {
+            /**
+             * The action (if any) to relink the inactive Authorization.
+             */
+            action: Inactive.Action;
+        }
+        namespace Active {
+            type Action = 'none' | 'relink_required';
+        }
+        namespace Inactive {
+            type Action = 'none' | 'relink_required';
+        }
+    }
+}
+export declare namespace FinancialConnections {
+    interface AuthorizationRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+    }
+}

package/esm/resources/FinancialConnections/Authorizations.js

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../StripeResource.js';
+export class AuthorizationResource extends StripeResource {
+    /**
+     * Retrieves the details of an Financial Connections Authorization.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/financial_connections/authorizations/${encodeURIComponent(id)}`, params, options);
+    }
+}
+//# sourceMappingURL=Authorizations.js.map

package/esm/resources/FinancialConnections/Authorizations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Authorizations.js","sourceRoot":"","sources":["../../../src/resources/FinancialConnections/Authorizations.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAMvD,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACvD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAyD,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,4CAA4C,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACpE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}