@augustusbank/typescript-sdk 0.22.1 → 0.22.2

package/src/resources/simulations/accounts.ts

@@ -7,13 +7,14 @@ import { path } from '../../internal/utils/path';
 
 export class Accounts extends APIResource {
   /**
-   * Creates a Mock-US USD operating (DDA) account owned by the caller merchant. This
-   * endpoint is unavailable in live production.
+   * Creates a Mock-US USD account owned by the caller merchant. This endpoint is
+   * unavailable in live production.
    *
    * @example
    * ```ts
    * const account = await client.simulations.accounts.create({
    *   label: 'x',
+   *   type: 'operating',
    * });
    * ```
    */
@@ -163,6 +164,11 @@ export interface AccountCreateParams {
    * Human-readable label for the operating account.
    */
   label: string;
+
+  /**
+   * Account type.
+   */
+  type: 'operating';
 }
 
 export interface AccountCloseParams {

package/src/resources/simulations/index.ts

@@ -27,7 +27,17 @@ export { Deposits, type DepositCreateResponse, type DepositCreateParams } from '
 export {
   Payouts,
   type PayoutRejectResponse,
+  type PayoutReturnResponse,
   type PayoutSendResponse,
   type PayoutRejectParams,
+  type PayoutReturnParams,
 } from './payouts';
+export {
+  Returns,
+  type ReturnRejectResponse,
+  type ReturnReturnResponse,
+  type ReturnSendResponse,
+  type ReturnRejectParams,
+  type ReturnReturnParams,
+} from './returns';
 export { Simulations } from './simulations';

package/src/resources/simulations/payouts.ts

@@ -22,6 +22,23 @@ export class Payouts extends APIResource {
     return this._client.post(path`/v1/simulations/payouts/${id}/reject`, { body, ...options });
   }
 
+  /**
+   * Submits an inbound return for a settled payout through the sandbox provider
+   * pipeline. The return is linked to the payout and the payout is exposed as
+   * returned. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulations.payouts.return(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { reason: 'account_closed' },
+   * );
+   * ```
+   */
+  return(id: string, body: PayoutReturnParams, options?: RequestOptions): APIPromise<PayoutReturnResponse> {
+    return this._client.post(path`/v1/simulations/payouts/${id}/return`, { body, ...options });
+  }
+
   /**
    * Submits a successful send event for an existing payout through the sandbox
    * provider pipeline. This endpoint is unavailable in live production.
@@ -50,6 +67,18 @@ export interface PayoutRejectResponse {
   type: 'payout_simulation';
 }
 
+export interface PayoutReturnResponse {
+  /**
+   * Payout whose lifecycle is being simulated.
+   */
+  payout_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'payout_simulation';
+}
+
 export interface PayoutSendResponse {
   /**
    * Payout whose lifecycle is being simulated.
@@ -71,10 +100,24 @@ export interface PayoutRejectParams {
   reason: 'invalid_routing_number' | 'invalid_account_format';
 }
 
+export interface PayoutReturnParams {
+  /**
+   * Reason the receiving bank returns the settled payout.
+   */
+  reason:
+    | 'account_closed'
+    | 'invalid_account_format'
+    | 'invalid_routing_number'
+    | 'account_blocked'
+    | 'unknown';
+}
+
 export declare namespace Payouts {
   export {
     type PayoutRejectResponse as PayoutRejectResponse,
+    type PayoutReturnResponse as PayoutReturnResponse,
     type PayoutSendResponse as PayoutSendResponse,
     type PayoutRejectParams as PayoutRejectParams,
+    type PayoutReturnParams as PayoutReturnParams,
   };
 }

package/src/resources/simulations/returns.ts

@@ -0,0 +1,123 @@
+// 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 Returns extends APIResource {
+  /**
+   * Submits a network rejection for an existing return through the sandbox provider
+   * pipeline. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulations.returns.reject(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { reason: 'invalid_routing_number' },
+   * );
+   * ```
+   */
+  reject(id: string, body: ReturnRejectParams, options?: RequestOptions): APIPromise<ReturnRejectResponse> {
+    return this._client.post(path`/v1/simulations/returns/${id}/reject`, { body, ...options });
+  }
+
+  /**
+   * Submits an inbound return for a sent return through the sandbox provider
+   * pipeline. The funds are credited back to the original deposit and the return
+   * moves to `returned`. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulations.returns.return(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { reason: 'account_closed' },
+   * );
+   * ```
+   */
+  return(id: string, body: ReturnReturnParams, options?: RequestOptions): APIPromise<ReturnReturnResponse> {
+    return this._client.post(path`/v1/simulations/returns/${id}/return`, { body, ...options });
+  }
+
+  /**
+   * Submits a successful send event for an existing return through the sandbox
+   * provider pipeline. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulations.returns.send(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  send(id: string, options?: RequestOptions): APIPromise<ReturnSendResponse> {
+    return this._client.post(path`/v1/simulations/returns/${id}/send`, options);
+  }
+}
+
+export interface ReturnRejectResponse {
+  /**
+   * Return whose lifecycle is being simulated.
+   */
+  return_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'return_simulation';
+}
+
+export interface ReturnReturnResponse {
+  /**
+   * Return whose lifecycle is being simulated.
+   */
+  return_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'return_simulation';
+}
+
+export interface ReturnSendResponse {
+  /**
+   * Return whose lifecycle is being simulated.
+   */
+  return_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'return_simulation';
+}
+
+export interface ReturnRejectParams {
+  /**
+   * Reason the sandbox provider rejects the return. Use `invalid_routing_number` for
+   * domestic rails and `invalid_account_format` for a SWIFT correspondent rejecting
+   * on the beneficiary details.
+   */
+  reason: 'invalid_routing_number' | 'invalid_account_format';
+}
+
+export interface ReturnReturnParams {
+  /**
+   * Reason the receiving bank returns the sent return.
+   */
+  reason:
+    | 'account_closed'
+    | 'invalid_account_format'
+    | 'invalid_routing_number'
+    | 'account_blocked'
+    | 'unknown';
+}
+
+export declare namespace Returns {
+  export {
+    type ReturnRejectResponse as ReturnRejectResponse,
+    type ReturnReturnResponse as ReturnReturnResponse,
+    type ReturnSendResponse as ReturnSendResponse,
+    type ReturnRejectParams as ReturnRejectParams,
+    type ReturnReturnParams as ReturnReturnParams,
+  };
+}

package/src/resources/simulations/simulations.ts

@@ -30,12 +30,29 @@ import { ConversionCompleteResponse, ConversionFailResponse, Conversions } from
 import * as DepositsAPI from './deposits';
 import { DepositCreateParams, DepositCreateResponse, Deposits } from './deposits';
 import * as PayoutsAPI from './payouts';
-import { PayoutRejectParams, PayoutRejectResponse, PayoutSendResponse, Payouts } from './payouts';
+import {
+  PayoutRejectParams,
+  PayoutRejectResponse,
+  PayoutReturnParams,
+  PayoutReturnResponse,
+  PayoutSendResponse,
+  Payouts,
+} from './payouts';
+import * as ReturnsAPI from './returns';
+import {
+  ReturnRejectParams,
+  ReturnRejectResponse,
+  ReturnReturnParams,
+  ReturnReturnResponse,
+  ReturnSendResponse,
+  Returns,
+} from './returns';
 
 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);
+  returns: ReturnsAPI.Returns = new ReturnsAPI.Returns(this._client);
   accountPrograms: AccountProgramsAPI.AccountPrograms = new AccountProgramsAPI.AccountPrograms(this._client);
   accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
 }
@@ -43,6 +60,7 @@ export class Simulations extends APIResource {
 Simulations.Deposits = Deposits;
 Simulations.Conversions = Conversions;
 Simulations.Payouts = Payouts;
+Simulations.Returns = Returns;
 Simulations.AccountPrograms = AccountPrograms;
 Simulations.Accounts = Accounts;
 
@@ -62,8 +80,19 @@ export declare namespace Simulations {
   export {
     Payouts as Payouts,
     type PayoutRejectResponse as PayoutRejectResponse,
+    type PayoutReturnResponse as PayoutReturnResponse,
     type PayoutSendResponse as PayoutSendResponse,
     type PayoutRejectParams as PayoutRejectParams,
+    type PayoutReturnParams as PayoutReturnParams,
+  };
+
+  export {
+    Returns as Returns,
+    type ReturnRejectResponse as ReturnRejectResponse,
+    type ReturnReturnResponse as ReturnReturnResponse,
+    type ReturnSendResponse as ReturnSendResponse,
+    type ReturnRejectParams as ReturnRejectParams,
+    type ReturnReturnParams as ReturnReturnParams,
   };
 
   export {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.22.1'; // x-release-please-version
+export const VERSION = '0.22.2'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.22.1";
+export declare const VERSION = "0.22.2";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.22.1";
+export declare const VERSION = "0.22.2";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.22.1'; // x-release-please-version
+exports.VERSION = '0.22.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.22.1'; // x-release-please-version
+export const VERSION = '0.22.2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map