@augustusbank/typescript-sdk 0.22.0 → 0.22.1

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

@@ -15,7 +15,6 @@ export class AccountPrograms extends APIResource {
    * const accountProgram =
    *   await client.simulations.accountPrograms.create({
    *     label: 'x',
-   *     type: 'fbo-program',
    *   });
    * ```
    */
@@ -62,7 +61,6 @@ export class AccountPrograms extends APIResource {
    *     {
    *       destination: {
    *         account_holder_name: 'Acme Sandbox Ltd.',
-   *         bic: 'COBADEFFXXX',
    *         iban: 'DE89370400440532013000',
    *         type: 'iban',
    *       },
@@ -117,22 +115,6 @@ export interface AccountProgramCreateResponse {
    */
   account_program_id: string;
 
-  /**
-   * Account program lifecycle event submitted to the sandbox.
-   */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payouts created by a drain event. Feed each id to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_ids: Array<string> | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -145,22 +127,6 @@ export interface AccountProgramCloseResponse {
    */
   account_program_id: string;
 
-  /**
-   * Account program lifecycle event submitted to the sandbox.
-   */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payouts created by a drain event. Feed each id to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_ids: Array<string> | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -174,20 +140,10 @@ export interface AccountProgramDrainResponse {
   account_program_id: string;
 
   /**
-   * Account program lifecycle event submitted to the sandbox.
+   * Payouts created by the drain. Feed each id to
+   * `POST /v1/simulations/payouts/{id}/send` to settle.
    */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payouts created by a drain event. Feed each id to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_ids: Array<string> | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
+  payout_ids: Array<string>;
 
   /**
    * Resource type discriminator.
@@ -201,22 +157,6 @@ export interface AccountProgramFreezeResponse {
    */
   account_program_id: string;
 
-  /**
-   * Account program lifecycle event submitted to the sandbox.
-   */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payouts created by a drain event. Feed each id to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_ids: Array<string> | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -229,22 +169,6 @@ export interface AccountProgramUnfreezeResponse {
    */
   account_program_id: string;
 
-  /**
-   * Account program lifecycle event submitted to the sandbox.
-   */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payouts created by a drain event. Feed each id to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_ids: Array<string> | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -256,11 +180,6 @@ export interface AccountProgramCreateParams {
    * Human-readable label for the account program.
    */
   label: string;
-
-  /**
-   * Account program type.
-   */
-  type: 'fbo-program' | 'fbo-sponsored';
 }
 
 export interface AccountProgramCloseParams {
@@ -276,23 +195,18 @@ export interface AccountProgramDrainParams {
    * under the program is drained.
    */
   destination:
-    | AccountProgramDrainParams.IbanFinancialAddress
+    | AccountProgramDrainParams.IbanFinancialAddressRequest
     | AccountProgramDrainParams.SortCodeFinancialAddress
     | AccountProgramDrainParams.AbaFinancialAddress;
 }
 
 export namespace AccountProgramDrainParams {
-  export interface IbanFinancialAddress {
+  export interface IbanFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
-    /**
-     * Bank Identifier Code, or null if not provided.
-     */
-    bic: string | null;
-
     /**
      * International Bank Account Number.
      */
@@ -302,6 +216,11 @@ export namespace AccountProgramDrainParams {
      * Discriminator for IBAN financial address.
      */
     type: 'iban';
+
+    /**
+     * Bank Identifier Code. Optional; omit or send null if not provided.
+     */
+    bic?: string | null;
   }
 
   export interface SortCodeFinancialAddress {

package/src/resources/simulations/accounts.ts

@@ -50,7 +50,6 @@ export class Accounts extends APIResource {
    *   {
    *     destination: {
    *       account_holder_name: 'Acme Sandbox Ltd.',
-   *       bic: 'COBADEFFXXX',
    *       iban: 'DE89370400440532013000',
    *       type: 'iban',
    *     },
@@ -99,22 +98,6 @@ export interface AccountCreateResponse {
    */
   account_id: string;
 
-  /**
-   * Account lifecycle event submitted to the sandbox.
-   */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payout created by a drain event. Feed to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_id: string | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -127,22 +110,6 @@ export interface AccountCloseResponse {
    */
   account_id: string;
 
-  /**
-   * Account lifecycle event submitted to the sandbox.
-   */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payout created by a drain event. Feed to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_id: string | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -156,20 +123,10 @@ export interface AccountDrainResponse {
   account_id: string;
 
   /**
-   * Account lifecycle event submitted to the sandbox.
-   */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payout created by a drain event. Feed to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_id: string | null;
-
-  /**
-   * Whether the simulation submission was successful.
+   * Payout created by the drain. Feed to `POST /v1/simulations/payouts/{id}/send` to
+   * settle.
    */
-  success: boolean;
+  payout_id: string;
 
   /**
    * Resource type discriminator.
@@ -183,22 +140,6 @@ export interface AccountFreezeResponse {
    */
   account_id: string;
 
-  /**
-   * Account lifecycle event submitted to the sandbox.
-   */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payout created by a drain event. Feed to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_id: string | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -211,22 +152,6 @@ export interface AccountUnfreezeResponse {
    */
   account_id: string;
 
-  /**
-   * Account lifecycle event submitted to the sandbox.
-   */
-  event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
-
-  /**
-   * Payout created by a drain event. Feed to
-   * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
-   */
-  payout_id: string | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -253,23 +178,18 @@ export interface AccountDrainParams {
    * drained.
    */
   destination:
-    | AccountDrainParams.IbanFinancialAddress
+    | AccountDrainParams.IbanFinancialAddressRequest
     | AccountDrainParams.SortCodeFinancialAddress
     | AccountDrainParams.AbaFinancialAddress;
 }
 
 export namespace AccountDrainParams {
-  export interface IbanFinancialAddress {
+  export interface IbanFinancialAddressRequest {
     /**
      * Name of the account holder.
      */
     account_holder_name: string;
 
-    /**
-     * Bank Identifier Code, or null if not provided.
-     */
-    bic: string | null;
-
     /**
      * International Bank Account Number.
      */
@@ -279,6 +199,11 @@ export namespace AccountDrainParams {
      * Discriminator for IBAN financial address.
      */
     type: 'iban';
+
+    /**
+     * Bank Identifier Code. Optional; omit or send null if not provided.
+     */
+    bic?: string | null;
   }
 
   export interface SortCodeFinancialAddress {

package/src/resources/simulations/conversions.ts

@@ -0,0 +1,70 @@
+// 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 Conversions extends APIResource {
+  /**
+   * Releases a controlled (sandbox) conversion paused at its first step so it runs
+   * to completion normally. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.simulations.conversions.complete(
+   *     '550e8400-e29b-41d4-a716-446655440006',
+   *   );
+   * ```
+   */
+  complete(id: string, options?: RequestOptions): APIPromise<ConversionCompleteResponse> {
+    return this._client.post(path`/v1/simulations/conversions/${id}/complete`, options);
+  }
+
+  /**
+   * Fails a controlled (sandbox) conversion paused at its first step, before any
+   * funds move. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulations.conversions.fail(
+   *   '550e8400-e29b-41d4-a716-446655440006',
+   * );
+   * ```
+   */
+  fail(id: string, options?: RequestOptions): APIPromise<ConversionFailResponse> {
+    return this._client.post(path`/v1/simulations/conversions/${id}/fail`, options);
+  }
+}
+
+export interface ConversionCompleteResponse {
+  /**
+   * Conversion whose execution is being simulated.
+   */
+  conversion_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'conversion_simulation';
+}
+
+export interface ConversionFailResponse {
+  /**
+   * Conversion whose execution is being simulated.
+   */
+  conversion_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'conversion_simulation';
+}
+
+export declare namespace Conversions {
+  export {
+    type ConversionCompleteResponse as ConversionCompleteResponse,
+    type ConversionFailResponse as ConversionFailResponse,
+  };
+}

package/src/resources/simulations/deposits.ts

@@ -29,36 +29,10 @@ export interface DepositCreateResponse {
    */
   account_id: string;
 
-  /**
-   * Simulated amount as a decimal string.
-   */
-  amount: string;
-
-  /**
-   * Currency of the receiving account.
-   */
-  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
-
-  /**
-   * Payment rail the simulated deposit arrived on, or null when not known.
-   */
-  rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'ach' | 'fedwire' | 'swift' | null;
-
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
   type: 'deposit_simulation';
-
-  /**
-   * ISO 20022 unstructured remittance information (<RmtInf>/<Ustrd>), or null when
-   * omitted.
-   */
-  unstructured_remittance_information: string | null;
 }
 
 export interface DepositCreateParams {
@@ -78,14 +52,32 @@ export interface DepositCreateParams {
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
-   * Sender of the simulated deposit.
+   * Sender of the simulated deposit. Mutually exclusive with `counterparty_id`.
    */
   counterparty?: DepositCreateParams.Counterparty;
 
+  /**
+   * ID of an existing counterparty to use as the sender of the simulated deposit.
+   * Mutually exclusive with `counterparty`.
+   */
+  counterparty_id?: string;
+
   /**
    * Payment rail the simulated deposit arrives on.
    */
-  rail?: 'sepa' | 'sepa_instant' | 'faster_payments' | 'ach' | 'fedwire' | 'swift';
+  rail?:
+    | 'sepa'
+    | 'sepa_instant'
+    | 'faster_payments'
+    | 'swift'
+    | 'ach'
+    | 'fedwire'
+    | 'ethereum'
+    | 'ethereum_sepolia'
+    | 'solana'
+    | 'solana_devnet'
+    | 'polygon'
+    | 'polygon_amoy';
 
   /**
    * Unstructured remittance information attached to the transfer. Not all rails
@@ -96,7 +88,7 @@ export interface DepositCreateParams {
 
 export namespace DepositCreateParams {
   /**
-   * Sender of the simulated deposit.
+   * Sender of the simulated deposit. Mutually exclusive with `counterparty_id`.
    */
   export interface Counterparty {
     /**
@@ -505,19 +497,19 @@ export namespace DepositCreateParams {
       line_1: string;
 
       /**
-       * Secondary street address, or null if not recorded.
+       * Postal or ZIP code.
        */
-      line_2: string | null;
+      postal_code: string;
 
       /**
-       * Postal or ZIP code.
+       * Secondary street address. Optional; omit or send null if not recorded.
        */
-      postal_code: string;
+      line_2?: string | null;
 
       /**
-       * State, province, or region, or null if not recorded.
+       * State, province, or region. Optional; omit or send null if not recorded.
        */
-      state: string | null;
+      state?: string | null;
     }
   }
 }

package/src/resources/simulations/index.ts

@@ -22,6 +22,7 @@ export {
   type AccountCloseParams,
   type AccountDrainParams,
 } from './accounts';
+export { Conversions, type ConversionCompleteResponse, type ConversionFailResponse } from './conversions';
 export { Deposits, type DepositCreateResponse, type DepositCreateParams } from './deposits';
 export {
   Payouts,

package/src/resources/simulations/payouts.ts

@@ -39,21 +39,11 @@ export class Payouts extends APIResource {
 }
 
 export interface PayoutRejectResponse {
-  /**
-   * Payout lifecycle event submitted to the sandbox provider.
-   */
-  event: 'send' | 'reject' | 'return';
-
   /**
    * Payout whose lifecycle is being simulated.
    */
   payout_id: string;
 
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -61,21 +51,11 @@ export interface PayoutRejectResponse {
 }
 
 export interface PayoutSendResponse {
-  /**
-   * Payout lifecycle event submitted to the sandbox provider.
-   */
-  event: 'send' | 'reject' | 'return';
-
   /**
    * Payout whose lifecycle is being simulated.
    */
   payout_id: string;
 
-  /**
-   * Whether the simulation submission was successful.
-   */
-  success: boolean;
-
   /**
    * Resource type discriminator.
    */
@@ -84,9 +64,11 @@ export interface PayoutSendResponse {
 
 export interface PayoutRejectParams {
   /**
-   * Reason the sandbox provider rejects the payout.
+   * Reason the sandbox provider rejects the payout. Use `invalid_routing_number` for
+   * domestic rails and `invalid_account_format` for a SWIFT correspondent rejecting
+   * on the beneficiary details.
    */
-  reason: 'invalid_routing_number';
+  reason: 'invalid_routing_number' | 'invalid_account_format';
 }
 
 export declare namespace Payouts {

package/src/resources/simulations/simulations.ts

@@ -25,6 +25,8 @@ import {
   AccountUnfreezeResponse,
   Accounts,
 } from './accounts';
+import * as ConversionsAPI from './conversions';
+import { ConversionCompleteResponse, ConversionFailResponse, Conversions } from './conversions';
 import * as DepositsAPI from './deposits';
 import { DepositCreateParams, DepositCreateResponse, Deposits } from './deposits';
 import * as PayoutsAPI from './payouts';
@@ -32,12 +34,14 @@ import { PayoutRejectParams, PayoutRejectResponse, PayoutSendResponse, Payouts }
 
 export class Simulations extends APIResource {
   deposits: DepositsAPI.Deposits = new DepositsAPI.Deposits(this._client);
+  conversions: ConversionsAPI.Conversions = new ConversionsAPI.Conversions(this._client);
   payouts: PayoutsAPI.Payouts = new PayoutsAPI.Payouts(this._client);
   accountPrograms: AccountProgramsAPI.AccountPrograms = new AccountProgramsAPI.AccountPrograms(this._client);
   accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
 }
 
 Simulations.Deposits = Deposits;
+Simulations.Conversions = Conversions;
 Simulations.Payouts = Payouts;
 Simulations.AccountPrograms = AccountPrograms;
 Simulations.Accounts = Accounts;
@@ -49,6 +53,12 @@ export declare namespace Simulations {
     type DepositCreateParams as DepositCreateParams,
   };
 
+  export {
+    Conversions as Conversions,
+    type ConversionCompleteResponse as ConversionCompleteResponse,
+    type ConversionFailResponse as ConversionFailResponse,
+  };
+
   export {
     Payouts as Payouts,
     type PayoutRejectResponse as PayoutRejectResponse,