@augustusbank/typescript-sdk 0.27.0 → 0.28.0

package/resources/counterparties.d.mts

@@ -11,8 +11,9 @@ export declare class Counterparties extends APIResource {
      * const counterparty = await client.counterparties.create({
      *   financial_address: {
      *     account_holder_name: 'Acme Sandbox Ltd.',
-     *     iban: 'DE89370400440532013000',
-     *     type: 'iban',
+     *     account_number: '000123456789',
+     *     routing_number: '110000000',
+     *     type: 'aba',
      *   },
      * });
      * ```
@@ -67,6 +68,10 @@ export interface CounterpartyCreateResponse {
      * Date of birth in YYYY-MM-DD format, or null if not recorded.
      */
     date_of_birth: string | null;
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -74,12 +79,16 @@ export interface CounterpartyCreateResponse {
     /**
      * Financial address of the counterparty.
      */
-    financial_address: CounterpartyCreateResponse.IbanFinancialAddress | CounterpartyCreateResponse.SortCodeFinancialAddress | CounterpartyCreateResponse.AbaFinancialAddress | CounterpartyCreateResponse.BicFinancialAddress | CounterpartyCreateResponse.CryptoWalletFinancialAddress;
+    financial_address: CounterpartyCreateResponse.AbaFinancialAddress | CounterpartyCreateResponse.IbanFinancialAddress | CounterpartyCreateResponse.SortCodeFinancialAddress | CounterpartyCreateResponse.BicFinancialAddress | CounterpartyCreateResponse.CryptoWalletFinancialAddress;
     /**
      * Whether the counterparty is self-owned. `false` if the counterparty is not owned
      * by you, `true` if it is.
      */
     is_self_owned: boolean;
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -92,6 +101,10 @@ export interface CounterpartyCreateResponse {
      * Name of the counterparty, or null if not recorded.
      */
     name: string | null;
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -102,11 +115,37 @@ export interface CounterpartyCreateResponse {
     type: 'counterparty';
 }
 export declare namespace CounterpartyCreateResponse {
+    interface AbaFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Bank account number.
+         */
+        account_number: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
+        /**
+         * ABA routing number (9 digits).
+         */
+        routing_number: string;
+        /**
+         * Discriminator for ABA wire financial address.
+         */
+        type: 'aba';
+    }
     interface IbanFinancialAddress {
         /**
          * Name of the account holder.
          */
         account_holder_name: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
         /**
          * Bank Identifier Code, or null if not provided.
          */
@@ -138,24 +177,6 @@ export declare namespace CounterpartyCreateResponse {
          */
         type: 'sort_code';
     }
-    interface AbaFinancialAddress {
-        /**
-         * Name of the account holder.
-         */
-        account_holder_name: string;
-        /**
-         * Bank account number.
-         */
-        account_number: string;
-        /**
-         * ABA routing number (9 digits).
-         */
-        routing_number: string;
-        /**
-         * Discriminator for ABA wire financial address.
-         */
-        type: 'aba';
-    }
     interface BicFinancialAddress {
         /**
          * Name of the account holder.
@@ -165,6 +186,10 @@ export declare namespace CounterpartyCreateResponse {
          * Local-format bank account number.
          */
         account_number: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
         /**
          * ISO 9362 Bank Identifier Code (8 or 11 characters).
          */
@@ -236,6 +261,10 @@ export interface CounterpartyRetrieveResponse {
      * Date of birth in YYYY-MM-DD format, or null if not recorded.
      */
     date_of_birth: string | null;
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -243,12 +272,16 @@ export interface CounterpartyRetrieveResponse {
     /**
      * Financial address of the counterparty.
      */
-    financial_address: CounterpartyRetrieveResponse.IbanFinancialAddress | CounterpartyRetrieveResponse.SortCodeFinancialAddress | CounterpartyRetrieveResponse.AbaFinancialAddress | CounterpartyRetrieveResponse.BicFinancialAddress | CounterpartyRetrieveResponse.CryptoWalletFinancialAddress;
+    financial_address: CounterpartyRetrieveResponse.AbaFinancialAddress | CounterpartyRetrieveResponse.IbanFinancialAddress | CounterpartyRetrieveResponse.SortCodeFinancialAddress | CounterpartyRetrieveResponse.BicFinancialAddress | CounterpartyRetrieveResponse.CryptoWalletFinancialAddress;
     /**
      * Whether the counterparty is self-owned. `false` if the counterparty is not owned
      * by you, `true` if it is.
      */
     is_self_owned: boolean;
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -261,6 +294,10 @@ export interface CounterpartyRetrieveResponse {
      * Name of the counterparty, or null if not recorded.
      */
     name: string | null;
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -271,11 +308,37 @@ export interface CounterpartyRetrieveResponse {
     type: 'counterparty';
 }
 export declare namespace CounterpartyRetrieveResponse {
+    interface AbaFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Bank account number.
+         */
+        account_number: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
+        /**
+         * ABA routing number (9 digits).
+         */
+        routing_number: string;
+        /**
+         * Discriminator for ABA wire financial address.
+         */
+        type: 'aba';
+    }
     interface IbanFinancialAddress {
         /**
          * Name of the account holder.
          */
         account_holder_name: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
         /**
          * Bank Identifier Code, or null if not provided.
          */
@@ -307,24 +370,6 @@ export declare namespace CounterpartyRetrieveResponse {
          */
         type: 'sort_code';
     }
-    interface AbaFinancialAddress {
-        /**
-         * Name of the account holder.
-         */
-        account_holder_name: string;
-        /**
-         * Bank account number.
-         */
-        account_number: string;
-        /**
-         * ABA routing number (9 digits).
-         */
-        routing_number: string;
-        /**
-         * Discriminator for ABA wire financial address.
-         */
-        type: 'aba';
-    }
     interface BicFinancialAddress {
         /**
          * Name of the account holder.
@@ -334,6 +379,10 @@ export declare namespace CounterpartyRetrieveResponse {
          * Local-format bank account number.
          */
         account_number: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
         /**
          * ISO 9362 Bank Identifier Code (8 or 11 characters).
          */
@@ -405,6 +454,10 @@ export interface CounterpartyUpdateResponse {
      * Date of birth in YYYY-MM-DD format, or null if not recorded.
      */
     date_of_birth: string | null;
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -412,12 +465,16 @@ export interface CounterpartyUpdateResponse {
     /**
      * Financial address of the counterparty.
      */
-    financial_address: CounterpartyUpdateResponse.IbanFinancialAddress | CounterpartyUpdateResponse.SortCodeFinancialAddress | CounterpartyUpdateResponse.AbaFinancialAddress | CounterpartyUpdateResponse.BicFinancialAddress | CounterpartyUpdateResponse.CryptoWalletFinancialAddress;
+    financial_address: CounterpartyUpdateResponse.AbaFinancialAddress | CounterpartyUpdateResponse.IbanFinancialAddress | CounterpartyUpdateResponse.SortCodeFinancialAddress | CounterpartyUpdateResponse.BicFinancialAddress | CounterpartyUpdateResponse.CryptoWalletFinancialAddress;
     /**
      * Whether the counterparty is self-owned. `false` if the counterparty is not owned
      * by you, `true` if it is.
      */
     is_self_owned: boolean;
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -430,6 +487,10 @@ export interface CounterpartyUpdateResponse {
      * Name of the counterparty, or null if not recorded.
      */
     name: string | null;
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -440,11 +501,37 @@ export interface CounterpartyUpdateResponse {
     type: 'counterparty';
 }
 export declare namespace CounterpartyUpdateResponse {
+    interface AbaFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Bank account number.
+         */
+        account_number: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
+        /**
+         * ABA routing number (9 digits).
+         */
+        routing_number: string;
+        /**
+         * Discriminator for ABA wire financial address.
+         */
+        type: 'aba';
+    }
     interface IbanFinancialAddress {
         /**
          * Name of the account holder.
          */
         account_holder_name: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
         /**
          * Bank Identifier Code, or null if not provided.
          */
@@ -476,24 +563,6 @@ export declare namespace CounterpartyUpdateResponse {
          */
         type: 'sort_code';
     }
-    interface AbaFinancialAddress {
-        /**
-         * Name of the account holder.
-         */
-        account_holder_name: string;
-        /**
-         * Bank account number.
-         */
-        account_number: string;
-        /**
-         * ABA routing number (9 digits).
-         */
-        routing_number: string;
-        /**
-         * Discriminator for ABA wire financial address.
-         */
-        type: 'aba';
-    }
     interface BicFinancialAddress {
         /**
          * Name of the account holder.
@@ -503,6 +572,10 @@ export declare namespace CounterpartyUpdateResponse {
          * Local-format bank account number.
          */
         account_number: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
         /**
          * ISO 9362 Bank Identifier Code (8 or 11 characters).
          */
@@ -574,6 +647,10 @@ export interface CounterpartyListResponse {
      * Date of birth in YYYY-MM-DD format, or null if not recorded.
      */
     date_of_birth: string | null;
+    /**
+     * Email address of the counterparty, or null if not recorded.
+     */
+    email: string | null;
     /**
      * Whether the counterparty is a business or an individual.
      */
@@ -581,12 +658,16 @@ export interface CounterpartyListResponse {
     /**
      * Financial address of the counterparty.
      */
-    financial_address: CounterpartyListResponse.IbanFinancialAddress | CounterpartyListResponse.SortCodeFinancialAddress | CounterpartyListResponse.AbaFinancialAddress | CounterpartyListResponse.BicFinancialAddress | CounterpartyListResponse.CryptoWalletFinancialAddress;
+    financial_address: CounterpartyListResponse.AbaFinancialAddress | CounterpartyListResponse.IbanFinancialAddress | CounterpartyListResponse.SortCodeFinancialAddress | CounterpartyListResponse.BicFinancialAddress | CounterpartyListResponse.CryptoWalletFinancialAddress;
     /**
      * Whether the counterparty is self-owned. `false` if the counterparty is not owned
      * by you, `true` if it is.
      */
     is_self_owned: boolean;
+    /**
+     * National tax or identity number of the counterparty, or null if not recorded.
+     */
+    legal_id: string | null;
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -599,6 +680,10 @@ export interface CounterpartyListResponse {
      * Name of the counterparty, or null if not recorded.
      */
     name: string | null;
+    /**
+     * Phone number of the counterparty, or null if not recorded.
+     */
+    phone: string | null;
     /**
      * Physical address of the counterparty, or null if not recorded.
      */
@@ -609,11 +694,37 @@ export interface CounterpartyListResponse {
     type: 'counterparty';
 }
 export declare namespace CounterpartyListResponse {
+    interface AbaFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Bank account number.
+         */
+        account_number: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
+        /**
+         * ABA routing number (9 digits).
+         */
+        routing_number: string;
+        /**
+         * Discriminator for ABA wire financial address.
+         */
+        type: 'aba';
+    }
     interface IbanFinancialAddress {
         /**
          * Name of the account holder.
          */
         account_holder_name: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
         /**
          * Bank Identifier Code, or null if not provided.
          */
@@ -645,24 +756,6 @@ export declare namespace CounterpartyListResponse {
          */
         type: 'sort_code';
     }
-    interface AbaFinancialAddress {
-        /**
-         * Name of the account holder.
-         */
-        account_holder_name: string;
-        /**
-         * Bank account number.
-         */
-        account_number: string;
-        /**
-         * ABA routing number (9 digits).
-         */
-        routing_number: string;
-        /**
-         * Discriminator for ABA wire financial address.
-         */
-        type: 'aba';
-    }
     interface BicFinancialAddress {
         /**
          * Name of the account holder.
@@ -672,6 +765,10 @@ export declare namespace CounterpartyListResponse {
          * Local-format bank account number.
          */
         account_number: string;
+        /**
+         * Whether the account is a checking or a savings account, or null if not provided.
+         */
+        account_type: 'checking' | 'savings' | null;
         /**
          * ISO 9362 Bank Identifier Code (8 or 11 characters).
          */
@@ -734,11 +831,16 @@ export interface CounterpartyCreateParams {
     /**
      * Financial address of the counterparty.
      */
-    financial_address: CounterpartyCreateParams.IbanFinancialAddressRequest | CounterpartyCreateParams.SortCodeFinancialAddressRequest | CounterpartyCreateParams.AbaFinancialAddressRequest | CounterpartyCreateParams.BicFinancialAddressRequest | CounterpartyCreateParams.CryptoWalletFinancialAddress;
+    financial_address: CounterpartyCreateParams.AbaFinancialAddressRequest | CounterpartyCreateParams.IbanFinancialAddressRequest | CounterpartyCreateParams.SortCodeFinancialAddressRequest | CounterpartyCreateParams.BicFinancialAddressRequest | CounterpartyCreateParams.CryptoWalletFinancialAddress;
     /**
      * Date of birth in YYYY-MM-DD format.
      */
     date_of_birth?: string;
+    /**
+     * Email address of the counterparty. Stored for operational contact only; it is
+     * not sent with payments.
+     */
+    email?: string;
     /**
      * Whether the counterparty is a business or an individual. Defaults to business.
      */
@@ -748,6 +850,12 @@ export interface CounterpartyCreateParams {
      * by you, `true` if it is.
      */
     is_self_owned?: boolean;
+    /**
+     * National tax or identity number of the counterparty, as issued in its country:
+     * CPF or CNPJ in Brazil, Cédula or NIT in Colombia, CUIL or CUIT in Argentina, DNI
+     * or RUC in Peru, RUT in Chile. Free text, up to 127 characters.
+     */
+    legal_id?: string;
     /**
      * Set of up to 50 key-value string pairs you can attach to store structured
      * information, such as correlating this resource with an object in your own
@@ -760,12 +868,42 @@ export interface CounterpartyCreateParams {
      * Name of the counterparty.
      */
     name?: string;
+    /**
+     * Phone number of the counterparty. Stored for operational contact only; it is not
+     * sent with payments.
+     */
+    phone?: string;
     /**
      * Physical address of the counterparty.
      */
     physical_address?: CounterpartyCreateParams.PhysicalAddress;
 }
 export declare namespace CounterpartyCreateParams {
+    interface AbaFinancialAddressRequest {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Bank account number.
+         */
+        account_number: string;
+        /**
+         * ABA routing number (9 digits).
+         */
+        routing_number: string;
+        /**
+         * Discriminator for ABA wire financial address.
+         */
+        type: 'aba';
+        /**
+         * Whether the account is a checking or a savings account. Optional; omit or send
+         * null if not provided. Some destination countries require it (for example the
+         * Dominican Republic, Honduras and Jamaica) and ACH uses it for the transaction
+         * code. A payment to an account without one is sent as checking.
+         */
+        account_type?: 'checking' | 'savings' | null;
+    }
     interface IbanFinancialAddressRequest {
         /**
          * Name of the account holder.
@@ -779,6 +917,13 @@ export declare namespace CounterpartyCreateParams {
          * Discriminator for IBAN financial address.
          */
         type: 'iban';
+        /**
+         * Whether the account is a checking or a savings account. Optional; omit or send
+         * null if not provided. Some destination countries require it (for example the
+         * Dominican Republic, Honduras and Jamaica) and ACH uses it for the transaction
+         * code. A payment to an account without one is sent as checking.
+         */
+        account_type?: 'checking' | 'savings' | null;
         /**
          * Bank Identifier Code. Optional; omit or send null if not provided.
          */
@@ -802,24 +947,6 @@ export declare namespace CounterpartyCreateParams {
          */
         type: 'sort_code';
     }
-    interface AbaFinancialAddressRequest {
-        /**
-         * Name of the account holder.
-         */
-        account_holder_name: string;
-        /**
-         * Bank account number.
-         */
-        account_number: string;
-        /**
-         * ABA routing number (9 digits).
-         */
-        routing_number: string;
-        /**
-         * Discriminator for ABA wire financial address.
-         */
-        type: 'aba';
-    }
     interface BicFinancialAddressRequest {
         /**
          * Name of the account holder.
@@ -837,6 +964,13 @@ export declare namespace CounterpartyCreateParams {
          * Discriminator for BIC + local account financial address.
          */
         type: 'bic';
+        /**
+         * Whether the account is a checking or a savings account. Optional; omit or send
+         * null if not provided. Some destination countries require it (for example the
+         * Dominican Republic, Honduras and Jamaica) and ACH uses it for the transaction
+         * code. A payment to an account without one is sent as checking.
+         */
+        account_type?: 'checking' | 'savings' | null;
         /**
          * Domestic bank or branch code where the destination country uses one (for example
          * the BSB in Australia). Optional; omit or send null where the country has none.
@@ -893,6 +1027,10 @@ export interface CounterpartyUpdateParams {
      * birth.
      */
     date_of_birth?: string | null;
+    /**
+     * New email address, or null to clear the current email address.
+     */
+    email?: string | null;
     /**
      * New entity type. Omit to keep the current entity type.
      */
@@ -901,10 +1039,18 @@ export interface CounterpartyUpdateParams {
      * New ownership status. Omit to keep the current ownership status.
      */
     is_self_owned?: boolean;
+    /**
+     * New legal identifier, or null to clear the current legal identifier.
+     */
+    legal_id?: string | null;
     /**
      * New name, or null to clear the current name.
      */
     name?: string | null;
+    /**
+     * New phone number, or null to clear the current phone number.
+     */
+    phone?: string | null;
     /**
      * New physical address, or null to clear the current physical address.
      */