@augustusbank/typescript-sdk 0.23.0 → 0.25.0

package/src/resources/accounts.ts

@@ -157,6 +157,13 @@ export interface AccountCreateResponse {
    */
   label: string;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Current status of the account.
    */
@@ -332,6 +339,13 @@ export interface AccountRetrieveResponse {
    */
   label: string;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Current status of the account.
    */
@@ -507,6 +521,13 @@ export interface AccountListResponse {
    */
   label: string;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Current status of the account.
    */
@@ -682,6 +703,13 @@ export interface AccountCloseResponse {
    */
   label: string;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Current status of the account.
    */
@@ -857,6 +885,13 @@ export interface AccountFreezeResponse {
    */
   label: string;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Current status of the account.
    */
@@ -1070,6 +1105,13 @@ export interface AccountUnfreezeResponse {
    */
   label: string;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Current status of the account.
    */
@@ -1217,17 +1259,23 @@ export interface AccountCreateParams {
    * ID of the account program to create the account under.
    */
   account_program_id: string;
+
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata?: { [key: string]: string } | null;
 }
 
 export interface AccountListParams extends CursorPageParams {
   /**
-   * Filter by account holder name (case-insensitive phrase match). Crypto wallets
-   * are excluded when set.
+   * Filter by account holder name (case-insensitive phrase match).
    */
   account_holder_name?: string;
 
   /**
-   * Filter by exact fiat account number. Crypto wallets are excluded when set.
+   * Filter by exact fiat account number.
    */
   account_number?: string;
 

package/src/resources/api-versions.ts

@@ -20,7 +20,11 @@ export interface APIVersionListResponse {
 
   has_more: boolean;
 
+  has_previous: boolean;
+
   next_cursor: string | null;
+
+  previous_cursor: string | null;
 }
 
 export namespace APIVersionListResponse {

package/src/resources/conversions.ts

@@ -78,7 +78,9 @@ export interface ConversionCreateResponse {
   created_at: string;
 
   /**
-   * Key-value pairs stored with the conversion.
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
    */
   metadata: { [key: string]: string };
 
@@ -135,7 +137,9 @@ export interface ConversionRetrieveResponse {
   created_at: string;
 
   /**
-   * Key-value pairs stored with the conversion.
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
    */
   metadata: { [key: string]: string };
 
@@ -192,7 +196,9 @@ export interface ConversionListResponse {
   created_at: string;
 
   /**
-   * Key-value pairs stored with the conversion.
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
    */
   metadata: { [key: string]: string };
 
@@ -249,7 +255,9 @@ export interface ConversionCreateParams {
   target_account_id: string;
 
   /**
-   * Key-value pairs stored with the conversion.
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
    */
   metadata?: { [key: string]: string } | null;
 }

package/src/resources/counterparties.ts

@@ -9,6 +9,17 @@ import { path } from '../internal/utils/path';
 export class Counterparties extends APIResource {
   /**
    * Creates a counterparty owned by the merchant.
+   *
+   * @example
+   * ```ts
+   * const counterparty = await client.counterparties.create({
+   *   financial_address: {
+   *     account_holder_name: 'Acme Sandbox Ltd.',
+   *     iban: 'DE89370400440532013000',
+   *     type: 'iban',
+   *   },
+   * });
+   * ```
    */
   create(body: CounterpartyCreateParams, options?: RequestOptions): APIPromise<CounterpartyCreateResponse> {
     return this._client.post('/v1/counterparties', { body, ...options });
@@ -16,6 +27,13 @@ export class Counterparties extends APIResource {
 
   /**
    * Retrieves a counterparty owned by the merchant.
+   *
+   * @example
+   * ```ts
+   * const counterparty = await client.counterparties.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<CounterpartyRetrieveResponse> {
     return this._client.get(path`/v1/counterparties/${id}`, options);
@@ -23,6 +41,13 @@ export class Counterparties extends APIResource {
 
   /**
    * Updates the mutable details of a counterparty owned by the merchant.
+   *
+   * @example
+   * ```ts
+   * const counterparty = await client.counterparties.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   update(
     id: string,
@@ -34,6 +59,14 @@ export class Counterparties extends APIResource {
 
   /**
    * Lists counterparties owned by the merchant with cursor-based pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const counterpartyListResponse of client.counterparties.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: CounterpartyListParams | null | undefined = {},
@@ -48,6 +81,13 @@ export class Counterparties extends APIResource {
   /**
    * Blocks payments to and from a counterparty owned by the merchant. Blocking an
    * already-blocked counterparty succeeds without changing the existing block.
+   *
+   * @example
+   * ```ts
+   * const response = await client.counterparties.block(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   block(id: string, options?: RequestOptions): APIPromise<CounterpartyBlockResponse> {
     return this._client.post(path`/v1/counterparties/${id}/block`, options);
@@ -93,6 +133,13 @@ export interface CounterpartyCreateResponse {
    */
   is_self_owned: boolean;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Name of the counterparty, or null if not recorded.
    */
@@ -552,6 +599,13 @@ export interface CounterpartyRetrieveResponse {
    */
   is_self_owned: boolean;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Name of the counterparty, or null if not recorded.
    */
@@ -1011,6 +1065,13 @@ export interface CounterpartyUpdateResponse {
    */
   is_self_owned: boolean;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Name of the counterparty, or null if not recorded.
    */
@@ -1470,6 +1531,13 @@ export interface CounterpartyListResponse {
    */
   is_self_owned: boolean;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Name of the counterparty, or null if not recorded.
    */
@@ -1929,6 +1997,13 @@ export interface CounterpartyBlockResponse {
    */
   is_self_owned: boolean;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Name of the counterparty, or null if not recorded.
    */
@@ -2378,6 +2453,13 @@ export interface CounterpartyCreateParams {
    */
   is_self_owned?: boolean;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata?: { [key: string]: string } | null;
+
   /**
    * Name of the counterparty.
    */

package/src/resources/events.ts

@@ -71,6 +71,12 @@ export interface EventRetrieveResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
+    | 'counterparty.created'
+    | 'counterparty.verified'
+    | 'counterparty.rejected'
+    | 'counterparty.blocked'
+    | 'counterparty.unblocked'
+    | 'counterparty.updated'
     | 'ping.test';
 
   /**
@@ -122,6 +128,12 @@ export interface EventListResponse {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
+    | 'counterparty.created'
+    | 'counterparty.verified'
+    | 'counterparty.rejected'
+    | 'counterparty.blocked'
+    | 'counterparty.unblocked'
+    | 'counterparty.updated'
     | 'ping.test';
 
   /**
@@ -153,6 +165,12 @@ export interface EventListParams extends CursorPageParams {
     | 'conversion.failed'
     | 'account_holder.active'
     | 'account_holder.closed'
+    | 'counterparty.created'
+    | 'counterparty.verified'
+    | 'counterparty.rejected'
+    | 'counterparty.blocked'
+    | 'counterparty.unblocked'
+    | 'counterparty.updated'
     | 'ping.test';
 }
 

package/src/resources/index.ts

@@ -139,6 +139,12 @@ export {
   type ConversionFailedWebhookEvent,
   type AccountHolderActiveWebhookEvent,
   type AccountHolderClosedWebhookEvent,
+  type CounterpartyCreatedWebhookEvent,
+  type CounterpartyVerifiedWebhookEvent,
+  type CounterpartyRejectedWebhookEvent,
+  type CounterpartyBlockedWebhookEvent,
+  type CounterpartyUnblockedWebhookEvent,
+  type CounterpartyUpdatedWebhookEvent,
   type PingTestWebhookEvent,
   type UnwrapWebhookEvent,
 } from './webhooks';

package/src/resources/payouts.ts

@@ -96,7 +96,9 @@ export interface PayoutCreateResponse {
   initiated_at: string;
 
   /**
-   * Key-value pairs stored with the payout.
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
    */
   metadata: { [key: string]: string };
 
@@ -230,7 +232,9 @@ export interface PayoutRetrieveResponse {
   initiated_at: string;
 
   /**
-   * Key-value pairs stored with the payout.
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
    */
   metadata: { [key: string]: string };
 
@@ -364,7 +368,9 @@ export interface PayoutListResponse {
   initiated_at: string;
 
   /**
-   * Key-value pairs stored with the payout.
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
    */
   metadata: { [key: string]: string };
 
@@ -483,7 +489,9 @@ export interface PayoutCreateParams {
   currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
 
   /**
-   * Key-value pairs stored with the payout.
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
    */
   metadata?: { [key: string]: string } | null;
 

package/src/resources/returns.ts

@@ -87,6 +87,13 @@ export interface ReturnCreateResponse {
    */
   initiated_at: string;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Payment scheme or blockchain used for the return, or null when unknown.
    */
@@ -199,6 +206,13 @@ export interface ReturnRetrieveResponse {
    */
   initiated_at: string;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Payment scheme or blockchain used for the return, or null when unknown.
    */
@@ -311,6 +325,13 @@ export interface ReturnListResponse {
    */
   initiated_at: string;
 
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata: { [key: string]: string };
+
   /**
    * Payment scheme or blockchain used for the return, or null when unknown.
    */
@@ -397,6 +418,13 @@ export interface ReturnCreateParams {
    * Deposit to return funds from.
    */
   deposit_id: string;
+
+  /**
+   * Set of up to 50 key-value string pairs you can attach to store structured
+   * information, such as correlating this resource with an object in your own
+   * system. Keys may be up to 40 characters and values up to 500 characters.
+   */
+  metadata?: { [key: string]: string } | null;
 }
 
 export interface ReturnListParams extends CursorPageParams {

package/src/resources/scopes.ts

@@ -20,7 +20,11 @@ export interface ScopeListResponse {
 
   has_more: boolean;
 
+  has_previous: boolean;
+
   next_cursor: string | null;
+
+  previous_cursor: string | null;
 }
 
 export namespace ScopeListResponse {

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

@@ -14,7 +14,7 @@ export class AccountPrograms extends APIResource {
    * ```ts
    * const accountProgram =
    *   await client.simulations.accountPrograms.create({
-   *     label: 'x',
+   *     label: 'Primary FBO program',
    *     type: 'fbo_program',
    *   });
    * ```

package/src/resources/simulations/accounts.ts

@@ -13,7 +13,7 @@ export class Accounts extends APIResource {
    * @example
    * ```ts
    * const account = await client.simulations.accounts.create({
-   *   label: 'x',
+   *   label: 'Operating EUR account',
    *   type: 'operating',
    * });
    * ```

package/src/resources/simulations/counterparties.ts

@@ -0,0 +1,40 @@
+// 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 Counterparties extends APIResource {
+  /**
+   * Submits a rejected provider decision for an existing counterparty with a pending
+   * verification attempt. This endpoint is unavailable in live production.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.simulations.counterparties.reject(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  reject(id: string, options?: RequestOptions): APIPromise<CounterpartyRejectResponse> {
+    return this._client.post(path`/v1/simulations/counterparties/${id}/reject`, options);
+  }
+}
+
+export interface CounterpartyRejectResponse {
+  /**
+   * Counterparty whose verification is being simulated.
+   */
+  counterparty_id: string;
+
+  /**
+   * Resource type discriminator.
+   */
+  type: 'counterparty_simulation';
+}
+
+export declare namespace Counterparties {
+  export { type CounterpartyRejectResponse as CounterpartyRejectResponse };
+}

package/src/resources/simulations/deposits.ts

@@ -13,7 +13,7 @@ export class Deposits extends APIResource {
    * ```ts
    * const deposit = await client.simulations.deposits.create({
    *   account_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   amount: '869.225610155',
+   *   amount: '100.50',
    *   currency: 'EUR',
    * });
    * ```

package/src/resources/simulations/index.ts

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

package/src/resources/simulations/simulations.ts

@@ -27,6 +27,8 @@ import {
 } from './accounts';
 import * as ConversionsAPI from './conversions';
 import { ConversionCompleteResponse, ConversionFailResponse, Conversions } from './conversions';
+import * as CounterpartiesAPI from './counterparties';
+import { Counterparties, CounterpartyRejectResponse } from './counterparties';
 import * as DepositsAPI from './deposits';
 import { DepositCreateParams, DepositCreateResponse, Deposits } from './deposits';
 import * as PayoutsAPI from './payouts';
@@ -51,6 +53,7 @@ import {
 export class Simulations extends APIResource {
   deposits: DepositsAPI.Deposits = new DepositsAPI.Deposits(this._client);
   conversions: ConversionsAPI.Conversions = new ConversionsAPI.Conversions(this._client);
+  counterparties: CounterpartiesAPI.Counterparties = new CounterpartiesAPI.Counterparties(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);
@@ -59,6 +62,7 @@ export class Simulations extends APIResource {
 
 Simulations.Deposits = Deposits;
 Simulations.Conversions = Conversions;
+Simulations.Counterparties = Counterparties;
 Simulations.Payouts = Payouts;
 Simulations.Returns = Returns;
 Simulations.AccountPrograms = AccountPrograms;
@@ -77,6 +81,8 @@ export declare namespace Simulations {
     type ConversionFailResponse as ConversionFailResponse,
   };
 
+  export { Counterparties as Counterparties, type CounterpartyRejectResponse as CounterpartyRejectResponse };
+
   export {
     Payouts as Payouts,
     type PayoutRejectResponse as PayoutRejectResponse,