modern-treasury 2.6.0 → 2.7.2

package/src/_shims/web-types.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export type Agent = any;
+
+declare const _fetch: typeof fetch;
+export { _fetch as fetch };
+
+type _Request = Request;
+export { _Request as Request };
+
+type _RequestInfo = RequestInfo;
+export { type _RequestInfo as RequestInfo };
+
+type _RequestInit = RequestInit;
+export { type _RequestInit as RequestInit };
+
+type _Response = Response;
+export { _Response as Response };
+
+type _ResponseInit = ResponseInit;
+export { type _ResponseInit as ResponseInit };
+
+type _ResponseType = ResponseType;
+export { type _ResponseType as ResponseType };
+
+type _BodyInit = BodyInit;
+export { type _BodyInit as BodyInit };
+
+type _Headers = Headers;
+export { _Headers as Headers };
+
+type _HeadersInit = HeadersInit;
+export { type _HeadersInit as HeadersInit };
+
+type EndingType = 'native' | 'transparent';
+
+export interface BlobPropertyBag {
+  endings?: EndingType;
+  type?: string;
+}
+
+export interface FilePropertyBag extends BlobPropertyBag {
+  lastModified?: number;
+}
+
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
+
+type _FormData = FormData;
+declare const _FormData: typeof FormData;
+export { _FormData as FormData };
+
+type _File = File;
+declare const _File: typeof File;
+export { _File as File };
+
+type _Blob = Blob;
+declare const _Blob: typeof Blob;
+export { _Blob as Blob };
+
+export declare class Readable {
+  readable: boolean;
+  readonly readableEnded: boolean;
+  readonly readableFlowing: boolean | null;
+  readonly readableHighWaterMark: number;
+  readonly readableLength: number;
+  readonly readableObjectMode: boolean;
+  destroyed: boolean;
+  read(size?: number): any;
+  pause(): this;
+  resume(): this;
+  isPaused(): boolean;
+  destroy(error?: Error): this;
+  [Symbol.asyncIterator](): AsyncIterableIterator<any>;
+}
+
+export declare class FsReadStream extends Readable {
+  path: {}; // node type is string | Buffer
+}
+
+type _ReadableStream<R = any> = ReadableStream<R>;
+export { type _ReadableStream as ReadableStream };

package/src/_shims/web-types.js

@@ -0,0 +1,3 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */

package/src/_shims/web-types.mjs

@@ -0,0 +1,3 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */

package/src/core.ts

@@ -1,23 +1,30 @@
-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 { VERSION } from './version';
 import {
+  ModernTreasuryError,
+  APIError,
+  APIConnectionError,
+  APIConnectionTimeoutError,
+  APIUserAbortError,
+} from './error';
+import {
+  kind as shimsKind,
+  type Readable,
+  getDefaultAgent,
+  type Agent,
   fetch,
-  isPolyfilled as fetchIsPolyfilled,
   type RequestInfo,
   type RequestInit,
   type Response,
   type HeadersInit,
-} from './_shims/fetch.js';
+} from './_shims/index';
 export { type Response };
-import { isMultipartBody } from './uploads.js';
+import { isMultipartBody } from './uploads';
 export {
   maybeMultipartFormRequestOptions,
   multipartFormRequestOptions,
   createForm,
   type Uploadable,
-} from './uploads.js';
+} from './uploads';
 
 const MAX_RETRIES = 2;
 
@@ -77,6 +84,12 @@ export class APIPromise<T> extends Promise<T> {
    *
    * If you want to parse the response body but still get the `Response`
    * instance, you can use {@link withResponse()}.
+   *
+   * 👋 Getting the wrong TypeScript type for `Response`?
+   * Try setting `"moduleResolution": "NodeNext"` if you can,
+   * or add one of these imports before your first `import … from 'modern-treasury'`:
+   * - `import 'modern-treasury/shims/node'` (if you're running on Node)
+   * - `import 'modern-treasury/shims/web'` (otherwise)
    */
   asResponse(): Promise<Response> {
     return this.responsePromise.then((p) => p.response);
@@ -86,6 +99,13 @@ export class APIPromise<T> extends Promise<T> {
    *
    * If you just want to get the raw `Response` instance without parsing it,
    * you can use {@link asResponse()}.
+   *
+   *
+   * 👋 Getting the wrong TypeScript type for `Response`?
+   * Try setting `"moduleResolution": "NodeNext"` if you can,
+   * or add one of these imports before your first `import … from 'modern-treasury'`:
+   * - `import 'modern-treasury/shims/node'` (if you're running on Node)
+   * - `import 'modern-treasury/shims/web'` (otherwise)
    */
   async withResponse(): Promise<{ data: T; response: Response }> {
     const [data, response] = await Promise.all([this.parse(), this.asResponse()]);
@@ -270,7 +290,7 @@ export abstract class APIClient {
       ...headers,
     };
     // let builtin fetch set the Content-Type for multipart bodies
-    if (isMultipartBody(options.body) && !fetchIsPolyfilled) {
+    if (isMultipartBody(options.body) && shimsKind !== 'node') {
       delete reqHeaders['Content-Type'];
     }
 
@@ -419,7 +439,7 @@ export abstract class APIClient {
         if (value === null) {
           return `${encodeURIComponent(key)}=`;
         }
-        throw new Error(
+        throw new ModernTreasuryError(
           `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
         );
       })
@@ -437,11 +457,14 @@ export abstract class APIClient {
 
     const timeout = setTimeout(() => controller.abort(), ms);
 
-    return this.getRequestClient()
-      .fetch(url, { signal: controller.signal as any, ...options })
-      .finally(() => {
-        clearTimeout(timeout);
-      });
+    return (
+      this.getRequestClient()
+        // use undefined this binding; fetch errors if bound to something else in browser/cloudflare
+        .fetch.call(undefined, url, { signal: controller.signal as any, ...options })
+        .finally(() => {
+          clearTimeout(timeout);
+        })
+    );
   }
 
   protected getRequestClient(): RequestClient {
@@ -479,32 +502,37 @@ export abstract class APIClient {
     retriesRemaining -= 1;
 
     // About the Retry-After header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
-    //
-    // TODO: we may want to handle the case where the header is using the http-date syntax: "Retry-After: <http-date>".
-    // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After#syntax for details.
-    const retryAfter = parseInt(responseHeaders?.['retry-after'] || '');
+    let timeoutMillis: number | undefined;
+    const retryAfterHeader = responseHeaders?.['retry-after'];
+    if (retryAfterHeader) {
+      const timeoutSeconds = parseInt(retryAfterHeader);
+      if (!Number.isNaN(timeoutSeconds)) {
+        timeoutMillis = timeoutSeconds * 1000;
+      } else {
+        timeoutMillis = Date.parse(retryAfterHeader) - Date.now();
+      }
+    }
 
-    const maxRetries = options.maxRetries ?? this.maxRetries;
-    const timeout = this.calculateRetryTimeoutSeconds(retriesRemaining, retryAfter, maxRetries) * 1000;
-    await sleep(timeout);
+    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
+    // just do what it says, but otherwise calculate a default
+    if (
+      !timeoutMillis ||
+      !Number.isInteger(timeoutMillis) ||
+      timeoutMillis <= 0 ||
+      timeoutMillis > 60 * 1000
+    ) {
+      const maxRetries = options.maxRetries ?? this.maxRetries;
+      timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
+    }
+    await sleep(timeoutMillis);
 
     return this.makeRequest(options, retriesRemaining);
   }
 
-  private calculateRetryTimeoutSeconds(
-    retriesRemaining: number,
-    retryAfter: number,
-    maxRetries: number,
-  ): number {
+  private calculateDefaultRetryTimeoutMillis(retriesRemaining: number, maxRetries: number): number {
     const initialRetryDelay = 0.5;
     const maxRetryDelay = 2;
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says.
-    if (Number.isInteger(retryAfter) && retryAfter <= 60) {
-      return retryAfter;
-    }
-
     const numRetries = maxRetries - retriesRemaining;
 
     // Apply exponential backoff, but not more than the max.
@@ -513,7 +541,7 @@ export abstract class APIClient {
     // Apply some jitter, plus-or-minus half a second.
     const jitter = Math.random() - 0.5;
 
-    return sleepSeconds + jitter;
+    return (sleepSeconds + jitter) * 1000;
   }
 
   private getUserAgent(): string {
@@ -575,7 +603,7 @@ export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
   async getNextPage(): Promise<this> {
     const nextInfo = this.nextPageInfo();
     if (!nextInfo) {
-      throw new Error(
+      throw new ModernTreasuryError(
         'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.',
       );
     }
@@ -585,7 +613,7 @@ export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
     } else if ('url' in nextInfo) {
       const params = [...Object.entries(nextOptions.query || {}), ...nextInfo.url.searchParams.entries()];
       for (const [key, value] of params) {
-        nextInfo.url.searchParams.set(key, value);
+        nextInfo.url.searchParams.set(key, value as any);
       }
       nextOptions.query = undefined;
       nextOptions.path = nextInfo.url.toString();
@@ -711,7 +739,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   idempotencyKey: true,
 };
 
-export const isRequestOptions = (obj: unknown): obj is RequestOptions => {
+export const isRequestOptions = (obj: unknown): obj is RequestOptions<Record<string, unknown> | Readable> => {
   return (
     typeof obj === 'object' &&
     obj !== null &&
@@ -901,10 +929,10 @@ export const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve
 
 const validatePositiveInteger = (name: string, n: unknown): number => {
   if (typeof n !== 'number' || !Number.isInteger(n)) {
-    throw new Error(`${name} must be an integer`);
+    throw new ModernTreasuryError(`${name} must be an integer`);
   }
   if (n < 0) {
-    throw new Error(`${name} must be a positive integer`);
+    throw new ModernTreasuryError(`${name} must be a positive integer`);
   }
   return n;
 };
@@ -915,7 +943,8 @@ export const castToError = (err: any): Error => {
 };
 
 export const ensurePresent = <T>(value: T | null | undefined): T => {
-  if (value == null) throw new Error(`Expected a value to be given but received ${value} instead.`);
+  if (value == null)
+    throw new ModernTreasuryError(`Expected a value to be given but received ${value} instead.`);
   return value;
 };
 
@@ -938,14 +967,14 @@ export const coerceInteger = (value: unknown): number => {
   if (typeof value === 'number') return Math.round(value);
   if (typeof value === 'string') return parseInt(value, 10);
 
-  throw new Error(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new ModernTreasuryError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceFloat = (value: unknown): number => {
   if (typeof value === 'number') return value;
   if (typeof value === 'string') return parseFloat(value);
 
-  throw new Error(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new ModernTreasuryError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceBoolean = (value: unknown): boolean => {
@@ -1049,5 +1078,5 @@ export const toBase64 = (str: string | null | undefined): string => {
     return btoa(str);
   }
 
-  throw new Error('Cannot generate b64 string; Expected `Buffer` or `btoa` to be defined');
+  throw new ModernTreasuryError('Cannot generate b64 string; Expected `Buffer` or `btoa` to be defined');
 };

package/src/error.ts

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

package/src/index.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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 Core from './core';
+import * as Pagination from './pagination';
+import * as API from './resources/index';
+import * as Errors from './error';
+import { type Agent } from './_shims/index';
+import * as Uploads from './uploads';
 import * as qs from 'qs';
 
 export interface ClientOptions {
@@ -102,12 +102,12 @@ export class ModernTreasury extends Core.APIClient {
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
-      throw new Error(
+      throw new Errors.ModernTreasuryError(
         "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) {
-      throw new Error(
+      throw new Errors.ModernTreasuryError(
         "The MODERN_TREASURY_ORGANIZATION_ID environment variable is missing or empty; either provide it, or instantiate the ModernTreasury client with an organizationId option, like new ModernTreasury({ organizationId: 'my-organization-ID' }).",
       );
     }
@@ -199,6 +199,7 @@ export class ModernTreasury extends Core.APIClient {
 
   static ModernTreasury = this;
 
+  static ModernTreasuryError = Errors.ModernTreasuryError;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -214,6 +215,7 @@ export class ModernTreasury extends Core.APIClient {
 }
 
 export const {
+  ModernTreasuryError,
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,

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.js';
+import { AbstractPage, Response, APIClient, FinalRequestOptions, coerceInteger, PageInfo } from './core';
 
 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.js';
+import type { ModernTreasury } from './index';
 
 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.js';
-import { APIResource } from '../resource.js';
-import { isRequestOptions } from '../core.js';
-import * as API from './index.js';
-import { Page, PageParams } from '../pagination.js';
+import * as Core from "../treasury/core";
+import { APIResource } from "../treasury/resource";
+import { isRequestOptions } from "../treasury/core";
+import * as API from './index';
+import { Page, PageParams } from "../treasury/pagination";
 
 export class AccountCollectionFlows extends APIResource {
   /**

package/src/resources/account-details.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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';
+import * as Core from "../treasury/core";
+import { APIResource } from "../treasury/resource";
+import { isRequestOptions } from "../treasury/core";
+import * as Shared from "../treasury/resources/shared";
+import * as API from './index';
+import { Page, PageParams } from "../treasury/pagination";
 
 export class AccountDetails extends APIResource {
   /**

package/src/resources/connections.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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';
+import * as Core from "../treasury/core";
+import { APIResource } from "../treasury/resource";
+import { isRequestOptions } from "../treasury/core";
+import * as API from './index';
+import { Page, PageParams } from "../treasury/pagination";
 
 export class Connections extends APIResource {
   /**

package/src/resources/counterparties.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIResource } from '../resource.js';
-import { isRequestOptions } from '../core.js';
-import * as AccountDetails from './account-details.js';
-import * as ExternalAccounts from './external-accounts.js';
-import * as RoutingDetails from './routing-details.js';
-import * as API from './index.js';
-import { Page, PageParams } from '../pagination.js';
+import * as Core from "../treasury/core";
+import { APIResource } from "../treasury/resource";
+import { isRequestOptions } from "../treasury/core";
+import * as AccountDetails from "../treasury/resources/account-details";
+import * as ExternalAccounts from "../treasury/resources/external-accounts";
+import * as RoutingDetails from "../treasury/resources/routing-details";
+import * as API from './index';
+import { Page, PageParams } from "../treasury/pagination";
 
 export class Counterparties extends APIResource {
   /**

package/src/resources/documents.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIResource } from '../resource.js';
-import { isRequestOptions } from '../core.js';
-import * as API from './index.js';
-import { type Uploadable, multipartFormRequestOptions } from '../core.js';
-import { Page, PageParams } from '../pagination.js';
+import * as Core from "../treasury/core";
+import { APIResource } from "../treasury/resource";
+import { isRequestOptions } from "../treasury/core";
+import * as API from './index';
+import { type Uploadable, multipartFormRequestOptions } from "../treasury/core";
+import { Page, PageParams } from "../treasury/pagination";
 
 export class Documents extends APIResource {
   /**

package/src/resources/events.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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';
+import * as Core from "../treasury/core";
+import { APIResource } from "../treasury/resource";
+import { isRequestOptions } from "../treasury/core";
+import * as API from './index';
+import { Page, PageParams } from "../treasury/pagination";
 
 export class Events extends APIResource {
   /**

package/src/resources/expected-payments.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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';
+import * as Core from "../treasury/core";
+import { APIResource } from "../treasury/resource";
+import { isRequestOptions } from "../treasury/core";
+import * as Shared from "../treasury/resources/shared";
+import * as API from './index';
+import { Page, PageParams } from "../treasury/pagination";
 
 export class ExpectedPayments extends APIResource {
   /**

package/src/resources/external-accounts.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIResource } from '../resource.js';
-import { isRequestOptions } from '../core.js';
-import * as AccountDetails from './account-details.js';
-import * as RoutingDetails from './routing-details.js';
-import * as Shared from './shared.js';
-import * as API from './index.js';
-import { Page, PageParams } from '../pagination.js';
+import * as Core from "../treasury/core";
+import { APIResource } from "../treasury/resource";
+import { isRequestOptions } from "../treasury/core";
+import * as AccountDetails from "../treasury/resources/account-details";
+import * as RoutingDetails from "../treasury/resources/routing-details";
+import * as Shared from "../treasury/resources/shared";
+import * as API from './index';
+import { Page, PageParams } from "../treasury/pagination";
 
 export class ExternalAccounts extends APIResource {
   /**

package/src/resources/incoming-payment-details.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core.js';
-import { APIResource } from '../resource.js';
-import { isRequestOptions } from '../core.js';
-import * as Shared from './shared.js';
-import * as VirtualAccounts from './virtual-accounts.js';
-import * as API from './index.js';
-import { Page, PageParams } from '../pagination.js';
+import * as Core from "../treasury/core";
+import { APIResource } from "../treasury/resource";
+import { isRequestOptions } from "../treasury/core";
+import * as Shared from "../treasury/resources/shared";
+import * as VirtualAccounts from "../treasury/resources/virtual-accounts";
+import * as API from './index';
+import { Page, PageParams } from "../treasury/pagination";
 
 export class IncomingPaymentDetails extends APIResource {
   /**