modern-treasury 2.3.0 → 2.4.0

package/src/resources/invoices/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,11 +15,17 @@ export class LineItems extends APIResource {
     params: LineItemCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<InvoiceLineItem> {
+    // @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/invoices/${invoiceId}/invoice_line_items`, {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -143,39 +149,33 @@ export interface InvoiceLineItem {
 
 export interface LineItemCreateParams {
   /**
-   * Body param: The name of the line item, typically a product or SKU name.
+   * The name of the line item, typically a product or SKU name.
    */
   name: string;
 
   /**
-   * Body param: The cost per unit of the product or service that this line item is
-   * for, specified in the invoice currency's smallest unit.
+   * The cost per unit of the product or service that this line item is for,
+   * specified in the invoice currency's smallest unit.
    */
   unit_amount: number;
 
   /**
-   * Body param: An optional free-form description of the line item.
+   * An optional free-form description of the line item.
    */
   description?: string;
 
   /**
-   * Body param: Either `debit` or `credit`. `debit` indicates that a client owes the
-   * business money and increases the invoice's `total_amount` due. `credit` has the
-   * opposite intention and effect.
+   * Either `debit` or `credit`. `debit` indicates that a client owes the business
+   * money and increases the invoice's `total_amount` due. `credit` has the opposite
+   * intention and effect.
    */
   direction?: string;
 
   /**
-   * Body param: The number of units of a product or service that this line item is
-   * for. Must be a whole number. Defaults to 1 if not provided.
+   * The number of units of a product or service that this line item is for. Must be
+   * a whole number. Defaults to 1 if not provided.
    */
   quantity?: number;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface LineItemUpdateParams {

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 {
   /**
@@ -14,11 +14,17 @@ export class LedgerAccountCategories extends APIResource {
     params: LedgerAccountCategoryCreateParams,
     options?: Core.RequestOptions,
   ): 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 },
     });
   }
 
@@ -299,46 +305,40 @@ 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 {

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 {
   /**
@@ -14,11 +14,17 @@ export class LedgerAccountPayouts extends APIResource {
     params: LedgerAccountPayoutCreateParams,
     options?: Core.RequestOptions,
   ): 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 },
     });
   }
 
@@ -151,52 +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: It is set to `false` by default. It should be set to `true` when
-   * migrating existing payouts.
+   * It is set to `false` by default. It should be set to `true` when migrating
+   * existing payouts.
    */
   skip_payout_ledger_transaction?: boolean | null;
 
   /**
-   * 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`.
+   * The status of the ledger account payout. It is set to `pending` by default. To
+   * post a ledger account payout at creation, use `posted`.
    */
   status?: 'pending' | 'posted' | null;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface LedgerAccountPayoutUpdateParams {

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 {
   /**
@@ -12,11 +12,17 @@ export class LedgerAccountStatements extends APIResource {
     params: LedgerAccountStatementCreateParams,
     options?: Core.RequestOptions,
   ): 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 },
     });
   }
 
@@ -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 {

package/src/resources/ledger-accounts.ts

@@ -1,21 +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): 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 },
     });
   }
 
@@ -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 {

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 {
   /**

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 {
   /**
@@ -14,11 +14,17 @@ export class LedgerEventHandlers extends APIResource {
     params: LedgerEventHandlerCreateParams,
     options?: Core.RequestOptions,
   ): 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 },
     });
   }
 
@@ -473,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';