@metronome/sdk 3.6.0 → 3.8.0

package/src/resources/v1/contracts/index.ts

@@ -9,6 +9,7 @@ export {
   type ContractArchiveResponse,
   type ContractCreateHistoricalInvoicesResponse,
   type ContractGetNetBalanceResponse,
+  type ContractGetSubscriptionSeatsHistoryResponse,
   type ContractListBalancesResponse,
   type ContractListSeatBalancesResponse,
   type ContractRetrieveRateScheduleResponse,
@@ -23,6 +24,7 @@ export {
   type ContractArchiveParams,
   type ContractCreateHistoricalInvoicesParams,
   type ContractGetNetBalanceParams,
+  type ContractGetSubscriptionSeatsHistoryParams,
   type ContractListBalancesParams,
   type ContractListSeatBalancesParams,
   type ContractRetrieveRateScheduleParams,

package/src/resources/v1/contracts/rate-cards/rates.ts

@@ -59,6 +59,10 @@ export class Rates extends APIResource {
   /**
    * Add a new rate
    *
+   * This endpoint is heavily rate limited. For adding multiple rates, using the
+   * [addRates](https://docs.metronome.com/api-reference/rate-cards/add-rates)
+   * endpoint is strongly encouraged.
+   *
    * @example
    * ```ts
    * const response =

package/src/resources/v1/customers/alerts.ts

@@ -50,11 +50,11 @@ export class Alerts extends APIResource {
    * - `null` - Notification has been archived
    * - `triggered_by`: Additional context about what caused the notification to
    *   trigger (when applicable)
+   * - `updated_at`: Timestamp of when the `customer_status` was last updated
    * - alert: Complete threshold notification configuration including:
    *   - Notification ID, name, and type
    *   - Current threshold values and credit type information
    *   - Notification status (enabled, disabled, or archived)
-   *   - Last update timestamp
    *   - Any applied filters (credit grant types, custom fields, group values)
    *
    * ### Usage guidelines:
@@ -248,10 +248,17 @@ export namespace CustomerAlert {
       | 'invoice_total_reached';
 
     /**
-     * Timestamp for when the threshold notification was last updated
+     * Timestamp for when the threshold notification's customer status was last updated
      */
     updated_at: string;
 
+    /**
+     * Present for `low_remaining_contract_credit_and_commit_balance_reached`
+     * notifications. The filters that define the balances that are considered when
+     * evaluating the alert.
+     */
+    alert_specifiers?: Array<Alert.AlertSpecifier>;
+
     /**
      * An array of strings, representing a way to filter the credit grant this
      * threshold notification applies to, by looking at the credit_grant_type field on
@@ -301,6 +308,48 @@ export namespace CustomerAlert {
   }
 
   export namespace Alert {
+    export interface AlertSpecifier {
+      /**
+       * A list of custom field filters for notification types that support advanced
+       * filtering
+       */
+      custom_field_filters?: Array<AlertSpecifier.CustomFieldFilter>;
+
+      /**
+       * If provided, the specifier will not apply to balances that matches the inclusion
+       * criteria and any of the excluding values.
+       */
+      exclude?: Array<AlertSpecifier.Exclude>;
+    }
+
+    export namespace AlertSpecifier {
+      export interface CustomFieldFilter {
+        entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
+
+        key: string;
+
+        value?: string;
+      }
+
+      export interface Exclude {
+        /**
+         * A list of custom field filters for notification types that support advanced
+         * filtering
+         */
+        custom_field_filters?: Array<Exclude.CustomFieldFilter>;
+      }
+
+      export namespace Exclude {
+        export interface CustomFieldFilter {
+          entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
+
+          key: string;
+
+          value: string;
+        }
+      }
+    }
+
     export interface CustomFieldFilter {
       entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
 
@@ -358,6 +407,12 @@ export interface AlertRetrieveParams {
    */
   customer_id: string;
 
+  /**
+   * Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+   * notifications. Used to filter the alert by the custom field key-value pair.
+   */
+  alert_specifiers?: Array<AlertRetrieveParams.AlertSpecifier>;
+
   /**
    * Only present for `spend_threshold_reached` notifications. Retrieve the
    * notification for a specific group key-value pair.
@@ -378,6 +433,48 @@ export interface AlertRetrieveParams {
 }
 
 export namespace AlertRetrieveParams {
+  export interface AlertSpecifier {
+    /**
+     * A list of custom field filters for notification types that support advanced
+     * filtering
+     */
+    custom_field_filters: Array<AlertSpecifier.CustomFieldFilter>;
+
+    /**
+     * If provided, the specifier will not apply to balances that matches the inclusion
+     * criteria and any of the excluding values.
+     */
+    exclude?: Array<AlertSpecifier.Exclude>;
+  }
+
+  export namespace AlertSpecifier {
+    export interface CustomFieldFilter {
+      entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
+
+      key: string;
+
+      value: string;
+    }
+
+    export interface Exclude {
+      /**
+       * A list of custom field filters for notification types that support advanced
+       * filtering
+       */
+      custom_field_filters?: Array<Exclude.CustomFieldFilter>;
+    }
+
+    export namespace Exclude {
+      export interface CustomFieldFilter {
+        entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
+
+        key: string;
+
+        value: string;
+      }
+    }
+  }
+
   /**
    * Scopes threshold notification evaluation to a specific presentation group key on
    * individual line items. Only present for spend notifications.

package/src/resources/v1/customers/invoices.ts

@@ -1052,6 +1052,12 @@ export interface InvoiceListParams extends CursorPageParams {
    * Query param: Filter invoices by type. Defaults to returning all invoice types.
    */
   type?: 'USAGE' | 'USAGE_CONSOLIDATED' | 'SCHEDULED';
+
+  /**
+   * Query param: Indicates that this API request was triggered by a webhook
+   * notification with the provided ID.
+   */
+  webhook_notification_id?: string;
 }
 
 export interface InvoiceAddChargeParams {

package/src/resources/v1/dashboards.ts

@@ -31,8 +31,13 @@ export class Dashboards extends APIResource {
    *
    * - Dashboard types: Choose from `invoices`, `usage`, or `commits_and_credits`
    * - Customization options:
-   *   - `dashboard_options`: Configure whether you want invoices to show zero usage
-   *     line items
+   *   - `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")
    *   - `color_overrides`: Match your brand's color palette
    *   - `bm_group_key_overrides`: Customize how dimensions are displayed (for the
    *     usage embeddable dashboard)
@@ -151,7 +156,9 @@ export namespace DashboardGetEmbeddableURLParams {
       | 'Primary_green'
       | 'Primary_red'
       | 'Progress_bar'
-      | 'Progress_bar_background';
+      | 'Progress_bar_background'
+      | 'Action'
+      | 'Action_hover';
 
     /**
      * Hex value representation of the color

package/src/resources/v1/index.ts

@@ -34,6 +34,7 @@ export {
   type ContractArchiveResponse,
   type ContractCreateHistoricalInvoicesResponse,
   type ContractGetNetBalanceResponse,
+  type ContractGetSubscriptionSeatsHistoryResponse,
   type ContractListBalancesResponse,
   type ContractListSeatBalancesResponse,
   type ContractRetrieveRateScheduleResponse,
@@ -48,6 +49,7 @@ export {
   type ContractArchiveParams,
   type ContractCreateHistoricalInvoicesParams,
   type ContractGetNetBalanceParams,
+  type ContractGetSubscriptionSeatsHistoryParams,
   type ContractListBalancesParams,
   type ContractListSeatBalancesParams,
   type ContractRetrieveRateScheduleParams,
@@ -143,17 +145,6 @@ export {
   type PackageListResponsesCursorPage,
   type PackageListContractsOnPackageResponsesCursorPage,
 } from './packages';
-export {
-  Payments,
-  type Payment,
-  type PaymentStatus,
-  type PaymentAttemptResponse,
-  type PaymentCancelResponse,
-  type PaymentListParams,
-  type PaymentAttemptParams,
-  type PaymentCancelParams,
-  type PaymentsBodyCursorPage,
-} from './payments';
 export {
   Plans,
   type PlanDetail,