@augustusbank/typescript-sdk 0.22.0 → 0.22.2

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.
@@ -40,19 +57,21 @@ export class Payouts extends APIResource {
 
 export interface PayoutRejectResponse {
   /**
-   * Payout lifecycle event submitted to the sandbox provider.
+   * Payout whose lifecycle is being simulated.
    */
-  event: 'send' | 'reject' | 'return';
+  payout_id: string;
 
   /**
-   * Payout whose lifecycle is being simulated.
+   * Resource type discriminator.
    */
-  payout_id: string;
+  type: 'payout_simulation';
+}
 
+export interface PayoutReturnResponse {
   /**
-   * Whether the simulation submission was successful.
+   * Payout whose lifecycle is being simulated.
    */
-  success: boolean;
+  payout_id: string;
 
   /**
    * Resource type discriminator.
@@ -61,21 +80,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,15 +93,31 @@ 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' | 'invalid_account_format';
+}
+
+export interface PayoutReturnParams {
+  /**
+   * Reason the receiving bank returns the settled payout.
    */
-  reason: 'invalid_routing_number';
+  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

@@ -25,20 +25,42 @@ 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';
-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);
 }
 
 Simulations.Deposits = Deposits;
+Simulations.Conversions = Conversions;
 Simulations.Payouts = Payouts;
+Simulations.Returns = Returns;
 Simulations.AccountPrograms = AccountPrograms;
 Simulations.Accounts = Accounts;
 
@@ -49,11 +71,28 @@ 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,
+    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/resources/transactions.ts

@@ -56,6 +56,13 @@ export interface TransactionRetrieveResponse {
    */
   counterparty: TransactionRetrieveResponse.Counterparty | null;
 
+  /**
+   * ID of the counterparty this transaction is associated with, or null when none
+   * was resolved. Correlates with the counterparties API and a payout's
+   * counterparty_id.
+   */
+  counterparty_id: string | null;
+
   /**
    * Currency code (ISO 4217 or crypto).
    */
@@ -88,11 +95,23 @@ export interface TransactionRetrieveResponse {
    */
   side: 'credit' | 'debit';
 
+  /**
+   * The resource that originated this transaction, or null when it does not map to a
+   * retrievable resource.
+   */
+  source: TransactionRetrieveResponse.Source | null;
+
   /**
    * State of the transaction. Transactions are by definition booked.
    */
   status: 'booked';
 
+  /**
+   * Reference used to track the payment across the payment network, such as the UETR
+   * for SWIFT payments.
+   */
+  tracking_reference: string | null;
+
   /**
    * Transaction hash for crypto transactions, or null when not known. Only
    * blockchain rails support this field.
@@ -537,6 +556,22 @@ export namespace TransactionRetrieveResponse {
       state: string | null;
     }
   }
+
+  /**
+   * The resource that originated this transaction, or null when it does not map to a
+   * retrievable resource.
+   */
+  export interface Source {
+    /**
+     * Identifier of the originating resource, retrievable on its own endpoint.
+     */
+    id: string;
+
+    /**
+     * Type of the resource that originated this transaction.
+     */
+    type: 'deposit' | 'payout' | 'return';
+  }
 }
 
 export interface TransactionListResponse {
@@ -565,6 +600,13 @@ export interface TransactionListResponse {
    */
   counterparty: TransactionListResponse.Counterparty | null;
 
+  /**
+   * ID of the counterparty this transaction is associated with, or null when none
+   * was resolved. Correlates with the counterparties API and a payout's
+   * counterparty_id.
+   */
+  counterparty_id: string | null;
+
   /**
    * Currency code (ISO 4217 or crypto).
    */
@@ -597,11 +639,23 @@ export interface TransactionListResponse {
    */
   side: 'credit' | 'debit';
 
+  /**
+   * The resource that originated this transaction, or null when it does not map to a
+   * retrievable resource.
+   */
+  source: TransactionListResponse.Source | null;
+
   /**
    * State of the transaction. Transactions are by definition booked.
    */
   status: 'booked';
 
+  /**
+   * Reference used to track the payment across the payment network, such as the UETR
+   * for SWIFT payments.
+   */
+  tracking_reference: string | null;
+
   /**
    * Transaction hash for crypto transactions, or null when not known. Only
    * blockchain rails support this field.
@@ -1046,6 +1100,22 @@ export namespace TransactionListResponse {
       state: string | null;
     }
   }
+
+  /**
+   * The resource that originated this transaction, or null when it does not map to a
+   * retrievable resource.
+   */
+  export interface Source {
+    /**
+     * Identifier of the originating resource, retrievable on its own endpoint.
+     */
+    id: string;
+
+    /**
+     * Type of the resource that originated this transaction.
+     */
+    type: 'deposit' | 'payout' | 'return';
+  }
 }
 
 export interface TransactionListParams extends CursorPageParams {

package/src/resources/webhook-subscriptions.ts

@@ -14,7 +14,7 @@ export class WebhookSubscriptions extends APIResource {
    * ```ts
    * const webhookSubscription =
    *   await client.webhookSubscriptions.create({
-   *     events: ['payout.paid'],
+   *     events: ['payout.sent'],
    *     url: 'https://sandbox.example.com/webhooks/augustus',
    *   });
    * ```
@@ -133,15 +133,17 @@ export interface WebhookSubscriptionCreateResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -180,15 +182,17 @@ export interface WebhookSubscriptionRetrieveResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -227,15 +231,17 @@ export interface WebhookSubscriptionUpdateResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -274,15 +280,17 @@ export interface WebhookSubscriptionListResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -321,15 +329,17 @@ export interface WebhookSubscriptionDeleteResponse {
    * Event types this subscription receives.
    */
   events: Array<
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -380,15 +390,17 @@ export interface WebhookSubscriptionSendTestEventResponse {
    * Event type.
    */
   event_type:
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -407,15 +419,17 @@ export interface WebhookSubscriptionCreateParams {
    * Event types to subscribe to. Use ["*"] for all events.
    */
   events: Array<
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'
@@ -436,15 +450,17 @@ export interface WebhookSubscriptionUpdateParams {
    * events.
    */
   events?: Array<
-    | 'payout.created'
     | 'payout.initiated'
-    | 'payout.paid'
+    | 'payout.submitted'
+    | 'payout.sent'
     | 'payout.failed'
+    | 'payout.returned'
     | 'return.initiated'
-    | 'return.paid'
+    | 'return.submitted'
+    | 'return.sent'
     | 'return.failed'
     | 'return.returned'
-    | 'deposit.received'
+    | 'deposit.settled'
     | 'conversion.created'
     | 'conversion.completed'
     | 'conversion.failed'