modern-treasury 2.2.0 → 2.4.0

package/src/index.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from './core';
-import * as Pagination from './pagination';
-import * as API from './resources/index';
-import * as Errors from './error';
-import type { Agent } from './_shims/agent';
-import * as Uploads from './uploads';
+import * as Core from './core.js';
+import * as Pagination from './pagination.js';
+import * as API from './resources/index.js';
+import * as Errors from './error.js';
+import type { Agent } from './_shims/agent.js';
+import * as Uploads from './uploads.js';
 import * as qs from 'qs';
 
 export interface ClientOptions {
@@ -73,7 +73,7 @@ export interface ClientOptions {
   webhookKey?: string | null;
 }
 
-/** Instantiate the API Client. */
+/** API Client for interfacing with the Modern Treasury API. */
 export class ModernTreasury extends Core.APIClient {
   apiKey: string;
   organizationId: string;
@@ -81,6 +81,20 @@ export class ModernTreasury extends Core.APIClient {
 
   private _options: ClientOptions;
 
+  /**
+   * API Client for interfacing with the Modern Treasury API.
+   *
+   * @param {string} [opts.apiKey=process.env['MODERN_TREASURY_API_KEY']] - The API Key to send to the API.
+   * @param {string} [opts.baseURL] - Override the default base URL for the API.
+   * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+   * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+   * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+   * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+   * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+   * @param {string} [opts.organizationId]
+   * @param {string | null} [opts.webhookKey]
+   */
   constructor({
     apiKey = Core.readEnv('MODERN_TREASURY_API_KEY'),
     organizationId = Core.readEnv('MODERN_TREASURY_ORGANIZATION_ID'),
@@ -89,7 +103,7 @@ export class ModernTreasury extends Core.APIClient {
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
       throw new Error(
-        'The MODERN_TREASURY_API_KEY environment variable is missing or empty; either provide it, or instantiate the ModernTreasury client with an apiKey option, like new ModernTreasury({ apiKey: undefined }).',
+        "The MODERN_TREASURY_API_KEY environment variable is missing or empty; either provide it, or instantiate the ModernTreasury client with an apiKey option, like new ModernTreasury({ apiKey: 'my apiKey' }).",
       );
     }
     if (organizationId === undefined) {
@@ -102,13 +116,13 @@ export class ModernTreasury extends Core.APIClient {
       apiKey,
       organizationId,
       webhookKey,
-      baseURL: `https://app.moderntreasury.com`,
       ...opts,
+      baseURL: opts.baseURL ?? `https://app.moderntreasury.com`,
     };
 
     super({
       baseURL: options.baseURL!,
-      timeout: options.timeout,
+      timeout: options.timeout ?? 60000 /* 1 minute */,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
       fetch: options.fetch,
@@ -157,7 +171,7 @@ export class ModernTreasury extends Core.APIClient {
    * A test endpoint often used to confirm credentials and headers are being passed
    * in correctly.
    */
-  ping(options?: Core.RequestOptions): Promise<Core.APIResponse<ModernTreasury.PingResponse>> {
+  ping(options?: Core.RequestOptions): Core.APIPromise<ModernTreasury.PingResponse> {
     return this.get('/api/ping', options);
   }
 
@@ -165,21 +179,21 @@ export class ModernTreasury extends Core.APIClient {
     return this._options.defaultQuery;
   }
 
-  protected override defaultHeaders(): Core.Headers {
+  protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
     return {
-      ...super.defaultHeaders(),
+      ...super.defaultHeaders(opts),
       ...this._options.defaultHeaders,
     };
   }
 
-  protected override authHeaders(): Core.Headers {
+  protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
     const credentials = `${this.organizationId}:${this.apiKey}`;
     const Authorization = `Basic ${Core.toBase64(credentials)}`;
     return { Authorization };
   }
 
   protected override stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'repeat' });
+    return qs.stringify(query, { arrayFormat: 'brackets' });
   }
 
   static ModernTreasury = this;
@@ -221,6 +235,8 @@ export namespace ModernTreasury {
   export import toFile = Uploads.toFile;
   export import fileFromPath = Uploads.fileFromPath;
 
+  export import RequestOptions = Core.RequestOptions;
+
   export import Page = Pagination.Page;
   export import PageParams = Pagination.PageParams;
   export import PageResponse = Pagination.PageResponse;
@@ -288,7 +304,6 @@ export namespace ModernTreasury {
   export import AccountCollectionFlow = API.AccountCollectionFlow;
   export import AccountCollectionFlowsPage = API.AccountCollectionFlowsPage;
   export import AccountCollectionFlowCreateParams = API.AccountCollectionFlowCreateParams;
-  export import AccountCollectionFlowRetrieveParams = API.AccountCollectionFlowRetrieveParams;
   export import AccountCollectionFlowUpdateParams = API.AccountCollectionFlowUpdateParams;
   export import AccountCollectionFlowListParams = API.AccountCollectionFlowListParams;
 
@@ -329,7 +344,6 @@ export namespace ModernTreasury {
   export import LedgerAccountCategoryRetrieveParams = API.LedgerAccountCategoryRetrieveParams;
   export import LedgerAccountCategoryUpdateParams = API.LedgerAccountCategoryUpdateParams;
   export import LedgerAccountCategoryListParams = API.LedgerAccountCategoryListParams;
-  export import LedgerAccountCategoryDeleteParams = API.LedgerAccountCategoryDeleteParams;
 
   export import LedgerAccounts = API.LedgerAccounts;
   export import LedgerAccount = API.LedgerAccount;
@@ -384,7 +398,6 @@ export namespace ModernTreasury {
   export import PaymentFlow = API.PaymentFlow;
   export import PaymentFlowsPage = API.PaymentFlowsPage;
   export import PaymentFlowCreateParams = API.PaymentFlowCreateParams;
-  export import PaymentFlowRetrieveParams = API.PaymentFlowRetrieveParams;
   export import PaymentFlowUpdateParams = API.PaymentFlowUpdateParams;
   export import PaymentFlowListParams = API.PaymentFlowListParams;
 

package/src/pagination.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { AbstractPage, APIResponse, APIClient, FinalRequestOptions, coerceInteger, PageInfo } from './core';
+import { AbstractPage, Response, APIClient, FinalRequestOptions, coerceInteger, PageInfo } from './core.js';
 
 export type PageResponse<Item> = Item[];
 
@@ -17,12 +17,12 @@ export class Page<Item> extends AbstractPage<Item> {
 
   after_cursor: string | null;
 
-  constructor(client: APIClient, response: APIResponse<PageResponse<Item>>, options: FinalRequestOptions) {
-    super(client, response, options);
+  constructor(client: APIClient, response: Response, body: PageResponse<Item>, options: FinalRequestOptions) {
+    super(client, response, body, options);
 
-    this.items = response || [];
-    this.per_page = coerceInteger(response.responseHeaders['x-per-page'] || null);
-    this.after_cursor = response.responseHeaders['x-after-cursor'] || null;
+    this.items = body || [];
+    this.per_page = coerceInteger(this.response.headers.get('x-per-page') || null);
+    this.after_cursor = this.response.headers.get('x-after-cursor') || null;
   }
 
   getPaginatedItems(): Item[] {

package/src/resource.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import type { ModernTreasury } from './index';
+import type { ModernTreasury } from './index.js';
 
 export class APIResource {
   protected client: ModernTreasury;

package/src/resources/account-collection-flows.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class AccountCollectionFlows extends APIResource {
   /**
@@ -13,37 +13,26 @@ export class AccountCollectionFlows extends APIResource {
   create(
     params: AccountCollectionFlowCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountCollectionFlow>> {
+  ): Core.APIPromise<AccountCollectionFlow> {
+    // @ts-expect-error idempotency key header isn't defined anymore but is included here for back-compat
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    if (idempotencyKey) {
+      console.warn(
+        "The Idempotency-Key request param is deprecated, the 'idempotencyToken' option should be set instead",
+      );
+    }
     return this.post('/api/account_collection_flows', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
   /**
    * get account_collection_flow
    */
-  retrieve(
-    id: string,
-    query?: AccountCollectionFlowRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountCollectionFlow>>;
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<AccountCollectionFlow>>;
-  retrieve(
-    id: string,
-    query: AccountCollectionFlowRetrieveParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountCollectionFlow>> {
-    if (isRequestOptions(query)) {
-      return this.retrieve(id, {}, query);
-    }
-    const { 'Idempotency-Key': idempotencyKey } = query;
-    return this.get(`/api/account_collection_flows/${id}`, {
-      ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
-    });
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<AccountCollectionFlow> {
+    return this.get(`/api/account_collection_flows/${id}`, options);
   }
 
   /**
@@ -53,12 +42,18 @@ export class AccountCollectionFlows extends APIResource {
     id: string,
     params: AccountCollectionFlowUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountCollectionFlow>> {
+  ): Core.APIPromise<AccountCollectionFlow> {
+    // @ts-expect-error idempotency key header isn't defined anymore but is included here for back-compat
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    if (idempotencyKey) {
+      console.warn(
+        "The Idempotency-Key request param is deprecated, the 'idempotencyToken' option should be set instead",
+      );
+    }
     return this.patch(`/api/account_collection_flows/${id}`, {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -68,12 +63,12 @@ export class AccountCollectionFlows extends APIResource {
   list(
     query?: AccountCollectionFlowListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountCollectionFlowsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<AccountCollectionFlowsPage>;
+  ): Core.PagePromise<AccountCollectionFlowsPage, AccountCollectionFlow>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AccountCollectionFlowsPage, AccountCollectionFlow>;
   list(
     query: AccountCollectionFlowListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountCollectionFlowsPage> {
+  ): Core.PagePromise<AccountCollectionFlowsPage, AccountCollectionFlow> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -131,41 +126,19 @@ export interface AccountCollectionFlow {
 
 export interface AccountCollectionFlowCreateParams {
   /**
-   * Body param: Required.
+   * Required.
    */
   counterparty_id: string;
 
-  /**
-   * Body param:
-   */
   payment_types: Array<string>;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
-}
-
-export interface AccountCollectionFlowRetrieveParams {
-  /**
-   * This key should be something unique, preferably something like an UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface AccountCollectionFlowUpdateParams {
   /**
-   * Body param: Required. The updated status of the account collection flow. Can
-   * only be used to mark a flow as `cancelled`.
+   * Required. The updated status of the account collection flow. Can only be used to
+   * mark a flow as `cancelled`.
    */
   status: 'cancelled';
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface AccountCollectionFlowListParams extends PageParams {
@@ -182,7 +155,6 @@ export namespace AccountCollectionFlows {
   export import AccountCollectionFlow = API.AccountCollectionFlow;
   export type AccountCollectionFlowsPage = _AccountCollectionFlowsPage;
   export import AccountCollectionFlowCreateParams = API.AccountCollectionFlowCreateParams;
-  export import AccountCollectionFlowRetrieveParams = API.AccountCollectionFlowRetrieveParams;
   export import AccountCollectionFlowUpdateParams = API.AccountCollectionFlowUpdateParams;
   export import AccountCollectionFlowListParams = API.AccountCollectionFlowListParams;
 }

package/src/resources/account-details.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as Shared from './shared';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as Shared from './shared.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class AccountDetails extends APIResource {
   /**
@@ -16,12 +16,18 @@ export class AccountDetails extends APIResource {
     accountId: string,
     params: AccountDetailCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountDetail>> {
+  ): Core.APIPromise<AccountDetail> {
+    // @ts-expect-error idempotency key header isn't defined anymore but is included here for back-compat
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    if (idempotencyKey) {
+      console.warn(
+        "The Idempotency-Key request param is deprecated, the 'idempotencyToken' option should be set instead",
+      );
+    }
     return this.post(`/api/${accountsType}/${accountId}/account_details`, {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -33,7 +39,7 @@ export class AccountDetails extends APIResource {
     accountId: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountDetail>> {
+  ): Core.APIPromise<AccountDetail> {
     return this.get(`/api/${accountsType}/${accountId}/account_details/${id}`, options);
   }
 
@@ -45,18 +51,18 @@ export class AccountDetails extends APIResource {
     accountId: string,
     query?: AccountDetailListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountDetailsPage>;
+  ): Core.PagePromise<AccountDetailsPage, AccountDetail>;
   list(
     accountsType: Shared.AccountsType,
     accountId: string,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountDetailsPage>;
+  ): Core.PagePromise<AccountDetailsPage, AccountDetail>;
   list(
     accountsType: Shared.AccountsType,
     accountId: string,
     query: AccountDetailListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountDetailsPage> {
+  ): Core.PagePromise<AccountDetailsPage, AccountDetail> {
     if (isRequestOptions(query)) {
       return this.list(accountsType, accountId, {}, query);
     }
@@ -74,7 +80,7 @@ export class AccountDetails extends APIResource {
     accountId: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<void>> {
+  ): Core.APIPromise<void> {
     return this.delete(`/api/${accountsType}/${accountId}/account_details/${id}`, {
       ...options,
       headers: { Accept: '', ...options?.headers },
@@ -122,21 +128,15 @@ export interface AccountDetail {
 
 export interface AccountDetailCreateParams {
   /**
-   * Body param: The account number for the bank account.
+   * The account number for the bank account.
    */
   account_number: string;
 
   /**
-   * Body param: One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if
-   * the bank account number is in a generic format.
+   * One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if the bank
+   * account number is in a generic format.
    */
   account_number_type?: 'clabe' | 'iban' | 'other' | 'pan' | 'wallet_address';
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface AccountDetailListParams extends PageParams {}

package/src/resources/connections.ts

@@ -1,21 +1,24 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as API from './index';
-import { Page, PageParams } from '../pagination';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class Connections extends APIResource {
   /**
    * Get a list of all connections.
    */
-  list(query?: ConnectionListParams, options?: Core.RequestOptions): Core.PagePromise<ConnectionsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ConnectionsPage>;
+  list(
+    query?: ConnectionListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ConnectionsPage, Connection>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ConnectionsPage, Connection>;
   list(
     query: ConnectionListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ConnectionsPage> {
+  ): Core.PagePromise<ConnectionsPage, Connection> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }