modern-treasury 2.3.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);
@@ -18,11 +18,17 @@ export class LedgerTransactions extends APIResource {
     params: LedgerTransactionCreateParams,
     options?: Core.RequestOptions,
   ): 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 },
     });
   }
 
@@ -193,44 +199,43 @@ export interface LedgerTransaction {
 
 export interface LedgerTransactionCreateParams {
   /**
-   * 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 timestamp (ISO8601 format) at which the ledger transaction
-   * happened for reporting purposes.
+   * The timestamp (ISO8601 format) at which the ledger transaction happened for
+   * reporting purposes.
    */
   effective_at?: string;
 
   /**
-   * Body param: The date (YYYY-MM-DD) on which the ledger transaction happened for
-   * reporting purposes.
+   * 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'
@@ -245,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 {

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

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 {
   /**
@@ -13,11 +13,17 @@ export class LedgerableEvents extends APIResource {
     params: LedgerableEventCreateParams,
     options?: Core.RequestOptions,
   ): 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 },
     });
   }
 
@@ -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,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 Ledgers extends APIResource {
   /**
    * Create a 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 },
     });
   }
 
@@ -106,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 {

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

package/src/resources/paper-items.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 PaperItems extends APIResource {
   /**

package/src/resources/payment-flows.ts

@@ -1,46 +1,35 @@
 // 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 PaymentFlows extends APIResource {
   /**
    * create payment_flow
    */
   create(params: PaymentFlowCreateParams, options?: Core.RequestOptions): Core.APIPromise<PaymentFlow> {
+    // @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_flows', {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
   /**
    * get payment_flow
    */
-  retrieve(
-    id: string,
-    query?: PaymentFlowRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PaymentFlow>;
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaymentFlow>;
-  retrieve(
-    id: string,
-    query: PaymentFlowRetrieveParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PaymentFlow> {
-    if (isRequestOptions(query)) {
-      return this.retrieve(id, {}, query);
-    }
-    const { 'Idempotency-Key': idempotencyKey } = query;
-    return this.get(`/api/payment_flows/${id}`, {
-      ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
-    });
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaymentFlow> {
+    return this.get(`/api/payment_flows/${id}`, options);
   }
 
   /**
@@ -51,11 +40,17 @@ export class PaymentFlows extends APIResource {
     params: PaymentFlowUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<PaymentFlow> {
+    // @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.patch(`/api/payment_flows/${id}`, {
       body,
       ...options,
-      headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
+      headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
     });
   }
 
@@ -150,61 +145,40 @@ export interface PaymentFlow {
 
 export interface PaymentFlowCreateParams {
   /**
-   * Body param: Required. Value in specified currency's smallest unit. e.g. $10
-   * would be represented as 1000. Can be any integer up to 36 digits.
+   * Required. Value in specified currency's smallest unit. e.g. $10 would be
+   * represented as 1000. Can be any integer up to 36 digits.
    */
   amount: number;
 
   /**
-   * Body param: Required. The ID of a counterparty associated with the payment. As
-   * part of the payment workflow an external account will be associated with this
-   * model.
+   * Required. The ID of a counterparty associated with the payment. As part of the
+   * payment workflow an external account will be associated with this model.
    */
   counterparty_id: string;
 
   /**
-   * Body param: Required. The currency of the payment.
+   * Required. The currency of the payment.
    */
   currency: string;
 
   /**
-   * Body param: Required. Describes the direction money is flowing in the
-   * transaction. Can only be `debit`. A `debit` pulls money from someone else's
-   * account to your own.
+   * Required. Describes the direction money is flowing in the transaction. Can only
+   * be `debit`. A `debit` pulls money from someone else's account to your own.
    */
   direction: 'credit' | 'debit';
 
   /**
-   * Body param: Required. The ID of one of your organization's internal accounts.
+   * Required. The ID of one of your organization's internal accounts.
    */
   originating_account_id: string;
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
-}
-
-export interface PaymentFlowRetrieveParams {
-  /**
-   * This key should be something unique, preferably something like an UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface PaymentFlowUpdateParams {
   /**
-   * Body param: Required. The updated status of the payment flow. Can only be used
-   * to mark a flow as `cancelled`.
+   * Required. The updated status of the payment flow. Can only be used to mark a
+   * flow as `cancelled`.
    */
   status: 'cancelled';
-
-  /**
-   * Header param: This key should be something unique, preferably something like an
-   * UUID.
-   */
-  'Idempotency-Key'?: string;
 }
 
 export interface PaymentFlowListParams extends PageParams {
@@ -225,7 +199,6 @@ export namespace PaymentFlows {
   export import PaymentFlow = API.PaymentFlow;
   export type PaymentFlowsPage = _PaymentFlowsPage;
   export import PaymentFlowCreateParams = API.PaymentFlowCreateParams;
-  export import PaymentFlowRetrieveParams = API.PaymentFlowRetrieveParams;
   export import PaymentFlowUpdateParams = API.PaymentFlowUpdateParams;
   export import PaymentFlowListParams = API.PaymentFlowListParams;
 }

package/src/resources/payment-orders/index.ts

@@ -10,5 +10,5 @@ export {
   PaymentOrderCreateAsyncParams,
   PaymentOrdersPage,
   PaymentOrders,
-} from './payment-orders';
-export { Reversal, ReversalCreateParams, ReversalListParams, ReversalsPage, Reversals } from './reversals';
+} from './payment-orders.js';
+export { Reversal, ReversalCreateParams, ReversalListParams, ReversalsPage, Reversals } from './reversals.js';