modern-treasury 2.2.0 → 2.4.0

package/src/resources/ledger-transactions/ledger-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 LedgerEntries from '../ledger-entries';
-import { Versions } from './versions';
-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 LedgerEntries from '../ledger-entries.js';
+import { Versions } from './versions.js';
+import * as API from './index.js';
+import { Page, PageParams } from '../../pagination.js';
 
 export class LedgerTransactions extends APIResource {
   versions: Versions = new Versions(this.client);
@@ -17,19 +17,25 @@ export class LedgerTransactions extends APIResource {
   create(
     params: LedgerTransactionCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>> {
+  ): Core.APIPromise<LedgerTransaction> {
+    // @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/ledger_transactions', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
   /**
    * Get details on a single ledger transaction.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerTransaction>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction> {
     return this.get(`/api/ledger_transactions/${id}`, options);
   }
 
@@ -40,13 +46,13 @@ export class LedgerTransactions extends APIResource {
     id: string,
     body?: LedgerTransactionUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerTransaction>>;
+  ): Core.APIPromise<LedgerTransaction>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
   update(
     id: string,
     body: LedgerTransactionUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>> {
+  ): Core.APIPromise<LedgerTransaction> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -59,12 +65,12 @@ export class LedgerTransactions extends APIResource {
   list(
     query?: LedgerTransactionListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerTransactionsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerTransactionsPage>;
+  ): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction>;
   list(
     query: LedgerTransactionListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerTransactionsPage> {
+  ): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -75,23 +81,20 @@ export class LedgerTransactions extends APIResource {
    * Create a ledger transaction reversal.
    */
   createReversal(
-    ledgerTransactionId: string,
+    id: string,
     body?: LedgerTransactionCreateReversalParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>>;
-  createReversal(
-    ledgerTransactionId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>>;
+  ): Core.APIPromise<LedgerTransaction>;
+  createReversal(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
   createReversal(
-    ledgerTransactionId: string,
+    id: string,
     body: LedgerTransactionCreateReversalParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>> {
+  ): Core.APIPromise<LedgerTransaction> {
     if (isRequestOptions(body)) {
-      return this.createReversal(ledgerTransactionId, {}, body);
+      return this.createReversal(id, {}, body);
     }
-    return this.post(`/api/ledger_transactions/${ledgerTransactionId}/reversal`, { body, ...options });
+    return this.post(`/api/ledger_transactions/${id}/reversal`, { body, ...options });
   }
 }
 
@@ -196,44 +199,43 @@ export interface LedgerTransaction {
 
 export interface LedgerTransactionCreateParams {
   /**
-   * Body param: The timestamp (ISO8601 format) at which the ledger transaction
-   * happened for reporting purposes.
-   */
-  effective_at: string;
-
-  /**
-   * Body param: An array of ledger entry objects.
+   * An array of ledger entry objects.
    */
   ledger_entries: Array<LedgerTransactionCreateParams.LedgerEntry>;
 
   /**
-   * Body param: An optional description for internal use.
+   * An optional description for internal use.
    */
   description?: string | null;
 
   /**
-   * Body param: The date (YYYY-MM-DD) on which the ledger transaction happened for
+   * 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.
+   */
   effective_date?: string;
 
   /**
-   * Body param: A unique string to represent the ledger transaction. Only one
-   * pending or posted ledger transaction may have this ID in the ledger.
+   * A unique string to represent the ledger transaction. Only one pending or posted
+   * ledger transaction may have this ID in the ledger.
    */
   external_id?: string;
 
   /**
-   * Body param: If the ledger transaction can be reconciled to another object in
-   * Modern Treasury, the id will be populated here, otherwise null.
+   * If the ledger transaction can be reconciled to another object in Modern
+   * Treasury, the id will be populated here, otherwise null.
    */
   ledgerable_id?: string;
 
   /**
-   * Body param: If the ledger transaction can be reconciled to another object in
-   * Modern Treasury, the type will be populated here, otherwise null. This can be
-   * one of payment_order, incoming_payment_detail, expected_payment, return, or
-   * reversal.
+   * If the ledger transaction can be reconciled to another object in Modern
+   * Treasury, the type will be populated here, otherwise null. This can be one of
+   * payment_order, incoming_payment_detail, expected_payment, return, or reversal.
    */
   ledgerable_type?:
     | 'counterparty'
@@ -248,21 +250,15 @@ export interface LedgerTransactionCreateParams {
     | 'reversal';
 
   /**
-   * 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: To post a ledger transaction at creation, use `posted`.
+   * To post a ledger transaction at creation, use `posted`.
    */
   status?: 'archived' | 'pending' | 'posted';
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace LedgerTransactionCreateParams {
@@ -301,6 +297,12 @@ export namespace LedgerTransactionCreateParams {
      */
     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
@@ -329,6 +331,12 @@ export interface LedgerTransactionUpdateParams {
    */
   description?: string | null;
 
+  /**
+   * The timestamp (ISO8601 format) at which the ledger transaction happened for
+   * reporting purposes.
+   */
+  effective_at?: string;
+
   /**
    * An array of ledger entry objects.
    */
@@ -382,6 +390,12 @@ export namespace LedgerTransactionUpdateParams {
      */
     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
@@ -405,7 +419,11 @@ export namespace LedgerTransactionUpdateParams {
 }
 
 export interface LedgerTransactionListParams extends PageParams {
-  id?: Record<string, string>;
+  /**
+   * If you have specific IDs to retrieve in bulk, you can pass them as query
+   * parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
+   */
+  id?: Array<string>;
 
   /**
    * Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by
@@ -427,6 +445,8 @@ export interface LedgerTransactionListParams extends PageParams {
 
   ledger_account_id?: string;
 
+  ledger_account_payout_id?: string;
+
   ledger_id?: string;
 
   ledgerable_id?: string;

package/src/resources/ledger-transactions/versions.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 Versions extends APIResource {
   /**
@@ -13,12 +13,14 @@ export class Versions extends APIResource {
   list(
     query?: VersionListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerTransactionVersionsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerTransactionVersionsPage>;
+  ): Core.PagePromise<LedgerTransactionVersionsPage, LedgerTransactionVersion>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LedgerTransactionVersionsPage, LedgerTransactionVersion>;
   list(
     query: VersionListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerTransactionVersionsPage> {
+  ): Core.PagePromise<LedgerTransactionVersionsPage, LedgerTransactionVersion> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/ledgerable-events.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 LedgerableEvents extends APIResource {
   /**
@@ -12,19 +12,25 @@ export class LedgerableEvents extends APIResource {
   create(
     params: LedgerableEventCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerableEvent>> {
+  ): Core.APIPromise<LedgerableEvent> {
+    // @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/ledgerable_events', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
   /**
    * Get details on a single ledgerable event.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerableEvent>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerableEvent> {
     return this.get(`/api/ledgerable_events/${id}`, options);
   }
 }
@@ -95,53 +101,47 @@ export interface LedgerableEvent {
 
 export interface LedgerableEventCreateParams {
   /**
-   * Body param: Value in specified currency's smallest unit. e.g. $10 would be
-   * represented as 1000.
+   * Value in specified currency's smallest unit. e.g. $10 would be represented
+   * as 1000.
    */
   amount: number;
 
   /**
-   * Body param: Name of the ledgerable event.
+   * Name of the ledgerable event.
    */
   name: string;
 
   /**
-   * Body param: An ISO 4217 conformed currency or a custom currency.
+   * An ISO 4217 conformed currency or a custom currency.
    */
   currency?: string | null;
 
   /**
-   * Body param: Must be included if currency is a custom currency. The
-   * currency_exponent cannot exceed 30.
+   * Must be included if currency is a custom currency. The currency_exponent cannot
+   * exceed 30.
    */
   currency_exponent?: number | null;
 
   /**
-   * Body param: Additionally data to be used by the Ledger Event Handler.
+   * Additionally data to be used by the Ledger Event Handler.
    */
   custom_data?: unknown | null;
 
   /**
-   * Body param: Description of the ledgerable event.
+   * Description of the ledgerable event.
    */
   description?: string | null;
 
   /**
-   * Body param: One of `credit`, `debit`.
+   * One of `credit`, `debit`.
    */
   direction?: string | null;
 
   /**
-   * 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 LedgerableEvents {

package/src/resources/ledgers.ts

@@ -1,45 +1,47 @@
 // 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 Ledgers extends APIResource {
   /**
    * Create a ledger.
    */
-  create(params: LedgerCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Ledger>> {
+  create(params: LedgerCreateParams, options?: Core.RequestOptions): Core.APIPromise<Ledger> {
+    // @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/ledgers', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
   /**
    * Get details on a single ledger.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Ledger>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Ledger> {
     return this.get(`/api/ledgers/${id}`, options);
   }
 
   /**
    * Update the details of a ledger.
    */
-  update(
-    id: string,
-    body?: LedgerUpdateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Ledger>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Ledger>>;
+  update(id: string, body?: LedgerUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Ledger>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<Ledger>;
   update(
     id: string,
     body: LedgerUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Ledger>> {
+  ): Core.APIPromise<Ledger> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -49,12 +51,12 @@ export class Ledgers extends APIResource {
   /**
    * Get a list of ledgers.
    */
-  list(query?: LedgerListParams, options?: Core.RequestOptions): Core.PagePromise<LedgersPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgersPage>;
+  list(query?: LedgerListParams, options?: Core.RequestOptions): Core.PagePromise<LedgersPage, Ledger>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgersPage, Ledger>;
   list(
     query: LedgerListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgersPage> {
+  ): Core.PagePromise<LedgersPage, Ledger> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -64,7 +66,7 @@ export class Ledgers extends APIResource {
   /**
    * Delete a ledger.
    */
-  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Ledger>> {
+  del(id: string, options?: Core.RequestOptions): Core.APIPromise<Ledger> {
     return this.delete(`/api/ledgers/${id}`, options);
   }
 }
@@ -110,26 +112,20 @@ export interface Ledger {
 
 export interface LedgerCreateParams {
   /**
-   * Body param: The name of the ledger.
+   * The name of the ledger.
    */
   name: string;
 
   /**
-   * Body param: An optional free-form description for internal use.
+   * An optional free-form description for internal use.
    */
   description?: string | null;
 
   /**
-   * 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 interface LedgerUpdateParams {
@@ -151,6 +147,12 @@ export interface LedgerUpdateParams {
 }
 
 export interface LedgerListParams extends PageParams {
+  /**
+   * If you have specific IDs to retrieve in bulk, you can pass them as query
+   * parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
+   */
+  id?: Array<string>;
+
   /**
    * For example, if you want to query for records with metadata key `Type` and value
    * `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query

package/src/resources/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 {
   /**
@@ -15,7 +15,7 @@ export class LineItems extends APIResource {
     itemizableId: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LineItem>> {
+  ): Core.APIPromise<LineItem> {
     return this.get(`/api/${itemizableType}/${itemizableId}/line_items/${id}`, options);
   }
 
@@ -28,20 +28,20 @@ export class LineItems extends APIResource {
     id: string,
     body?: LineItemUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LineItem>>;
+  ): Core.APIPromise<LineItem>;
   update(
     itemizableType: 'expected_payments' | 'payment_orders',
     itemizableId: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LineItem>>;
+  ): Core.APIPromise<LineItem>;
   update(
     itemizableType: 'expected_payments' | 'payment_orders',
     itemizableId: string,
     id: string,
     body: LineItemUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LineItem>> {
+  ): Core.APIPromise<LineItem> {
     if (isRequestOptions(body)) {
       return this.update(itemizableType, itemizableId, id, {}, body);
     }
@@ -56,18 +56,18 @@ export class LineItems extends APIResource {
     itemizableId: string,
     query?: LineItemListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LineItemsPage>;
+  ): Core.PagePromise<LineItemsPage, LineItem>;
   list(
     itemizableType: 'expected_payments' | 'payment_orders',
     itemizableId: string,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LineItemsPage>;
+  ): Core.PagePromise<LineItemsPage, LineItem>;
   list(
     itemizableType: 'expected_payments' | 'payment_orders',
     itemizableId: string,
     query: LineItemListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LineItemsPage> {
+  ): Core.PagePromise<LineItemsPage, LineItem> {
     if (isRequestOptions(query)) {
       return this.list(itemizableType, itemizableId, {}, query);
     }

package/src/resources/paper-items.ts

@@ -1,29 +1,32 @@
 // 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 PaperItems extends APIResource {
   /**
    * Get details on a single paper item.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaperItem>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaperItem> {
     return this.get(`/api/paper_items/${id}`, options);
   }
 
   /**
    * Get a list of all paper items.
    */
-  list(query?: PaperItemListParams, options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage>;
+  list(
+    query?: PaperItemListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PaperItemsPage, PaperItem>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage, PaperItem>;
   list(
     query: PaperItemListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<PaperItemsPage> {
+  ): Core.PagePromise<PaperItemsPage, PaperItem> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }