increase 0.11.1 → 0.11.3

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 {
+  IncreaseError,
+  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 'increase'`:
+   * - `import 'increase/shims/node'` (if you're running on Node)
+   * - `import 'increase/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 'increase'`:
+   * - `import 'increase/shims/node'` (if you're running on Node)
+   * - `import 'increase/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 IncreaseError(
           `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 IncreaseError(
         '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 IncreaseError(`${name} must be an integer`);
   }
   if (n < 0) {
-    throw new Error(`${name} must be a positive integer`);
+    throw new IncreaseError(`${name} must be a positive integer`);
   }
   return n;
 };
@@ -915,7 +943,7 @@ 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 IncreaseError(`Expected a value to be given but received ${value} instead.`);
   return value;
 };
 
@@ -938,14 +966,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 IncreaseError(`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 IncreaseError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceBoolean = (value: unknown): boolean => {
@@ -1049,5 +1077,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 IncreaseError('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 IncreaseError extends Error {}
+
+export class APIError extends IncreaseError {
   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';
 
 const environments = {
@@ -105,7 +105,7 @@ export class Increase extends Core.APIClient {
    */
   constructor({ apiKey = Core.readEnv('INCREASE_API_KEY'), ...opts }: ClientOptions = {}) {
     if (apiKey === undefined) {
-      throw new Error(
+      throw new Errors.IncreaseError(
         "The INCREASE_API_KEY environment variable is missing or empty; either provide it, or instantiate the Increase client with an apiKey option, like new Increase({ apiKey: 'my apiKey' }).",
       );
     }
@@ -189,6 +189,7 @@ export class Increase extends Core.APIClient {
 
   static Increase = this;
 
+  static IncreaseError = Errors.IncreaseError;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -217,6 +218,7 @@ export class Increase extends Core.APIClient {
 }
 
 export const {
+  IncreaseError,
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,

package/src/pagination.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core.js';
+import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
 
 /**
  * A list of Account objects.

package/src/resource.ts

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

package/src/resources/account-numbers.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 "../e/core";
+import { APIResource } from "../e/resource";
+import { isRequestOptions } from "../e/core";
+import * as API from './index';
+import { Page, PageParams } from "../e/pagination";
 
 export class AccountNumbers extends APIResource {
   /**
@@ -89,6 +89,12 @@ export interface AccountNumber {
    */
   inbound_ach: AccountNumber.InboundACH;
 
+  /**
+   * Properties related to how this Account Number should handle inbound check
+   * withdrawls.
+   */
+  inbound_checks: AccountNumber.InboundChecks;
+
   /**
    * The name you choose for the Account Number.
    */
@@ -129,6 +135,22 @@ export namespace AccountNumber {
      */
     debit_status: 'allowed' | 'blocked';
   }
+
+  /**
+   * Properties related to how this Account Number should handle inbound check
+   * withdrawls.
+   */
+  export interface InboundChecks {
+    /**
+     * How Increase should process checks with this account number printed on them.
+     *
+     * - `allowed` - Checks with this Account Number will be processed even if they are
+     *   not associated with a Check Transfer.
+     * - `check_transfers_only` - Checks with this Account Number will be processed
+     *   only if they can be matched to an existing Check Transfer.
+     */
+    status: 'allowed' | 'check_transfers_only';
+  }
 }
 
 export interface AccountNumberCreateParams {
@@ -146,6 +168,12 @@ export interface AccountNumberCreateParams {
    * Options related to how this Account Number should handle inbound ACH transfers.
    */
   inbound_ach?: AccountNumberCreateParams.InboundACH;
+
+  /**
+   * Options related to how this Account Number should handle inbound check
+   * withdrawls.
+   */
+  inbound_checks?: AccountNumberCreateParams.InboundChecks;
 }
 
 export namespace AccountNumberCreateParams {
@@ -162,6 +190,22 @@ export namespace AccountNumberCreateParams {
      */
     debit_status: 'allowed' | 'blocked';
   }
+
+  /**
+   * Options related to how this Account Number should handle inbound check
+   * withdrawls.
+   */
+  export interface InboundChecks {
+    /**
+     * How Increase should process checks with this account number printed on them.
+     *
+     * - `allowed` - Checks with this Account Number will be processed even if they are
+     *   not associated with a Check Transfer.
+     * - `check_transfers_only` - Checks with this Account Number will be processed
+     *   only if they can be matched to an existing Check Transfer.
+     */
+    status: 'allowed' | 'check_transfers_only';
+  }
 }
 
 export interface AccountNumberUpdateParams {

package/src/resources/account-statements.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 "../e/core";
+import { APIResource } from "../e/resource";
+import { isRequestOptions } from "../e/core";
+import * as API from './index';
+import { Page, PageParams } from "../e/pagination";
 
 export class AccountStatements extends APIResource {
   /**

package/src/resources/account-transfers.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 "../e/core";
+import { APIResource } from "../e/resource";
+import { isRequestOptions } from "../e/core";
+import * as API from './index';
+import { Page, PageParams } from "../e/pagination";
 
 export class AccountTransfers extends APIResource {
   /**

package/src/resources/accounts.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 "../e/core";
+import { APIResource } from "../e/resource";
+import { isRequestOptions } from "../e/core";
+import * as API from './index';
+import { Page, PageParams } from "../e/pagination";
 
 export class Accounts extends APIResource {
   /**

package/src/resources/ach-prenotifications.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 "../e/core";
+import { APIResource } from "../e/resource";
+import { isRequestOptions } from "../e/core";
+import * as API from './index';
+import { Page, PageParams } from "../e/pagination";
 
 export class ACHPrenotifications extends APIResource {
   /**
@@ -161,6 +161,23 @@ export namespace ACHPrenotification {
      * - `addenda_format_error` - The addenda had an incorrect format.
      * - `incorrect_standard_entry_class_code_for_outbound_international_payment` - The
      *   standard entry class code was incorrect for an outbound international payment.
+     * - `misrouted_notification_of_change` - The notification of change was misrouted.
+     * - `incorrect_trace_number` - The trace number was incorrect.
+     * - `incorrect_company_identification_number` - The company identification number
+     *   was incorrect.
+     * - `incorrect_identification_number` - The individual identification number or
+     *   identification number was incorrect.
+     * - `incorrectly_formatted_corrected_data` - The corrected data was incorrectly
+     *   formatted.
+     * - `incorrect_discretionary_data` - The discretionary data was incorrect.
+     * - `routing_number_not_from_original_entry_detail_record` - The routing number
+     *   was not from the original entry detail record.
+     * - `depository_financial_institution_account_number_not_from_original_entry_detail_record` -
+     *   The depository financial institution account number was not from the original
+     *   entry detail record.
+     * - `incorrect_transaction_code_by_originating_depository_financial_institution` -
+     *   The transaction code was incorrect, initiated by the originating depository
+     *   financial institution.
      */
     change_code:
       | 'incorrect_account_number'
@@ -172,7 +189,16 @@ export namespace ACHPrenotification {
       | 'incorrect_receiving_depository_financial_institution_identification'
       | 'incorrect_individual_identification_number'
       | 'addenda_format_error'
-      | 'incorrect_standard_entry_class_code_for_outbound_international_payment';
+      | 'incorrect_standard_entry_class_code_for_outbound_international_payment'
+      | 'misrouted_notification_of_change'
+      | 'incorrect_trace_number'
+      | 'incorrect_company_identification_number'
+      | 'incorrect_identification_number'
+      | 'incorrectly_formatted_corrected_data'
+      | 'incorrect_discretionary_data'
+      | 'routing_number_not_from_original_entry_detail_record'
+      | 'depository_financial_institution_account_number_not_from_original_entry_detail_record'
+      | 'incorrect_transaction_code_by_originating_depository_financial_institution';
 
     /**
      * The corrected data that should be used in future ACHs to this account.
@@ -199,20 +225,21 @@ export namespace ACHPrenotification {
     /**
      * Why the Prenotification was returned.
      *
-     * - `insufficient_fund` - Code R01. Insufficient funds in the source account.
+     * - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
+     *   Sometimes abbreviated to NSF.
      * - `no_account` - Code R03. The account does not exist or the receiving bank was
      *   unable to locate it.
-     * - `account_closed` - Code R02. The account is closed.
+     * - `account_closed` - Code R02. The account is closed at the receiving bank.
      * - `invalid_account_number_structure` - Code R04. The account number is invalid
      *   at the receiving bank.
      * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
-     *   was frozen per the Office of Foreign Assets Control.
+     *   at the receiving bank was frozen per the Office of Foreign Assets Control.
      * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
      *   refused a credit transfer.
      * - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
      *   The receiving bank rejected because of an incorrect Standard Entry Class code.
      * - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
-     *   reversed the transfer.
+     *   at the receiving bank reversed the transfer.
      * - `payment_stopped` - Code R08. The receiving bank stopped payment on this
      *   transfer.
      * - `non_transaction_account` - Code R20. The receiving bank account does not
@@ -222,19 +249,21 @@ export namespace ACHPrenotification {
      * - `routing_number_check_digit_error` - Code R28. The routing number is
      *   incorrect.
      * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
-     *   The customer reversed the transfer.
+     *   The customer at the receiving bank reversed the transfer.
      * - `amount_field_error` - Code R19. The amount field is incorrect or too large.
-     * - `authorization_revoked_by_customer` - Code R07. The customer who initiated the
-     *   transfer revoked authorization.
+     * - `authorization_revoked_by_customer` - Code R07. The customer at the receiving
+     *   institution informed their bank that they have revoked authorization for a
+     *   previously authorized transfer.
      * - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
      * - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
      *   process a field in the transfer.
      * - `enr_invalid_individual_name` - Code R45. The individual name field was
      *   invalid.
      * - `returned_per_odfi_request` - Code R06. The originating financial institution
-     *   asked for this transfer to be returned.
+     *   asked for this transfer to be returned. The receiving bank is complying with
+     *   the request.
      * - `limited_participation_dfi` - Code R34. The receiving bank's regulatory
-     *   supervisor has limited their participation.
+     *   supervisor has limited their participation in the ACH network.
      * - `incorrectly_coded_outbound_international_payment` - Code R85. The outbound
      *   international ACH transfer was incorrect.
      * - `account_sold_to_another_dfi` - Code R12. A rare return reason. The account
@@ -337,7 +366,7 @@ export namespace ACHPrenotification {
      *   attached to the ACH, usually an ACH check conversion, includes a stop payment.
      * - `timely_original_return` - Code R73. A rare return reason. The bank receiving
      *   an `untimely_return` believes it was on time.
-     * - `trace_number_error` - Code R27. A rare return reason. An ACH Return's trace
+     * - `trace_number_error` - Code R27. A rare return reason. An ACH return's trace
      *   number does not match an originated ACH.
      * - `untimely_dishonored_return` - Code R72. A rare return reason. The dishonored
      *   return was sent too late.