@augustusbank/typescript-sdk 0.21.0 → 0.22.1

package/src/resources/account-programs.ts

@@ -31,8 +31,12 @@ export class AccountPrograms extends APIResource {
    * Returns the aggregated available balance for all virtual accounts under the
    * account program.
    */
-  retrieveBalance(id: string, options?: RequestOptions): APIPromise<AccountProgramRetrieveBalanceResponse> {
-    return this._client.get(path`/v1/account_programs/${id}/balance`, options);
+  retrieveBalance(
+    id: string,
+    query: AccountProgramRetrieveBalanceParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AccountProgramRetrieveBalanceResponse> {
+    return this._client.get(path`/v1/account_programs/${id}/balance`, { query, ...options });
   }
 }
 
@@ -44,12 +48,6 @@ export interface AccountProgramRetrieveResponse {
    */
   id: string;
 
-  /**
-   * Which for-benefit-of (FBO) program model applies: `fbo_program` (merchant
-   * program) or `fbo_sponsored` (sponsored program).
-   */
-  account_program_type: 'fbo_program' | 'fbo_sponsored';
-
   /**
    * ISO 8601 UTC timestamp when the account program was created.
    */
@@ -83,12 +81,6 @@ export interface AccountProgramListResponse {
    */
   id: string;
 
-  /**
-   * Which for-benefit-of (FBO) program model applies: `fbo_program` (merchant
-   * program) or `fbo_sponsored` (sponsored program).
-   */
-  account_program_type: 'fbo_program' | 'fbo_sponsored';
-
   /**
    * ISO 8601 UTC timestamp when the account program was created.
    */
@@ -122,10 +114,7 @@ export interface AccountProgramRetrieveBalanceResponse {
    */
   id: string;
 
-  /**
-   * Total available balance as a string decimal (e.g. "100.50").
-   */
-  amount: string;
+  amount: AccountProgramRetrieveBalanceResponse.Amount;
 
   /**
    * ISO 8601 UTC timestamp when this balance snapshot was produced.
@@ -133,7 +122,7 @@ export interface AccountProgramRetrieveBalanceResponse {
   as_of: string;
 
   /**
-   * ISO 4217 currency code for the balance.
+   * ISO 4217 currency code.
    */
   currency: 'EUR' | 'GBP' | 'USD';
 
@@ -143,8 +132,29 @@ export interface AccountProgramRetrieveBalanceResponse {
   type: 'account_program_balance';
 }
 
+export namespace AccountProgramRetrieveBalanceResponse {
+  export interface Amount {
+    /**
+     * Available balance as a string decimal (e.g. "100.50").
+     */
+    available: string;
+
+    /**
+     * Pending balance as a string decimal (e.g. "7.50").
+     */
+    pending: string;
+  }
+}
+
 export interface AccountProgramListParams extends CursorPageParams {}
 
+export interface AccountProgramRetrieveBalanceParams {
+  /**
+   * ISO 8601 UTC timestamp to retrieve balance at.
+   */
+  as_of?: string;
+}
+
 export declare namespace AccountPrograms {
   export {
     type AccountProgramRetrieveResponse as AccountProgramRetrieveResponse,
@@ -152,5 +162,6 @@ export declare namespace AccountPrograms {
     type AccountProgramRetrieveBalanceResponse as AccountProgramRetrieveBalanceResponse,
     type AccountProgramListResponsesCursorPage as AccountProgramListResponsesCursorPage,
     type AccountProgramListParams as AccountProgramListParams,
+    type AccountProgramRetrieveBalanceParams as AccountProgramRetrieveBalanceParams,
   };
 }

package/src/resources/accounts.ts

@@ -9,6 +9,15 @@ import { path } from '../internal/utils/path';
 export class Accounts extends APIResource {
   /**
    * Creates a new account.
+   *
+   * @example
+   * ```ts
+   * const account = await client.accounts.create({
+   *   account_holder_id: '68e0a1b2c3d4e5f60718293a',
+   *   account_program_id:
+   *     '550e8400-e29b-41d4-a716-446655440002',
+   * });
+   * ```
    */
   create(body: AccountCreateParams, options?: RequestOptions): APIPromise<AccountCreateResponse> {
     return this._client.post('/v1/accounts', { body, ...options });
@@ -16,6 +25,13 @@ export class Accounts extends APIResource {
 
   /**
    * Retrieves an account by ID.
+   *
+   * @example
+   * ```ts
+   * const account = await client.accounts.retrieve(
+   *   '550e8400-e29b-41d4-a716-446655440001',
+   * );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<AccountRetrieveResponse> {
     return this._client.get(path`/v1/accounts/${id}`, options);
@@ -23,6 +39,14 @@ export class Accounts extends APIResource {
 
   /**
    * Returns a paginated list of accounts.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const accountListResponse of client.accounts.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: AccountListParams | null | undefined = {},
@@ -33,6 +57,14 @@ export class Accounts extends APIResource {
 
   /**
    * Closes an account
+   *
+   * @example
+   * ```ts
+   * const response = await client.accounts.close(
+   *   '550e8400-e29b-41d4-a716-446655440001',
+   *   { reason: 'aml_risk_fraud' },
+   * );
+   * ```
    */
   close(id: string, body: AccountCloseParams, options?: RequestOptions): APIPromise<AccountCloseResponse> {
     return this._client.post(path`/v1/accounts/${id}/close`, { body, ...options });
@@ -40,6 +72,13 @@ export class Accounts extends APIResource {
 
   /**
    * Freezes an account
+   *
+   * @example
+   * ```ts
+   * const response = await client.accounts.freeze(
+   *   '550e8400-e29b-41d4-a716-446655440001',
+   * );
+   * ```
    */
   freeze(id: string, options?: RequestOptions): APIPromise<AccountFreezeResponse> {
     return this._client.post(path`/v1/accounts/${id}/freeze`, options);
@@ -47,13 +86,31 @@ export class Accounts extends APIResource {
 
   /**
    * Retrieves the available balance for an account.
-   */
-  retrieveBalance(id: string, options?: RequestOptions): APIPromise<AccountRetrieveBalanceResponse> {
-    return this._client.get(path`/v1/accounts/${id}/balance`, options);
+   *
+   * @example
+   * ```ts
+   * const response = await client.accounts.retrieveBalance(
+   *   '550e8400-e29b-41d4-a716-446655440001',
+   * );
+   * ```
+   */
+  retrieveBalance(
+    id: string,
+    query: AccountRetrieveBalanceParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AccountRetrieveBalanceResponse> {
+    return this._client.get(path`/v1/accounts/${id}/balance`, { query, ...options });
   }
 
   /**
    * Unfreezes an account
+   *
+   * @example
+   * ```ts
+   * const response = await client.accounts.unfreeze(
+   *   '550e8400-e29b-41d4-a716-446655440001',
+   * );
+   * ```
    */
   unfreeze(id: string, options?: RequestOptions): APIPromise<AccountUnfreezeResponse> {
     return this._client.post(path`/v1/accounts/${id}/unfreeze`, options);
@@ -68,11 +125,6 @@ export interface AccountCreateResponse {
    */
   id: string;
 
-  /**
-   * Type of the account.
-   */
-  account_type: 'virtual_account' | 'payment_account' | 'collateral_account';
-
   /**
    * Asset type of the account.
    */
@@ -84,7 +136,7 @@ export interface AccountCreateResponse {
   created_at: string;
 
   /**
-   * ISO 4217 currency code for the account.
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -96,6 +148,7 @@ export interface AccountCreateResponse {
     | AccountCreateResponse.IbanFinancialAddress
     | AccountCreateResponse.SortCodeFinancialAddress
     | AccountCreateResponse.AbaFinancialAddress
+    | AccountCreateResponse.BicFinancialAddress
     | AccountCreateResponse.CryptoWalletFinancialAddress
   >;
 
@@ -187,6 +240,34 @@ export namespace AccountCreateResponse {
     type: 'aba';
   }
 
+  export interface BicFinancialAddress {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Local-format bank account number.
+     */
+    account_number: string;
+
+    /**
+     * ISO 9362 Bank Identifier Code (8 or 11 characters).
+     */
+    bic: string;
+
+    /**
+     * Domestic bank or branch code where the destination country uses one (for example
+     * the BSB in Australia), or null.
+     */
+    local_bank_code: string | null;
+
+    /**
+     * Discriminator for BIC + local account financial address.
+     */
+    type: 'bic';
+  }
+
   export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
@@ -219,11 +300,6 @@ export interface AccountRetrieveResponse {
    */
   id: string;
 
-  /**
-   * Type of the account.
-   */
-  account_type: 'virtual_account' | 'payment_account' | 'collateral_account';
-
   /**
    * Asset type of the account.
    */
@@ -235,7 +311,7 @@ export interface AccountRetrieveResponse {
   created_at: string;
 
   /**
-   * ISO 4217 currency code for the account.
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -247,6 +323,7 @@ export interface AccountRetrieveResponse {
     | AccountRetrieveResponse.IbanFinancialAddress
     | AccountRetrieveResponse.SortCodeFinancialAddress
     | AccountRetrieveResponse.AbaFinancialAddress
+    | AccountRetrieveResponse.BicFinancialAddress
     | AccountRetrieveResponse.CryptoWalletFinancialAddress
   >;
 
@@ -338,6 +415,34 @@ export namespace AccountRetrieveResponse {
     type: 'aba';
   }
 
+  export interface BicFinancialAddress {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Local-format bank account number.
+     */
+    account_number: string;
+
+    /**
+     * ISO 9362 Bank Identifier Code (8 or 11 characters).
+     */
+    bic: string;
+
+    /**
+     * Domestic bank or branch code where the destination country uses one (for example
+     * the BSB in Australia), or null.
+     */
+    local_bank_code: string | null;
+
+    /**
+     * Discriminator for BIC + local account financial address.
+     */
+    type: 'bic';
+  }
+
   export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
@@ -370,11 +475,6 @@ export interface AccountListResponse {
    */
   id: string;
 
-  /**
-   * Type of the account.
-   */
-  account_type: 'virtual_account' | 'payment_account' | 'collateral_account';
-
   /**
    * Asset type of the account.
    */
@@ -386,7 +486,7 @@ export interface AccountListResponse {
   created_at: string;
 
   /**
-   * ISO 4217 currency code for the account.
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -398,6 +498,7 @@ export interface AccountListResponse {
     | AccountListResponse.IbanFinancialAddress
     | AccountListResponse.SortCodeFinancialAddress
     | AccountListResponse.AbaFinancialAddress
+    | AccountListResponse.BicFinancialAddress
     | AccountListResponse.CryptoWalletFinancialAddress
   >;
 
@@ -489,6 +590,34 @@ export namespace AccountListResponse {
     type: 'aba';
   }
 
+  export interface BicFinancialAddress {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Local-format bank account number.
+     */
+    account_number: string;
+
+    /**
+     * ISO 9362 Bank Identifier Code (8 or 11 characters).
+     */
+    bic: string;
+
+    /**
+     * Domestic bank or branch code where the destination country uses one (for example
+     * the BSB in Australia), or null.
+     */
+    local_bank_code: string | null;
+
+    /**
+     * Discriminator for BIC + local account financial address.
+     */
+    type: 'bic';
+  }
+
   export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
@@ -521,11 +650,6 @@ export interface AccountCloseResponse {
    */
   id: string;
 
-  /**
-   * Type of the account.
-   */
-  account_type: 'virtual_account' | 'payment_account' | 'collateral_account';
-
   /**
    * Asset type of the account.
    */
@@ -537,7 +661,7 @@ export interface AccountCloseResponse {
   created_at: string;
 
   /**
-   * ISO 4217 currency code for the account.
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -549,6 +673,7 @@ export interface AccountCloseResponse {
     | AccountCloseResponse.IbanFinancialAddress
     | AccountCloseResponse.SortCodeFinancialAddress
     | AccountCloseResponse.AbaFinancialAddress
+    | AccountCloseResponse.BicFinancialAddress
     | AccountCloseResponse.CryptoWalletFinancialAddress
   >;
 
@@ -640,6 +765,34 @@ export namespace AccountCloseResponse {
     type: 'aba';
   }
 
+  export interface BicFinancialAddress {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Local-format bank account number.
+     */
+    account_number: string;
+
+    /**
+     * ISO 9362 Bank Identifier Code (8 or 11 characters).
+     */
+    bic: string;
+
+    /**
+     * Domestic bank or branch code where the destination country uses one (for example
+     * the BSB in Australia), or null.
+     */
+    local_bank_code: string | null;
+
+    /**
+     * Discriminator for BIC + local account financial address.
+     */
+    type: 'bic';
+  }
+
   export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
@@ -672,11 +825,6 @@ export interface AccountFreezeResponse {
    */
   id: string;
 
-  /**
-   * Type of the account.
-   */
-  account_type: 'virtual_account' | 'payment_account' | 'collateral_account';
-
   /**
    * Asset type of the account.
    */
@@ -688,7 +836,7 @@ export interface AccountFreezeResponse {
   created_at: string;
 
   /**
-   * ISO 4217 currency code for the account.
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -700,6 +848,7 @@ export interface AccountFreezeResponse {
     | AccountFreezeResponse.IbanFinancialAddress
     | AccountFreezeResponse.SortCodeFinancialAddress
     | AccountFreezeResponse.AbaFinancialAddress
+    | AccountFreezeResponse.BicFinancialAddress
     | AccountFreezeResponse.CryptoWalletFinancialAddress
   >;
 
@@ -791,6 +940,34 @@ export namespace AccountFreezeResponse {
     type: 'aba';
   }
 
+  export interface BicFinancialAddress {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Local-format bank account number.
+     */
+    account_number: string;
+
+    /**
+     * ISO 9362 Bank Identifier Code (8 or 11 characters).
+     */
+    bic: string;
+
+    /**
+     * Domestic bank or branch code where the destination country uses one (for example
+     * the BSB in Australia), or null.
+     */
+    local_bank_code: string | null;
+
+    /**
+     * Discriminator for BIC + local account financial address.
+     */
+    type: 'bic';
+  }
+
   export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
@@ -823,10 +1000,7 @@ export interface AccountRetrieveBalanceResponse {
    */
   account_id: string;
 
-  /**
-   * Available balance amount as a decimal string.
-   */
-  amount: string;
+  amount: AccountRetrieveBalanceResponse.Amount;
 
   /**
    * ISO 8601 UTC timestamp when the balance was retrieved.
@@ -834,7 +1008,7 @@ export interface AccountRetrieveBalanceResponse {
   as_of: string;
 
   /**
-   * ISO 4217 currency code for the balance.
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -844,17 +1018,26 @@ export interface AccountRetrieveBalanceResponse {
   type: 'account_balance';
 }
 
+export namespace AccountRetrieveBalanceResponse {
+  export interface Amount {
+    /**
+     * Available balance as a string decimal (e.g. "100.50").
+     */
+    available: string;
+
+    /**
+     * Pending balance as a string decimal (e.g. "7.50").
+     */
+    pending: string;
+  }
+}
+
 export interface AccountUnfreezeResponse {
   /**
    * Unique identifier of the account.
    */
   id: string;
 
-  /**
-   * Type of the account.
-   */
-  account_type: 'virtual_account' | 'payment_account' | 'collateral_account';
-
   /**
    * Asset type of the account.
    */
@@ -866,7 +1049,7 @@ export interface AccountUnfreezeResponse {
   created_at: string;
 
   /**
-   * ISO 4217 currency code for the account.
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -878,6 +1061,7 @@ export interface AccountUnfreezeResponse {
     | AccountUnfreezeResponse.IbanFinancialAddress
     | AccountUnfreezeResponse.SortCodeFinancialAddress
     | AccountUnfreezeResponse.AbaFinancialAddress
+    | AccountUnfreezeResponse.BicFinancialAddress
     | AccountUnfreezeResponse.CryptoWalletFinancialAddress
   >;
 
@@ -969,6 +1153,34 @@ export namespace AccountUnfreezeResponse {
     type: 'aba';
   }
 
+  export interface BicFinancialAddress {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * Local-format bank account number.
+     */
+    account_number: string;
+
+    /**
+     * ISO 9362 Bank Identifier Code (8 or 11 characters).
+     */
+    bic: string;
+
+    /**
+     * Domestic bank or branch code where the destination country uses one (for example
+     * the BSB in Australia), or null.
+     */
+    local_bank_code: string | null;
+
+    /**
+     * Discriminator for BIC + local account financial address.
+     */
+    type: 'bic';
+  }
+
   export interface CryptoWalletFinancialAddress {
     /**
      * Wallet address on the specified blockchain.
@@ -1005,11 +1217,6 @@ export interface AccountCreateParams {
    * ID of the account program to create the account under.
    */
   account_program_id: string;
-
-  /**
-   * Type of account. Currently only virtual account.
-   */
-  account_type: 'virtual_account';
 }
 
 export interface AccountListParams extends CursorPageParams {
@@ -1027,7 +1234,7 @@ export interface AccountListParams extends CursorPageParams {
   /**
    * ID of the account program to list virtual accounts for.
    */
-  parent_id?: string;
+  account_program_id?: string;
 
   /**
    * Filter by account status.
@@ -1042,6 +1249,13 @@ export interface AccountCloseParams {
   reason: 'aml_risk_fraud' | 'client_request';
 }
 
+export interface AccountRetrieveBalanceParams {
+  /**
+   * ISO 8601 UTC timestamp to retrieve balance at.
+   */
+  as_of?: string;
+}
+
 export declare namespace Accounts {
   export {
     type AccountCreateResponse as AccountCreateResponse,
@@ -1055,5 +1269,6 @@ export declare namespace Accounts {
     type AccountCreateParams as AccountCreateParams,
     type AccountListParams as AccountListParams,
     type AccountCloseParams as AccountCloseParams,
+    type AccountRetrieveBalanceParams as AccountRetrieveBalanceParams,
   };
 }

package/src/resources/api-keys.ts

@@ -67,12 +67,15 @@ export interface APIKeyIntrospectResponse {
     | 'account_programs:read'
     | 'account_holders:read'
     | 'account_holders:write'
+    | 'counterparties:read'
+    | 'counterparties:write'
     | 'webhook_subscriptions:read'
     | 'webhook_subscriptions:write'
     | 'events:read'
     | 'webhook_deliveries:read'
     | 'webhook_deliveries:write'
     | 'transactions:read'
+    | 'simulations:write'
   >;
 
   /**

package/src/resources/api-versions.ts

@@ -52,6 +52,9 @@ export namespace APIVersionListResponse {
      */
     sunset_at: string | null;
 
+    /**
+     * Resource type discriminator.
+     */
     type: 'api_version';
   }
 }