@augustusbank/typescript-sdk 0.21.0 → 0.22.1

package/src/resources/quotes/indicative.ts

@@ -33,29 +33,24 @@ export interface IndicativeRetrieveResponse {
   rate: string;
 
   /**
-   * Source amount as a string decimal.
+   * Amount as a string decimal (e.g. "100.50").
    */
   source_amount: string;
 
   /**
-   * Source currency code.
+   * Currency code (ISO 4217 or crypto).
    */
   source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
   /**
-   * Target amount as a string decimal.
+   * Amount as a string decimal (e.g. "100.50").
    */
   target_amount: string;
 
   /**
-   * Target currency code.
+   * Currency code (ISO 4217 or crypto).
    */
   target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
-
-  /**
-   * Venue the quote was fetched from.
-   */
-  venue: string;
 }
 
 export namespace IndicativeRetrieveResponse {
@@ -77,17 +72,17 @@ export namespace IndicativeRetrieveResponse {
 
 export interface IndicativeRetrieveParams {
   /**
-   * Source currency code.
+   * Currency code (ISO 4217 or crypto).
    */
   source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
   /**
-   * Target currency code.
+   * Currency code (ISO 4217 or crypto).
    */
   target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
   /**
-   * Source amount as a string decimal. Defaults to 1 unit if omitted.
+   * Amount as a string decimal (e.g. "100.50").
    */
   source_amount?: string;
 }

package/src/resources/quotes/quotes.ts

@@ -45,12 +45,12 @@ export interface QuoteRetrieveResponse {
   funding_status: 'pending' | 'sent' | 'completed' | 'failed' | 'on_hold';
 
   /**
-   * Source amount as a string decimal.
+   * Amount as a string decimal (e.g. "100.50").
    */
   source_amount: string;
 
   /**
-   * Source currency code.
+   * Currency code (ISO 4217 or crypto).
    */
   source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
@@ -70,12 +70,12 @@ export interface QuoteRetrieveResponse {
     | 'failed';
 
   /**
-   * Target amount as a string decimal.
+   * Amount as a string decimal (e.g. "100.50").
    */
   target_amount: string;
 
   /**
-   * Target currency code.
+   * Currency code (ISO 4217 or crypto).
    */
   target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
 
@@ -88,11 +88,6 @@ export interface QuoteRetrieveResponse {
    * ISO 8601 UTC timestamp when the quote was last updated.
    */
   updated_at: string;
-
-  /**
-   * Execution venue (e.g. "kraken").
-   */
-  venue: string;
 }
 
 Quotes.Indicative = Indicative;

package/src/resources/returns.ts

@@ -9,6 +9,13 @@ import { path } from '../internal/utils/path';
 export class Returns extends APIResource {
   /**
    * Initiates a return of funds from a deposit to the source.
+   *
+   * @example
+   * ```ts
+   * const _return = await client.returns.create({
+   *   deposit_id: '550e8400-e29b-41d4-a716-446655440004',
+   * });
+   * ```
    */
   create(body: ReturnCreateParams, options?: RequestOptions): APIPromise<ReturnCreateResponse> {
     return this._client.post('/v1/returns', { body, ...options });
@@ -16,6 +23,13 @@ export class Returns extends APIResource {
 
   /**
    * Retrieves a return by ID.
+   *
+   * @example
+   * ```ts
+   * const _return = await client.returns.retrieve(
+   *   '550e8400-e29b-41d4-a716-446655440005',
+   * );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<ReturnRetrieveResponse> {
     return this._client.get(path`/v1/returns/${id}`, options);
@@ -23,6 +37,14 @@ export class Returns extends APIResource {
 
   /**
    * Lists deposit returns for the merchant with cursor-based pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const returnListResponse of client.returns.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: ReturnListParams | null | undefined = {},
@@ -46,12 +68,7 @@ export interface ReturnCreateResponse {
   amount: string;
 
   /**
-   * ISO 8601 UTC timestamp when the return was created.
-   */
-  created_at: string;
-
-  /**
-   * Currency code (ISO 4217 currency code or crypto currency code).
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -65,20 +82,53 @@ export interface ReturnCreateResponse {
    */
   failure: ReturnCreateResponse.Failure | null;
 
+  /**
+   * ISO 8601 UTC timestamp when the return was initiated.
+   */
+  initiated_at: string;
+
+  /**
+   * Payment scheme or blockchain used for the return, or null when unknown.
+   */
+  rail:
+    | 'sepa'
+    | 'sepa_instant'
+    | 'faster_payments'
+    | 'swift'
+    | 'internal'
+    | 'target'
+    | 'ach'
+    | 'fedwire'
+    | 'bitcoin'
+    | 'bitcoin_testnet4'
+    | 'ethereum'
+    | 'ethereum_sepolia'
+    | 'solana'
+    | 'solana_devnet'
+    | 'polygon'
+    | 'polygon_amoy'
+    | null;
+
+  /**
+   * ISO 8601 UTC timestamp when the return was sent.
+   */
+  sent_at: string | null;
+
   /**
    * Current status of the return.
    */
-  status: 'pending' | 'paid' | 'failed' | 'returned';
+  status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 
   /**
-   * Type of the resource.
+   * Transaction hash for crypto returns, or null when not known. Only blockchain
+   * rails support this field.
    */
-  type: 'return';
+  tx_hash: string | null;
 
   /**
-   * ISO 8601 UTC timestamp when the return was last updated.
+   * Resource type discriminator.
    */
-  updated_at: string;
+  type: 'return';
 }
 
 export namespace ReturnCreateResponse {
@@ -94,6 +144,7 @@ export namespace ReturnCreateResponse {
       | 'account_blocked'
       | 'insufficient_funds'
       | 'invalid_account_format'
+      | 'invalid_routing_number'
       | 'invalid_instruction'
       | 'invalid_amount'
       | 'invalid_time'
@@ -129,12 +180,7 @@ export interface ReturnRetrieveResponse {
   amount: string;
 
   /**
-   * ISO 8601 UTC timestamp when the return was created.
-   */
-  created_at: string;
-
-  /**
-   * Currency code (ISO 4217 currency code or crypto currency code).
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -148,20 +194,53 @@ export interface ReturnRetrieveResponse {
    */
   failure: ReturnRetrieveResponse.Failure | null;
 
+  /**
+   * ISO 8601 UTC timestamp when the return was initiated.
+   */
+  initiated_at: string;
+
+  /**
+   * Payment scheme or blockchain used for the return, or null when unknown.
+   */
+  rail:
+    | 'sepa'
+    | 'sepa_instant'
+    | 'faster_payments'
+    | 'swift'
+    | 'internal'
+    | 'target'
+    | 'ach'
+    | 'fedwire'
+    | 'bitcoin'
+    | 'bitcoin_testnet4'
+    | 'ethereum'
+    | 'ethereum_sepolia'
+    | 'solana'
+    | 'solana_devnet'
+    | 'polygon'
+    | 'polygon_amoy'
+    | null;
+
+  /**
+   * ISO 8601 UTC timestamp when the return was sent.
+   */
+  sent_at: string | null;
+
   /**
    * Current status of the return.
    */
-  status: 'pending' | 'paid' | 'failed' | 'returned';
+  status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 
   /**
-   * Type of the resource.
+   * Transaction hash for crypto returns, or null when not known. Only blockchain
+   * rails support this field.
    */
-  type: 'return';
+  tx_hash: string | null;
 
   /**
-   * ISO 8601 UTC timestamp when the return was last updated.
+   * Resource type discriminator.
    */
-  updated_at: string;
+  type: 'return';
 }
 
 export namespace ReturnRetrieveResponse {
@@ -177,6 +256,7 @@ export namespace ReturnRetrieveResponse {
       | 'account_blocked'
       | 'insufficient_funds'
       | 'invalid_account_format'
+      | 'invalid_routing_number'
       | 'invalid_instruction'
       | 'invalid_amount'
       | 'invalid_time'
@@ -212,12 +292,7 @@ export interface ReturnListResponse {
   amount: string;
 
   /**
-   * ISO 8601 UTC timestamp when the return was created.
-   */
-  created_at: string;
-
-  /**
-   * Currency code (ISO 4217 currency code or crypto currency code).
+   * Currency code (ISO 4217 or crypto).
    */
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
@@ -231,20 +306,53 @@ export interface ReturnListResponse {
    */
   failure: ReturnListResponse.Failure | null;
 
+  /**
+   * ISO 8601 UTC timestamp when the return was initiated.
+   */
+  initiated_at: string;
+
+  /**
+   * Payment scheme or blockchain used for the return, or null when unknown.
+   */
+  rail:
+    | 'sepa'
+    | 'sepa_instant'
+    | 'faster_payments'
+    | 'swift'
+    | 'internal'
+    | 'target'
+    | 'ach'
+    | 'fedwire'
+    | 'bitcoin'
+    | 'bitcoin_testnet4'
+    | 'ethereum'
+    | 'ethereum_sepolia'
+    | 'solana'
+    | 'solana_devnet'
+    | 'polygon'
+    | 'polygon_amoy'
+    | null;
+
+  /**
+   * ISO 8601 UTC timestamp when the return was sent.
+   */
+  sent_at: string | null;
+
   /**
    * Current status of the return.
    */
-  status: 'pending' | 'paid' | 'failed' | 'returned';
+  status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 
   /**
-   * Type of the resource.
+   * Transaction hash for crypto returns, or null when not known. Only blockchain
+   * rails support this field.
    */
-  type: 'return';
+  tx_hash: string | null;
 
   /**
-   * ISO 8601 UTC timestamp when the return was last updated.
+   * Resource type discriminator.
    */
-  updated_at: string;
+  type: 'return';
 }
 
 export namespace ReturnListResponse {
@@ -260,6 +368,7 @@ export namespace ReturnListResponse {
       | 'account_blocked'
       | 'insufficient_funds'
       | 'invalid_account_format'
+      | 'invalid_routing_number'
       | 'invalid_instruction'
       | 'invalid_amount'
       | 'invalid_time'
@@ -288,11 +397,6 @@ export interface ReturnCreateParams {
    * Deposit to return funds from.
    */
   deposit_id: string;
-
-  /**
-   * Payment rail when the deposit allows multiple schemes.
-   */
-  rail?: 'sepa_instant' | 'sepa' | 'faster_payments';
 }
 
 export interface ReturnListParams extends CursorPageParams {
@@ -304,9 +408,9 @@ export interface ReturnListParams extends CursorPageParams {
   deposit_id?: string;
 
   /**
-   * Current status of the return.
+   * Filter by return status.
    */
-  status?: 'pending' | 'paid' | 'failed' | 'returned';
+  status?: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
 }
 
 export namespace ReturnListParams {

package/src/resources/scopes.ts

@@ -42,12 +42,15 @@ export namespace ScopeListResponse {
       | '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';
+      | 'transactions:read'
+      | 'simulations:write';
 
     /**
      * Action category.
@@ -74,6 +77,9 @@ export namespace ScopeListResponse {
      */
     resource: string;
 
+    /**
+     * Resource type discriminator.
+     */
     type: 'scope';
   }
 }

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

@@ -0,0 +1,282 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class AccountPrograms extends APIResource {
+  /**
+   * Creates a Mock-US USD account program owned by the caller merchant. This
+   * endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const accountProgram =
+   *   await client.simulations.accountPrograms.create({
+   *     label: 'x',
+   *   });
+   * ```
+   */
+  create(
+    body: AccountProgramCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<AccountProgramCreateResponse> {
+    return this._client.post('/v1/simulations/account_programs', { body, ...options });
+  }
+
+  /**
+   * Closes an account program. All child accounts must be drained via the drain
+   * endpoint first. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.simulations.accountPrograms.close(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { reason: 'aml_risk_fraud' },
+   *   );
+   * ```
+   */
+  close(
+    id: string,
+    body: AccountProgramCloseParams,
+    options?: RequestOptions,
+  ): APIPromise<AccountProgramCloseResponse> {
+    return this._client.post(path`/v1/simulations/account_programs/${id}/close`, { body, ...options });
+  }
+
+  /**
+   * Creates outbound payouts that drain the residual balance of every frozen account
+   * under the program to the provided destination. The program must be frozen. Every
+   * returned `payout_ids[i]` must be settled via
+   * `POST /v1/simulations/payouts/{id}/send` for the program balance to reach zero.
+   * This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.simulations.accountPrograms.drain(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       destination: {
+   *         account_holder_name: 'Acme Sandbox Ltd.',
+   *         iban: 'DE89370400440532013000',
+   *         type: 'iban',
+   *       },
+   *     },
+   *   );
+   * ```
+   */
+  drain(
+    id: string,
+    body: AccountProgramDrainParams,
+    options?: RequestOptions,
+  ): APIPromise<AccountProgramDrainResponse> {
+    return this._client.post(path`/v1/simulations/account_programs/${id}/drain`, { body, ...options });
+  }
+
+  /**
+   * Freezes an existing account program and its virtual accounts. This endpoint is
+   * unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.simulations.accountPrograms.freeze(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  freeze(id: string, options?: RequestOptions): APIPromise<AccountProgramFreezeResponse> {
+    return this._client.post(path`/v1/simulations/account_programs/${id}/freeze`, options);
+  }
+
+  /**
+   * Unfreezes an existing account program and its virtual accounts. This endpoint is
+   * unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.simulations.accountPrograms.unfreeze(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  unfreeze(id: string, options?: RequestOptions): APIPromise<AccountProgramUnfreezeResponse> {
+    return this._client.post(path`/v1/simulations/account_programs/${id}/unfreeze`, options);
+  }
+}
+
+export interface AccountProgramCreateResponse {
+  /**
+   * Account program whose lifecycle is being simulated.
+   */
+  account_program_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'account_program_simulation';
+}
+
+export interface AccountProgramCloseResponse {
+  /**
+   * Account program whose lifecycle is being simulated.
+   */
+  account_program_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'account_program_simulation';
+}
+
+export interface AccountProgramDrainResponse {
+  /**
+   * Account program whose lifecycle is being simulated.
+   */
+  account_program_id: string;
+
+  /**
+   * Payouts created by the drain. Feed each id to
+   * `POST /v1/simulations/payouts/{id}/send` to settle.
+   */
+  payout_ids: Array<string>;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'account_program_simulation';
+}
+
+export interface AccountProgramFreezeResponse {
+  /**
+   * Account program whose lifecycle is being simulated.
+   */
+  account_program_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'account_program_simulation';
+}
+
+export interface AccountProgramUnfreezeResponse {
+  /**
+   * Account program whose lifecycle is being simulated.
+   */
+  account_program_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'account_program_simulation';
+}
+
+export interface AccountProgramCreateParams {
+  /**
+   * Human-readable label for the account program.
+   */
+  label: string;
+}
+
+export interface AccountProgramCloseParams {
+  /**
+   * Reason for closing the account program.
+   */
+  reason: 'aml_risk_fraud' | 'client_request';
+}
+
+export interface AccountProgramDrainParams {
+  /**
+   * Fiat financial address to which the residual balance of every frozen account
+   * under the program is drained.
+   */
+  destination:
+    | AccountProgramDrainParams.IbanFinancialAddressRequest
+    | AccountProgramDrainParams.SortCodeFinancialAddress
+    | AccountProgramDrainParams.AbaFinancialAddress;
+}
+
+export namespace AccountProgramDrainParams {
+  export interface IbanFinancialAddressRequest {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * International Bank Account Number.
+     */
+    iban: string;
+
+    /**
+     * Discriminator for IBAN financial address.
+     */
+    type: 'iban';
+
+    /**
+     * Bank Identifier Code. Optional; omit or send null if not provided.
+     */
+    bic?: string | null;
+  }
+
+  export interface SortCodeFinancialAddress {
+    /**
+     * Name of the account holder.
+     */
+    account_holder_name: string;
+
+    /**
+     * UK account number (8 digits).
+     */
+    account_number: string;
+
+    /**
+     * UK sort code (6 digits).
+     */
+    sort_code: string;
+
+    /**
+     * Discriminator for UK sort code financial address.
+     */
+    type: 'sort_code';
+  }
+
+  export 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';
+  }
+}
+
+export declare namespace AccountPrograms {
+  export {
+    type AccountProgramCreateResponse as AccountProgramCreateResponse,
+    type AccountProgramCloseResponse as AccountProgramCloseResponse,
+    type AccountProgramDrainResponse as AccountProgramDrainResponse,
+    type AccountProgramFreezeResponse as AccountProgramFreezeResponse,
+    type AccountProgramUnfreezeResponse as AccountProgramUnfreezeResponse,
+    type AccountProgramCreateParams as AccountProgramCreateParams,
+    type AccountProgramCloseParams as AccountProgramCloseParams,
+    type AccountProgramDrainParams as AccountProgramDrainParams,
+  };
+}