modern-treasury 2.2.0 → 2.4.0

package/src/resources/payment-flows.ts

@@ -1,49 +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,
-  ): Promise<Core.APIResponse<PaymentFlow>> {
+  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,
-  ): Promise<Core.APIResponse<PaymentFlow>>;
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaymentFlow>>;
-  retrieve(
-    id: string,
-    query: PaymentFlowRetrieveParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<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);
   }
 
   /**
@@ -53,24 +39,33 @@ export class PaymentFlows extends APIResource {
     id: string,
     params: PaymentFlowUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<PaymentFlow>> {
+  ): 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 },
     });
   }
 
   /**
    * list payment_flows
    */
-  list(query?: PaymentFlowListParams, options?: Core.RequestOptions): Core.PagePromise<PaymentFlowsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PaymentFlowsPage>;
+  list(
+    query?: PaymentFlowListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PaymentFlowsPage, PaymentFlow>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PaymentFlowsPage, PaymentFlow>;
   list(
     query: PaymentFlowListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<PaymentFlowsPage> {
+  ): Core.PagePromise<PaymentFlowsPage, PaymentFlow> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -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';