@augustusbank/typescript-sdk 0.20.0 → 0.22.0

package/src/resources/simulations/deposits.ts

@@ -0,0 +1,530 @@
+// 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';
+
+export class Deposits extends APIResource {
+  /**
+   * Initiates an incoming deposit through the sandbox provider pipeline. This
+   * endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const deposit = await client.simulations.deposits.create({
+   *   account_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   amount: '869.225610155',
+   *   currency: 'EUR',
+   * });
+   * ```
+   */
+  create(body: DepositCreateParams, options?: RequestOptions): APIPromise<DepositCreateResponse> {
+    return this._client.post('/v1/simulations/deposits', { body, ...options });
+  }
+}
+
+export interface DepositCreateResponse {
+  /**
+   * Account receiving the simulated deposit.
+   */
+  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 {
+  /**
+   * ID of the account to credit with the simulated deposit.
+   */
+  account_id: string;
+
+  /**
+   * Amount as a decimal string in the account currency (e.g. "100.50").
+   */
+  amount: string;
+
+  /**
+   * Currency of the simulated deposit.
+   */
+  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
+
+  /**
+   * Sender of the simulated deposit.
+   */
+  counterparty?: DepositCreateParams.Counterparty;
+
+  /**
+   * Payment rail the simulated deposit arrives on.
+   */
+  rail?: 'sepa' | 'sepa_instant' | 'faster_payments' | 'ach' | 'fedwire' | 'swift';
+
+  /**
+   * Unstructured remittance information attached to the transfer. Not all rails
+   * support this field.
+   */
+  unstructured_remittance_information?: string;
+}
+
+export namespace DepositCreateParams {
+  /**
+   * Sender of the simulated deposit.
+   */
+  export interface Counterparty {
+    /**
+     * Financial address of the counterparty.
+     */
+    financial_address:
+      | Counterparty.IbanFinancialAddressRequest
+      | Counterparty.SortCodeFinancialAddress
+      | Counterparty.AbaFinancialAddress
+      | Counterparty.BicFinancialAddressRequest
+      | Counterparty.CryptoWalletFinancialAddress;
+
+    /**
+     * Physical address of the counterparty.
+     */
+    physical_address?: Counterparty.PhysicalAddress | null;
+  }
+
+  export namespace Counterparty {
+    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 interface BicFinancialAddressRequest {
+      /**
+       * Name of the account holder.
+       */
+      account_holder_name: string;
+
+      /**
+       * Local-format bank account number (1-34 alphanumeric characters).
+       */
+      account_number: string;
+
+      /**
+       * ISO 9362 Bank Identifier Code (8 or 11 characters).
+       */
+      bic: string;
+
+      /**
+       * Discriminator for BIC + local account financial address.
+       */
+      type: 'bic';
+
+      /**
+       * 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.
+       */
+      local_bank_code?: string | null;
+    }
+
+    export interface CryptoWalletFinancialAddress {
+      /**
+       * Wallet address on the specified blockchain.
+       */
+      address: string;
+
+      /**
+       * Blockchain network for the crypto wallet.
+       */
+      blockchain:
+        | 'bitcoin'
+        | 'ethereum'
+        | 'solana'
+        | 'polygon'
+        | 'bitcoin_testnet4'
+        | 'ethereum_sepolia'
+        | 'solana_devnet'
+        | 'polygon_amoy';
+
+      /**
+       * Discriminator for crypto wallet financial address.
+       */
+      type: 'crypto_wallet';
+    }
+
+    /**
+     * Physical address of the counterparty.
+     */
+    export interface PhysicalAddress {
+      /**
+       * City or locality.
+       */
+      city: string;
+
+      /**
+       * ISO 3166-1 alpha-2 country code.
+       */
+      country_code:
+        | 'AF'
+        | 'AL'
+        | 'DZ'
+        | 'AS'
+        | 'AD'
+        | 'AO'
+        | 'AI'
+        | 'AQ'
+        | 'AG'
+        | 'AR'
+        | 'AM'
+        | 'AW'
+        | 'AU'
+        | 'AT'
+        | 'AZ'
+        | 'BS'
+        | 'BH'
+        | 'BD'
+        | 'BB'
+        | 'BY'
+        | 'BE'
+        | 'BZ'
+        | 'BJ'
+        | 'BM'
+        | 'BT'
+        | 'BO'
+        | 'BA'
+        | 'BW'
+        | 'BV'
+        | 'BR'
+        | 'IO'
+        | 'BN'
+        | 'BG'
+        | 'BF'
+        | 'BI'
+        | 'KH'
+        | 'CM'
+        | 'CA'
+        | 'CV'
+        | 'KY'
+        | 'CF'
+        | 'TD'
+        | 'CL'
+        | 'CN'
+        | 'CX'
+        | 'CC'
+        | 'CO'
+        | 'KM'
+        | 'CG'
+        | 'CD'
+        | 'CK'
+        | 'CR'
+        | 'CI'
+        | 'HR'
+        | 'CU'
+        | 'CY'
+        | 'CZ'
+        | 'DK'
+        | 'DJ'
+        | 'DM'
+        | 'DO'
+        | 'EC'
+        | 'EG'
+        | 'SV'
+        | 'GQ'
+        | 'ER'
+        | 'EE'
+        | 'ET'
+        | 'FK'
+        | 'FO'
+        | 'FJ'
+        | 'FI'
+        | 'FR'
+        | 'GF'
+        | 'PF'
+        | 'TF'
+        | 'GA'
+        | 'GM'
+        | 'GE'
+        | 'DE'
+        | 'GH'
+        | 'GI'
+        | 'GR'
+        | 'GL'
+        | 'GD'
+        | 'GP'
+        | 'GU'
+        | 'GT'
+        | 'GN'
+        | 'GW'
+        | 'GY'
+        | 'HT'
+        | 'HM'
+        | 'VA'
+        | 'HN'
+        | 'HK'
+        | 'HU'
+        | 'IS'
+        | 'IN'
+        | 'ID'
+        | 'IR'
+        | 'IQ'
+        | 'IE'
+        | 'IL'
+        | 'IT'
+        | 'JM'
+        | 'JP'
+        | 'JO'
+        | 'KZ'
+        | 'KE'
+        | 'KI'
+        | 'KP'
+        | 'KR'
+        | 'KW'
+        | 'KG'
+        | 'LA'
+        | 'LV'
+        | 'LB'
+        | 'LS'
+        | 'LR'
+        | 'LY'
+        | 'LI'
+        | 'LT'
+        | 'LU'
+        | 'MO'
+        | 'MG'
+        | 'MW'
+        | 'MY'
+        | 'MV'
+        | 'ML'
+        | 'MT'
+        | 'MH'
+        | 'MQ'
+        | 'MR'
+        | 'MU'
+        | 'YT'
+        | 'MX'
+        | 'FM'
+        | 'MD'
+        | 'MC'
+        | 'MN'
+        | 'MS'
+        | 'MA'
+        | 'MZ'
+        | 'MM'
+        | 'NA'
+        | 'NR'
+        | 'NP'
+        | 'NL'
+        | 'NC'
+        | 'NZ'
+        | 'NI'
+        | 'NE'
+        | 'NG'
+        | 'NU'
+        | 'NF'
+        | 'MP'
+        | 'MK'
+        | 'NO'
+        | 'OM'
+        | 'PK'
+        | 'PW'
+        | 'PS'
+        | 'PA'
+        | 'PG'
+        | 'PY'
+        | 'PE'
+        | 'PH'
+        | 'PN'
+        | 'PL'
+        | 'PT'
+        | 'PR'
+        | 'QA'
+        | 'RE'
+        | 'RO'
+        | 'RU'
+        | 'RW'
+        | 'SH'
+        | 'KN'
+        | 'LC'
+        | 'PM'
+        | 'VC'
+        | 'WS'
+        | 'SM'
+        | 'ST'
+        | 'SA'
+        | 'SN'
+        | 'SC'
+        | 'SL'
+        | 'SG'
+        | 'SK'
+        | 'SI'
+        | 'SB'
+        | 'SO'
+        | 'ZA'
+        | 'GS'
+        | 'ES'
+        | 'LK'
+        | 'SD'
+        | 'SR'
+        | 'SJ'
+        | 'SZ'
+        | 'SE'
+        | 'CH'
+        | 'SY'
+        | 'TW'
+        | 'TJ'
+        | 'TZ'
+        | 'TH'
+        | 'TL'
+        | 'TG'
+        | 'TK'
+        | 'TO'
+        | 'TT'
+        | 'TN'
+        | 'TR'
+        | 'TM'
+        | 'TC'
+        | 'TV'
+        | 'UG'
+        | 'UA'
+        | 'AE'
+        | 'GB'
+        | 'US'
+        | 'UM'
+        | 'UY'
+        | 'UZ'
+        | 'VU'
+        | 'VE'
+        | 'VN'
+        | 'VG'
+        | 'VI'
+        | 'WF'
+        | 'EH'
+        | 'YE'
+        | 'ZM'
+        | 'ZW'
+        | 'AX'
+        | 'BQ'
+        | 'CW'
+        | 'GG'
+        | 'IM'
+        | 'JE'
+        | 'ME'
+        | 'BL'
+        | 'MF'
+        | 'RS'
+        | 'SX'
+        | 'SS'
+        | 'XK';
+
+      /**
+       * Primary street address.
+       */
+      line_1: string;
+
+      /**
+       * Secondary street address, or null if not recorded.
+       */
+      line_2: string | null;
+
+      /**
+       * Postal or ZIP code.
+       */
+      postal_code: string;
+
+      /**
+       * State, province, or region, or null if not recorded.
+       */
+      state: string | null;
+    }
+  }
+}
+
+export declare namespace Deposits {
+  export {
+    type DepositCreateResponse as DepositCreateResponse,
+    type DepositCreateParams as DepositCreateParams,
+  };
+}

package/src/resources/simulations/index.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  AccountPrograms,
+  type AccountProgramCreateResponse,
+  type AccountProgramCloseResponse,
+  type AccountProgramDrainResponse,
+  type AccountProgramFreezeResponse,
+  type AccountProgramUnfreezeResponse,
+  type AccountProgramCreateParams,
+  type AccountProgramCloseParams,
+  type AccountProgramDrainParams,
+} from './account-programs';
+export {
+  Accounts,
+  type AccountCreateResponse,
+  type AccountCloseResponse,
+  type AccountDrainResponse,
+  type AccountFreezeResponse,
+  type AccountUnfreezeResponse,
+  type AccountCreateParams,
+  type AccountCloseParams,
+  type AccountDrainParams,
+} from './accounts';
+export { Deposits, type DepositCreateResponse, type DepositCreateParams } from './deposits';
+export {
+  Payouts,
+  type PayoutRejectResponse,
+  type PayoutSendResponse,
+  type PayoutRejectParams,
+} from './payouts';
+export { Simulations } from './simulations';

package/src/resources/simulations/payouts.ts

@@ -0,0 +1,98 @@
+// 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 Payouts extends APIResource {
+  /**
+   * Submits a network rejection for an existing payout through the sandbox provider
+   * pipeline. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulations.payouts.reject(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { reason: 'invalid_routing_number' },
+   * );
+   * ```
+   */
+  reject(id: string, body: PayoutRejectParams, options?: RequestOptions): APIPromise<PayoutRejectResponse> {
+    return this._client.post(path`/v1/simulations/payouts/${id}/reject`, { body, ...options });
+  }
+
+  /**
+   * Submits a successful send event for an existing payout through the sandbox
+   * provider pipeline. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulations.payouts.send(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  send(id: string, options?: RequestOptions): APIPromise<PayoutSendResponse> {
+    return this._client.post(path`/v1/simulations/payouts/${id}/send`, options);
+  }
+}
+
+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.
+   */
+  type: 'payout_simulation';
+}
+
+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.
+   */
+  type: 'payout_simulation';
+}
+
+export interface PayoutRejectParams {
+  /**
+   * Reason the sandbox provider rejects the payout.
+   */
+  reason: 'invalid_routing_number';
+}
+
+export declare namespace Payouts {
+  export {
+    type PayoutRejectResponse as PayoutRejectResponse,
+    type PayoutSendResponse as PayoutSendResponse,
+    type PayoutRejectParams as PayoutRejectParams,
+  };
+}