modern-treasury 2.6.0 → 2.7.2

package/resources/external-accounts.d.ts

@@ -3,443 +3,365 @@ import { APIResource } from 'modern-treasury/resource';
 import * as AccountDetails from 'modern-treasury/resources/account-details';
 import * as RoutingDetails from 'modern-treasury/resources/routing-details';
 import * as Shared from 'modern-treasury/resources/shared';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { Page, PageParams } from 'modern-treasury/pagination';
 export declare class ExternalAccounts extends APIResource {
-  /**
-   * create external account
-   */
-  create(
-    params: ExternalAccountCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ExternalAccount>;
-  /**
-   * show external account
-   */
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
-  /**
-   * update external account
-   */
-  update(
-    id: string,
-    body?: ExternalAccountUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ExternalAccount>;
-  update(id: string, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
-  /**
-   * list external accounts
-   */
-  list(
-    query?: ExternalAccountListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<ExternalAccountsPage, ExternalAccount>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ExternalAccountsPage, ExternalAccount>;
-  /**
-   * delete external account
-   */
-  del(id: string, options?: Core.RequestOptions): Core.APIPromise<void>;
-  /**
-   * complete verification of external account
-   */
-  completeVerification(
-    id: string,
-    params?: ExternalAccountCompleteVerificationParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ExternalAccount>;
-  completeVerification(id: string, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
-  /**
-   * verify external account
-   */
-  verify(
-    id: string,
-    params: ExternalAccountVerifyParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ExternalAccount>;
+    /**
+     * create external account
+     */
+    create(params: ExternalAccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
+    /**
+     * show external account
+     */
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
+    /**
+     * update external account
+     */
+    update(id: string, body?: ExternalAccountUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
+    update(id: string, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
+    /**
+     * list external accounts
+     */
+    list(query?: ExternalAccountListParams, options?: Core.RequestOptions): Core.PagePromise<ExternalAccountsPage, ExternalAccount>;
+    list(options?: Core.RequestOptions): Core.PagePromise<ExternalAccountsPage, ExternalAccount>;
+    /**
+     * delete external account
+     */
+    del(id: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * complete verification of external account
+     */
+    completeVerification(id: string, params?: ExternalAccountCompleteVerificationParams, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
+    completeVerification(id: string, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
+    /**
+     * verify external account
+     */
+    verify(id: string, params: ExternalAccountVerifyParams, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount>;
+}
+export declare class ExternalAccountsPage extends Page<ExternalAccount> {
 }
-export declare class ExternalAccountsPage extends Page<ExternalAccount> {}
 type _ExternalAccountsPage = ExternalAccountsPage;
 export interface ExternalAccount {
-  id: string;
-  account_details: Array<AccountDetails.AccountDetail>;
-  /**
-   * Can be `checking`, `savings` or `other`.
-   */
-  account_type: ExternalAccountType;
-  contact_details: Array<ExternalAccount.ContactDetail>;
-  counterparty_id: string | null;
-  created_at: string;
-  discarded_at: string | null;
-  /**
-   * If the external account links to a ledger account in Modern Treasury, the id of
-   * the ledger account will be populated here.
-   */
-  ledger_account_id: string | null;
-  /**
-   * This field will be true if this object exists in the live environment or false
-   * if it exists in the test environment.
-   */
-  live_mode: boolean;
-  /**
-   * Additional data represented as key-value pairs. Both the key and value must be
-   * strings.
-   */
-  metadata: Record<string, string>;
-  /**
-   * A nickname for the external account. This is only for internal usage and won't
-   * affect any payments
-   */
-  name: string | null;
-  object: string;
-  /**
-   * The address associated with the owner or `null`.
-   */
-  party_address: ExternalAccount.PartyAddress | null;
-  /**
-   * The legal name of the entity which owns the account.
-   */
-  party_name: string;
-  /**
-   * Either `individual` or `business`.
-   */
-  party_type: 'business' | 'individual' | null;
-  routing_details: Array<RoutingDetails.RoutingDetail>;
-  updated_at: string;
-  verification_status: 'pending_verification' | 'unverified' | 'verified';
-}
-export declare namespace ExternalAccount {
-  interface ContactDetail {
     id: string;
-    contact_identifier: string;
-    contact_identifier_type: 'email' | 'phone_number' | 'website';
+    account_details: Array<AccountDetails.AccountDetail>;
+    /**
+     * Can be `checking`, `savings` or `other`.
+     */
+    account_type: ExternalAccountType;
+    contact_details: Array<ExternalAccount.ContactDetail>;
+    counterparty_id: string | null;
     created_at: string;
     discarded_at: string | null;
+    /**
+     * If the external account links to a ledger account in Modern Treasury, the id of
+     * the ledger account will be populated here.
+     */
+    ledger_account_id: string | null;
     /**
      * This field will be true if this object exists in the live environment or false
      * if it exists in the test environment.
      */
     live_mode: boolean;
-    object: string;
-    updated_at: string;
-  }
-  /**
-   * The address associated with the owner or `null`.
-   */
-  interface PartyAddress {
-    id: string;
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
      */
-    country: string | null;
-    created_at: string;
-    line1: string | null;
-    line2: string | null;
+    metadata: Record<string, string>;
     /**
-     * This field will be true if this object exists in the live environment or false
-     * if it exists in the test environment.
+     * A nickname for the external account. This is only for internal usage and won't
+     * affect any payments
      */
-    live_mode: boolean;
+    name: string | null;
+    object: string;
     /**
-     * Locality or City.
+     * The address associated with the owner or `null`.
      */
-    locality: string | null;
-    object: string;
+    party_address: ExternalAccount.PartyAddress | null;
     /**
-     * The postal code of the address.
+     * The legal name of the entity which owns the account.
      */
-    postal_code: string | null;
+    party_name: string;
     /**
-     * Region or State.
+     * Either `individual` or `business`.
      */
-    region: string | null;
+    party_type: 'business' | 'individual' | null;
+    routing_details: Array<RoutingDetails.RoutingDetail>;
     updated_at: string;
-  }
+    verification_status: 'pending_verification' | 'unverified' | 'verified';
+}
+export declare namespace ExternalAccount {
+    interface ContactDetail {
+        id: string;
+        contact_identifier: string;
+        contact_identifier_type: 'email' | 'phone_number' | 'website';
+        created_at: string;
+        discarded_at: string | null;
+        /**
+         * This field will be true if this object exists in the live environment or false
+         * if it exists in the test environment.
+         */
+        live_mode: boolean;
+        object: string;
+        updated_at: string;
+    }
+    /**
+     * The address associated with the owner or `null`.
+     */
+    interface PartyAddress {
+        id: string;
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country: string | null;
+        created_at: string;
+        line1: string | null;
+        line2: string | null;
+        /**
+         * This field will be true if this object exists in the live environment or false
+         * if it exists in the test environment.
+         */
+        live_mode: boolean;
+        /**
+         * Locality or City.
+         */
+        locality: string | null;
+        object: string;
+        /**
+         * The postal code of the address.
+         */
+        postal_code: string | null;
+        /**
+         * Region or State.
+         */
+        region: string | null;
+        updated_at: string;
+    }
 }
 /**
  * Can be `checking`, `savings` or `other`.
  */
-export type ExternalAccountType =
-  | 'cash'
-  | 'checking'
-  | 'loan'
-  | 'non_resident'
-  | 'other'
-  | 'overdraft'
-  | 'savings';
+export type ExternalAccountType = 'cash' | 'checking' | 'loan' | 'non_resident' | 'other' | 'overdraft' | 'savings';
 export interface ExternalAccountCreateParams {
-  counterparty_id: string | null;
-  account_details?: Array<ExternalAccountCreateParams.AccountDetail>;
-  /**
-   * Can be `checking`, `savings` or `other`.
-   */
-  account_type?: ExternalAccountType;
-  contact_details?: Array<ExternalAccountCreateParams.ContactDetail>;
-  /**
-   * Specifies a ledger account object that will be created with the external
-   * account. The resulting ledger account is linked to the external account for
-   * auto-ledgering Payment objects. See
-   * https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
-   * for more details.
-   */
-  ledger_account?: ExternalAccountCreateParams.LedgerAccount;
-  /**
-   * Additional data represented as key-value pairs. Both the key and value must be
-   * strings.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * A nickname for the external account. This is only for internal usage and won't
-   * affect any payments
-   */
-  name?: string | null;
-  /**
-   * Required if receiving wire payments.
-   */
-  party_address?: ExternalAccountCreateParams.PartyAddress;
-  party_identifier?: string;
-  /**
-   * If this value isn't provided, it will be inherited from the counterparty's name.
-   */
-  party_name?: string;
-  /**
-   * Either `individual` or `business`.
-   */
-  party_type?: 'business' | 'individual' | null;
-  /**
-   * If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
-   * you can pass the processor token in this field.
-   */
-  plaid_processor_token?: string;
-  routing_details?: Array<ExternalAccountCreateParams.RoutingDetail>;
-}
-export declare namespace ExternalAccountCreateParams {
-  interface AccountDetail {
-    account_number: string;
-    account_number_type?: 'iban' | 'clabe' | 'wallet_address' | 'pan' | 'other';
-  }
-  interface ContactDetail {
-    contact_identifier?: string;
-    contact_identifier_type?: 'email' | 'phone_number' | 'website';
-  }
-  /**
-   * Specifies a ledger account object that will be created with the external
-   * account. The resulting ledger account is linked to the external account for
-   * auto-ledgering Payment objects. See
-   * https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
-   * for more details.
-   */
-  interface LedgerAccount {
+    counterparty_id: string | null;
+    account_details?: Array<ExternalAccountCreateParams.AccountDetail>;
     /**
-     * The currency of the ledger account.
+     * Can be `checking`, `savings` or `other`.
      */
-    currency: string;
+    account_type?: ExternalAccountType;
+    contact_details?: Array<ExternalAccountCreateParams.ContactDetail>;
     /**
-     * The id of the ledger that this account belongs to.
+     * Specifies a ledger account object that will be created with the external
+     * account. The resulting ledger account is linked to the external account for
+     * auto-ledgering Payment objects. See
+     * https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
+     * for more details.
      */
-    ledger_id: string;
+    ledger_account?: ExternalAccountCreateParams.LedgerAccount;
     /**
-     * The name of the ledger account.
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
      */
-    name: string;
+    metadata?: Record<string, string>;
     /**
-     * The normal balance of the ledger account.
+     * A nickname for the external account. This is only for internal usage and won't
+     * affect any payments
      */
-    normal_balance: 'credit' | 'debit';
+    name?: string | null;
     /**
-     * The currency exponent of the ledger account.
+     * Required if receiving wire payments.
      */
-    currency_exponent?: number | null;
+    party_address?: ExternalAccountCreateParams.PartyAddress;
+    party_identifier?: string;
     /**
-     * The description of the ledger account.
+     * If this value isn't provided, it will be inherited from the counterparty's name.
      */
-    description?: string | null;
+    party_name?: string;
     /**
-     * If the ledger account links to another object in Modern Treasury, the id will be
-     * populated here, otherwise null.
+     * Either `individual` or `business`.
      */
-    ledgerable_id?: string;
+    party_type?: 'business' | 'individual' | null;
     /**
-     * If the ledger account links to another object in Modern Treasury, the type will
-     * be populated here, otherwise null. The value is one of internal_account or
-     * external_account.
+     * If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
+     * you can pass the processor token in this field.
      */
-    ledgerable_type?: 'external_account' | 'internal_account';
+    plaid_processor_token?: string;
+    routing_details?: Array<ExternalAccountCreateParams.RoutingDetail>;
+}
+export declare namespace ExternalAccountCreateParams {
+    interface AccountDetail {
+        account_number: string;
+        account_number_type?: 'iban' | 'clabe' | 'wallet_address' | 'pan' | 'other';
+    }
+    interface ContactDetail {
+        contact_identifier?: string;
+        contact_identifier_type?: 'email' | 'phone_number' | 'website';
+    }
     /**
-     * Additional data represented as key-value pairs. Both the key and value must be
-     * strings.
+     * Specifies a ledger account object that will be created with the external
+     * account. The resulting ledger account is linked to the external account for
+     * auto-ledgering Payment objects. See
+     * https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
+     * for more details.
      */
-    metadata?: Record<string, string>;
-  }
-  /**
-   * Required if receiving wire payments.
-   */
-  interface PartyAddress {
-    /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
-     */
-    country?: string | null;
-    line1?: string | null;
-    line2?: string | null;
-    /**
-     * Locality or City.
-     */
-    locality?: string | null;
-    /**
-     * The postal code of the address.
-     */
-    postal_code?: string | null;
-    /**
-     * Region or State.
-     */
-    region?: string | null;
-  }
-  interface RoutingDetail {
-    routing_number: string;
-    routing_number_type:
-      | 'aba'
-      | 'au_bsb'
-      | 'se_bankgiro_clearing_code'
-      | 'br_codigo'
-      | 'ca_cpa'
-      | 'chips'
-      | 'cnaps'
-      | 'gb_sort_code'
-      | 'in_ifsc'
-      | 'my_branch_code'
-      | 'swift'
-      | 'jp_zengin_code';
-    payment_type?:
-      | 'ach'
-      | 'au_becs'
-      | 'se_bankgirot'
-      | 'bacs'
-      | 'book'
-      | 'card'
-      | 'check'
-      | 'eft'
-      | 'cross_border'
-      | 'interac'
-      | 'masav'
-      | 'neft'
-      | 'nics'
-      | 'provxchange'
-      | 'rtp'
-      | 'sen'
-      | 'sic'
-      | 'sepa'
-      | 'signet'
-      | 'wire'
-      | 'zengin';
-  }
+    interface LedgerAccount {
+        /**
+         * The currency of the ledger account.
+         */
+        currency: string;
+        /**
+         * The id of the ledger that this account belongs to.
+         */
+        ledger_id: string;
+        /**
+         * The name of the ledger account.
+         */
+        name: string;
+        /**
+         * The normal balance of the ledger account.
+         */
+        normal_balance: 'credit' | 'debit';
+        /**
+         * The currency exponent of the ledger account.
+         */
+        currency_exponent?: number | null;
+        /**
+         * The description of the ledger account.
+         */
+        description?: string | null;
+        /**
+         * If the ledger account links to another object in Modern Treasury, the id will be
+         * populated here, otherwise null.
+         */
+        ledgerable_id?: string;
+        /**
+         * If the ledger account links to another object in Modern Treasury, the type will
+         * be populated here, otherwise null. The value is one of internal_account or
+         * external_account.
+         */
+        ledgerable_type?: 'external_account' | 'internal_account';
+        /**
+         * Additional data represented as key-value pairs. Both the key and value must be
+         * strings.
+         */
+        metadata?: Record<string, string>;
+    }
+    /**
+     * Required if receiving wire payments.
+     */
+    interface PartyAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country?: string | null;
+        line1?: string | null;
+        line2?: string | null;
+        /**
+         * Locality or City.
+         */
+        locality?: string | null;
+        /**
+         * The postal code of the address.
+         */
+        postal_code?: string | null;
+        /**
+         * Region or State.
+         */
+        region?: string | null;
+    }
+    interface RoutingDetail {
+        routing_number: string;
+        routing_number_type: 'aba' | 'au_bsb' | 'se_bankgiro_clearing_code' | 'br_codigo' | 'ca_cpa' | 'chips' | 'cnaps' | 'gb_sort_code' | 'in_ifsc' | 'my_branch_code' | 'swift' | 'jp_zengin_code';
+        payment_type?: 'ach' | 'au_becs' | 'se_bankgirot' | 'bacs' | 'book' | 'card' | 'check' | 'eft' | 'cross_border' | 'interac' | 'masav' | 'neft' | 'nics' | 'provxchange' | 'rtp' | 'sen' | 'sic' | 'sepa' | 'signet' | 'wire' | 'zengin';
+    }
 }
 export interface ExternalAccountUpdateParams {
-  /**
-   * Can be `checking`, `savings` or `other`.
-   */
-  account_type?: ExternalAccountType;
-  counterparty_id?: string | null;
-  /**
-   * Additional data in the form of key-value pairs. Pairs can be removed by passing
-   * an empty string or `null` as the value.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * A nickname for the external account. This is only for internal usage and won't
-   * affect any payments
-   */
-  name?: string | null;
-  party_address?: ExternalAccountUpdateParams.PartyAddress;
-  /**
-   * If this value isn't provided, it will be inherited from the counterparty's name.
-   */
-  party_name?: string;
-  /**
-   * Either `individual` or `business`.
-   */
-  party_type?: 'business' | 'individual' | null;
-}
-export declare namespace ExternalAccountUpdateParams {
-  interface PartyAddress {
     /**
-     * Country code conforms to [ISO 3166-1 alpha-2]
+     * Can be `checking`, `savings` or `other`.
      */
-    country?: string | null;
-    line1?: string | null;
-    line2?: string | null;
+    account_type?: ExternalAccountType;
+    counterparty_id?: string | null;
     /**
-     * Locality or City.
+     * Additional data in the form of key-value pairs. Pairs can be removed by passing
+     * an empty string or `null` as the value.
      */
-    locality?: string | null;
+    metadata?: Record<string, string>;
+    /**
+     * A nickname for the external account. This is only for internal usage and won't
+     * affect any payments
+     */
+    name?: string | null;
+    party_address?: ExternalAccountUpdateParams.PartyAddress;
     /**
-     * The postal code of the address.
+     * If this value isn't provided, it will be inherited from the counterparty's name.
      */
-    postal_code?: string | null;
+    party_name?: string;
     /**
-     * Region or State.
+     * Either `individual` or `business`.
      */
-    region?: string | null;
-  }
+    party_type?: 'business' | 'individual' | null;
+}
+export declare namespace ExternalAccountUpdateParams {
+    interface PartyAddress {
+        /**
+         * Country code conforms to [ISO 3166-1 alpha-2]
+         */
+        country?: string | null;
+        line1?: string | null;
+        line2?: string | null;
+        /**
+         * Locality or City.
+         */
+        locality?: string | null;
+        /**
+         * The postal code of the address.
+         */
+        postal_code?: string | null;
+        /**
+         * Region or State.
+         */
+        region?: string | null;
+    }
 }
 export interface ExternalAccountListParams extends PageParams {
-  counterparty_id?: string;
-  /**
-   * For example, if you want to query for records with metadata key `Type` and value
-   * `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-   * parameters.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * Searches the ExternalAccount's party_name AND the Counterparty's party_name
-   */
-  party_name?: string;
+    counterparty_id?: string;
+    /**
+     * For example, if you want to query for records with metadata key `Type` and value
+     * `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+     * parameters.
+     */
+    metadata?: Record<string, string>;
+    /**
+     * Searches the ExternalAccount's party_name AND the Counterparty's party_name
+     */
+    party_name?: string;
 }
 export interface ExternalAccountCompleteVerificationParams {
-  amounts?: Array<number>;
+    amounts?: Array<number>;
 }
 export interface ExternalAccountVerifyParams {
-  /**
-   * The ID of the internal account where the micro-deposits originate from. Both
-   * credit and debit capabilities must be enabled.
-   */
-  originating_account_id: string;
-  /**
-   * Both ach and eft are supported payment types.
-   */
-  payment_type:
-    | 'ach'
-    | 'au_becs'
-    | 'bacs'
-    | 'book'
-    | 'card'
-    | 'check'
-    | 'cross_border'
-    | 'eft'
-    | 'interac'
-    | 'masav'
-    | 'neft'
-    | 'nics'
-    | 'provxchange'
-    | 'rtp'
-    | 'se_bankgirot'
-    | 'sen'
-    | 'sepa'
-    | 'sic'
-    | 'signet'
-    | 'wire'
-    | 'zengin';
-  /**
-   * Defaults to the currency of the originating account.
-   */
-  currency?: Shared.Currency | null;
+    /**
+     * The ID of the internal account where the micro-deposits originate from. Both
+     * credit and debit capabilities must be enabled.
+     */
+    originating_account_id: string;
+    /**
+     * Both ach and eft are supported payment types.
+     */
+    payment_type: 'ach' | 'au_becs' | 'bacs' | 'book' | 'card' | 'check' | 'cross_border' | 'eft' | 'interac' | 'masav' | 'neft' | 'nics' | 'provxchange' | 'rtp' | 'se_bankgirot' | 'sen' | 'sepa' | 'sic' | 'signet' | 'wire' | 'zengin';
+    /**
+     * Defaults to the currency of the originating account.
+     */
+    currency?: Shared.Currency | null;
 }
 export declare namespace ExternalAccounts {
-  export import ExternalAccount = API.ExternalAccount;
-  export import ExternalAccountType = API.ExternalAccountType;
-  type ExternalAccountsPage = _ExternalAccountsPage;
-  export import ExternalAccountCreateParams = API.ExternalAccountCreateParams;
-  export import ExternalAccountUpdateParams = API.ExternalAccountUpdateParams;
-  export import ExternalAccountListParams = API.ExternalAccountListParams;
-  export import ExternalAccountCompleteVerificationParams = API.ExternalAccountCompleteVerificationParams;
-  export import ExternalAccountVerifyParams = API.ExternalAccountVerifyParams;
+    export import ExternalAccount = API.ExternalAccount;
+    export import ExternalAccountType = API.ExternalAccountType;
+    type ExternalAccountsPage = _ExternalAccountsPage;
+    export import ExternalAccountCreateParams = API.ExternalAccountCreateParams;
+    export import ExternalAccountUpdateParams = API.ExternalAccountUpdateParams;
+    export import ExternalAccountListParams = API.ExternalAccountListParams;
+    export import ExternalAccountCompleteVerificationParams = API.ExternalAccountCompleteVerificationParams;
+    export import ExternalAccountVerifyParams = API.ExternalAccountVerifyParams;
 }
 export {};
-//# sourceMappingURL=external-accounts.d.ts.map
+//# sourceMappingURL=external-accounts.d.ts.map