modern-treasury 2.0.0 → 2.2.0

package/src/index.ts

@@ -1,14 +1,14 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as qs from 'qs';
 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 'modern-treasury/_shims/agent';
+import type { Agent } from './_shims/agent';
 import * as Uploads from './uploads';
+import * as qs from 'qs';
 
-type Config = {
+export interface ClientOptions {
   /**
    * Defaults to process.env["MODERN_TREASURY_API_KEY"].
    */
@@ -36,6 +36,14 @@ type Config = {
    */
   httpAgent?: Agent;
 
+  /**
+   * Specify a custom `fetch` function implementation.
+   *
+   * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
+   * defined globally.
+   */
+  fetch?: Core.Fetch | undefined;
+
   /**
    * The maximum number of times that the client will retry a request in case of a
    * temporary failure, like a network error or a 5XX error from the server.
@@ -60,10 +68,10 @@ type Config = {
    */
   defaultQuery?: Core.DefaultQuery;
 
-  organizationId?: string | null;
+  organizationId?: string;
 
   webhookKey?: string | null;
-};
+}
 
 /** Instantiate the API Client. */
 export class ModernTreasury extends Core.APIClient {
@@ -71,39 +79,46 @@ export class ModernTreasury extends Core.APIClient {
   organizationId: string;
   webhookKey?: string | null;
 
-  private _options: Config;
+  private _options: ClientOptions;
 
-  constructor(config: Config) {
-    const options: Config = {
-      apiKey: typeof process === 'undefined' ? '' : process.env['MODERN_TREASURY_API_KEY'] || '',
-      baseURL: 'https://app.moderntreasury.com',
-      ...config,
-    };
-
-    if (!options.apiKey && options.apiKey !== null) {
+  constructor({
+    apiKey = Core.readEnv('MODERN_TREASURY_API_KEY'),
+    organizationId = Core.readEnv('MODERN_TREASURY_ORGANIZATION_ID'),
+    webhookKey = Core.readEnv('MODERN_TREASURY_WEBHOOK_KEY') ?? null,
+    ...opts
+  }: 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 }).',
+      );
+    }
+    if (organizationId === 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: 'my api key' }).",
+        "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' }).",
       );
     }
 
+    const options: ClientOptions = {
+      apiKey,
+      organizationId,
+      webhookKey,
+      baseURL: `https://app.moderntreasury.com`,
+      ...opts,
+    };
+
     super({
       baseURL: options.baseURL!,
       timeout: options.timeout,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
+      fetch: options.fetch,
     });
-    this.apiKey = options.apiKey;
     this._options = options;
     this.idempotencyHeader = 'Idempotency-Key';
 
-    const organizationId = config.organizationId || process.env['MODERN_TREASURY_ORGANIZATION_ID'];
-    if (!organizationId) {
-      throw new Error(
-        "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' }).",
-      );
-    }
+    this.apiKey = apiKey;
     this.organizationId = organizationId;
-    this.webhookKey = config.webhookKey || process.env['MODERN_TREASURY_WEBHOOK_KEY'] || null;
+    this.webhookKey = webhookKey;
   }
 
   connections: API.Connections = new API.Connections(this);
@@ -159,17 +174,20 @@ export class ModernTreasury extends Core.APIClient {
 
   protected override authHeaders(): Core.Headers {
     const credentials = `${this.organizationId}:${this.apiKey}`;
-    const Authorization = `Basic ${Buffer.from(credentials).toString('base64')}`;
+    const Authorization = `Basic ${Core.toBase64(credentials)}`;
     return { Authorization };
   }
 
-  protected override qsOptions(): qs.IStringifyOptions {
-    return { arrayFormat: 'repeat' };
+  protected override stringifyQuery(query: Record<string, unknown>): string {
+    return qs.stringify(query, { arrayFormat: 'repeat' });
   }
 
+  static ModernTreasury = this;
+
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static APIUserAbortError = Errors.APIUserAbortError;
   static NotFoundError = Errors.NotFoundError;
   static ConflictError = Errors.ConflictError;
   static RateLimitError = Errors.RateLimitError;
@@ -184,6 +202,7 @@ export const {
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,
+  APIUserAbortError,
   NotFoundError,
   ConflictError,
   RateLimitError,
@@ -266,8 +285,8 @@ export namespace ModernTreasury {
   export import DocumentListParams = API.DocumentListParams;
 
   export import AccountCollectionFlows = API.AccountCollectionFlows;
-  export import AccountConnectionFlow = API.AccountConnectionFlow;
-  export import AccountConnectionFlowsPage = API.AccountConnectionFlowsPage;
+  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;

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

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class AccountCollectionFlows extends APIResource {
   /**
@@ -13,7 +13,7 @@ export class AccountCollectionFlows extends APIResource {
   create(
     params: AccountCollectionFlowCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountConnectionFlow>> {
+  ): Promise<Core.APIResponse<AccountCollectionFlow>> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/account_collection_flows', {
       body,
@@ -29,13 +29,13 @@ export class AccountCollectionFlows extends APIResource {
     id: string,
     query?: AccountCollectionFlowRetrieveParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountConnectionFlow>>;
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<AccountConnectionFlow>>;
+  ): 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<AccountConnectionFlow>> {
+  ): Promise<Core.APIResponse<AccountCollectionFlow>> {
     if (isRequestOptions(query)) {
       return this.retrieve(id, {}, query);
     }
@@ -53,7 +53,7 @@ export class AccountCollectionFlows extends APIResource {
     id: string,
     params: AccountCollectionFlowUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountConnectionFlow>> {
+  ): Promise<Core.APIResponse<AccountCollectionFlow>> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.patch(`/api/account_collection_flows/${id}`, {
       body,
@@ -68,27 +68,27 @@ export class AccountCollectionFlows extends APIResource {
   list(
     query?: AccountCollectionFlowListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountConnectionFlowsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<AccountConnectionFlowsPage>;
+  ): Core.PagePromise<AccountCollectionFlowsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AccountCollectionFlowsPage>;
   list(
     query: AccountCollectionFlowListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountConnectionFlowsPage> {
+  ): Core.PagePromise<AccountCollectionFlowsPage> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/api/account_collection_flows', AccountConnectionFlowsPage, {
+    return this.getAPIList('/api/account_collection_flows', AccountCollectionFlowsPage, {
       query,
       ...options,
     });
   }
 }
 
-export class AccountConnectionFlowsPage extends Page<AccountConnectionFlow> {}
+export class AccountCollectionFlowsPage extends Page<AccountCollectionFlow> {}
 // alias so we can export it in the namespace
-type _AccountConnectionFlowsPage = AccountConnectionFlowsPage;
+type _AccountCollectionFlowsPage = AccountCollectionFlowsPage;
 
-export interface AccountConnectionFlow {
+export interface AccountCollectionFlow {
   /**
    * The ID of a counterparty. An external account created with this flow will be
    * associated with this counterparty.
@@ -179,8 +179,8 @@ export interface AccountCollectionFlowListParams extends PageParams {
 }
 
 export namespace AccountCollectionFlows {
-  export import AccountConnectionFlow = API.AccountConnectionFlow;
-  export type AccountConnectionFlowsPage = _AccountConnectionFlowsPage;
+  export import AccountCollectionFlow = API.AccountCollectionFlow;
+  export type AccountCollectionFlowsPage = _AccountCollectionFlowsPage;
   export import AccountCollectionFlowCreateParams = API.AccountCollectionFlowCreateParams;
   export import AccountCollectionFlowRetrieveParams = API.AccountCollectionFlowRetrieveParams;
   export import AccountCollectionFlowUpdateParams = API.AccountCollectionFlowUpdateParams;

package/src/resources/account-details.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as Shared from 'modern-treasury/resources/shared';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+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';
 
 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 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../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 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as ExternalAccounts from 'modern-treasury/resources/external-accounts';
-import * as AccountDetails from 'modern-treasury/resources/account-details';
-import * as RoutingDetails from 'modern-treasury/resources/routing-details';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as ExternalAccounts from './external-accounts';
+import * as AccountDetails from './account-details';
+import * as RoutingDetails from './routing-details';
+import * as API from './index';
+import { Page, PageParams } from '../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 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { type Uploadable, multipartFormRequestOptions } from 'modern-treasury/core';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { type Uploadable, multipartFormRequestOptions } from '../core';
+import { Page, PageParams } from '../pagination';
 
 export class Documents extends APIResource {
   /**
@@ -15,16 +15,10 @@ export class Documents extends APIResource {
     params: DocumentCreateParams,
     options?: Core.RequestOptions,
   ): Promise<Core.APIResponse<Document>> {
-    const {
-      documentable_id: documentableId,
-      documentable_type: documentableType,
-      'Idempotency-Key': idempotencyKey,
-      ...body
-    } = params;
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post(
       '/api/documents',
       await multipartFormRequestOptions({
-        query: { documentable_id: documentableId, documentable_type: documentableType },
         body,
         ...options,
         headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
@@ -157,15 +151,12 @@ export namespace Document {
 
 export interface DocumentCreateParams {
   /**
-   * Query param: The unique identifier for the associated object.
+   * Body param: The unique identifier for the associated object.
    */
   documentable_id: string;
 
   /**
-   * Query param: The type of the associated object. Currently can be one of
-   * `payment_order`, `transaction`, `paper_item`, `expected_payment`,
-   * `counterparty`, `organization`, `case`, `internal_account`, `decision`, or
-   * `external_account`.
+   * Body param:
    */
   documentable_type:
     | 'cases'

package/src/resources/events.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../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 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as Shared from 'modern-treasury/resources/shared';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+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';
 
 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 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as AccountDetails from 'modern-treasury/resources/account-details';
-import * as RoutingDetails from 'modern-treasury/resources/routing-details';
-import * as Shared from 'modern-treasury/resources/shared';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as AccountDetails from './account-details';
+import * as RoutingDetails from './routing-details';
+import * as Shared from './shared';
+import * as API from './index';
+import { Page, PageParams } from '../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 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as VirtualAccounts from 'modern-treasury/resources/virtual-accounts';
-import * as Shared from 'modern-treasury/resources/shared';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as VirtualAccounts from './virtual-accounts';
+import * as Shared from './shared';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
 
 export class IncomingPaymentDetails extends APIResource {
   /**

package/src/resources/index.ts

@@ -2,12 +2,12 @@
 
 export * from './shared';
 export {
-  AccountConnectionFlow,
+  AccountCollectionFlow,
   AccountCollectionFlowCreateParams,
   AccountCollectionFlowRetrieveParams,
   AccountCollectionFlowUpdateParams,
   AccountCollectionFlowListParams,
-  AccountConnectionFlowsPage,
+  AccountCollectionFlowsPage,
   AccountCollectionFlows,
 } from './account-collection-flows';
 export {

package/src/resources/internal-accounts/balance-reports.ts

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

package/src/resources/internal-accounts/internal-accounts.ts

@@ -1,15 +1,15 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from 'modern-treasury/core';
-import { APIResource } from 'modern-treasury/resource';
-import { isRequestOptions } from 'modern-treasury/core';
-import * as AccountDetails from 'modern-treasury/resources/account-details';
-import * as RoutingDetails from 'modern-treasury/resources/routing-details';
-import * as Connections from 'modern-treasury/resources/connections';
-import * as Shared from 'modern-treasury/resources/shared';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as AccountDetails from '../account-details';
+import * as RoutingDetails from '../routing-details';
+import * as Connections from '../connections';
+import * as Shared from '../shared';
 import { BalanceReports } from './balance-reports';
-import * as API from './';
-import { Page, PageParams } from 'modern-treasury/pagination';
+import * as API from './index';
+import { Page, PageParams } from '../../pagination';
 
 export class InternalAccounts extends APIResource {
   balanceReports: BalanceReports = new BalanceReports(this.client);
@@ -234,11 +234,6 @@ export interface InternalAccountCreateParams {
    */
   counterparty_id?: string;
 
-  /**
-   * Body param: The identifier of the entity at Increase which owns the account.
-   */
-  entity_id?: string;
-
   /**
    * Body param: The parent internal account of this new account.
    */
@@ -249,6 +244,12 @@ export interface InternalAccountCreateParams {
    */
   party_address?: InternalAccountCreateParams.PartyAddress;
 
+  /**
+   * Body param: A hash of vendor specific attributes that will be used when creating
+   * the account at the vendor specified by the given connection.
+   */
+  vendor_attributes?: Record<string, string>;
+
   /**
    * Header param: This key should be something unique, preferably something like an
    * UUID.