@metronome/sdk 0.1.0-beta.8 → 0.1.0

package/src/resources/{credit-grants.ts → v1/credit-grants.ts}

@@ -1,25 +1,66 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as Core from '../core';
-import * as CreditGrantsAPI from './credit-grants';
-import * as Shared from './shared';
-import { CursorPage, type CursorPageParams } from '../pagination';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import * as CreditGrantsAPI from "./credit-grants.js";
+import * as Shared from "../shared.js";
+import { CursorPage, type CursorPageParams } from "../../pagination.js";
 
 export class CreditGrants extends APIResource {
   /**
    * Create a new credit grant
+   *
+   * @example
+   * ```ts
+   * const creditGrant = await client.v1.creditGrants.create({
+   *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   *   expires_at: '2022-04-01T00:00:00Z',
+   *   grant_amount: {
+   *     amount: 1000,
+   *     credit_type_id: '5ae401dc-a648-4b49-9ac3-391bb5bc4d7b',
+   *   },
+   *   name: 'Acme Corp Promotional Credit Grant',
+   *   paid_amount: {
+   *     amount: 5000,
+   *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *   },
+   *   priority: 0.5,
+   *   credit_grant_type: 'trial',
+   *   effective_at: '2022-02-01T00:00:00Z',
+   *   reason: 'Incentivize new customer',
+   * });
+   * ```
    */
   create(
     body: CreditGrantCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CreditGrantCreateResponse> {
-    return this._client.post('/credits/createGrant', { body, ...options });
+    return this._client.post('/v1/credits/createGrant', { body, ...options });
   }
 
   /**
    * List credit grants. This list does not included voided grants.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const creditGrantListResponse of client.v1.creditGrants.list(
+   *   {
+   *     credit_type_ids: [
+   *       '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *     ],
+   *     customer_ids: [
+   *       'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *       '0e5b8609-d901-4992-b394-c3c2e3f37b1c',
+   *     ],
+   *     effective_before: '2022-02-01T00:00:00Z',
+   *     not_expiring_before: '2022-02-01T00:00:00Z',
+   *   },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params?: CreditGrantListParams,
@@ -36,7 +77,7 @@ export class CreditGrants extends APIResource {
       return this.list({}, params);
     }
     const { limit, next_page, ...body } = params;
-    return this._client.getAPIList('/credits/listGrants', CreditGrantListResponsesCursorPage, {
+    return this._client.getAPIList('/v1/credits/listGrants', CreditGrantListResponsesCursorPage, {
       query: { limit, next_page },
       body,
       method: 'post',
@@ -46,15 +87,34 @@ export class CreditGrants extends APIResource {
 
   /**
    * Edit an existing credit grant
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.creditGrants.edit({
+   *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   *   expires_at: '2022-04-01T00:00:00Z',
+   *   name: 'Acme Corp Promotional Credit Grant',
+   * });
+   * ```
    */
   edit(body: CreditGrantEditParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantEditResponse> {
-    return this._client.post('/credits/editGrant', { body, ...options });
+    return this._client.post('/v1/credits/editGrant', { body, ...options });
   }
 
   /**
    * Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
    * Ledger entries are returned in chronological order. Ledger entries associated
    * with voided credit grants are not included.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.creditGrants.listEntries({
+   *   credit_type_ids: ['2714e483-4ff1-48e4-9e25-ac732e8f24f2'],
+   *   customer_ids: ['6a37bb88-8538-48c5-b37b-a41c836328bd'],
+   *   ending_before: '2021-02-01T00:00:00Z',
+   *   starting_on: '2021-01-01T00:00:00Z',
+   * });
+   * ```
    */
   listEntries(
     params?: CreditGrantListEntriesParams,
@@ -68,15 +128,22 @@ export class CreditGrants extends APIResource {
     if (isRequestOptions(params)) {
       return this.listEntries({}, params);
     }
-    const { next_page, ...body } = params;
-    return this._client.post('/credits/listEntries', { query: { next_page }, body, ...options });
+    const { next_page, sort, ...body } = params;
+    return this._client.post('/v1/credits/listEntries', { query: { next_page, sort }, body, ...options });
   }
 
   /**
    * Void a credit grant
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.creditGrants.void({
+   *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   * });
+   * ```
    */
   void(body: CreditGrantVoidParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantVoidResponse> {
-    return this._client.post('/credits/voidGrant', { body, ...options });
+    return this._client.post('/v1/credits/voidGrant', { body, ...options });
   }
 }
 
@@ -154,7 +221,7 @@ export interface CreditGrantListResponse {
    */
   balance: CreditGrantListResponse.Balance;
 
-  custom_fields: Record<string, string>;
+  custom_fields: { [key: string]: string };
 
   /**
    * the Metronome ID of the customer
@@ -382,7 +449,7 @@ export interface CreditGrantCreateParams {
   /**
    * Custom fields to attach to the credit grant.
    */
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   /**
    * The credit grant will only apply to usage or charges dated on or after this
@@ -528,6 +595,11 @@ export interface CreditGrantListEntriesParams {
    */
   next_page?: string;
 
+  /**
+   * Query param: Ledgers sort order by date, asc or desc. Defaults to asc.
+   */
+  sort?: 'asc' | 'desc';
+
   /**
    * Body param: A list of Metronome credit type IDs to fetch ledger entries for. If
    * absent, ledger entries for all credit types will be returned.

package/src/resources/{custom-fields.ts → v1/custom-fields.ts}

@@ -1,16 +1,25 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as Core from '../core';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
 
 export class CustomFields extends APIResource {
   /**
    * Add a key to the allow list for a given entity. There is a 100 character limit
    * on custom field keys.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customFields.addKey({
+   *   enforce_uniqueness: true,
+   *   entity: 'customer',
+   *   key: 'x_account_id',
+   * });
+   * ```
    */
   addKey(body: CustomFieldAddKeyParams, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post('/customFields/addKey', {
+    return this._client.post('/v1/customFields/addKey', {
       body,
       ...options,
       headers: { Accept: '*/*', ...options?.headers },
@@ -19,9 +28,18 @@ export class CustomFields extends APIResource {
 
   /**
    * Deletes one or more custom fields on an instance of a Metronome entity.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customFields.deleteValues({
+   *   entity: 'customer',
+   *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+   *   keys: ['x_account_id'],
+   * });
+   * ```
    */
   deleteValues(body: CustomFieldDeleteValuesParams, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post('/customFields/deleteValues', {
+    return this._client.post('/v1/customFields/deleteValues', {
       body,
       ...options,
       headers: { Accept: '*/*', ...options?.headers },
@@ -30,6 +48,13 @@ export class CustomFields extends APIResource {
 
   /**
    * List all active custom field keys, optionally filtered by entity type.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.customFields.listKeys({
+   *   entities: ['customer'],
+   * });
+   * ```
    */
   listKeys(
     params?: CustomFieldListKeysParams,
@@ -44,14 +69,22 @@ export class CustomFields extends APIResource {
       return this.listKeys({}, params);
     }
     const { next_page, ...body } = params;
-    return this._client.post('/customFields/listKeys', { query: { next_page }, body, ...options });
+    return this._client.post('/v1/customFields/listKeys', { query: { next_page }, body, ...options });
   }
 
   /**
    * Remove a key from the allow list for a given entity.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customFields.removeKey({
+   *   entity: 'customer',
+   *   key: 'x_account_id',
+   * });
+   * ```
    */
   removeKey(body: CustomFieldRemoveKeyParams, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post('/customFields/removeKey', {
+    return this._client.post('/v1/customFields/removeKey', {
       body,
       ...options,
       headers: { Accept: '*/*', ...options?.headers },
@@ -66,9 +99,18 @@ export class CustomFields extends APIResource {
    * transactional and will update all key/value pairs or no key/value pairs. Partial
    * updates are not supported. There is a 200 character limit on custom field
    * values.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customFields.setValues({
+   *   custom_fields: { x_account_id: 'KyVnHhSBWl7eY2bl' },
+   *   entity: 'customer',
+   *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+   * });
+   * ```
    */
   setValues(body: CustomFieldSetValuesParams, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post('/customFields/setValues', {
+    return this._client.post('/v1/customFields/setValues', {
       body,
       ...options,
       headers: { Accept: '*/*', ...options?.headers },
@@ -103,7 +145,8 @@ export namespace CustomFieldListKeysResponse {
       | 'professional_service'
       | 'product'
       | 'rate_card'
-      | 'scheduled_charge';
+      | 'scheduled_charge'
+      | 'subscription';
 
     key: string;
   }
@@ -129,7 +172,8 @@ export interface CustomFieldAddKeyParams {
     | 'professional_service'
     | 'product'
     | 'rate_card'
-    | 'scheduled_charge';
+    | 'scheduled_charge'
+    | 'subscription';
 
   key: string;
 }
@@ -152,7 +196,8 @@ export interface CustomFieldDeleteValuesParams {
     | 'professional_service'
     | 'product'
     | 'rate_card'
-    | 'scheduled_charge';
+    | 'scheduled_charge'
+    | 'subscription';
 
   entity_id: string;
 
@@ -186,6 +231,7 @@ export interface CustomFieldListKeysParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
+    | 'subscription'
   >;
 }
 
@@ -207,13 +253,14 @@ export interface CustomFieldRemoveKeyParams {
     | 'professional_service'
     | 'product'
     | 'rate_card'
-    | 'scheduled_charge';
+    | 'scheduled_charge'
+    | 'subscription';
 
   key: string;
 }
 
 export interface CustomFieldSetValuesParams {
-  custom_fields: Record<string, string>;
+  custom_fields: { [key: string]: string };
 
   entity:
     | 'alert'
@@ -232,7 +279,8 @@ export interface CustomFieldSetValuesParams {
     | 'professional_service'
     | 'product'
     | 'rate_card'
-    | 'scheduled_charge';
+    | 'scheduled_charge'
+    | 'subscription';
 
   entity_id: string;
 }

package/src/resources/{customers → v1/customers}/alerts.ts

@@ -1,31 +1,54 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import * as Shared from '../shared';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
+import * as Shared from "../../shared.js";
 
 export class Alerts extends APIResource {
   /**
    * Get the customer alert status and alert information for the specified customer
    * and alert
+   *
+   * @example
+   * ```ts
+   * const alert = await client.v1.customers.alerts.retrieve({
+   *   alert_id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+   *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   * });
+   * ```
    */
   retrieve(body: AlertRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<AlertRetrieveResponse> {
-    return this._client.post('/customer-alerts/get', { body, ...options });
+    return this._client.post('/v1/customer-alerts/get', { body, ...options });
   }
 
   /**
    * Fetch all customer alert statuses and alert information for a customer
+   *
+   * @example
+   * ```ts
+   * const alerts = await client.v1.customers.alerts.list({
+   *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   * });
+   * ```
    */
   list(params: AlertListParams, options?: Core.RequestOptions): Core.APIPromise<AlertListResponse> {
     const { next_page, ...body } = params;
-    return this._client.post('/customer-alerts/list', { query: { next_page }, body, ...options });
+    return this._client.post('/v1/customer-alerts/list', { query: { next_page }, body, ...options });
   }
 
   /**
    * Reset state for an alert by customer id and force re-evaluation
+   *
+   * @example
+   * ```ts
+   * await client.v1.customers.alerts.reset({
+   *   alert_id: '5e8691bf-b22a-4672-922d-f80eee940f01',
+   *   customer_id: '4c83caf3-8af4-44e2-9aeb-e290531726d9',
+   * });
+   * ```
    */
   reset(body: AlertResetParams, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post('/customer-alerts/reset', {
+    return this._client.post('/v1/customer-alerts/reset', {
       body,
       ...options,
       headers: { Accept: '*/*', ...options?.headers },
@@ -169,6 +192,12 @@ export interface AlertRetrieveParams {
    * The Metronome ID of the customer
    */
   customer_id: string;
+
+  /**
+   * When parallel alerts are enabled during migration, this flag denotes whether to
+   * fetch alerts for plans or contracts.
+   */
+  plans_or_contracts?: 'PLANS' | 'CONTRACTS';
 }
 
 export interface AlertListParams {

package/src/resources/{customers → v1/customers}/billing-config.ts

@@ -1,15 +1,25 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
 
 export class BillingConfig extends APIResource {
   /**
    * Set the billing configuration for a given customer.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customers.billingConfig.create({
+   *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   billing_provider_type: 'stripe',
+   *   billing_provider_customer_id: 'cus_AJ6y20bjkOOayM',
+   *   stripe_collection_method: 'charge_automatically',
+   * });
+   * ```
    */
   create(params: BillingConfigCreateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     const { customer_id, billing_provider_type, ...body } = params;
-    return this._client.post(`/customers/${customer_id}/billing-config/${billing_provider_type}`, {
+    return this._client.post(`/v1/customers/${customer_id}/billing-config/${billing_provider_type}`, {
       body,
       ...options,
       headers: { Accept: '*/*', ...options?.headers },
@@ -18,22 +28,39 @@ export class BillingConfig extends APIResource {
 
   /**
    * Fetch the billing configuration for the given customer.
+   *
+   * @example
+   * ```ts
+   * const billingConfig =
+   *   await client.v1.customers.billingConfig.retrieve({
+   *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     billing_provider_type: 'stripe',
+   *   });
+   * ```
    */
   retrieve(
     params: BillingConfigRetrieveParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<BillingConfigRetrieveResponse> {
     const { customer_id, billing_provider_type } = params;
-    return this._client.get(`/customers/${customer_id}/billing-config/${billing_provider_type}`, options);
+    return this._client.get(`/v1/customers/${customer_id}/billing-config/${billing_provider_type}`, options);
   }
 
   /**
    * Delete the billing configuration for a given customer. Note: this is unsupported
    * for Azure and AWS Marketplace customers.
+   *
+   * @example
+   * ```ts
+   * await client.v1.customers.billingConfig.delete({
+   *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   billing_provider_type: 'stripe',
+   * });
+   * ```
    */
   delete(params: BillingConfigDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     const { customer_id, billing_provider_type } = params;
-    return this._client.delete(`/customers/${customer_id}/billing-config/${billing_provider_type}`, {
+    return this._client.delete(`/v1/customers/${customer_id}/billing-config/${billing_provider_type}`, {
       ...options,
       headers: { Accept: '*/*', ...options?.headers },
     });
@@ -53,6 +80,11 @@ export namespace BillingConfigRetrieveResponse {
      */
     aws_expiration_date?: string;
 
+    /**
+     * True if the aws_product_code is a SAAS subscription product, false otherwise.
+     */
+    aws_is_subscription_product?: boolean;
+
     aws_product_code?: string;
 
     aws_region?:

package/src/resources/{customers → v1/customers}/commits.ts

@@ -1,32 +1,87 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import * as Shared from '../shared';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
+import * as Shared from "../../shared.js";
 
 export class Commits extends APIResource {
   /**
    * Create a new commit at the customer level.
+   *
+   * @example
+   * ```ts
+   * const commit = await client.v1.customers.commits.create({
+   *   access_schedule: {
+   *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *     schedule_items: [
+   *       {
+   *         amount: 1000,
+   *         starting_at: '2020-01-01T00:00:00.000Z',
+   *         ending_before: '2020-02-01T00:00:00.000Z',
+   *       },
+   *     ],
+   *   },
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   priority: 100,
+   *   product_id: 'f14d6729-6a44-4b13-9908-9387f1918790',
+   *   type: 'prepaid',
+   *   invoice_contract_id:
+   *     'e57d6929-c2f1-4796-a9a8-63cedefe848d',
+   *   invoice_schedule: {
+   *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *     schedule_items: [
+   *       {
+   *         unit_price: 10000000,
+   *         quantity: 1,
+   *         timestamp: '2020-03-01T00:00:00.000Z',
+   *       },
+   *     ],
+   *   },
+   *   name: 'My Commit',
+   * });
+   * ```
    */
   create(body: CommitCreateParams, options?: Core.RequestOptions): Core.APIPromise<CommitCreateResponse> {
-    return this._client.post('/contracts/customerCommits/create', { body, ...options });
+    return this._client.post('/v1/contracts/customerCommits/create', { body, ...options });
   }
 
   /**
    * List commits.
+   *
+   * @example
+   * ```ts
+   * const commits = await client.v1.customers.commits.list({
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+   *   include_ledgers: true,
+   * });
+   * ```
    */
   list(body: CommitListParams, options?: Core.RequestOptions): Core.APIPromise<CommitListResponse> {
-    return this._client.post('/contracts/customerCommits/list', { body, ...options });
+    return this._client.post('/v1/contracts/customerCommits/list', { body, ...options });
   }
 
   /**
-   * Update the end date of a PREPAID commit
+   * Pull forward the end date of a prepaid commit. Use the "edit a commit" endpoint
+   * to extend the end date of a prepaid commit, or to make other edits to the
+   * commit.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.customers.commits.updateEndDate({
+   *     commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+   *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *     access_ending_before: '2020-01-01T00:00:00.000Z',
+   *     invoices_ending_before: '2020-01-01T00:00:00.000Z',
+   *   });
+   * ```
    */
   updateEndDate(
     body: CommitUpdateEndDateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CommitUpdateEndDateResponse> {
-    return this._client.post('/contracts/customerCommits/updateEndDate', { body, ...options });
+    return this._client.post('/v1/contracts/customerCommits/updateEndDate', { body, ...options });
   }
 }
 
@@ -74,18 +129,20 @@ export interface CommitCreateParams {
   applicable_contract_ids?: Array<string>;
 
   /**
-   * Which products the commit applies to. If both applicable_product_ids and
-   * applicable_product_tags are not provided, the commit applies to all products.
+   * Which products the commit applies to. If applicable_product_ids,
+   * applicable_product_tags or specifiers are not provided, the commit applies to
+   * all products.
    */
   applicable_product_ids?: Array<string>;
 
   /**
-   * Which tags the commit applies to. If both applicable_product_ids and
-   * applicable_product_tags are not provided, the commit applies to all products.
+   * Which tags the commit applies to. If applicable_product_ids,
+   * applicable_product_tags or specifiers are not provided, the commit applies to
+   * all products.
    */
   applicable_product_tags?: Array<string>;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   /**
    * Used only in UI/API. It is not exposed to end customers.
@@ -124,6 +181,14 @@ export interface CommitCreateParams {
    */
   salesforce_opportunity_id?: string;
 
+  /**
+   * List of filters that determine what kind of customer usage draws down a commit
+   * or credit. A customer's usage needs to meet the condition of at least one of the
+   * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+   * be used together with `applicable_product_ids` or `applicable_product_tags`.
+   */
+  specifiers?: Array<CommitCreateParams.Specifier>;
+
   /**
    * Prevents the creation of duplicates. If a request to create a commit or credit
    * is made with a uniqueness key that was previously used to create a commit or
@@ -259,6 +324,23 @@ export namespace CommitCreateParams {
       unit_price?: number;
     }
   }
+
+  export interface Specifier {
+    presentation_group_values?: { [key: string]: string };
+
+    pricing_group_values?: { [key: string]: string };
+
+    /**
+     * If provided, the specifier will only apply to the product with the specified ID.
+     */
+    product_id?: string;
+
+    /**
+     * If provided, the specifier will only apply to products with all the specified
+     * tags.
+     */
+    product_tags?: Array<string>;
+  }
 }
 
 export interface CommitListParams {
@@ -277,7 +359,7 @@ export interface CommitListParams {
   effective_before?: string;
 
   /**
-   * Include commits from archived contracts.
+   * Include archived commits and commits from archived contracts.
    */
   include_archived?: boolean;
 
@@ -298,6 +380,11 @@ export interface CommitListParams {
    */
   include_ledgers?: boolean;
 
+  /**
+   * The maximum number of commits to return. Defaults to 25.
+   */
+  limit?: number;
+
   /**
    * The next page token from a previous response.
    */