modern-treasury 2.3.0 → 2.4.0

package/src/resources/counterparties.ts

@@ -1,24 +1,30 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import { isRequestOptions } from '../core.js';
+import * as ExternalAccounts from './external-accounts.js';
+import * as AccountDetails from './account-details.js';
+import * as RoutingDetails from './routing-details.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class Counterparties extends APIResource {
   /**
    * Create a new counterparty.
    */
   create(params: CounterpartyCreateParams, options?: Core.RequestOptions): Core.APIPromise<Counterparty> {
+    // @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/counterparties', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -85,11 +91,17 @@ export class Counterparties extends APIResource {
     params: CounterpartyCollectAccountParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CounterpartyCollectAccountResponse> {
+    // @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/counterparties/${id}/collect_account`, {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 }
@@ -304,58 +316,49 @@ export interface CounterpartyCollectAccountResponse {
 
 export interface CounterpartyCreateParams {
   /**
-   * Body param: A human friendly name for this counterparty.
+   * A human friendly name for this counterparty.
    */
   name: string | null;
 
-  /**
-   * Body param:
-   */
   accounting?: CounterpartyCreateParams.Accounting;
 
   /**
-   * Body param: The accounts for this counterparty.
+   * The accounts for this counterparty.
    */
   accounts?: Array<CounterpartyCreateParams.Account>;
 
   /**
-   * Body param: The counterparty's email.
+   * The counterparty's email.
    */
   email?: string | null;
 
   /**
-   * Body param: An optional type to auto-sync the counterparty to your ledger.
-   * Either `customer` or `vendor`.
+   * An optional type to auto-sync the counterparty to your ledger. Either `customer`
+   * or `vendor`.
    */
   ledger_type?: 'customer' | 'vendor';
 
   /**
-   * Body param: Additional data represented as key-value pairs. Both the key and
-   * value must be strings.
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
    */
   metadata?: Record<string, string>;
 
   /**
-   * Body param: Send an email to the counterparty whenever an associated payment
-   * order is sent to the bank.
+   * Send an email to the counterparty whenever an associated payment order is sent
+   * to the bank.
    */
   send_remittance_advice?: boolean;
 
   /**
-   * Body param: Either a valid SSN or EIN.
+   * Either a valid SSN or EIN.
    */
   taxpayer_identifier?: string;
 
   /**
-   * Body param: The verification status of the counterparty.
+   * The verification status of the counterparty.
    */
   verification_status?: 'denied' | 'needs_approval' | 'unverified' | 'verified';
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace CounterpartyCreateParams {
@@ -623,26 +626,25 @@ export interface CounterpartyListParams extends PageParams {
 
 export interface CounterpartyCollectAccountParams {
   /**
-   * Body param: One of `credit` or `debit`. Use `credit` when you want to pay a
-   * counterparty. Use `debit` when you need to charge a counterparty. This field
-   * helps us send a more tailored email to your counterparties."
+   * One of `credit` or `debit`. Use `credit` when you want to pay a counterparty.
+   * Use `debit` when you need to charge a counterparty. This field helps us send a
+   * more tailored email to your counterparties."
    */
   direction: 'credit' | 'debit';
 
   /**
-   * Body param: The URL you want your customer to visit upon filling out the form.
-   * By default, they will be sent to a Modern Treasury landing page. This must be a
-   * valid HTTPS URL if set.
+   * The URL you want your customer to visit upon filling out the form. By default,
+   * they will be sent to a Modern Treasury landing page. This must be a valid HTTPS
+   * URL if set.
    */
   custom_redirect?: string;
 
   /**
-   * Body param: The list of fields you want on the form. This field is optional and
-   * if it is not set, will default to [\"nameOnAccount\", \"accountType\",
-   * \"accountNumber\", \"routingNumber\", \"address\"]. The full list of options is
-   * [\"name\", \"nameOnAccount\", \"taxpayerIdentifier\", \"accountType\",
-   * \"accountNumber\", \"routingNumber\", \"address\", \"ibanNumber\",
-   * \"swiftCode\"].
+   * The list of fields you want on the form. This field is optional and if it is not
+   * set, will default to [\"nameOnAccount\", \"accountType\", \"accountNumber\",
+   * \"routingNumber\", \"address\"]. The full list of options is [\"name\",
+   * \"nameOnAccount\", \"taxpayerIdentifier\", \"accountType\", \"accountNumber\",
+   * \"routingNumber\", \"address\", \"ibanNumber\", \"swiftCode\"].
    */
   fields?: Array<
     | 'name'
@@ -669,18 +671,12 @@ export interface CounterpartyCollectAccountParams {
   >;
 
   /**
-   * Body param: By default, Modern Treasury will send an email to your counterparty
-   * that includes a link to the form they must fill out. However, if you would like
-   * to send the counterparty the link, you can set this parameter to `false`. The
-   * JSON body will include the link to the secure Modern Treasury form.
+   * By default, Modern Treasury will send an email to your counterparty that
+   * includes a link to the form they must fill out. However, if you would like to
+   * send the counterparty the link, you can set this parameter to `false`. The JSON
+   * body will include the link to the secure Modern Treasury form.
    */
   send_email?: boolean;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace Counterparties {

package/src/resources/documents.ts

@@ -1,24 +1,30 @@
 // 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 { type Uploadable, multipartFormRequestOptions } from '../core';
-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 { type Uploadable, multipartFormRequestOptions } from '../core.js';
+import { Page, PageParams } from '../pagination.js';
 
 export class Documents extends APIResource {
   /**
    * Create a document.
    */
   create(params: DocumentCreateParams, options?: Core.RequestOptions): Core.APIPromise<Document> {
+    // @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/documents',
       multipartFormRequestOptions({
         body,
         ...options,
-        headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+        headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
       }),
     );
   }
@@ -148,13 +154,10 @@ export namespace Document {
 
 export interface DocumentCreateParams {
   /**
-   * Body param: The unique identifier for the associated object.
+   * The unique identifier for the associated object.
    */
   documentable_id: string;
 
-  /**
-   * Body param:
-   */
   documentable_type:
     | 'cases'
     | 'counterparties'
@@ -168,21 +171,12 @@ export interface DocumentCreateParams {
     | 'decisions'
     | 'connections';
 
-  /**
-   * Body param:
-   */
   file: Uploadable;
 
   /**
-   * Body param: A category given to the document, can be `null`.
+   * A category given to the document, can be `null`.
    */
   document_type?: string;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface DocumentListParams extends PageParams {

package/src/resources/events.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 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';
-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 ExpectedPayments extends APIResource {
   /**
@@ -15,11 +15,17 @@ export class ExpectedPayments extends APIResource {
     params: ExpectedPaymentCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ExpectedPayment> {
+    // @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/expected_payments', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -234,101 +240,91 @@ export type ExpectedPaymentType =
 
 export interface ExpectedPaymentCreateParams {
   /**
-   * Body param: The lowest amount this expected payment may be equal to. Value in
-   * specified currency's smallest unit. e.g. $10 would be represented as 1000.
+   * The lowest amount this expected payment may be equal to. Value in specified
+   * currency's smallest unit. e.g. $10 would be represented as 1000.
    */
   amount_lower_bound: number;
 
   /**
-   * Body param: The highest amount this expected payment may be equal to. Value in
-   * specified currency's smallest unit. e.g. $10 would be represented as 1000.
+   * The highest amount this expected payment may be equal to. Value in specified
+   * currency's smallest unit. e.g. $10 would be represented as 1000.
    */
   amount_upper_bound: number;
 
   /**
-   * Body param: One of credit or debit. When you are receiving money, use credit.
-   * When you are being charged, use debit.
+   * One of credit or debit. When you are receiving money, use credit. When you are
+   * being charged, use debit.
    */
   direction: 'credit' | 'debit';
 
   /**
-   * Body param: The ID of the Internal Account for the expected payment.
+   * The ID of the Internal Account for the expected payment.
    */
   internal_account_id: string;
 
   /**
-   * Body param: The ID of the counterparty you expect for this payment.
+   * The ID of the counterparty you expect for this payment.
    */
   counterparty_id?: string | null;
 
   /**
-   * Body param: Must conform to ISO 4217. Defaults to the currency of the internal
-   * account.
+   * Must conform to ISO 4217. Defaults to the currency of the internal account.
    */
   currency?: Shared.Currency | null;
 
   /**
-   * Body param: The earliest date the payment may come in. Format: yyyy-mm-dd
+   * The earliest date the payment may come in. Format: yyyy-mm-dd
    */
   date_lower_bound?: string | null;
 
   /**
-   * Body param: The latest date the payment may come in. Format: yyyy-mm-dd
+   * The latest date the payment may come in. Format: yyyy-mm-dd
    */
   date_upper_bound?: string | null;
 
   /**
-   * Body param: An optional description for internal use.
+   * An optional description for internal use.
    */
   description?: string | null;
 
-  /**
-   * Body param:
-   */
   line_items?: Array<ExpectedPaymentCreateParams.LineItem>;
 
   /**
-   * Body param: Additional data represented as key-value pairs. Both the key and
-   * value must be strings.
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
    */
   metadata?: Record<string, string>;
 
   /**
-   * Body param: The reconciliation filters you have for this payment.
+   * The reconciliation filters you have for this payment.
    */
   reconciliation_filters?: unknown | null;
 
   /**
-   * Body param: The reconciliation groups you have for this payment.
+   * The reconciliation groups you have for this payment.
    */
   reconciliation_groups?: unknown | null;
 
   /**
-   * Body param: For `ach`, this field will be passed through on an addenda record.
-   * For `wire` payments the field will be passed through as the "Originator to
-   * Beneficiary Information", also known as OBI or Fedwire tag 6000.
+   * For `ach`, this field will be passed through on an addenda record. For `wire`
+   * payments the field will be passed through as the "Originator to Beneficiary
+   * Information", also known as OBI or Fedwire tag 6000.
    */
   remittance_information?: string | null;
 
   /**
-   * Body param: The statement description you expect to see on the transaction. For
-   * ACH payments, this will be the full line item passed from the bank. For wire
+   * The statement description you expect to see on the transaction. For ACH
+   * payments, this will be the full line item passed from the bank. For wire
    * payments, this will be the OBI field on the wire. For check payments, this will
    * be the memo field.
    */
   statement_descriptor?: string | null;
 
   /**
-   * Body param: One of: ach, au_becs, bacs, book, check, eft, interac, provxchange,
-   * rtp, sen, sepa, signet, wire.
+   * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+   * sepa, signet, wire.
    */
   type?: ExpectedPaymentType | null;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace ExpectedPaymentCreateParams {

package/src/resources/external-accounts.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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';
+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';
 
 export class ExternalAccounts extends APIResource {
   /**
@@ -17,11 +17,17 @@ export class ExternalAccounts extends APIResource {
     params: ExternalAccountCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ExternalAccount> {
+    // @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/external_accounts', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -97,11 +103,17 @@ export class ExternalAccounts extends APIResource {
     if (isRequestOptions(params)) {
       return this.completeVerification(id, {}, params);
     }
+    // @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/external_accounts/${id}/complete_verification`, {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -113,11 +125,17 @@ export class ExternalAccounts extends APIResource {
     params: ExternalAccountVerifyParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ExternalAccount> {
+    // @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/external_accounts/${id}/verify`, {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 }
@@ -272,84 +290,62 @@ export type ExternalAccountType =
   | 'savings';
 
 export interface ExternalAccountCreateParams {
-  /**
-   * Body param:
-   */
   counterparty_id: string | null;
 
-  /**
-   * Body param:
-   */
   account_details?: Array<ExternalAccountCreateParams.AccountDetail>;
 
   /**
-   * Body param: Can be `checking`, `savings` or `other`.
+   * Can be `checking`, `savings` or `other`.
    */
   account_type?: ExternalAccountType;
 
-  /**
-   * Body param:
-   */
   contact_details?: Array<ExternalAccountCreateParams.ContactDetail>;
 
   /**
-   * Body param: Specifies a ledger account object that will be created with the
-   * external account. The resulting ledger account is linked to the external account
-   * for auto-ledgering Payment objects. See
+   * Specifies a ledger account object that will be created with the external
+   * account. The resulting ledger account is linked to the external account for
+   * auto-ledgering Payment objects. See
    * https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
    * for more details.
    */
   ledger_account?: ExternalAccountCreateParams.LedgerAccount;
 
   /**
-   * Body param: Additional data represented as key-value pairs. Both the key and
-   * value must be strings.
+   * Additional data represented as key-value pairs. Both the key and value must be
+   * strings.
    */
   metadata?: Record<string, string>;
 
   /**
-   * Body param: A nickname for the external account. This is only for internal usage
-   * and won't affect any payments
+   * A nickname for the external account. This is only for internal usage and won't
+   * affect any payments
    */
   name?: string | null;
 
   /**
-   * Body param: Required if receiving wire payments.
+   * Required if receiving wire payments.
    */
   party_address?: ExternalAccountCreateParams.PartyAddress;
 
-  /**
-   * Body param:
-   */
   party_identifier?: string;
 
   /**
-   * Body param: If this value isn't provided, it will be inherited from the
-   * counterparty's name.
+   * If this value isn't provided, it will be inherited from the counterparty's name.
    */
   party_name?: string;
 
   /**
-   * Body param: Either `individual` or `business`.
+   * Either `individual` or `business`.
    */
   party_type?: 'business' | 'individual' | null;
 
   /**
-   * Body param: If you've enabled the Modern Treasury + Plaid integration in your
-   * Plaid account, you can pass the processor token in this field.
+   * If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
+   * you can pass the processor token in this field.
    */
   plaid_processor_token?: string;
 
-  /**
-   * Body param:
-   */
   routing_details?: Array<ExternalAccountCreateParams.RoutingDetail>;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace ExternalAccountCreateParams {
@@ -566,27 +562,18 @@ export interface ExternalAccountListParams extends PageParams {
 }
 
 export interface ExternalAccountCompleteVerificationParams {
-  /**
-   * Body param:
-   */
   amounts?: Array<number>;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface ExternalAccountVerifyParams {
   /**
-   * Body param: The ID of the internal account where the micro-deposits originate
-   * from. Both credit and debit capabilities must be enabled.
+   * The ID of the internal account where the micro-deposits originate from. Both
+   * credit and debit capabilities must be enabled.
    */
   originating_account_id: string;
 
   /**
-   * Body param: Both ach and eft are supported payment types.
+   * Both ach and eft are supported payment types.
    */
   payment_type:
     | 'ach'
@@ -608,15 +595,9 @@ export interface ExternalAccountVerifyParams {
     | 'wire';
 
   /**
-   * Body param: Defaults to the currency of the originating account.
+   * Defaults to the currency of the originating account.
    */
   currency?: Shared.Currency | null;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace ExternalAccounts {