@augustusbank/typescript-sdk 0.27.0 → 0.29.0

package/src/resources/accounts.ts

@@ -43,13 +43,18 @@ export class Accounts extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const accountListResponse of client.accounts.list()) {
+   * for await (const accountListResponse of client.accounts.list(
+   *   {
+   *     account_program_id:
+   *       '550e8400-e29b-41d4-a716-446655440002',
+   *   },
+   * )) {
    *   // ...
    * }
    * ```
    */
   list(
-    query: AccountListParams | null | undefined = {},
+    query: AccountListParams,
     options?: RequestOptions,
   ): PagePromise<AccountListResponsesCursorPage, AccountListResponse> {
     return this._client.getAPIList('/v1/accounts', CursorPage<AccountListResponse>, { query, ...options });
@@ -145,9 +150,9 @@ export interface AccountCreateResponse {
    * this account can send or receive funds.
    */
   financial_addresses: Array<
+    | AccountCreateResponse.AbaFinancialAddress
     | AccountCreateResponse.IbanFinancialAddress
     | AccountCreateResponse.SortCodeFinancialAddress
-    | AccountCreateResponse.AbaFinancialAddress
     | AccountCreateResponse.BicFinancialAddress
     | AccountCreateResponse.CryptoWalletFinancialAddress
   >;
@@ -181,70 +186,80 @@ export interface AccountCreateResponse {
 }
 
 export namespace AccountCreateResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -258,6 +273,11 @@ export namespace AccountCreateResponse {
      */
     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).
      */
@@ -327,9 +347,9 @@ export interface AccountRetrieveResponse {
    * this account can send or receive funds.
    */
   financial_addresses: Array<
+    | AccountRetrieveResponse.AbaFinancialAddress
     | AccountRetrieveResponse.IbanFinancialAddress
     | AccountRetrieveResponse.SortCodeFinancialAddress
-    | AccountRetrieveResponse.AbaFinancialAddress
     | AccountRetrieveResponse.BicFinancialAddress
     | AccountRetrieveResponse.CryptoWalletFinancialAddress
   >;
@@ -363,70 +383,80 @@ export interface AccountRetrieveResponse {
 }
 
 export namespace AccountRetrieveResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -440,6 +470,11 @@ export namespace AccountRetrieveResponse {
      */
     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).
      */
@@ -509,9 +544,9 @@ export interface AccountListResponse {
    * this account can send or receive funds.
    */
   financial_addresses: Array<
+    | AccountListResponse.AbaFinancialAddress
     | AccountListResponse.IbanFinancialAddress
     | AccountListResponse.SortCodeFinancialAddress
-    | AccountListResponse.AbaFinancialAddress
     | AccountListResponse.BicFinancialAddress
     | AccountListResponse.CryptoWalletFinancialAddress
   >;
@@ -545,70 +580,80 @@ export interface AccountListResponse {
 }
 
 export namespace AccountListResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -622,6 +667,11 @@ export namespace AccountListResponse {
      */
     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).
      */
@@ -691,9 +741,9 @@ export interface AccountCloseResponse {
    * this account can send or receive funds.
    */
   financial_addresses: Array<
+    | AccountCloseResponse.AbaFinancialAddress
     | AccountCloseResponse.IbanFinancialAddress
     | AccountCloseResponse.SortCodeFinancialAddress
-    | AccountCloseResponse.AbaFinancialAddress
     | AccountCloseResponse.BicFinancialAddress
     | AccountCloseResponse.CryptoWalletFinancialAddress
   >;
@@ -727,70 +777,80 @@ export interface AccountCloseResponse {
 }
 
 export namespace AccountCloseResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -804,6 +864,11 @@ export namespace AccountCloseResponse {
      */
     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).
      */
@@ -873,9 +938,9 @@ export interface AccountFreezeResponse {
    * this account can send or receive funds.
    */
   financial_addresses: Array<
+    | AccountFreezeResponse.AbaFinancialAddress
     | AccountFreezeResponse.IbanFinancialAddress
     | AccountFreezeResponse.SortCodeFinancialAddress
-    | AccountFreezeResponse.AbaFinancialAddress
     | AccountFreezeResponse.BicFinancialAddress
     | AccountFreezeResponse.CryptoWalletFinancialAddress
   >;
@@ -909,70 +974,80 @@ export interface AccountFreezeResponse {
 }
 
 export namespace AccountFreezeResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -986,6 +1061,11 @@ export namespace AccountFreezeResponse {
      */
     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).
      */
@@ -1093,9 +1173,9 @@ export interface AccountUnfreezeResponse {
    * this account can send or receive funds.
    */
   financial_addresses: Array<
+    | AccountUnfreezeResponse.AbaFinancialAddress
     | AccountUnfreezeResponse.IbanFinancialAddress
     | AccountUnfreezeResponse.SortCodeFinancialAddress
-    | AccountUnfreezeResponse.AbaFinancialAddress
     | AccountUnfreezeResponse.BicFinancialAddress
     | AccountUnfreezeResponse.CryptoWalletFinancialAddress
   >;
@@ -1129,70 +1209,80 @@ export interface AccountUnfreezeResponse {
 }
 
 export namespace AccountUnfreezeResponse {
-  export interface IbanFinancialAddress {
+  export interface AbaFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank Identifier Code, or null if not provided.
+     * Bank account number.
      */
-    bic: string | null;
+    account_number: string;
 
     /**
-     * International Bank Account Number.
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    iban: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
+
+    /**
+     * Discriminator for ABA wire financial address.
+     */
+    type: 'aba';
   }
 
-  export interface SortCodeFinancialAddress {
+  export interface IbanFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * Whether the account is a checking or a savings account, or null if not provided.
      */
-    account_number: string;
+    account_type: 'checking' | 'savings' | null;
 
     /**
-     * UK sort code (6 digits).
+     * Bank Identifier Code, or null if not provided.
      */
-    sort_code: string;
+    bic: string | null;
 
     /**
-     * Discriminator for UK sort code financial address.
+     * International Bank Account Number.
      */
-    type: 'sort_code';
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
   }
 
-  export interface AbaFinancialAddress {
+  export interface SortCodeFinancialAddress {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * Bank account number.
+     * UK account number (8 digits).
      */
     account_number: string;
 
     /**
-     * ABA routing number (9 digits).
+     * UK sort code (6 digits).
      */
-    routing_number: string;
+    sort_code: string;
 
     /**
-     * Discriminator for ABA wire financial address.
+     * Discriminator for UK sort code financial address.
      */
-    type: 'aba';
+    type: 'sort_code';
   }
 
   export interface BicFinancialAddress {
@@ -1206,6 +1296,11 @@ export namespace AccountUnfreezeResponse {
      */
     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).
      */
@@ -1269,6 +1364,11 @@ export interface AccountCreateParams {
 }
 
 export interface AccountListParams extends CursorPageParams {
+  /**
+   * ID of the account program to list accounts for.
+   */
+  account_program_id: string;
+
   /**
    * Filter by account holder name (case-insensitive phrase match).
    */
@@ -1279,11 +1379,6 @@ export interface AccountListParams extends CursorPageParams {
    */
   account_number?: string;
 
-  /**
-   * ID of the account program to list accounts for.
-   */
-  account_program_id?: string;
-
   /**
    * Filter by account status.
    */