modern-treasury 2.6.0 → 2.7.2

package/resources/counterparties.d.ts

@@ -3,524 +3,458 @@ import { APIResource } from 'modern-treasury/resource';
 import * as AccountDetails from 'modern-treasury/resources/account-details';
 import * as ExternalAccounts from 'modern-treasury/resources/external-accounts';
 import * as RoutingDetails from 'modern-treasury/resources/routing-details';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { Page, PageParams } from 'modern-treasury/pagination';
 export declare class Counterparties extends APIResource {
-  /**
-   * Create a new counterparty.
-   */
-  create(params: CounterpartyCreateParams, options?: Core.RequestOptions): Core.APIPromise<Counterparty>;
-  /**
-   * Get details on a single counterparty.
-   */
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Counterparty>;
-  /**
-   * Updates a given counterparty with new information.
-   */
-  update(
-    id: string,
-    body?: CounterpartyUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Counterparty>;
-  update(id: string, options?: Core.RequestOptions): Core.APIPromise<Counterparty>;
-  /**
-   * Get a paginated list of all counterparties.
-   */
-  list(
-    query?: CounterpartyListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<CounterpartiesPage, Counterparty>;
-  list(options?: Core.RequestOptions): Core.PagePromise<CounterpartiesPage, Counterparty>;
-  /**
-   * Deletes a given counterparty.
-   */
-  del(id: string, options?: Core.RequestOptions): Core.APIPromise<void>;
-  /**
-   * Send an email requesting account details.
-   */
-  collectAccount(
-    id: string,
-    params: CounterpartyCollectAccountParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<CounterpartyCollectAccountResponse>;
+    /**
+     * Create a new counterparty.
+     */
+    create(params: CounterpartyCreateParams, options?: Core.RequestOptions): Core.APIPromise<Counterparty>;
+    /**
+     * Get details on a single counterparty.
+     */
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Counterparty>;
+    /**
+     * Updates a given counterparty with new information.
+     */
+    update(id: string, body?: CounterpartyUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Counterparty>;
+    update(id: string, options?: Core.RequestOptions): Core.APIPromise<Counterparty>;
+    /**
+     * Get a paginated list of all counterparties.
+     */
+    list(query?: CounterpartyListParams, options?: Core.RequestOptions): Core.PagePromise<CounterpartiesPage, Counterparty>;
+    list(options?: Core.RequestOptions): Core.PagePromise<CounterpartiesPage, Counterparty>;
+    /**
+     * Deletes a given counterparty.
+     */
+    del(id: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * Send an email requesting account details.
+     */
+    collectAccount(id: string, params: CounterpartyCollectAccountParams, options?: Core.RequestOptions): Core.APIPromise<CounterpartyCollectAccountResponse>;
+}
+export declare class CounterpartiesPage extends Page<Counterparty> {
 }
-export declare class CounterpartiesPage extends Page<Counterparty> {}
 type _CounterpartiesPage = CounterpartiesPage;
 export interface Counterparty {
-  id: string;
-  /**
-   * The accounts for this counterparty.
-   */
-  accounts: Array<Counterparty.Account>;
-  created_at: string;
-  discarded_at: string | null;
-  /**
-   * The counterparty's email.
-   */
-  email: 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 human friendly name for this counterparty.
-   */
-  name: string | null;
-  object: string;
-  /**
-   * Send an email to the counterparty whenever an associated payment order is sent
-   * to the bank.
-   */
-  send_remittance_advice: boolean;
-  updated_at: string;
-  /**
-   * The verification status of the counterparty.
-   */
-  verification_status: 'denied' | 'needs_approval' | 'unverified' | 'verified';
-}
-export declare namespace Counterparty {
-  interface Account {
-    id?: string;
-    account_details?: Array<AccountDetails.AccountDetail>;
+    id: string;
     /**
-     * Can be `checking`, `savings` or `other`.
+     * The accounts for this counterparty.
      */
-    account_type?: ExternalAccounts.ExternalAccountType;
-    contact_details?: Array<Account.ContactDetail>;
-    created_at?: string;
-    discarded_at?: string | null;
+    accounts: Array<Counterparty.Account>;
+    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.
+     * The counterparty's email.
      */
-    ledger_account_id?: string | null;
+    email: 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;
+    live_mode: boolean;
     /**
      * Additional data represented as key-value pairs. Both the key and value must be
      * strings.
      */
-    metadata?: Record<string, string>;
+    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?: Account.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';
-  }
-  namespace Account {
-    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;
-    }
+     * A human friendly name for this counterparty.
+     */
+    name: string | null;
+    object: string;
+    /**
+     * Send an email to the counterparty whenever an associated payment order is sent
+     * to the bank.
+     */
+    send_remittance_advice: boolean;
+    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;
+     * The verification status of the counterparty.
+     */
+    verification_status: 'denied' | 'needs_approval' | 'unverified' | 'verified';
+}
+export declare namespace Counterparty {
+    interface Account {
+        id?: string;
+        account_details?: Array<AccountDetails.AccountDetail>;
+        /**
+         * Can be `checking`, `savings` or `other`.
+         */
+        account_type?: ExternalAccounts.ExternalAccountType;
+        contact_details?: Array<Account.ContactDetail>;
+        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?: Account.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';
+    }
+    namespace Account {
+        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;
+        }
     }
-  }
 }
 export interface CounterpartyCollectAccountResponse {
-  /**
-   * The id of the existing counterparty.
-   */
-  id: string;
-  /**
-   * This is the link to the secure Modern Treasury form. By default, Modern Treasury
-   * will send an email to your counterparty that includes a link to this form.
-   * However, if `send_email` is passed as `false` in the body then Modern Treasury
-   * will not send the email and you can send it to the counterparty directly.
-   */
-  form_link: string;
-  /**
-   * This field will be `true` if an email requesting account details has already
-   * been sent to this counterparty.
-   */
-  is_resend: boolean;
+    /**
+     * The id of the existing counterparty.
+     */
+    id: string;
+    /**
+     * This is the link to the secure Modern Treasury form. By default, Modern Treasury
+     * will send an email to your counterparty that includes a link to this form.
+     * However, if `send_email` is passed as `false` in the body then Modern Treasury
+     * will not send the email and you can send it to the counterparty directly.
+     */
+    form_link: string;
+    /**
+     * This field will be `true` if an email requesting account details has already
+     * been sent to this counterparty.
+     */
+    is_resend: boolean;
 }
 export interface CounterpartyCreateParams {
-  /**
-   * A human friendly name for this counterparty.
-   */
-  name: string | null;
-  accounting?: CounterpartyCreateParams.Accounting;
-  /**
-   * The accounts for this counterparty.
-   */
-  accounts?: Array<CounterpartyCreateParams.Account>;
-  /**
-   * The counterparty's email.
-   */
-  email?: string | null;
-  /**
-   * An optional type to auto-sync the counterparty to your ledger. Either `customer`
-   * or `vendor`.
-   */
-  ledger_type?: 'customer' | 'vendor';
-  /**
-   * Additional data represented as key-value pairs. Both the key and value must be
-   * strings.
-   */
-  metadata?: Record<string, string>;
-  /**
-   * Send an email to the counterparty whenever an associated payment order is sent
-   * to the bank.
-   */
-  send_remittance_advice?: boolean;
-  /**
-   * Either a valid SSN or EIN.
-   */
-  taxpayer_identifier?: string;
-  /**
-   * The verification status of the counterparty.
-   */
-  verification_status?: 'denied' | 'needs_approval' | 'unverified' | 'verified';
-}
-export declare namespace CounterpartyCreateParams {
-  interface Accounting {
     /**
-     * An optional type to auto-sync the counterparty to your ledger. Either `customer`
-     * or `vendor`.
+     * A human friendly name for this counterparty.
      */
-    type?: 'customer' | 'vendor';
-  }
-  interface Account {
-    account_details?: Array<Account.AccountDetail>;
+    name: string | null;
+    accounting?: CounterpartyCreateParams.Accounting;
     /**
-     * Can be `checking`, `savings` or `other`.
+     * The accounts for this counterparty.
      */
-    account_type?: ExternalAccounts.ExternalAccountType;
-    contact_details?: Array<Account.ContactDetail>;
+    accounts?: Array<CounterpartyCreateParams.Account>;
     /**
-     * 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.
+     * The counterparty's email.
+     */
+    email?: string | null;
+    /**
+     * An optional type to auto-sync the counterparty to your ledger. Either `customer`
+     * or `vendor`.
      */
-    ledger_account?: Account.LedgerAccount;
+    ledger_type?: 'customer' | 'vendor';
     /**
      * 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
+     * Send an email to the counterparty whenever an associated payment order is sent
+     * to the bank.
      */
-    name?: string | null;
+    send_remittance_advice?: boolean;
     /**
-     * Required if receiving wire payments.
+     * Either a valid SSN or EIN.
      */
-    party_address?: Account.PartyAddress;
-    party_identifier?: string;
+    taxpayer_identifier?: string;
     /**
-     * If this value isn't provided, it will be inherited from the counterparty's name.
+     * The verification status of the counterparty.
      */
-    party_name?: string;
+    verification_status?: 'denied' | 'needs_approval' | 'unverified' | 'verified';
+}
+export declare namespace CounterpartyCreateParams {
+    interface Accounting {
+        /**
+         * An optional type to auto-sync the counterparty to your ledger. Either `customer`
+         * or `vendor`.
+         */
+        type?: 'customer' | 'vendor';
+    }
+    interface Account {
+        account_details?: Array<Account.AccountDetail>;
+        /**
+         * Can be `checking`, `savings` or `other`.
+         */
+        account_type?: ExternalAccounts.ExternalAccountType;
+        contact_details?: Array<Account.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?: Account.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?: Account.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<Account.RoutingDetail>;
+    }
+    namespace Account {
+        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 {
+            /**
+             * 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 CounterpartyUpdateParams {
     /**
-     * Either `individual` or `business`.
+     * A new email for the counterparty.
      */
-    party_type?: 'business' | 'individual' | null;
+    email?: string;
     /**
-     * If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
-     * you can pass the processor token in this field.
+     * Additional data in the form of key-value pairs. Pairs can be removed by passing
+     * an empty string or `null` as the value.
      */
-    plaid_processor_token?: string;
-    routing_details?: Array<Account.RoutingDetail>;
-  }
-  namespace Account {
-    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';
-    }
+    metadata?: Record<string, string>;
     /**
-     * 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 {
-      /**
-       * 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>;
-    }
+     * A new name for the counterparty. Will only update if passed.
+     */
+    name?: 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 CounterpartyUpdateParams {
-  /**
-   * A new email for the counterparty.
-   */
-  email?: string;
-  /**
-   * 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 new name for the counterparty. Will only update if passed.
-   */
-  name?: string;
-  /**
-   * If this is `true`, Modern Treasury will send an email to the counterparty
-   * whenever an associated payment order is sent to the bank.
-   */
-  send_remittance_advice?: boolean;
-  /**
-   * Either a valid SSN or EIN.
-   */
-  taxpayer_identifier?: string;
+     * If this is `true`, Modern Treasury will send an email to the counterparty
+     * whenever an associated payment order is sent to the bank.
+     */
+    send_remittance_advice?: boolean;
+    /**
+     * Either a valid SSN or EIN.
+     */
+    taxpayer_identifier?: string;
 }
 export interface CounterpartyListParams extends PageParams {
-  /**
-   * Used to return counterparties created after some datetime.
-   */
-  created_at_lower_bound?: string;
-  /**
-   * Used to return counterparties created before some datetime.
-   */
-  created_at_upper_bound?: string;
-  /**
-   * Performs a partial string match of the email field. This is also case
-   * insensitive.
-   */
-  email?: 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>;
-  /**
-   * Performs a partial string match of the name field. This is also case
-   * insensitive.
-   */
-  name?: string;
+    /**
+     * Used to return counterparties created after some datetime.
+     */
+    created_at_lower_bound?: string;
+    /**
+     * Used to return counterparties created before some datetime.
+     */
+    created_at_upper_bound?: string;
+    /**
+     * Performs a partial string match of the email field. This is also case
+     * insensitive.
+     */
+    email?: 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>;
+    /**
+     * Performs a partial string match of the name field. This is also case
+     * insensitive.
+     */
+    name?: string;
 }
 export interface CounterpartyCollectAccountParams {
-  /**
-   * One of `credit` or `debit`. Use `credit` when you want to pay a counterparty.
-   * Use `debit` when you need to charge a counterparty. This field helps us send a
-   * more tailored email to your counterparties."
-   */
-  direction: 'credit' | 'debit';
-  /**
-   * The URL you want your customer to visit upon filling out the form. By default,
-   * they will be sent to a Modern Treasury landing page. This must be a valid HTTPS
-   * URL if set.
-   */
-  custom_redirect?: string;
-  /**
-   * The list of fields you want on the form. This field is optional and if it is not
-   * set, will default to [\"nameOnAccount\", \"accountType\", \"accountNumber\",
-   * \"routingNumber\", \"address\"]. The full list of options is [\"name\",
-   * \"nameOnAccount\", \"taxpayerIdentifier\", \"accountType\", \"accountNumber\",
-   * \"routingNumber\", \"address\", \"ibanNumber\", \"swiftCode\"].
-   */
-  fields?: Array<
-    | 'name'
-    | 'nameOnAccount'
-    | 'taxpayerIdentifier'
-    | 'accountType'
-    | 'accountNumber'
-    | 'ibanNumber'
-    | 'clabeNumber'
-    | 'walletAddress'
-    | 'panNumber'
-    | 'routingNumber'
-    | 'abaWireRoutingNumber'
-    | 'swiftCode'
-    | 'auBsb'
-    | 'caCpa'
-    | 'cnaps'
-    | 'gbSortCode'
-    | 'inIfsc'
-    | 'myBranchCode'
-    | 'brCodigo'
-    | 'routingNumberType'
-    | 'address'
-    | 'jp_zengin_code'
-  >;
-  /**
-   * By default, Modern Treasury will send an email to your counterparty that
-   * includes a link to the form they must fill out. However, if you would like to
-   * send the counterparty the link, you can set this parameter to `false`. The JSON
-   * body will include the link to the secure Modern Treasury form.
-   */
-  send_email?: boolean;
+    /**
+     * One of `credit` or `debit`. Use `credit` when you want to pay a counterparty.
+     * Use `debit` when you need to charge a counterparty. This field helps us send a
+     * more tailored email to your counterparties."
+     */
+    direction: 'credit' | 'debit';
+    /**
+     * The URL you want your customer to visit upon filling out the form. By default,
+     * they will be sent to a Modern Treasury landing page. This must be a valid HTTPS
+     * URL if set.
+     */
+    custom_redirect?: string;
+    /**
+     * The list of fields you want on the form. This field is optional and if it is not
+     * set, will default to [\"nameOnAccount\", \"accountType\", \"accountNumber\",
+     * \"routingNumber\", \"address\"]. The full list of options is [\"name\",
+     * \"nameOnAccount\", \"taxpayerIdentifier\", \"accountType\", \"accountNumber\",
+     * \"routingNumber\", \"address\", \"ibanNumber\", \"swiftCode\"].
+     */
+    fields?: Array<'name' | 'nameOnAccount' | 'taxpayerIdentifier' | 'accountType' | 'accountNumber' | 'ibanNumber' | 'clabeNumber' | 'walletAddress' | 'panNumber' | 'routingNumber' | 'abaWireRoutingNumber' | 'swiftCode' | 'auBsb' | 'caCpa' | 'cnaps' | 'gbSortCode' | 'inIfsc' | 'myBranchCode' | 'brCodigo' | 'routingNumberType' | 'address' | 'jp_zengin_code'>;
+    /**
+     * By default, Modern Treasury will send an email to your counterparty that
+     * includes a link to the form they must fill out. However, if you would like to
+     * send the counterparty the link, you can set this parameter to `false`. The JSON
+     * body will include the link to the secure Modern Treasury form.
+     */
+    send_email?: boolean;
 }
 export declare namespace Counterparties {
-  export import Counterparty = API.Counterparty;
-  export import CounterpartyCollectAccountResponse = API.CounterpartyCollectAccountResponse;
-  type CounterpartiesPage = _CounterpartiesPage;
-  export import CounterpartyCreateParams = API.CounterpartyCreateParams;
-  export import CounterpartyUpdateParams = API.CounterpartyUpdateParams;
-  export import CounterpartyListParams = API.CounterpartyListParams;
-  export import CounterpartyCollectAccountParams = API.CounterpartyCollectAccountParams;
+    export import Counterparty = API.Counterparty;
+    export import CounterpartyCollectAccountResponse = API.CounterpartyCollectAccountResponse;
+    type CounterpartiesPage = _CounterpartiesPage;
+    export import CounterpartyCreateParams = API.CounterpartyCreateParams;
+    export import CounterpartyUpdateParams = API.CounterpartyUpdateParams;
+    export import CounterpartyListParams = API.CounterpartyListParams;
+    export import CounterpartyCollectAccountParams = API.CounterpartyCollectAccountParams;
 }
 export {};
-//# sourceMappingURL=counterparties.d.ts.map
+//# sourceMappingURL=counterparties.d.ts.map