modern-treasury 2.2.0 → 2.3.0

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

@@ -17,7 +17,7 @@ export class LedgerTransactions extends APIResource {
   create(
     params: LedgerTransactionCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>> {
+  ): Core.APIPromise<LedgerTransaction> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/ledger_transactions', {
       body,
@@ -29,7 +29,7 @@ export class LedgerTransactions extends APIResource {
   /**
    * Get details on a single ledger transaction.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerTransaction>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction> {
     return this.get(`/api/ledger_transactions/${id}`, options);
   }
 
@@ -40,13 +40,13 @@ export class LedgerTransactions extends APIResource {
     id: string,
     body?: LedgerTransactionUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerTransaction>>;
+  ): Core.APIPromise<LedgerTransaction>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
   update(
     id: string,
     body: LedgerTransactionUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>> {
+  ): Core.APIPromise<LedgerTransaction> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -59,12 +59,12 @@ export class LedgerTransactions extends APIResource {
   list(
     query?: LedgerTransactionListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerTransactionsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerTransactionsPage>;
+  ): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction>;
   list(
     query: LedgerTransactionListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerTransactionsPage> {
+  ): Core.PagePromise<LedgerTransactionsPage, LedgerTransaction> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -75,23 +75,20 @@ export class LedgerTransactions extends APIResource {
    * Create a ledger transaction reversal.
    */
   createReversal(
-    ledgerTransactionId: string,
+    id: string,
     body?: LedgerTransactionCreateReversalParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>>;
-  createReversal(
-    ledgerTransactionId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>>;
+  ): Core.APIPromise<LedgerTransaction>;
+  createReversal(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerTransaction>;
   createReversal(
-    ledgerTransactionId: string,
+    id: string,
     body: LedgerTransactionCreateReversalParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerTransaction>> {
+  ): Core.APIPromise<LedgerTransaction> {
     if (isRequestOptions(body)) {
-      return this.createReversal(ledgerTransactionId, {}, body);
+      return this.createReversal(id, {}, body);
     }
-    return this.post(`/api/ledger_transactions/${ledgerTransactionId}/reversal`, { body, ...options });
+    return this.post(`/api/ledger_transactions/${id}/reversal`, { body, ...options });
   }
 }
 
@@ -195,12 +192,6 @@ export interface LedgerTransaction {
 }
 
 export interface LedgerTransactionCreateParams {
-  /**
-   * Body param: The timestamp (ISO8601 format) at which the ledger transaction
-   * happened for reporting purposes.
-   */
-  effective_at: string;
-
   /**
    * Body param: An array of ledger entry objects.
    */
@@ -211,6 +202,12 @@ export interface LedgerTransactionCreateParams {
    */
   description?: string | null;
 
+  /**
+   * Body param: 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.
@@ -301,6 +298,12 @@ export namespace LedgerTransactionCreateParams {
      */
     lock_version?: number | null;
 
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+
     /**
      * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
      * account’s pending balance. If any of these conditions would be false after the
@@ -329,6 +332,12 @@ export interface LedgerTransactionUpdateParams {
    */
   description?: string | null;
 
+  /**
+   * The timestamp (ISO8601 format) at which the ledger transaction happened for
+   * reporting purposes.
+   */
+  effective_at?: string;
+
   /**
    * An array of ledger entry objects.
    */
@@ -382,6 +391,12 @@ export namespace LedgerTransactionUpdateParams {
      */
     lock_version?: number | null;
 
+    /**
+     * Additional data represented as key-value pairs. Both the key and value must be
+     * strings.
+     */
+    metadata?: Record<string, string>;
+
     /**
      * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
      * account’s pending balance. If any of these conditions would be false after the
@@ -405,7 +420,11 @@ export namespace LedgerTransactionUpdateParams {
 }
 
 export interface LedgerTransactionListParams 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>;
 
   /**
    * Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by
@@ -427,6 +446,8 @@ export interface LedgerTransactionListParams extends PageParams {
 
   ledger_account_id?: string;
 
+  ledger_account_payout_id?: string;
+
   ledger_id?: string;
 
   ledgerable_id?: string;

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

@@ -13,12 +13,14 @@ export class Versions extends APIResource {
   list(
     query?: VersionListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerTransactionVersionsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerTransactionVersionsPage>;
+  ): Core.PagePromise<LedgerTransactionVersionsPage, LedgerTransactionVersion>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LedgerTransactionVersionsPage, LedgerTransactionVersion>;
   list(
     query: VersionListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerTransactionVersionsPage> {
+  ): Core.PagePromise<LedgerTransactionVersionsPage, LedgerTransactionVersion> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/ledgerable-events.ts

@@ -12,7 +12,7 @@ export class LedgerableEvents extends APIResource {
   create(
     params: LedgerableEventCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerableEvent>> {
+  ): Core.APIPromise<LedgerableEvent> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/ledgerable_events', {
       body,
@@ -24,7 +24,7 @@ export class LedgerableEvents extends APIResource {
   /**
    * Get details on a single ledgerable event.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerableEvent>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerableEvent> {
     return this.get(`/api/ledgerable_events/${id}`, options);
   }
 }

package/src/resources/ledgers.ts

@@ -10,7 +10,7 @@ export class Ledgers extends APIResource {
   /**
    * Create a ledger.
    */
-  create(params: LedgerCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Ledger>> {
+  create(params: LedgerCreateParams, options?: Core.RequestOptions): Core.APIPromise<Ledger> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/ledgers', {
       body,
@@ -22,24 +22,20 @@ export class Ledgers extends APIResource {
   /**
    * Get details on a single ledger.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Ledger>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Ledger> {
     return this.get(`/api/ledgers/${id}`, options);
   }
 
   /**
    * Update the details of a ledger.
    */
-  update(
-    id: string,
-    body?: LedgerUpdateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Ledger>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Ledger>>;
+  update(id: string, body?: LedgerUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Ledger>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<Ledger>;
   update(
     id: string,
     body: LedgerUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Ledger>> {
+  ): Core.APIPromise<Ledger> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -49,12 +45,12 @@ export class Ledgers extends APIResource {
   /**
    * Get a list of ledgers.
    */
-  list(query?: LedgerListParams, options?: Core.RequestOptions): Core.PagePromise<LedgersPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgersPage>;
+  list(query?: LedgerListParams, options?: Core.RequestOptions): Core.PagePromise<LedgersPage, Ledger>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgersPage, Ledger>;
   list(
     query: LedgerListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgersPage> {
+  ): Core.PagePromise<LedgersPage, Ledger> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -64,7 +60,7 @@ export class Ledgers extends APIResource {
   /**
    * Delete a ledger.
    */
-  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Ledger>> {
+  del(id: string, options?: Core.RequestOptions): Core.APIPromise<Ledger> {
     return this.delete(`/api/ledgers/${id}`, options);
   }
 }
@@ -151,6 +147,12 @@ export interface LedgerUpdateParams {
 }
 
 export interface LedgerListParams 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

package/src/resources/line-items.ts

@@ -15,7 +15,7 @@ export class LineItems extends APIResource {
     itemizableId: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LineItem>> {
+  ): Core.APIPromise<LineItem> {
     return this.get(`/api/${itemizableType}/${itemizableId}/line_items/${id}`, options);
   }
 
@@ -28,20 +28,20 @@ export class LineItems extends APIResource {
     id: string,
     body?: LineItemUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LineItem>>;
+  ): Core.APIPromise<LineItem>;
   update(
     itemizableType: 'expected_payments' | 'payment_orders',
     itemizableId: string,
     id: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LineItem>>;
+  ): Core.APIPromise<LineItem>;
   update(
     itemizableType: 'expected_payments' | 'payment_orders',
     itemizableId: string,
     id: string,
     body: LineItemUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LineItem>> {
+  ): Core.APIPromise<LineItem> {
     if (isRequestOptions(body)) {
       return this.update(itemizableType, itemizableId, id, {}, body);
     }
@@ -56,18 +56,18 @@ export class LineItems extends APIResource {
     itemizableId: string,
     query?: LineItemListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LineItemsPage>;
+  ): Core.PagePromise<LineItemsPage, LineItem>;
   list(
     itemizableType: 'expected_payments' | 'payment_orders',
     itemizableId: string,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LineItemsPage>;
+  ): Core.PagePromise<LineItemsPage, LineItem>;
   list(
     itemizableType: 'expected_payments' | 'payment_orders',
     itemizableId: string,
     query: LineItemListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LineItemsPage> {
+  ): Core.PagePromise<LineItemsPage, LineItem> {
     if (isRequestOptions(query)) {
       return this.list(itemizableType, itemizableId, {}, query);
     }

package/src/resources/paper-items.ts

@@ -11,19 +11,22 @@ export class PaperItems extends APIResource {
   /**
    * Get details on a single paper item.
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaperItem>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaperItem> {
     return this.get(`/api/paper_items/${id}`, options);
   }
 
   /**
    * Get a list of all paper items.
    */
-  list(query?: PaperItemListParams, options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage>;
+  list(
+    query?: PaperItemListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PaperItemsPage, PaperItem>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PaperItemsPage, PaperItem>;
   list(
     query: PaperItemListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<PaperItemsPage> {
+  ): Core.PagePromise<PaperItemsPage, PaperItem> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/payment-flows.ts

@@ -10,10 +10,7 @@ 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> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/payment_flows', {
       body,
@@ -29,13 +26,13 @@ export class PaymentFlows extends APIResource {
     id: string,
     query?: PaymentFlowRetrieveParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<PaymentFlow>>;
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaymentFlow>>;
+  ): Core.APIPromise<PaymentFlow>;
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaymentFlow>;
   retrieve(
     id: string,
     query: PaymentFlowRetrieveParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<PaymentFlow>> {
+  ): Core.APIPromise<PaymentFlow> {
     if (isRequestOptions(query)) {
       return this.retrieve(id, {}, query);
     }
@@ -53,7 +50,7 @@ export class PaymentFlows extends APIResource {
     id: string,
     params: PaymentFlowUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<PaymentFlow>> {
+  ): Core.APIPromise<PaymentFlow> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.patch(`/api/payment_flows/${id}`, {
       body,
@@ -65,12 +62,15 @@ export class PaymentFlows extends APIResource {
   /**
    * 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);
     }

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

@@ -17,21 +17,14 @@ export class PaymentOrders extends APIResource {
   /**
    * Create a new Payment Order
    */
-  async create(
-    params: PaymentOrderCreateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<PaymentOrder>> {
-    const { 'Content-Type': contentType, 'Idempotency-Key': idempotencyKey, ...body } = params;
+  create(params: PaymentOrderCreateParams, options?: Core.RequestOptions): Core.APIPromise<PaymentOrder> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post(
       '/api/payment_orders',
-      await maybeMultipartFormRequestOptions({
+      maybeMultipartFormRequestOptions({
         body,
         ...options,
-        headers: {
-          'Content-Type': contentType?.toString() || '',
-          'Idempotency-Key': idempotencyKey || '',
-          ...options?.headers,
-        },
+        headers: { 'Idempotency-Key': idempotencyKey || '', ...options?.headers },
       }),
     );
   }
@@ -39,7 +32,7 @@ export class PaymentOrders extends APIResource {
   /**
    * Get details on a single payment order
    */
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaymentOrder>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<PaymentOrder> {
     return this.get(`/api/payment_orders/${id}`, options);
   }
 
@@ -50,13 +43,13 @@ export class PaymentOrders extends APIResource {
     id: string,
     body?: PaymentOrderUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<PaymentOrder>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<PaymentOrder>>;
+  ): Core.APIPromise<PaymentOrder>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<PaymentOrder>;
   update(
     id: string,
     body: PaymentOrderUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<PaymentOrder>> {
+  ): Core.APIPromise<PaymentOrder> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -66,12 +59,15 @@ export class PaymentOrders extends APIResource {
   /**
    * Get a list of all payment orders
    */
-  list(query?: PaymentOrderListParams, options?: Core.RequestOptions): Core.PagePromise<PaymentOrdersPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PaymentOrdersPage>;
+  list(
+    query?: PaymentOrderListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PaymentOrdersPage, PaymentOrder>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PaymentOrdersPage, PaymentOrder>;
   list(
     query: PaymentOrderListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<PaymentOrdersPage> {
+  ): Core.PagePromise<PaymentOrdersPage, PaymentOrder> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -84,7 +80,7 @@ export class PaymentOrders extends APIResource {
   createAsync(
     params: PaymentOrderCreateAsyncParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Shared.AsyncResponse>> {
+  ): Core.APIPromise<Shared.AsyncResponse> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/payment_orders/create_async', {
       body,
@@ -711,11 +707,6 @@ export interface PaymentOrderCreateParams {
    */
   ultimate_receiving_party_name?: string | null;
 
-  /**
-   * Header param:
-   */
-  'Content-Type'?: 'application/json' | 'multipart/form-data';
-
   /**
    * Header param: This key should be something unique, preferably something like an
    * UUID.
@@ -773,12 +764,6 @@ export namespace PaymentOrderCreateParams {
    * the payment order.
    */
   export interface LedgerTransaction {
-    /**
-     * The timestamp (ISO8601 format) at which the ledger transaction happened for
-     * reporting purposes.
-     */
-    effective_at: string;
-
     /**
      * An array of ledger entry objects.
      */
@@ -789,6 +774,12 @@ export namespace PaymentOrderCreateParams {
      */
     description?: string | null;
 
+    /**
+     * The timestamp (ISO8601 format) at which the ledger transaction happened for
+     * reporting purposes.
+     */
+    effective_at?: string;
+
     /**
      * The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
      * purposes.
@@ -872,6 +863,12 @@ export namespace PaymentOrderCreateParams {
        */
       lock_version?: number | null;
 
+      /**
+       * Additional data represented as key-value pairs. Both the key and value must be
+       * strings.
+       */
+      metadata?: Record<string, string>;
+
       /**
        * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
        * account’s pending balance. If any of these conditions would be false after the
@@ -1903,12 +1900,6 @@ export namespace PaymentOrderCreateAsyncParams {
    * the payment order.
    */
   export interface LedgerTransaction {
-    /**
-     * The timestamp (ISO8601 format) at which the ledger transaction happened for
-     * reporting purposes.
-     */
-    effective_at: string;
-
     /**
      * An array of ledger entry objects.
      */
@@ -1919,6 +1910,12 @@ export namespace PaymentOrderCreateAsyncParams {
      */
     description?: string | null;
 
+    /**
+     * The timestamp (ISO8601 format) at which the ledger transaction happened for
+     * reporting purposes.
+     */
+    effective_at?: string;
+
     /**
      * The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
      * purposes.
@@ -2002,6 +1999,12 @@ export namespace PaymentOrderCreateAsyncParams {
        */
       lock_version?: number | null;
 
+      /**
+       * Additional data represented as key-value pairs. Both the key and value must be
+       * strings.
+       */
+      metadata?: Record<string, string>;
+
       /**
        * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
        * account’s pending balance. If any of these conditions would be false after the

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

@@ -14,7 +14,7 @@ export class Reversals extends APIResource {
     paymentOrderId: string,
     params: ReversalCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Reversal>> {
+  ): Core.APIPromise<Reversal> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post(`/api/payment_orders/${paymentOrderId}/reversals`, {
       body,
@@ -30,7 +30,7 @@ export class Reversals extends APIResource {
     paymentOrderId: string,
     reversalId: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Reversal>> {
+  ): Core.APIPromise<Reversal> {
     return this.get(`/api/payment_orders/${paymentOrderId}/reversals/${reversalId}`, options);
   }
 
@@ -41,13 +41,13 @@ export class Reversals extends APIResource {
     paymentOrderId: string,
     query?: ReversalListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ReversalsPage>;
-  list(paymentOrderId: string, options?: Core.RequestOptions): Core.PagePromise<ReversalsPage>;
+  ): Core.PagePromise<ReversalsPage, Reversal>;
+  list(paymentOrderId: string, options?: Core.RequestOptions): Core.PagePromise<ReversalsPage, Reversal>;
   list(
     paymentOrderId: string,
     query: ReversalListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ReversalsPage> {
+  ): Core.PagePromise<ReversalsPage, Reversal> {
     if (isRequestOptions(query)) {
       return this.list(paymentOrderId, {}, query);
     }
@@ -145,12 +145,6 @@ export namespace ReversalCreateParams {
    * The resulting ledger transaction will mirror the status of the reversal.
    */
   export interface LedgerTransaction {
-    /**
-     * The timestamp (ISO8601 format) at which the ledger transaction happened for
-     * reporting purposes.
-     */
-    effective_at: string;
-
     /**
      * An array of ledger entry objects.
      */
@@ -161,6 +155,12 @@ export namespace ReversalCreateParams {
      */
     description?: string | null;
 
+    /**
+     * The timestamp (ISO8601 format) at which the ledger transaction happened for
+     * reporting purposes.
+     */
+    effective_at?: string;
+
     /**
      * The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
      * purposes.
@@ -244,6 +244,12 @@ export namespace ReversalCreateParams {
        */
       lock_version?: number | null;
 
+      /**
+       * Additional data represented as key-value pairs. Both the key and value must be
+       * strings.
+       */
+      metadata?: Record<string, string>;
+
       /**
        * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
        * account’s pending balance. If any of these conditions would be false after the