modern-treasury 2.3.0 → 2.4.0

package/src/core.ts

@@ -1,22 +1,23 @@
-import { VERSION } from './version';
-import { APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError } from './error';
-import type { Readable } from './_shims/node-readable';
-import { getDefaultAgent, type Agent } from './_shims/agent';
+import { VERSION } from './version.js';
+import { APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError } from './error.js';
+import type { Readable } from './_shims/node-readable.js';
+import { getDefaultAgent, type Agent } from './_shims/agent.js';
 import {
   fetch,
   isPolyfilled as fetchIsPolyfilled,
   type RequestInfo,
   type RequestInit,
   type Response,
+  type HeadersInit,
 } from './_shims/fetch.js';
 export { type Response };
-import { isMultipartBody } from './uploads';
+import { isMultipartBody } from './uploads.js';
 export {
   maybeMultipartFormRequestOptions,
   multipartFormRequestOptions,
   createForm,
   type Uploadable,
-} from './uploads';
+} from './uploads.js';
 
 const MAX_RETRIES = 2;
 
@@ -44,7 +45,7 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
   // TODO handle blob, arraybuffer, other content types, etc.
   const text = await response.text();
   debug('response', response.status, response.url, response.headers, text);
-  return text as T;
+  return text as any as T;
 }
 
 /**
@@ -146,7 +147,7 @@ export abstract class APIClient {
     this.fetch = overridenFetch ?? fetch;
   }
 
-  protected authHeaders(): Headers {
+  protected authHeaders(opts: FinalRequestOptions): Headers {
     return {};
   }
 
@@ -158,13 +159,13 @@ export abstract class APIClient {
    *    Authorization: 'Bearer 123',
    *  }
    */
-  protected defaultHeaders(): Headers {
+  protected defaultHeaders(opts: FinalRequestOptions): Headers {
     return {
       Accept: 'application/json',
       'Content-Type': 'application/json',
       'User-Agent': this.getUserAgent(),
       ...getPlatformHeaders(),
-      ...this.authHeaders(),
+      ...this.authHeaders(opts),
     };
   }
 
@@ -265,7 +266,7 @@ export abstract class APIClient {
 
     const reqHeaders: Record<string, string> = {
       ...(contentLength && { 'Content-Length': contentLength }),
-      ...this.defaultHeaders(),
+      ...this.defaultHeaders(options),
       ...headers,
     };
     // let builtin fetch set the Content-Type for multipart bodies
@@ -297,7 +298,19 @@ export abstract class APIClient {
    * This is useful for cases where you want to add certain headers based off of
    * the request properties, e.g. `method` or `url`.
    */
-  protected async prepareRequest(request: RequestInit, { url }: { url: string }): Promise<void> {}
+  protected async prepareRequest(
+    request: RequestInit,
+    { url, options }: { url: string; options: FinalRequestOptions },
+  ): Promise<void> {}
+
+  protected parseHeaders(headers: HeadersInit | null | undefined): Record<string, string> {
+    return (
+      !headers ? {}
+      : Symbol.iterator in headers ?
+        Object.fromEntries(Array.from(headers as Iterable<string[]>).map((header) => [...header]))
+      : { ...headers }
+    );
+  }
 
   protected makeStatusError(
     status: number | undefined,
@@ -315,10 +328,10 @@ export abstract class APIClient {
     return new APIPromise(this.makeRequest(options, remainingRetries));
   }
 
-  private async makeRequest<T>(
+  private async makeRequest(
     optionsInput: PromiseOrValue<FinalRequestOptions>,
     retriesRemaining: number | null,
-  ): Promise<{ response: Response; options: FinalRequestOptions; controller: AbortController }> {
+  ): Promise<APIResponseProps> {
     const options = await optionsInput;
     if (retriesRemaining == null) {
       retriesRemaining = options.maxRetries ?? this.maxRetries;
@@ -326,7 +339,7 @@ export abstract class APIClient {
 
     const { req, url, timeout } = this.buildRequest(options);
 
-    await this.prepareRequest(req, { url });
+    await this.prepareRequest(req, { url, options });
 
     debug('request', url, options, req.headers);
 
@@ -378,7 +391,7 @@ export abstract class APIClient {
     return new PagePromise<PageClass, Item>(this, request, Page);
   }
 
-  buildURL<Req>(path: string, query: Req | undefined): string {
+  buildURL<Req extends Record<string, unknown>>(path: string, query: Req | null | undefined): string {
     const url =
       isAbsoluteURL(path) ?
         new URL(path)
@@ -455,11 +468,11 @@ export abstract class APIClient {
     return false;
   }
 
-  private async retryRequest<Req extends {}, Rsp>(
-    options: FinalRequestOptions<Req>,
+  private async retryRequest(
+    options: FinalRequestOptions,
     retriesRemaining: number,
     responseHeaders?: Headers | undefined,
-  ): Promise<Rsp> {
+  ): Promise<APIResponseProps> {
     retriesRemaining -= 1;
 
     // About the Retry-After header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
@@ -472,7 +485,7 @@ export abstract class APIClient {
     const timeout = this.calculateRetryTimeoutSeconds(retriesRemaining, retryAfter, maxRetries) * 1000;
     await sleep(timeout);
 
-    return this.request(options, retriesRemaining);
+    return this.makeRequest(options, retriesRemaining);
   }
 
   private calculateRetryTimeoutSeconds(
@@ -556,7 +569,7 @@ export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
     return this.nextPageInfo() != null;
   }
 
-  async getNextPage(): Promise<AbstractPage<Item>> {
+  async getNextPage(): Promise<this> {
     const nextInfo = this.nextPageInfo();
     if (!nextInfo) {
       throw new Error(
@@ -796,7 +809,7 @@ declare const navigator: { userAgent: string } | undefined;
 
 // Note: modified from https://github.com/JS-DevTools/host-environment/blob/b1ab79ecde37db5d6e163c050e54fe7d287d7c92/src/isomorphic.browser.ts
 function getBrowserInfo(): BrowserInfo | null {
-  if (!navigator || typeof navigator === 'undefined') {
+  if (typeof navigator === 'undefined' || !navigator) {
     return null;
   }
 

package/src/error.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { castToError, Headers } from './core';
+import { castToError, Headers } from './core.js';
 
 export class APIError extends Error {
   readonly status: number | undefined;

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'),
@@ -102,8 +116,8 @@ export class ModernTreasury extends Core.APIClient {
       apiKey,
       organizationId,
       webhookKey,
-      baseURL: `https://app.moderntreasury.com`,
       ...opts,
+      baseURL: opts.baseURL ?? `https://app.moderntreasury.com`,
     };
 
     super({
@@ -165,14 +179,14 @@ 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 };
@@ -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;
 
@@ -383,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, Response, APIClient, FinalRequestOptions, coerceInteger, PageInfo } from './core';
+import { AbstractPage, Response, APIClient, FinalRequestOptions, coerceInteger, PageInfo } from './core.js';
 
 export type PageResponse<Item> = 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 {
   /**
@@ -14,36 +14,25 @@ export class AccountCollectionFlows extends APIResource {
     params: AccountCollectionFlowCreateParams,
     options?: Core.RequestOptions,
   ): 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,
-  ): Core.APIPromise<AccountCollectionFlow>;
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<AccountCollectionFlow>;
-  retrieve(
-    id: string,
-    query: AccountCollectionFlowRetrieveParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<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);
   }
 
   /**
@@ -54,11 +43,17 @@ export class AccountCollectionFlows extends APIResource {
     params: AccountCollectionFlowUpdateParams,
     options?: Core.RequestOptions,
   ): 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 },
     });
   }
 
@@ -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 {
   /**
@@ -17,11 +17,17 @@ export class AccountDetails extends APIResource {
     params: AccountDetailCreateParams,
     options?: Core.RequestOptions,
   ): 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 },
     });
   }
 
@@ -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,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 Connections extends APIResource {
   /**