@augustusbank/typescript-sdk 0.22.2 → 0.24.0

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/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/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/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,

package/src/resources/webhook-subscriptions.ts

@@ -151,6 +151,13 @@ export interface WebhookSubscriptionCreateResponse {
     | 'account_holder.closed'
   >;
 
+  /**
+   * 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 };
+
   /**
    * Resource type discriminator.
    */
@@ -200,6 +207,13 @@ export interface WebhookSubscriptionRetrieveResponse {
     | 'account_holder.closed'
   >;
 
+  /**
+   * 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 };
+
   /**
    * Resource type discriminator.
    */
@@ -249,6 +263,13 @@ export interface WebhookSubscriptionUpdateResponse {
     | 'account_holder.closed'
   >;
 
+  /**
+   * 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 };
+
   /**
    * Resource type discriminator.
    */
@@ -298,6 +319,13 @@ export interface WebhookSubscriptionListResponse {
     | 'account_holder.closed'
   >;
 
+  /**
+   * 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 };
+
   /**
    * Resource type discriminator.
    */
@@ -347,6 +375,13 @@ export interface WebhookSubscriptionDeleteResponse {
     | 'account_holder.closed'
   >;
 
+  /**
+   * 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 };
+
   /**
    * Resource type discriminator.
    */
@@ -442,6 +477,13 @@ export interface WebhookSubscriptionCreateParams {
    * The HTTPS URL where webhook events will be delivered.
    */
   url: 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 WebhookSubscriptionUpdateParams {

package/src/resources/webhooks.ts

@@ -86,7 +86,9 @@ export namespace PayoutInitiatedWebhookEvent {
     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 };
 
@@ -252,7 +254,9 @@ export namespace PayoutSubmittedWebhookEvent {
     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 };
 
@@ -418,7 +422,9 @@ export namespace PayoutSentWebhookEvent {
     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 };
 
@@ -584,7 +590,9 @@ export namespace PayoutFailedWebhookEvent {
     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 };
 
@@ -750,7 +758,9 @@ export namespace PayoutReturnedWebhookEvent {
     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 };
 
@@ -910,6 +920,13 @@ export namespace ReturnInitiatedWebhookEvent {
      */
     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.
      */
@@ -1054,6 +1071,13 @@ export namespace ReturnSubmittedWebhookEvent {
      */
     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.
      */
@@ -1198,6 +1222,13 @@ export namespace ReturnSentWebhookEvent {
      */
     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.
      */
@@ -1342,6 +1373,13 @@ export namespace ReturnFailedWebhookEvent {
      */
     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.
      */
@@ -1486,6 +1524,13 @@ export namespace ReturnReturnedWebhookEvent {
      */
     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.
      */
@@ -1735,7 +1780,9 @@ export namespace ConversionCreatedWebhookEvent {
     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 };
 
@@ -1824,7 +1871,9 @@ export namespace ConversionCompletedWebhookEvent {
     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 };
 
@@ -1913,7 +1962,9 @@ export namespace ConversionFailedWebhookEvent {
     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 };
 
@@ -2012,6 +2063,13 @@ export namespace AccountHolderActiveWebhookEvent {
      */
     holder_type: 'natural_person' | 'business';
 
+    /**
+     * 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 account holder status.
      */
@@ -5945,6 +6003,13 @@ export namespace AccountHolderClosedWebhookEvent {
      */
     holder_type: 'natural_person' | 'business';
 
+    /**
+     * 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 account holder status.
      */

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.22.2";
+export declare const VERSION = "0.24.0";
 //# 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.2'; // x-release-please-version
+exports.VERSION = '0.24.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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