@augustusbank/typescript-sdk 0.27.0 → 0.28.0

package/src/resources/payouts.ts

@@ -16,7 +16,7 @@ export class Payouts extends APIResource {
    *   account_id: '550e8400-e29b-41d4-a716-44665544000b',
    *   amount: '100.50',
    *   counterparty_id: '550e8400-e29b-41d4-a716-446655440000',
-   *   currency: 'EUR',
+   *   currency: 'USD',
    * });
    * ```
    */

package/src/resources/simulations/account-programs.ts

@@ -62,8 +62,9 @@ export class AccountPrograms extends APIResource {
    *     {
    *       destination: {
    *         account_holder_name: 'Acme Sandbox Ltd.',
-   *         iban: 'DE89370400440532013000',
-   *         type: 'iban',
+   *         account_number: '000123456789',
+   *         routing_number: '110000000',
+   *         type: 'aba',
    *       },
    *     },
    *   );
@@ -185,7 +186,7 @@ export interface AccountProgramCreateParams {
   /**
    * Account program type.
    */
-  type: 'fbo_program' | 'fbo_sponsored';
+  type: 'fbo_program' | 'fbo_sponsored' | 'operating' | 'crypto';
 }
 
 export interface AccountProgramCloseParams {
@@ -201,76 +202,92 @@ export interface AccountProgramDrainParams {
    * under the program is drained.
    */
   destination:
+    | AccountProgramDrainParams.AbaFinancialAddressRequest
     | AccountProgramDrainParams.IbanFinancialAddressRequest
-    | AccountProgramDrainParams.SortCodeFinancialAddressRequest
-    | AccountProgramDrainParams.AbaFinancialAddressRequest;
+    | AccountProgramDrainParams.SortCodeFinancialAddressRequest;
 }
 
 export namespace AccountProgramDrainParams {
-  export interface IbanFinancialAddressRequest {
+  export interface AbaFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * International Bank Account Number.
+     * Bank account number.
      */
-    iban: string;
+    account_number: string;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
 
     /**
-     * Bank Identifier Code. Optional; omit or send null if not provided.
+     * Discriminator for ABA wire financial address.
      */
-    bic?: string | null;
+    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;
   }
 
-  export interface SortCodeFinancialAddressRequest {
+  export interface IbanFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * International Bank Account Number.
      */
-    account_number: string;
+    iban: string;
 
     /**
-     * UK sort code (6 digits).
+     * Discriminator for IBAN financial address.
      */
-    sort_code: string;
+    type: 'iban';
 
     /**
-     * Discriminator for UK sort code financial address.
+     * 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.
      */
-    type: 'sort_code';
+    account_type?: 'checking' | 'savings' | null;
+
+    /**
+     * Bank Identifier Code. Optional; omit or send null if not provided.
+     */
+    bic?: string | null;
   }
 
-  export interface AbaFinancialAddressRequest {
+  export interface SortCodeFinancialAddressRequest {
     /**
      * 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';
   }
 }
 

package/src/resources/simulations/accounts.ts

@@ -13,7 +13,7 @@ export class Accounts extends APIResource {
    * @example
    * ```ts
    * const account = await client.simulations.accounts.create({
-   *   label: 'Operating EUR account',
+   *   label: 'Operating USD account',
    *   type: 'operating',
    * });
    * ```
@@ -51,8 +51,9 @@ export class Accounts extends APIResource {
    *   {
    *     destination: {
    *       account_holder_name: 'Acme Sandbox Ltd.',
-   *       iban: 'DE89370400440532013000',
-   *       type: 'iban',
+   *       account_number: '000123456789',
+   *       routing_number: '110000000',
+   *       type: 'aba',
    *     },
    *   },
    * );
@@ -184,76 +185,92 @@ export interface AccountDrainParams {
    * drained.
    */
   destination:
+    | AccountDrainParams.AbaFinancialAddressRequest
     | AccountDrainParams.IbanFinancialAddressRequest
-    | AccountDrainParams.SortCodeFinancialAddressRequest
-    | AccountDrainParams.AbaFinancialAddressRequest;
+    | AccountDrainParams.SortCodeFinancialAddressRequest;
 }
 
 export namespace AccountDrainParams {
-  export interface IbanFinancialAddressRequest {
+  export interface AbaFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * International Bank Account Number.
+     * Bank account number.
      */
-    iban: string;
+    account_number: string;
 
     /**
-     * Discriminator for IBAN financial address.
+     * ABA routing number (9 digits).
      */
-    type: 'iban';
+    routing_number: string;
 
     /**
-     * Bank Identifier Code. Optional; omit or send null if not provided.
+     * Discriminator for ABA wire financial address.
      */
-    bic?: string | null;
+    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;
   }
 
-  export interface SortCodeFinancialAddressRequest {
+  export interface IbanFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
     /**
-     * UK account number (8 digits).
+     * International Bank Account Number.
      */
-    account_number: string;
+    iban: string;
 
     /**
-     * UK sort code (6 digits).
+     * Discriminator for IBAN financial address.
      */
-    sort_code: string;
+    type: 'iban';
 
     /**
-     * Discriminator for UK sort code financial address.
+     * 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.
      */
-    type: 'sort_code';
+    account_type?: 'checking' | 'savings' | null;
+
+    /**
+     * Bank Identifier Code. Optional; omit or send null if not provided.
+     */
+    bic?: string | null;
   }
 
-  export interface AbaFinancialAddressRequest {
+  export interface SortCodeFinancialAddressRequest {
     /**
      * 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';
   }
 }
 

package/src/resources/simulations/deposits.ts

@@ -14,7 +14,7 @@ export class Deposits extends APIResource {
    * const deposit = await client.simulations.deposits.create({
    *   account_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *   amount: '100.50',
-   *   currency: 'EUR',
+   *   currency: 'USD',
    * });
    * ```
    */
@@ -95,9 +95,9 @@ export namespace DepositCreateParams {
      * Financial address of the counterparty.
      */
     financial_address:
+      | Counterparty.AbaFinancialAddressRequest
       | Counterparty.IbanFinancialAddressRequest
       | Counterparty.SortCodeFinancialAddressRequest
-      | Counterparty.AbaFinancialAddressRequest
       | Counterparty.BicFinancialAddressRequest
       | Counterparty.CryptoWalletFinancialAddress;
 
@@ -108,70 +108,86 @@ export namespace DepositCreateParams {
   }
 
   export namespace Counterparty {
-    export interface IbanFinancialAddressRequest {
+    export interface AbaFinancialAddressRequest {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * International Bank Account Number.
+       * Bank account number.
        */
-      iban: string;
+      account_number: string;
 
       /**
-       * Discriminator for IBAN financial address.
+       * ABA routing number (9 digits).
        */
-      type: 'iban';
+      routing_number: string;
 
       /**
-       * Bank Identifier Code. Optional; omit or send null if not provided.
+       * Discriminator for ABA wire financial address.
        */
-      bic?: string | null;
+      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;
     }
 
-    export interface SortCodeFinancialAddressRequest {
+    export interface IbanFinancialAddressRequest {
       /**
        * Name of the account holder.
        */
       account_holder_name: string;
 
       /**
-       * UK account number (8 digits).
+       * International Bank Account Number.
        */
-      account_number: string;
+      iban: string;
 
       /**
-       * UK sort code (6 digits).
+       * Discriminator for IBAN financial address.
        */
-      sort_code: string;
+      type: 'iban';
 
       /**
-       * Discriminator for UK sort code financial address.
+       * 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.
        */
-      type: 'sort_code';
+      account_type?: 'checking' | 'savings' | null;
+
+      /**
+       * Bank Identifier Code. Optional; omit or send null if not provided.
+       */
+      bic?: string | null;
     }
 
-    export interface AbaFinancialAddressRequest {
+    export interface SortCodeFinancialAddressRequest {
       /**
        * 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 BicFinancialAddressRequest {
@@ -195,6 +211,14 @@ export namespace DepositCreateParams {
        */
       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.

package/src/resources/transactions.ts

@@ -139,9 +139,9 @@ export namespace TransactionRetrieveResponse {
      * Financial address of the counterparty.
      */
     financial_address:
+      | Counterparty.AbaFinancialAddress
       | Counterparty.IbanFinancialAddress
       | Counterparty.SortCodeFinancialAddress
-      | Counterparty.AbaFinancialAddress
       | Counterparty.BicFinancialAddress
       | Counterparty.CryptoWalletFinancialAddress;
 
@@ -152,70 +152,80 @@ export namespace TransactionRetrieveResponse {
   }
 
   export namespace Counterparty {
-    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 {
@@ -229,6 +239,11 @@ export namespace TransactionRetrieveResponse {
        */
       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).
        */
@@ -683,9 +698,9 @@ export namespace TransactionListResponse {
      * Financial address of the counterparty.
      */
     financial_address:
+      | Counterparty.AbaFinancialAddress
       | Counterparty.IbanFinancialAddress
       | Counterparty.SortCodeFinancialAddress
-      | Counterparty.AbaFinancialAddress
       | Counterparty.BicFinancialAddress
       | Counterparty.CryptoWalletFinancialAddress;
 
@@ -696,70 +711,80 @@ export namespace TransactionListResponse {
   }
 
   export namespace Counterparty {
-    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 {
@@ -773,6 +798,11 @@ export namespace TransactionListResponse {
        */
       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).
        */