modern-treasury 2.2.0 → 2.4.0

package/src/resources/ledger-accounts.ts

@@ -1,24 +1,27 @@
 // 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 LedgerAccounts extends APIResource {
   /**
    * Create a ledger account.
    */
-  create(
-    params: LedgerAccountCreateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>> {
+  create(params: LedgerAccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<LedgerAccount> {
+    // @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_accounts', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -29,13 +32,13 @@ export class LedgerAccounts extends APIResource {
     id: string,
     query?: LedgerAccountRetrieveParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>>;
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccount>>;
+  ): Core.APIPromise<LedgerAccount>;
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccount>;
   retrieve(
     id: string,
     query: LedgerAccountRetrieveParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>> {
+  ): Core.APIPromise<LedgerAccount> {
     if (isRequestOptions(query)) {
       return this.retrieve(id, {}, query);
     }
@@ -49,13 +52,13 @@ export class LedgerAccounts extends APIResource {
     id: string,
     body?: LedgerAccountUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccount>>;
+  ): Core.APIPromise<LedgerAccount>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccount>;
   update(
     id: string,
     body: LedgerAccountUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>> {
+  ): Core.APIPromise<LedgerAccount> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -65,12 +68,15 @@ export class LedgerAccounts extends APIResource {
   /**
    * Get a list of ledger accounts.
    */
-  list(query?: LedgerAccountListParams, options?: Core.RequestOptions): Core.PagePromise<LedgerAccountsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountsPage>;
+  list(
+    query?: LedgerAccountListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LedgerAccountsPage, LedgerAccount>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountsPage, LedgerAccount>;
   list(
     query: LedgerAccountListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerAccountsPage> {
+  ): Core.PagePromise<LedgerAccountsPage, LedgerAccount> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -80,7 +86,7 @@ export class LedgerAccounts extends APIResource {
   /**
    * Delete a ledger account.
    */
-  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccount>> {
+  del(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccount> {
     return this.delete(`/api/ledger_accounts/${id}`, options);
   }
 }
@@ -271,59 +277,53 @@ export namespace LedgerAccount {
 
 export interface LedgerAccountCreateParams {
   /**
-   * Body param: The currency of the ledger account.
+   * The currency of the ledger account.
    */
   currency: string;
 
   /**
-   * Body param: The id of the ledger that this account belongs to.
+   * The id of the ledger that this account belongs to.
    */
   ledger_id: string;
 
   /**
-   * Body param: The name of the ledger account.
+   * The name of the ledger account.
    */
   name: string;
 
   /**
-   * Body param: The normal balance of the ledger account.
+   * The normal balance of the ledger account.
    */
   normal_balance: 'credit' | 'debit';
 
   /**
-   * Body param: The currency exponent of the ledger account.
+   * The currency exponent of the ledger account.
    */
   currency_exponent?: number | null;
 
   /**
-   * Body param: The description of the ledger account.
+   * The description of the ledger account.
    */
   description?: string | null;
 
   /**
-   * Body param: If the ledger account links to another object in Modern Treasury,
-   * the id will be populated here, otherwise null.
+   * If the ledger account links to another object in Modern Treasury, the id will be
+   * populated here, otherwise null.
    */
   ledgerable_id?: string;
 
   /**
-   * Body param: If the ledger account links to another object in Modern Treasury,
-   * the type will be populated here, otherwise null. The value is one of
-   * internal_account or external_account.
+   * If the ledger account links to another object in Modern Treasury, the type will
+   * be populated here, otherwise null. The value is one of internal_account or
+   * external_account.
    */
   ledgerable_type?: 'external_account' | 'internal_account';
 
   /**
-   * 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 LedgerAccountRetrieveParams {
@@ -379,7 +379,11 @@ export interface LedgerAccountUpdateParams {
 }
 
 export interface LedgerAccountListParams extends PageParams {
-  id?: 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 `balances[effective_at_lower_bound]` and
@@ -397,6 +401,8 @@ export interface LedgerAccountListParams extends PageParams {
    */
   created_at?: Record<string, string>;
 
+  currency?: string;
+
   ledger_account_category_id?: string;
 
   ledger_id?: string;

package/src/resources/ledger-entries.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 LedgerEntries extends APIResource {
   /**
@@ -14,13 +14,13 @@ export class LedgerEntries extends APIResource {
     id: string,
     query?: LedgerEntryRetrieveParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEntry>>;
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerEntry>>;
+  ): Core.APIPromise<LedgerEntry>;
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerEntry>;
   retrieve(
     id: string,
     query: LedgerEntryRetrieveParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEntry>> {
+  ): Core.APIPromise<LedgerEntry> {
     if (isRequestOptions(query)) {
       return this.retrieve(id, {}, query);
     }
@@ -30,12 +30,15 @@ export class LedgerEntries extends APIResource {
   /**
    * Get a list of all ledger entries.
    */
-  list(query?: LedgerEntryListParams, options?: Core.RequestOptions): Core.PagePromise<LedgerEntriesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerEntriesPage>;
+  list(
+    query?: LedgerEntryListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LedgerEntriesPage, LedgerEntry>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgerEntriesPage, LedgerEntry>;
   list(
     query: LedgerEntryListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerEntriesPage> {
+  ): Core.PagePromise<LedgerEntriesPage, LedgerEntry> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -238,7 +241,11 @@ export interface LedgerEntryRetrieveParams {
 }
 
 export interface LedgerEntryListParams 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>;
 
   /**
    * Shows all ledger entries that were present on a ledger account at a particular
@@ -254,7 +261,7 @@ export interface LedgerEntryListParams extends PageParams {
   direction?: 'credit' | 'debit';
 
   /**
-   * Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by the
+   * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
    * transaction's effective time. Format ISO8601
    */
   effective_at?: Record<string, string>;
@@ -281,6 +288,8 @@ export interface LedgerEntryListParams extends PageParams {
    */
   ledger_account_lock_version?: Record<string, number>;
 
+  ledger_account_payout_id?: string;
+
   /**
    * Get all ledger entries that are included in the ledger account statement.
    */
@@ -288,6 +297,13 @@ export interface LedgerEntryListParams extends PageParams {
 
   ledger_transaction_id?: 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
+   * parameters.
+   */
+  metadata?: Record<string, string>;
+
   /**
    * Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
    * to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering

package/src/resources/ledger-event-handlers.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 LedgerEventHandlers extends APIResource {
   /**
@@ -13,22 +13,25 @@ export class LedgerEventHandlers extends APIResource {
   create(
     params: LedgerEventHandlerCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEventHandlerCreateResponse>> {
+  ): Core.APIPromise<LedgerEventHandlerCreateResponse> {
+    // @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_event_handlers', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
   /**
    * Get details on a single ledger event handler.
    */
-  retrieve(
-    id: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEventHandlerRetrieveResponse>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerEventHandlerRetrieveResponse> {
     return this.get(`/api/ledger_event_handlers/${id}`, options);
   }
 
@@ -38,12 +41,14 @@ export class LedgerEventHandlers extends APIResource {
   list(
     query?: LedgerEventHandlerListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerEventHandlerListResponsesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerEventHandlerListResponsesPage>;
+  ): Core.PagePromise<LedgerEventHandlerListResponsesPage, LedgerEventHandlerListResponse>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LedgerEventHandlerListResponsesPage, LedgerEventHandlerListResponse>;
   list(
     query: LedgerEventHandlerListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerEventHandlerListResponsesPage> {
+  ): Core.PagePromise<LedgerEventHandlerListResponsesPage, LedgerEventHandlerListResponse> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -56,10 +61,7 @@ export class LedgerEventHandlers extends APIResource {
   /**
    * Archive a ledger event handler.
    */
-  del(
-    id: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEventHandlerDeleteResponse>> {
+  del(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerEventHandlerDeleteResponse> {
     return this.delete(`/api/ledger_event_handlers/${id}`, options);
   }
 }
@@ -477,42 +479,30 @@ export namespace LedgerEventHandlerDeleteResponse {
 }
 
 export interface LedgerEventHandlerCreateParams {
-  /**
-   * Body param:
-   */
   ledger_transaction_template: LedgerEventHandlerCreateParams.LedgerTransactionTemplate;
 
   /**
-   * Body param: Name of the ledger event handler.
+   * Name of the ledger event handler.
    */
   name: string;
 
-  /**
-   * Body param:
-   */
   conditions?: LedgerEventHandlerCreateParams.Conditions | null;
 
   /**
-   * Body param: An optional description.
+   * An optional description.
    */
   description?: string | null;
 
   /**
-   * Body param: The id of the ledger that this account belongs to.
+   * The id of the ledger that this account belongs to.
    */
   ledger_id?: string;
 
   /**
-   * 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> | null;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export namespace LedgerEventHandlerCreateParams {

package/src/resources/ledger-transactions/index.ts

@@ -8,10 +8,10 @@ export {
   LedgerTransactionCreateReversalParams,
   LedgerTransactionsPage,
   LedgerTransactions,
-} from './ledger-transactions';
+} from './ledger-transactions.js';
 export {
   LedgerTransactionVersion,
   VersionListParams,
   LedgerTransactionVersionsPage,
   Versions,
-} from './versions';
+} from './versions.js';