@metronome/sdk 3.9.0 → 3.10.0

package/src/resources/v1/dashboards.ts

@@ -31,16 +31,13 @@ export class Dashboards extends APIResource {
    *
    * - Dashboard types: Choose from `invoices`, `usage`, or `commits_and_credits`
    * - Customization options:
-   *   - `dashboard_options`: Configure dashboard behavior. For the invoices
-   *     dashboard, supported keys include: `show_zero_usage_line_items`
-   *     ("true"/"false"), `hide_voided_invoices` ("true"/"false"), `contract_id`
-   *     (UUID, filters invoices by contract), `invoice_type` ("USAGE" or
-   *     "SCHEDULED", filters by invoice type), `invoice_status_filter` ("VOID",
-   *     "FINALIZED", "DRAFT", "FINALIZED_AND_DRAFT", or "ALL"), and
-   *     `billable_status_filter` ("BILLABLE", "UNBILLABLE", or "ALL")
+   *   - `dashboard_options`: Configure dashboard behavior. Supported for the
+   *     invoices dashboard only. Available keys include:
+   *     `show_zero_usage_line_items` ("true"/"false"), `contract_id` (UUID, filters
+   *     invoices by contract), `invoice_type` ("USAGE" or "SCHEDULED", filters by
+   *     invoice type), and `invoice_status_filter` ("VOID", "FINALIZED", "DRAFT",
+   *     "FINALIZED_AND_DRAFT", or "ALL")
    *   - `color_overrides`: Match your brand's color palette
-   *   - `bm_group_key_overrides`: Customize how dimensions are displayed (for the
-   *     usage embeddable dashboard)
    * - Iframe implementation: Embed the returned URL directly in an iframe element
    * - Responsive design: Dashboards automatically adapt to container dimensions
    *
@@ -50,22 +47,12 @@ export class Dashboards extends APIResource {
    *   await client.v1.dashboards.getEmbeddableURL({
    *     customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
    *     dashboard: 'invoices',
-   *     bm_group_key_overrides: [
-   *       {
-   *         group_key_name: 'tenant_id',
-   *         display_name: 'Org ID',
-   *         value_display_names: {
-   *           '48ecb18f358f': 'Cluster EU',
-   *           e358f3ce242d: 'Cluster APAC',
-   *         },
-   *       },
-   *     ],
    *     color_overrides: [
    *       { name: 'Gray_dark', value: '#ff0000' },
    *     ],
    *     dashboard_options: [
    *       { key: 'show_zero_usage_line_items', value: 'false' },
-   *       { key: 'hide_voided_invoices', value: 'true' },
+   *       { key: 'invoice_status_filter', value: 'FINALIZED' },
    *     ],
    *   });
    * ```
@@ -170,10 +157,22 @@ export namespace DashboardGetEmbeddableURLParams {
     /**
      * The option key name
      */
-    key: string;
+    key:
+      | 'show_zero_usage_line_items'
+      | 'contract_id'
+      | 'invoice_type'
+      | 'invoice_status_filter'
+      | 'hide_voided_invoices'
+      | 'billable_status_filter'
+      | 'hide_grant_name'
+      | 'credit_ledger_credit_type_id';
 
     /**
-     * The option value
+     * The option value. For show_zero_usage_line_items: "true" or "false" (default
+     * "false"). For contract_id: a UUID filtering invoices to a specific contract. For
+     * invoice_type: "USAGE" or "SCHEDULED". For invoice_status_filter: "VOID",
+     * "FINALIZED", "DRAFT", "FINALIZED_AND_DRAFT", or "ALL". For hide_voided_invoices
+     * (deprecated): "true" or "false".
      */
     value: string;
   }

package/src/resources/v1/packages.ts

@@ -678,7 +678,8 @@ export namespace PackageRetrieveResponse {
        * The commits will be created on the usage invoice frequency. If provided: - The
        * period defined in the duration will correspond to this frequency. - Commits will
        * be created aligned with the recurring commit's starting_at rather than the usage
-       * invoice dates.
+       * invoice dates. - Daily recurring commits have a limit of one per contract, and
+       * are unable to be created with seat-based subscriptions
        */
       recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -880,7 +881,8 @@ export namespace PackageRetrieveResponse {
        * The commits will be created on the usage invoice frequency. If provided: - The
        * period defined in the duration will correspond to this frequency. - Commits will
        * be created aligned with the recurring commit's starting_at rather than the usage
-       * invoice dates.
+       * invoice dates. - Daily recurring commits have a limit of one per contract, and
+       * are unable to be created with seat-based subscriptions
        */
       recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -1620,7 +1622,8 @@ export namespace PackageListResponse {
      * The commits will be created on the usage invoice frequency. If provided: - The
      * period defined in the duration will correspond to this frequency. - Commits will
      * be created aligned with the recurring commit's starting_at rather than the usage
-     * invoice dates.
+     * invoice dates. - Daily recurring commits have a limit of one per contract, and
+     * are unable to be created with seat-based subscriptions
      */
     recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -1822,7 +1825,8 @@ export namespace PackageListResponse {
      * The commits will be created on the usage invoice frequency. If provided: - The
      * period defined in the duration will correspond to this frequency. - Commits will
      * be created aligned with the recurring commit's starting_at rather than the usage
-     * invoice dates.
+     * invoice dates. - Daily recurring commits have a limit of one per contract, and
+     * are unable to be created with seat-based subscriptions
      */
     recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -2725,7 +2729,8 @@ export namespace PackageCreateParams {
      * The commits will be created on the usage invoice frequency. If provided: - The
      * period defined in the duration will correspond to this frequency. - Commits will
      * be created aligned with the recurring commit's starting_at rather than the usage
-     * invoice dates.
+     * invoice dates. - Daily recurring commits have a limit of one per contract, and
+     * are unable to be created with seat-based subscriptions
      */
     recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -2950,7 +2955,8 @@ export namespace PackageCreateParams {
      * The commits will be created on the usage invoice frequency. If provided: - The
      * period defined in the duration will correspond to this frequency. - Commits will
      * be created aligned with the recurring commit's starting_at rather than the usage
-     * invoice dates.
+     * invoice dates. - Daily recurring commits have a limit of one per contract, and
+     * are unable to be created with seat-based subscriptions
      */
     recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 

package/src/resources/v2/contracts.ts

@@ -682,7 +682,8 @@ export namespace ContractEditResponse {
          * The commits will be created on the usage invoice frequency. If provided: - The
          * period defined in the duration will correspond to this frequency. - Commits will
          * be created aligned with the recurring commit's starting_at rather than the usage
-         * invoice dates.
+         * invoice dates. - Daily recurring commits have a limit of one per contract, and
+         * are unable to be created with seat-based subscriptions
          */
         recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -865,7 +866,8 @@ export namespace ContractEditResponse {
          * The commits will be created on the usage invoice frequency. If provided: - The
          * period defined in the duration will correspond to this frequency. - Commits will
          * be created aligned with the recurring commit's starting_at rather than the usage
-         * invoice dates.
+         * invoice dates. - Daily recurring commits have a limit of one per contract, and
+         * are unable to be created with seat-based subscriptions
          */
         recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -2419,7 +2421,8 @@ export namespace ContractGetEditHistoryResponse {
        * The commits will be created on the usage invoice frequency. If provided: - The
        * period defined in the duration will correspond to this frequency. - Commits will
        * be created aligned with the recurring commit's starting_at rather than the usage
-       * invoice dates.
+       * invoice dates. - Daily recurring commits have a limit of one per contract, and
+       * are unable to be created with seat-based subscriptions
        */
       recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -2602,7 +2605,8 @@ export namespace ContractGetEditHistoryResponse {
        * The commits will be created on the usage invoice frequency. If provided: - The
        * period defined in the duration will correspond to this frequency. - Commits will
        * be created aligned with the recurring commit's starting_at rather than the usage
-       * invoice dates.
+       * invoice dates. - Daily recurring commits have a limit of one per contract, and
+       * are unable to be created with seat-based subscriptions
        */
       recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -3950,7 +3954,7 @@ export namespace ContractEditParams {
         | 'gcp_marketplace'
         | 'metronome';
 
-      billing_provider_configuration_id?: string;
+      billing_provider_configuration_id?: string | null;
 
       delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
     }
@@ -4801,7 +4805,8 @@ export namespace ContractEditParams {
      * The commits will be created on the usage invoice frequency. If provided: - The
      * period defined in the duration will correspond to this frequency. - Commits will
      * be created aligned with the recurring commit's starting_at rather than the usage
-     * invoice dates.
+     * invoice dates. - Daily recurring commits have a limit of one per contract, and
+     * are unable to be created with seat-based subscriptions
      */
     recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -5014,7 +5019,8 @@ export namespace ContractEditParams {
      * The commits will be created on the usage invoice frequency. If provided: - The
      * period defined in the duration will correspond to this frequency. - Commits will
      * be created aligned with the recurring commit's starting_at rather than the usage
-     * invoice dates.
+     * invoice dates. - Daily recurring commits have a limit of one per contract, and
+     * are unable to be created with seat-based subscriptions
      */
     recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
@@ -5189,7 +5195,7 @@ export namespace ContractEditParams {
        */
       provider?: 'netsuite';
 
-      revenue_system_configuration_id?: string;
+      revenue_system_configuration_id?: string | null;
     }
 
     export interface Schedule {
@@ -6195,6 +6201,13 @@ export interface ContractEditCommitParams {
 
   access_schedule?: ContractEditCommitParams.AccessSchedule;
 
+  /**
+   * Which contracts the customer-level commit applies to. If set to null, the commit
+   * applies to all of the customer's contracts. This field cannot be edited for
+   * POSTPAID commits or contract-level commits.
+   */
+  applicable_contract_ids?: Array<string> | null;
+
   /**
    * Which products the commit applies to. If applicable_product_ids,
    * applicable_product_tags or specifiers are not provided, the commit applies to
@@ -6340,6 +6353,13 @@ export interface ContractEditCreditParams {
 
   access_schedule?: ContractEditCreditParams.AccessSchedule;
 
+  /**
+   * Which contracts the customer-level credit applies to. If set to null, the credit
+   * applies to all of the customer's contracts. This field cannot be set on a
+   * contract-level credit.
+   */
+  applicable_contract_ids?: Array<string> | null;
+
   /**
    * Which products the credit applies to. If both applicable_product_ids and
    * applicable_product_tags are not provided, the credit applies to all products.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.9.0'; // x-release-please-version
+export const VERSION = '3.10.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.9.0";
+export declare const VERSION = "3.10.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.9.0";
+export declare const VERSION = "3.10.0";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '3.9.0'; // x-release-please-version
+exports.VERSION = '3.10.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '3.9.0'; // x-release-please-version
+export const VERSION = '3.10.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}