@augustusbank/typescript-sdk 0.26.0 → 0.28.0

package/src/resources/accounts.ts

@@ -145,9 +145,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 +181,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 +268,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 +342,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 +378,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 +465,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 +539,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 +575,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 +662,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 +736,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 +772,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 +859,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 +933,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 +969,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 +1056,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 +1168,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 +1204,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 +1291,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).
      */
@@ -1299,7 +1389,8 @@ export interface AccountCloseParams {
 
 export interface AccountRetrieveBalanceParams {
   /**
-   * ISO 8601 UTC timestamp to retrieve balance at.
+   * ISO 8601 UTC timestamp to retrieve balance at. Must be at least 5 minutes in the
+   * past.
    */
   as_of?: string;
 }