modern-treasury 2.2.0 → 2.4.0

package/src/resources/payment-orders/reversals.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 Reversals extends APIResource {
   /**
@@ -14,12 +14,18 @@ export class Reversals extends APIResource {
     paymentOrderId: string,
     params: ReversalCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Reversal>> {
+  ): Core.APIPromise<Reversal> {
+    // @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/payment_orders/${paymentOrderId}/reversals`, {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -30,7 +36,7 @@ export class Reversals extends APIResource {
     paymentOrderId: string,
     reversalId: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Reversal>> {
+  ): Core.APIPromise<Reversal> {
     return this.get(`/api/payment_orders/${paymentOrderId}/reversals/${reversalId}`, options);
   }
 
@@ -41,13 +47,13 @@ export class Reversals extends APIResource {
     paymentOrderId: string,
     query?: ReversalListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ReversalsPage>;
-  list(paymentOrderId: string, options?: Core.RequestOptions): Core.PagePromise<ReversalsPage>;
+  ): Core.PagePromise<ReversalsPage, Reversal>;
+  list(paymentOrderId: string, options?: Core.RequestOptions): Core.PagePromise<ReversalsPage, Reversal>;
   list(
     paymentOrderId: string,
     query: ReversalListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ReversalsPage> {
+  ): Core.PagePromise<ReversalsPage, Reversal> {
     if (isRequestOptions(query)) {
       return this.list(paymentOrderId, {}, query);
     }
@@ -106,8 +112,8 @@ export interface Reversal {
 
 export interface ReversalCreateParams {
   /**
-   * Body param: The reason for the reversal. Must be one of `duplicate`,
-   * `incorrect_amount`, `incorrect_receiving_account`, `date_earlier_than_intended`,
+   * The reason for the reversal. Must be one of `duplicate`, `incorrect_amount`,
+   * `incorrect_receiving_account`, `date_earlier_than_intended`,
    * `date_later_than_intended`.
    */
   reason:
@@ -118,24 +124,17 @@ export interface ReversalCreateParams {
     | 'date_later_than_intended';
 
   /**
-   * Body param: Specifies a ledger transaction object that will be created with the
-   * reversal. If the ledger transaction cannot be created, then the reversal
-   * creation will fail. The resulting ledger transaction will mirror the status of
-   * the reversal.
+   * Specifies a ledger transaction object that will be created with the reversal. If
+   * the ledger transaction cannot be created, then the reversal creation will fail.
+   * The resulting ledger transaction will mirror the status of the reversal.
    */
   ledger_transaction?: ReversalCreateParams.LedgerTransaction;
 
   /**
-   * 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>;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace ReversalCreateParams {
@@ -145,12 +144,6 @@ export namespace ReversalCreateParams {
    * The resulting ledger transaction will mirror the status of the reversal.
    */
   export interface LedgerTransaction {
-    /**
-     * The timestamp (ISO8601 format) at which the ledger transaction happened for
-     * reporting purposes.
-     */
-    effective_at: string;
-
     /**
      * An array of ledger entry objects.
      */
@@ -161,6 +154,12 @@ export namespace ReversalCreateParams {
      */
     description?: string | null;
 
+    /**
+     * The timestamp (ISO8601 format) at which the ledger transaction happened for
+     * reporting purposes.
+     */
+    effective_at?: string;
+
     /**
      * The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
      * purposes.
@@ -244,6 +243,12 @@ export namespace ReversalCreateParams {
        */
       lock_version?: number | null;
 
+      /**
+       * Additional data represented as key-value pairs. Both the key and value must be
+       * strings.
+       */
+      metadata?: Record<string, string>;
+
       /**
        * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
        * account’s pending balance. If any of these conditions would be false after the

package/src/resources/payment-references.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 PaymentReferences extends APIResource {
   /**
@@ -13,12 +13,12 @@ export class PaymentReferences extends APIResource {
   list(
     query?: PaymentReferenceListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<PaymentReferencesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PaymentReferencesPage>;
+  ): Core.PagePromise<PaymentReferencesPage, PaymentReference>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PaymentReferencesPage, PaymentReference>;
   list(
     query: PaymentReferenceListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<PaymentReferencesPage> {
+  ): Core.PagePromise<PaymentReferencesPage, PaymentReference> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -28,7 +28,7 @@ export class PaymentReferences extends APIResource {
   /**
    * get payment_reference
    */
-  retireve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaymentReference>> {
+  retireve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaymentReference> {
     return this.get(`/api/payment_references/${id}`, options);
   }
 }

package/src/resources/returns.ts

@@ -1,41 +1,50 @@
 // 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 Returns extends APIResource {
   /**
    * Create a return.
    */
-  create(params: ReturnCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<ReturnObject>> {
+  create(params: ReturnCreateParams, options?: Core.RequestOptions): Core.APIPromise<ReturnObject> {
+    // @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/returns', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
   /**
    * Get a single return.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ReturnObject>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ReturnObject> {
     return this.get(`/api/returns/${id}`, options);
   }
 
   /**
    * Get a list of returns.
    */
-  list(query?: ReturnListParams, options?: Core.RequestOptions): Core.PagePromise<ReturnObjectsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ReturnObjectsPage>;
+  list(
+    query?: ReturnListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ReturnObjectsPage, ReturnObject>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ReturnObjectsPage, ReturnObject>;
   list(
     query: ReturnListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ReturnObjectsPage> {
+  ): Core.PagePromise<ReturnObjectsPage, ReturnObject> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -301,25 +310,24 @@ export namespace ReturnObject {
 
 export interface ReturnCreateParams {
   /**
-   * Body param: The ID of the object being returned or `null`.
+   * The ID of the object being returned or `null`.
    */
   returnable_id: string | null;
 
   /**
-   * Body param: The type of object being returned. Currently, this may only be
+   * The type of object being returned. Currently, this may only be
    * incoming_payment_detail.
    */
   returnable_type: 'incoming_payment_detail';
 
   /**
-   * Body param: Some returns may include additional information from the bank. In
-   * these cases, this string will be present.
+   * Some returns may include additional information from the bank. In these cases,
+   * this string will be present.
    */
   additional_information?: string | null;
 
   /**
-   * Body param: The return code. For ACH returns, this is the required ACH return
-   * code.
+   * The return code. For ACH returns, this is the required ACH return code.
    */
   code?:
     | '901'
@@ -368,22 +376,16 @@ export interface ReturnCreateParams {
     | null;
 
   /**
-   * Body param: If the return code is `R14` or `R15` this is the date the deceased
-   * counterparty passed away.
+   * If the return code is `R14` or `R15` this is the date the deceased counterparty
+   * passed away.
    */
   date_of_death?: string | null;
 
   /**
-   * Body param: An optional description of the reason for the return. This is for
-   * internal usage and will not be transmitted to the bank.”
+   * An optional description of the reason for the return. This is for internal usage
+   * and will not be transmitted to the bank.”
    */
   reason?: string | null;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface ReturnListParams extends PageParams {

package/src/resources/routing-details.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 RoutingDetails extends APIResource {
   /**
@@ -16,12 +16,18 @@ export class RoutingDetails extends APIResource {
     accountId: string,
     params: RoutingDetailCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<RoutingDetail>> {
+  ): Core.APIPromise<RoutingDetail> {
+    // @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/${accountsType}/${accountId}/routing_details`, {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -33,7 +39,7 @@ export class RoutingDetails extends APIResource {
     accountId: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<RoutingDetail>> {
+  ): Core.APIPromise<RoutingDetail> {
     return this.get(`/api/${accountsType}/${accountId}/routing_details/${id}`, options);
   }
 
@@ -45,18 +51,18 @@ export class RoutingDetails extends APIResource {
     accountId: string,
     query?: RoutingDetailListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<RoutingDetailsPage>;
+  ): Core.PagePromise<RoutingDetailsPage, RoutingDetail>;
   list(
     accountsType: Shared.AccountsType,
     accountId: string,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<RoutingDetailsPage>;
+  ): Core.PagePromise<RoutingDetailsPage, RoutingDetail>;
   list(
     accountsType: Shared.AccountsType,
     accountId: string,
     query: RoutingDetailListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<RoutingDetailsPage> {
+  ): Core.PagePromise<RoutingDetailsPage, RoutingDetail> {
     if (isRequestOptions(query)) {
       return this.list(accountsType, accountId, {}, query);
     }
@@ -74,7 +80,7 @@ export class RoutingDetails extends APIResource {
     accountId: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<void>> {
+  ): Core.APIPromise<void> {
     return this.delete(`/api/${accountsType}/${accountId}/routing_details/${id}`, {
       ...options,
       headers: { Accept: '', ...options?.headers },
@@ -199,13 +205,12 @@ export namespace RoutingDetail {
 
 export interface RoutingDetailCreateParams {
   /**
-   * Body param: The routing number of the bank.
+   * The routing number of the bank.
    */
   routing_number: string;
 
   /**
-   * Body param: One of `aba`, `swift`, `ca_cpa`, `au_bsb`, `gb_sort_code`,
-   * `in_ifsc`, `cnaps`.
+   * One of `aba`, `swift`, `ca_cpa`, `au_bsb`, `gb_sort_code`, `in_ifsc`, `cnaps`.
    */
   routing_number_type:
     | 'aba'
@@ -220,8 +225,8 @@ export interface RoutingDetailCreateParams {
     | 'swift';
 
   /**
-   * Body param: If the routing detail is to be used for a specific payment type this
-   * field will be populated, otherwise null.
+   * If the routing detail is to be used for a specific payment type this field will
+   * be populated, otherwise null.
    */
   payment_type?:
     | 'ach'
@@ -242,12 +247,6 @@ export interface RoutingDetailCreateParams {
     | 'signet'
     | 'wire'
     | null;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface RoutingDetailListParams extends PageParams {}

package/src/resources/top-level.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as API from './index';
+import * as API from './index.js';
 
 export interface PingResponse {
   ping: string;

package/src/resources/transactions/index.ts

@@ -6,5 +6,10 @@ export {
   TransactionListParams,
   TransactionsPage,
   Transactions,
-} from './transactions';
-export { TransactionLineItem, LineItemListParams, TransactionLineItemsPage, LineItems } from './line-items';
+} from './transactions.js';
+export {
+  TransactionLineItem,
+  LineItemListParams,
+  TransactionLineItemsPage,
+  LineItems,
+} from './line-items.js';

package/src/resources/transactions/line-items.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 LineItems extends APIResource {
   /**
@@ -14,13 +14,16 @@ export class LineItems extends APIResource {
     transactionId: string,
     query?: LineItemListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<TransactionLineItemsPage>;
-  list(transactionId: string, options?: Core.RequestOptions): Core.PagePromise<TransactionLineItemsPage>;
+  ): Core.PagePromise<TransactionLineItemsPage, TransactionLineItem>;
+  list(
+    transactionId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<TransactionLineItemsPage, TransactionLineItem>;
   list(
     transactionId: string,
     query: LineItemListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<TransactionLineItemsPage> {
+  ): Core.PagePromise<TransactionLineItemsPage, TransactionLineItem> {
     if (isRequestOptions(query)) {
       return this.list(transactionId, {}, query);
     }

package/src/resources/transactions/transactions.ts

@@ -1,12 +1,12 @@
 // 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 { LineItems } from './line-items';
-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 { LineItems } from './line-items.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../../pagination.js';
 
 export class Transactions extends APIResource {
   lineItems: LineItems = new LineItems(this.client);
@@ -14,7 +14,7 @@ export class Transactions extends APIResource {
   /**
    * Get details on a single transaction.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Transaction>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Transaction> {
     return this.get(`/api/transactions/${id}`, options);
   }
 
@@ -25,13 +25,13 @@ export class Transactions extends APIResource {
     id: string,
     body?: TransactionUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Transaction>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Transaction>>;
+  ): Core.APIPromise<Transaction>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<Transaction>;
   update(
     id: string,
     body: TransactionUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Transaction>> {
+  ): Core.APIPromise<Transaction> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -41,12 +41,15 @@ export class Transactions extends APIResource {
   /**
    * Get a list of all transactions.
    */
-  list(query?: TransactionListParams, options?: Core.RequestOptions): Core.PagePromise<TransactionsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<TransactionsPage>;
+  list(
+    query?: TransactionListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<TransactionsPage, Transaction>;
+  list(options?: Core.RequestOptions): Core.PagePromise<TransactionsPage, Transaction>;
   list(
     query: TransactionListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<TransactionsPage> {
+  ): Core.PagePromise<TransactionsPage, Transaction> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/validations.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import * as API from './index';
+import * as Core from '../core.js';
+import { APIResource } from '../resource.js';
+import * as API from './index.js';
 
 export class Validations extends APIResource {
   /**
@@ -12,7 +12,7 @@ export class Validations extends APIResource {
   validateRoutingNumber(
     query: ValidationValidateRoutingNumberParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<RoutingNumberLookupRequest>> {
+  ): Core.APIPromise<RoutingNumberLookupRequest> {
     return this.get('/api/validations/routing_numbers', { query, ...options });
   }
 }