modern-treasury 2.2.0 → 2.4.0

package/src/resources/counterparties.ts

@@ -1,34 +1,37 @@
 // 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,
-  ): Promise<Core.APIResponse<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 },
     });
   }
 
   /**
    * Get details on a single counterparty.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Counterparty>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Counterparty> {
     return this.get(`/api/counterparties/${id}`, options);
   }
 
@@ -39,13 +42,13 @@ export class Counterparties extends APIResource {
     id: string,
     body?: CounterpartyUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Counterparty>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Counterparty>>;
+  ): Core.APIPromise<Counterparty>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<Counterparty>;
   update(
     id: string,
     body: CounterpartyUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Counterparty>> {
+  ): Core.APIPromise<Counterparty> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -55,12 +58,15 @@ export class Counterparties extends APIResource {
   /**
    * Get a paginated list of all counterparties.
    */
-  list(query?: CounterpartyListParams, options?: Core.RequestOptions): Core.PagePromise<CounterpartiesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<CounterpartiesPage>;
+  list(
+    query?: CounterpartyListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CounterpartiesPage, Counterparty>;
+  list(options?: Core.RequestOptions): Core.PagePromise<CounterpartiesPage, Counterparty>;
   list(
     query: CounterpartyListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<CounterpartiesPage> {
+  ): Core.PagePromise<CounterpartiesPage, Counterparty> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -70,7 +76,7 @@ export class Counterparties extends APIResource {
   /**
    * Deletes a given counterparty.
    */
-  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<void>> {
+  del(id: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this.delete(`/api/counterparties/${id}`, {
       ...options,
       headers: { Accept: '', ...options?.headers },
@@ -84,12 +90,18 @@ export class Counterparties extends APIResource {
     id: string,
     params: CounterpartyCollectAccountParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<CounterpartyCollectAccountResponse>> {
+  ): 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,27 +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.
    */
-  async create(
-    params: DocumentCreateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<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',
-      await multipartFormRequestOptions({
+      multipartFormRequestOptions({
         body,
         ...options,
-        headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+        headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
       }),
     );
   }
@@ -29,19 +32,19 @@ export class Documents extends APIResource {
   /**
    * Get an existing document.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Document>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Document> {
     return this.get(`/api/documents/${id}`, options);
   }
 
   /**
    * Get a list of documents.
    */
-  list(query?: DocumentListParams, options?: Core.RequestOptions): Core.PagePromise<DocumentsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<DocumentsPage>;
+  list(query?: DocumentListParams, options?: Core.RequestOptions): Core.PagePromise<DocumentsPage, Document>;
+  list(options?: Core.RequestOptions): Core.PagePromise<DocumentsPage, Document>;
   list(
     query: DocumentListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<DocumentsPage> {
+  ): Core.PagePromise<DocumentsPage, Document> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -151,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'
@@ -171,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,28 +1,28 @@
 // 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 {
   /**
    * get event
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Event>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Event> {
     return this.get(`/api/events/${id}`, options);
   }
 
   /**
    * list events
    */
-  list(query?: EventListParams, options?: Core.RequestOptions): Core.PagePromise<EventsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<EventsPage>;
+  list(query?: EventListParams, options?: Core.RequestOptions): Core.PagePromise<EventsPage, Event>;
+  list(options?: Core.RequestOptions): Core.PagePromise<EventsPage, Event>;
   list(
     query: EventListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EventsPage> {
+  ): Core.PagePromise<EventsPage, Event> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

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 {
   /**
@@ -14,19 +14,25 @@ export class ExpectedPayments extends APIResource {
   create(
     params: ExpectedPaymentCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<ExpectedPayment>> {
+  ): 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 },
     });
   }
 
   /**
    * get expected payment
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ExpectedPayment>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment> {
     return this.get(`/api/expected_payments/${id}`, options);
   }
 
@@ -37,13 +43,13 @@ export class ExpectedPayments extends APIResource {
     id: string,
     body?: ExpectedPaymentUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<ExpectedPayment>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ExpectedPayment>>;
+  ): Core.APIPromise<ExpectedPayment>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment>;
   update(
     id: string,
     body: ExpectedPaymentUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<ExpectedPayment>> {
+  ): Core.APIPromise<ExpectedPayment> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -56,12 +62,12 @@ export class ExpectedPayments extends APIResource {
   list(
     query?: ExpectedPaymentListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ExpectedPaymentsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ExpectedPaymentsPage>;
+  ): Core.PagePromise<ExpectedPaymentsPage, ExpectedPayment>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ExpectedPaymentsPage, ExpectedPayment>;
   list(
     query: ExpectedPaymentListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ExpectedPaymentsPage> {
+  ): Core.PagePromise<ExpectedPaymentsPage, ExpectedPayment> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -71,7 +77,7 @@ export class ExpectedPayments extends APIResource {
   /**
    * delete expected payment
    */
-  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ExpectedPayment>> {
+  del(id: string, options?: Core.RequestOptions): Core.APIPromise<ExpectedPayment> {
     return this.delete(`/api/expected_payments/${id}`, options);
   }
 }
@@ -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 {