modern-treasury 2.2.0 → 2.4.0

package/src/resources/ledger-account-categories.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 LedgerAccountCategories extends APIResource {
   /**
@@ -13,12 +13,18 @@ export class LedgerAccountCategories extends APIResource {
   create(
     params: LedgerAccountCategoryCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>> {
+  ): Core.APIPromise<LedgerAccountCategory> {
+    // @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_account_categories', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -29,13 +35,13 @@ export class LedgerAccountCategories extends APIResource {
     id: string,
     query?: LedgerAccountCategoryRetrieveParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>>;
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccountCategory>>;
+  ): Core.APIPromise<LedgerAccountCategory>;
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
   retrieve(
     id: string,
     query: LedgerAccountCategoryRetrieveParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>> {
+  ): Core.APIPromise<LedgerAccountCategory> {
     if (isRequestOptions(query)) {
       return this.retrieve(id, {}, query);
     }
@@ -47,20 +53,19 @@ export class LedgerAccountCategories extends APIResource {
    */
   update(
     id: string,
-    params?: LedgerAccountCategoryUpdateParams,
+    body?: LedgerAccountCategoryUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccountCategory>>;
+  ): Core.APIPromise<LedgerAccountCategory>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory>;
   update(
     id: string,
-    params: LedgerAccountCategoryUpdateParams | Core.RequestOptions = {},
+    body: LedgerAccountCategoryUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>> {
-    if (isRequestOptions(params)) {
-      return this.update(id, {}, params);
+  ): Core.APIPromise<LedgerAccountCategory> {
+    if (isRequestOptions(body)) {
+      return this.update(id, {}, body);
     }
-    const { balances, ...body } = params;
-    return this.patch(`/api/ledger_account_categories/${id}`, { query: { balances }, body, ...options });
+    return this.patch(`/api/ledger_account_categories/${id}`, { body, ...options });
   }
 
   /**
@@ -69,12 +74,12 @@ export class LedgerAccountCategories extends APIResource {
   list(
     query?: LedgerAccountCategoryListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerAccountCategoriesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountCategoriesPage>;
+  ): Core.PagePromise<LedgerAccountCategoriesPage, LedgerAccountCategory>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountCategoriesPage, LedgerAccountCategory>;
   list(
     query: LedgerAccountCategoryListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerAccountCategoriesPage> {
+  ): Core.PagePromise<LedgerAccountCategoriesPage, LedgerAccountCategory> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -87,32 +92,18 @@ export class LedgerAccountCategories extends APIResource {
   /**
    * Delete a ledger account category.
    */
-  del(
-    id: string,
-    body?: LedgerAccountCategoryDeleteParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>>;
-  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccountCategory>>;
-  del(
-    id: string,
-    body: LedgerAccountCategoryDeleteParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>> {
-    if (isRequestOptions(body)) {
-      return this.del(id, {}, body);
-    }
-    const { balances } = body;
-    return this.delete(`/api/ledger_account_categories/${id}`, { query: { balances }, ...options });
+  del(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountCategory> {
+    return this.delete(`/api/ledger_account_categories/${id}`, options);
   }
 
   /**
-   * Add a ledger account category to an account.
+   * Add a ledger account to a ledger account category.
    */
   addLedgerAccount(
     id: string,
     ledgerAccountId: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<void>> {
+  ): Core.APIPromise<void> {
     return this.put(`/api/ledger_account_categories/${id}/ledger_accounts/${ledgerAccountId}`, {
       ...options,
       headers: { Accept: '', ...options?.headers },
@@ -122,11 +113,7 @@ export class LedgerAccountCategories extends APIResource {
   /**
    * Add a ledger account category to a ledger account category.
    */
-  addNestedCategory(
-    id: string,
-    subCategoryId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<void>> {
+  addNestedCategory(id: string, subCategoryId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this.put(`/api/ledger_account_categories/${id}/ledger_account_categories/${subCategoryId}`, {
       ...options,
       headers: { Accept: '', ...options?.headers },
@@ -134,13 +121,13 @@ export class LedgerAccountCategories extends APIResource {
   }
 
   /**
-   * Delete a ledger account category from an account.
+   * Remove a ledger account from a ledger account category.
    */
   removeLedgerAccount(
     id: string,
     ledgerAccountId: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<void>> {
+  ): Core.APIPromise<void> {
     return this.delete(`/api/ledger_account_categories/${id}/ledger_accounts/${ledgerAccountId}`, {
       ...options,
       headers: { Accept: '', ...options?.headers },
@@ -154,7 +141,7 @@ export class LedgerAccountCategories extends APIResource {
     id: string,
     subCategoryId: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<void>> {
+  ): Core.APIPromise<void> {
     return this.delete(`/api/ledger_account_categories/${id}/ledger_account_categories/${subCategoryId}`, {
       ...options,
       headers: { Accept: '', ...options?.headers },
@@ -318,64 +305,56 @@ export namespace LedgerAccountCategory {
 
 export interface LedgerAccountCategoryCreateParams {
   /**
-   * Body param: The currency of the ledger account category.
+   * The currency of the ledger account category.
    */
   currency: string;
 
   /**
-   * Body param: The id of the ledger that this account category belongs to.
+   * The id of the ledger that this account category belongs to.
    */
   ledger_id: string;
 
   /**
-   * Body param: The name of the ledger account category.
+   * The name of the ledger account category.
    */
   name: string;
 
   /**
-   * Body param: The normal balance of the ledger account category.
+   * The normal balance of the ledger account category.
    */
   normal_balance: 'credit' | 'debit';
 
   /**
-   * Body param: The currency exponent of the ledger account category.
+   * The currency exponent of the ledger account category.
    */
   currency_exponent?: number | null;
 
   /**
-   * Body param: The description of the ledger account category.
+   * The description of the ledger account category.
    */
   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 LedgerAccountCategoryRetrieveParams {
   /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
+   * For example, if you want the balances as of a particular time (ISO8601), the
+   * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+   * The balances as of a time are inclusive of entries with that exact time.
    */
   balances?: LedgerAccountCategoryRetrieveParams.Balances;
 }
 
 export namespace LedgerAccountCategoryRetrieveParams {
   /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
+   * For example, if you want the balances as of a particular time (ISO8601), the
+   * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+   * The balances as of a time are inclusive of entries with that exact time.
    */
   export interface Balances {
     as_of_date?: string;
@@ -386,45 +365,36 @@ export namespace LedgerAccountCategoryRetrieveParams {
 
 export interface LedgerAccountCategoryUpdateParams {
   /**
-   * Query param: For example, if you want the balances as of a particular effective
-   * date (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
-   */
-  balances?: LedgerAccountCategoryUpdateParams.Balances;
-
-  /**
-   * Body param: The description of the ledger account category.
+   * The description of the ledger account category.
    */
   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>;
 
   /**
-   * Body param: The name of the ledger account category.
+   * The name of the ledger account category.
    */
   name?: string;
 }
 
-export namespace LedgerAccountCategoryUpdateParams {
+export interface LedgerAccountCategoryListParams extends PageParams {
   /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
+   * 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`.
    */
-  export interface Balances {
-    as_of_date?: string;
+  id?: Array<string>;
 
-    effective_at?: string;
-  }
-}
+  /**
+   * For example, if you want the balances as of a particular time (ISO8601), the
+   * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+   * The balances as of a time are inclusive of entries with that exact time.
+   */
+  balances?: LedgerAccountCategoryListParams.Balances;
 
-export interface LedgerAccountCategoryListParams extends PageParams {
   /**
    * Query categories which contain a ledger account directly or through child
    * categories.
@@ -448,26 +418,13 @@ export interface LedgerAccountCategoryListParams extends PageParams {
   parent_ledger_account_category_id?: string;
 }
 
-export interface LedgerAccountCategoryDeleteParams {
-  /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
-   */
-  balances?: LedgerAccountCategoryDeleteParams.Balances;
-}
-
-export namespace LedgerAccountCategoryDeleteParams {
+export namespace LedgerAccountCategoryListParams {
   /**
-   * For example, if you want the balances as of a particular effective date
-   * (YYYY-MM-DD), the encoded query string would be
-   * balances%5Bas_of_date%5D=2000-12-31. The balances as of a date are exclusive of
-   * entries with that exact date.
+   * For example, if you want the balances as of a particular time (ISO8601), the
+   * encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+   * The balances as of a time are inclusive of entries with that exact time.
    */
   export interface Balances {
-    as_of_date?: string;
-
     effective_at?: string;
   }
 }
@@ -479,5 +436,4 @@ export namespace LedgerAccountCategories {
   export import LedgerAccountCategoryRetrieveParams = API.LedgerAccountCategoryRetrieveParams;
   export import LedgerAccountCategoryUpdateParams = API.LedgerAccountCategoryUpdateParams;
   export import LedgerAccountCategoryListParams = API.LedgerAccountCategoryListParams;
-  export import LedgerAccountCategoryDeleteParams = API.LedgerAccountCategoryDeleteParams;
 }

package/src/resources/ledger-account-payouts.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 LedgerAccountPayouts extends APIResource {
   /**
@@ -13,12 +13,18 @@ export class LedgerAccountPayouts extends APIResource {
   create(
     params: LedgerAccountPayoutCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountPayout>> {
+  ): Core.APIPromise<LedgerAccountPayout> {
+    // @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_account_payouts', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -29,13 +35,13 @@ export class LedgerAccountPayouts extends APIResource {
     id: string,
     body?: LedgerAccountPayoutUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountPayout>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccountPayout>>;
+  ): Core.APIPromise<LedgerAccountPayout>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountPayout>;
   update(
     id: string,
     body: LedgerAccountPayoutUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountPayout>> {
+  ): Core.APIPromise<LedgerAccountPayout> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -48,12 +54,12 @@ export class LedgerAccountPayouts extends APIResource {
   list(
     query?: LedgerAccountPayoutListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerAccountPayoutsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountPayoutsPage>;
+  ): Core.PagePromise<LedgerAccountPayoutsPage, LedgerAccountPayout>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountPayoutsPage, LedgerAccountPayout>;
   list(
     query: LedgerAccountPayoutListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerAccountPayoutsPage> {
+  ): Core.PagePromise<LedgerAccountPayoutsPage, LedgerAccountPayout> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -63,7 +69,7 @@ export class LedgerAccountPayouts extends APIResource {
   /**
    * Get details on a single ledger account payout.
    */
-  retireve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccountPayout>> {
+  retireve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccountPayout> {
     return this.get(`/api/ledger_account_payouts/${id}`, options);
   }
 }
@@ -151,46 +157,46 @@ export interface LedgerAccountPayout {
 
 export interface LedgerAccountPayoutCreateParams {
   /**
-   * Body param: The id of the funding ledger account that sends to or receives funds
-   * from the payout ledger account.
+   * The id of the funding ledger account that sends to or receives funds from the
+   * payout ledger account.
    */
   funding_ledger_account_id: string;
 
   /**
-   * Body param: The id of the payout ledger account whose ledger entries are queried
-   * against, and its balance is reduced as a result.
+   * The id of the payout ledger account whose ledger entries are queried against,
+   * and its balance is reduced as a result.
    */
   payout_ledger_account_id: string;
 
   /**
-   * Body param: The description of the ledger account payout.
+   * The description of the ledger account payout.
    */
   description?: string | null;
 
   /**
-   * Body param: The exclusive upper bound of the effective_at timestamp of the
-   * ledger entries to be included in the ledger account payout. The default value is
-   * the created_at timestamp of the ledger account payout.
+   * The exclusive upper bound of the effective_at timestamp of the ledger entries to
+   * be included in the ledger account payout. The default value is the created_at
+   * timestamp of the ledger account payout.
    */
   effective_at_upper_bound?: 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>;
 
   /**
-   * Body param: The status of the ledger account payout. It is set to `pending` by
-   * default. To post a ledger account payout at creation, use `posted`.
+   * It is set to `false` by default. It should be set to `true` when migrating
+   * existing payouts.
    */
-  status?: 'pending' | 'posted' | null;
+  skip_payout_ledger_transaction?: boolean | null;
 
   /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
+   * The status of the ledger account payout. It is set to `pending` by default. To
+   * post a ledger account payout at creation, use `posted`.
    */
-  'Idempotency-Key'?: string;
+  status?: 'pending' | 'posted' | null;
 }
 
 export interface LedgerAccountPayoutUpdateParams {
@@ -213,6 +219,19 @@ export interface LedgerAccountPayoutUpdateParams {
 }
 
 export interface LedgerAccountPayoutListParams 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
+   * parameters.
+   */
+  metadata?: Record<string, string>;
+
   payout_ledger_account_id?: string;
 }
 

package/src/resources/ledger-account-statements.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 LedgerAccountStatements extends APIResource {
   /**
@@ -11,12 +11,18 @@ export class LedgerAccountStatements extends APIResource {
   create(
     params: LedgerAccountStatementCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountStatementCreateResponse>> {
+  ): Core.APIPromise<LedgerAccountStatementCreateResponse> {
+    // @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_account_statements', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -26,7 +32,7 @@ export class LedgerAccountStatements extends APIResource {
   retrieve(
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountStatementRetrieveResponse>> {
+  ): Core.APIPromise<LedgerAccountStatementRetrieveResponse> {
     return this.get(`/api/ledger_account_statements/${id}`, options);
   }
 }
@@ -573,39 +579,33 @@ export namespace LedgerAccountStatementRetrieveResponse {
 
 export interface LedgerAccountStatementCreateParams {
   /**
-   * Body param: The inclusive lower bound of the effective_at timestamp of the
-   * ledger entries to be included in the ledger account statement.
+   * The inclusive lower bound of the effective_at timestamp of the ledger entries to
+   * be included in the ledger account statement.
    */
   effective_at_lower_bound: string;
 
   /**
-   * Body param: The exclusive upper bound of the effective_at timestamp of the
-   * ledger entries to be included in the ledger account statement.
+   * The exclusive upper bound of the effective_at timestamp of the ledger entries to
+   * be included in the ledger account statement.
    */
   effective_at_upper_bound: string;
 
   /**
-   * Body param: The id of the ledger account whose ledger entries are queried
-   * against, and its balances are computed as a result.
+   * The id of the ledger account whose ledger entries are queried against, and its
+   * balances are computed as a result.
    */
   ledger_account_id: string;
 
   /**
-   * Body param: The description of the ledger account statement.
+   * The description of the ledger account statement.
    */
   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 namespace LedgerAccountStatements {