modern-treasury 2.2.0 → 2.3.0

package/src/resources/ledger-account-categories.ts

@@ -13,7 +13,7 @@ export class LedgerAccountCategories extends APIResource {
   create(
     params: LedgerAccountCategoryCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountCategory>> {
+  ): Core.APIPromise<LedgerAccountCategory> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/ledger_account_categories', {
       body,
@@ -29,13 +29,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 +47,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 +68,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 +86,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 +107,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 +115,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 +135,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 },
@@ -362,20 +343,18 @@ export interface LedgerAccountCategoryCreateParams {
 
 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 {
+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.
-   */
-  balances?: LedgerAccountCategoryDeleteParams.Balances;
-}
-
-export namespace 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.
+   * 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

@@ -13,7 +13,7 @@ export class LedgerAccountPayouts extends APIResource {
   create(
     params: LedgerAccountPayoutCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountPayout>> {
+  ): Core.APIPromise<LedgerAccountPayout> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/ledger_account_payouts', {
       body,
@@ -29,13 +29,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 +48,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 +63,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);
   }
 }
@@ -180,6 +180,12 @@ export interface LedgerAccountPayoutCreateParams {
    */
   metadata?: Record<string, string>;
 
+  /**
+   * Body param: 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`.
@@ -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

@@ -11,7 +11,7 @@ export class LedgerAccountStatements extends APIResource {
   create(
     params: LedgerAccountStatementCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccountStatementCreateResponse>> {
+  ): Core.APIPromise<LedgerAccountStatementCreateResponse> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/ledger_account_statements', {
       body,
@@ -26,7 +26,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);
   }
 }

package/src/resources/ledger-accounts.ts

@@ -10,10 +10,7 @@ export class LedgerAccounts extends APIResource {
   /**
    * Create a ledger account.
    */
-  create(
-    params: LedgerAccountCreateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>> {
+  create(params: LedgerAccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<LedgerAccount> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/ledger_accounts', {
       body,
@@ -29,13 +26,13 @@ export class LedgerAccounts extends APIResource {
     id: string,
     query?: LedgerAccountRetrieveParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>>;
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccount>>;
+  ): Core.APIPromise<LedgerAccount>;
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccount>;
   retrieve(
     id: string,
     query: LedgerAccountRetrieveParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>> {
+  ): Core.APIPromise<LedgerAccount> {
     if (isRequestOptions(query)) {
       return this.retrieve(id, {}, query);
     }
@@ -49,13 +46,13 @@ export class LedgerAccounts extends APIResource {
     id: string,
     body?: LedgerAccountUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>>;
-  update(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccount>>;
+  ): Core.APIPromise<LedgerAccount>;
+  update(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccount>;
   update(
     id: string,
     body: LedgerAccountUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerAccount>> {
+  ): Core.APIPromise<LedgerAccount> {
     if (isRequestOptions(body)) {
       return this.update(id, {}, body);
     }
@@ -65,12 +62,15 @@ export class LedgerAccounts extends APIResource {
   /**
    * Get a list of ledger accounts.
    */
-  list(query?: LedgerAccountListParams, options?: Core.RequestOptions): Core.PagePromise<LedgerAccountsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountsPage>;
+  list(
+    query?: LedgerAccountListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LedgerAccountsPage, LedgerAccount>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgerAccountsPage, LedgerAccount>;
   list(
     query: LedgerAccountListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerAccountsPage> {
+  ): Core.PagePromise<LedgerAccountsPage, LedgerAccount> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -80,7 +80,7 @@ export class LedgerAccounts extends APIResource {
   /**
    * Delete a ledger account.
    */
-  del(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerAccount>> {
+  del(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerAccount> {
     return this.delete(`/api/ledger_accounts/${id}`, options);
   }
 }
@@ -379,7 +379,11 @@ export interface LedgerAccountUpdateParams {
 }
 
 export interface LedgerAccountListParams extends PageParams {
-  id?: 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 `balances[effective_at_lower_bound]` and
@@ -397,6 +401,8 @@ export interface LedgerAccountListParams extends PageParams {
    */
   created_at?: Record<string, string>;
 
+  currency?: string;
+
   ledger_account_category_id?: string;
 
   ledger_id?: string;

package/src/resources/ledger-entries.ts

@@ -14,13 +14,13 @@ export class LedgerEntries extends APIResource {
     id: string,
     query?: LedgerEntryRetrieveParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEntry>>;
-  retrieve(id: string, options?: Core.RequestOptions): Promise<Core.APIResponse<LedgerEntry>>;
+  ): Core.APIPromise<LedgerEntry>;
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerEntry>;
   retrieve(
     id: string,
     query: LedgerEntryRetrieveParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEntry>> {
+  ): Core.APIPromise<LedgerEntry> {
     if (isRequestOptions(query)) {
       return this.retrieve(id, {}, query);
     }
@@ -30,12 +30,15 @@ export class LedgerEntries extends APIResource {
   /**
    * Get a list of all ledger entries.
    */
-  list(query?: LedgerEntryListParams, options?: Core.RequestOptions): Core.PagePromise<LedgerEntriesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerEntriesPage>;
+  list(
+    query?: LedgerEntryListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LedgerEntriesPage, LedgerEntry>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LedgerEntriesPage, LedgerEntry>;
   list(
     query: LedgerEntryListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerEntriesPage> {
+  ): Core.PagePromise<LedgerEntriesPage, LedgerEntry> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -238,7 +241,11 @@ export interface LedgerEntryRetrieveParams {
 }
 
 export interface LedgerEntryListParams 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>;
 
   /**
    * Shows all ledger entries that were present on a ledger account at a particular
@@ -254,7 +261,7 @@ export interface LedgerEntryListParams extends PageParams {
   direction?: 'credit' | 'debit';
 
   /**
-   * Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by the
+   * Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
    * transaction's effective time. Format ISO8601
    */
   effective_at?: Record<string, string>;
@@ -281,6 +288,8 @@ export interface LedgerEntryListParams extends PageParams {
    */
   ledger_account_lock_version?: Record<string, number>;
 
+  ledger_account_payout_id?: string;
+
   /**
    * Get all ledger entries that are included in the ledger account statement.
    */
@@ -288,6 +297,13 @@ export interface LedgerEntryListParams extends PageParams {
 
   ledger_transaction_id?: 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>;
+
   /**
    * Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
    * to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering

package/src/resources/ledger-event-handlers.ts

@@ -13,7 +13,7 @@ export class LedgerEventHandlers extends APIResource {
   create(
     params: LedgerEventHandlerCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEventHandlerCreateResponse>> {
+  ): Core.APIPromise<LedgerEventHandlerCreateResponse> {
     const { 'Idempotency-Key': idempotencyKey, ...body } = params;
     return this.post('/api/ledger_event_handlers', {
       body,
@@ -25,10 +25,7 @@ export class LedgerEventHandlers extends APIResource {
   /**
    * Get details on a single ledger event handler.
    */
-  retrieve(
-    id: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEventHandlerRetrieveResponse>> {
+  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerEventHandlerRetrieveResponse> {
     return this.get(`/api/ledger_event_handlers/${id}`, options);
   }
 
@@ -38,12 +35,14 @@ export class LedgerEventHandlers extends APIResource {
   list(
     query?: LedgerEventHandlerListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerEventHandlerListResponsesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LedgerEventHandlerListResponsesPage>;
+  ): Core.PagePromise<LedgerEventHandlerListResponsesPage, LedgerEventHandlerListResponse>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LedgerEventHandlerListResponsesPage, LedgerEventHandlerListResponse>;
   list(
     query: LedgerEventHandlerListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LedgerEventHandlerListResponsesPage> {
+  ): Core.PagePromise<LedgerEventHandlerListResponsesPage, LedgerEventHandlerListResponse> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -56,10 +55,7 @@ export class LedgerEventHandlers extends APIResource {
   /**
    * Archive a ledger event handler.
    */
-  del(
-    id: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<LedgerEventHandlerDeleteResponse>> {
+  del(id: string, options?: Core.RequestOptions): Core.APIPromise<LedgerEventHandlerDeleteResponse> {
     return this.delete(`/api/ledger_event_handlers/${id}`, options);
   }
 }