@metronome/sdk 1.0.0 → 2.0.0

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

@@ -5,17 +5,26 @@ import { CursorPageWithoutLimit, type CursorPageWithoutLimitParams, PagePromise
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Alerts extends APIResource {
     /**
-     * Retrieve the real-time evaluation status for a specific alert-customer pair.
-     * This endpoint provides instant visibility into whether a customer has triggered
-     * an alert condition, enabling you to monitor account health and take proactive
-     * action based on current alert states.
+     * Retrieve the real-time evaluation status for a specific threshold
+     * notification-customer pair. This endpoint provides instant visibility into
+     * whether a customer has triggered a threshold notification condition, enabling
+     * you to monitor account health and take proactive action based on current
+     * threshold notification states.
      *
      * ### Use this endpoint to:
      *
-     * - Check if a specific customer is currently violating an alert threshold
+     * - Check if a specific customer is currently violating an threshold notification
      *   (`in_alarm` status)
-     * - Verify alert configuration details and threshold values for a customer
-     * - Integrate alert status checks into customer support tools or admin interfaces
+     * - Verify threshold notification configuration details and threshold values for a
+     *   customer
+     * - Monitor the evaluation state of newly created or recently modified threshold
+     *   notification
+     * - Build dashboards or automated workflows that respond to specific threshold
+     *   notification conditions
+     * - Validate threshold notification behavior before deploying to production
+     *   customers
+     * - Integrate threshold notification status checks into customer support tools or
+     *   admin interfaces
      *
      * ### Key response fields:
      *
@@ -24,29 +33,32 @@ export declare class Alerts extends APIResource {
      * - `customer_status`: The current evaluation state
      *
      * - `ok` - Customer is within acceptable thresholds
-     * - `in_alarm`- Customer has breached the alert threshold
-     * - `evaluating` - Alert has yet to be evaluated (typically due to a customer or
-     *   alert having just been created)
-     * - `null` - Alert has been archived
-     * - `triggered_by`: Additional context about what caused the alert to trigger
-     *   (when applicable)
-     * - alert: Complete alert configuration including:
-     *   - Alert ID, name, and type
+     * - `in_alarm` - Customer has breached the threshold for the notification
+     * - `evaluating` - Notification is currently being evaluated (typically during
+     *   initial setup)
+     * - `null` - Notification has been archived
+     * - `triggered_by`: Additional context about what caused the notification to
+     *   trigger (when applicable)
+     * - alert: Complete threshold notification configuration including:
+     *   - Notification ID, name, and type
      *   - Current threshold values and credit type information
-     *   - Alert status (enabled, disabled, or archived)
+     *   - Notification status (enabled, disabled, or archived)
      *   - Last update timestamp
      *   - Any applied filters (credit grant types, custom fields, group values)
      *
      * ### Usage guidelines:
      *
      * - Customer status: Returns the current evaluation state, not historical data.
-     *   For alert history, use webhook notifications or event logs
-     * - Archived alerts: Returns null for customer_status if the alert has been
-     *   archived, but still includes the alert configuration details
-     * - Integration patterns: This endpoint can be used to check a customer's alert
-     *   status, but shouldn't be scraped. You should instead rely on the webhook
-     *   notification to understand when customers are moved to IN_ALARM.
-     * - Error handling: Returns 404 if either the customer or alert ID doesn't exist
+     *   For threshold notification history, use webhook notifications or event logs
+     * - Required parameters: Both customer_id and alert_id must be valid UUIDs that
+     *   exist in your organization
+     * - Archived notifications: Returns null for customer_status if the notification
+     *   has been archived, but still includes the notification configuration details
+     * - Performance considerations: This endpoint queries live evaluation state,
+     *   making it ideal for real-time monitoring but not for bulk status checks
+     * - Integration patterns: Best used for on-demand status checks in response to
+     *   user actions or as part of targeted monitoring workflows
+     * - Error handling: Returns 404 if either the customer or alert_id doesn't exist
      *   or isn't accessible to your organization
      *
      * @example
@@ -59,31 +71,37 @@ export declare class Alerts extends APIResource {
      */
     retrieve(body: AlertRetrieveParams, options?: RequestOptions): APIPromise<AlertRetrieveResponse>;
     /**
-     * Retrieve all alert configurations and their current statuses for a specific
-     * customer in a single API call. This endpoint provides a comprehensive view of
-     * all alerts monitoring a customer account.
+     * Retrieve all threshold notification configurations and their current statuses
+     * for a specific customer in a single API call. This endpoint provides a
+     * comprehensive view of all threshold notification monitoring a customer account.
      *
      * ### Use this endpoint to:
      *
-     * - Display all active alerts for a customer in dashboards or admin panels
-     * - Quickly identify which alerts a customer is currently triggering
-     * - Audit alert coverage for specific accounts
-     * - Filter alerts by status (enabled, disabled, or archived)
+     * - Display all active threshold notifications for a customer in dashboards or
+     *   admin panels
+     * - Quickly identify which threshold notifications a customer is currently
+     *   triggering
+     * - Audit threshold notification coverage for specific accounts
+     * - Filter threshold notifications by status (enabled, disabled, or archived)
      *
      * ### Key response fields:
      *
      * - data: Array of CustomerAlert objects, each containing:
      *   - Current evaluation status (`ok`, `in_alarm`, `evaluating`, or `null`)
-     *   - Complete alert configuration and threshold details
-     *   - Alert metadata including type, name, and last update time
-     * - `next_page`: Pagination cursor for retrieving additional results
+     *   - Complete threshold notification configuration and threshold details
+     *   - Threshold notification metadata including type, name, and last update time
+     * - next_page: Pagination cursor for retrieving additional results
      *
      * ### Usage guidelines:
      *
-     * - Default behavior: Returns only enabled alerts unless alert_statuses filter is
-     *   specified
+     * - Default behavior: Returns only enabled threshold notifications unless
+     *   `alert_statuses` filter is specified
      * - Pagination: Use the `next_page` cursor to retrieve all results for customers
-     *   with many alerts
+     *   with many notifications
+     * - Performance: Efficiently retrieves multiple threshold notification statuses in
+     *   a single request instead of making individual calls
+     * - Filtering: Pass the `alert_statuses` array to include disabled or archived
+     *   threshold notifications in results
      *
      * @example
      * ```ts
@@ -97,23 +115,24 @@ export declare class Alerts extends APIResource {
      */
     list(params: AlertListParams, options?: RequestOptions): PagePromise<CustomerAlertsCursorPageWithoutLimit, CustomerAlert>;
     /**
-     * Force an immediate re-evaluation of a specific alert for a customer, clearing
-     * any previous state and triggering a fresh assessment against current thresholds.
-     * This endpoint ensures alert accuracy after configuration changes or data
-     * corrections.
+     * Force an immediate re-evaluation of a specific threshold notification for a
+     * customer, clearing any previous state and triggering a fresh assessment against
+     * current thresholds. This endpoint ensures threshold notification accuracy after
+     * configuration changes or data corrections.
      *
      * ### Use this endpoint to:
      *
-     * - Clear false positive alerts after fixing data issues
-     * - Re-evaluate alerts after adjusting customer balances or credits
-     * - Test alert behavior during development and debugging
-     * - Resolve stuck alerts that may be in an incorrect state
+     * - Clear false positive threshold notifications after fixing data issues
+     * - Re-evaluate threshold notifications after adjusting customer balances or
+     *   credits
+     * - Test threshold notification behavior during development and debugging
+     * - Resolve stuck threshold notification that may be in an incorrect state
      * - Trigger immediate evaluation after threshold modifications
      *
      * ### Key response fields:
      *
-     * - 200 Success: Confirmation that the alert has been reset and re-evaluation
-     *   initiated
+     * - 200 Success: Confirmation that the threshold notification has been reset and
+     *   re-evaluation initiated
      * - No response body is returned - the operation completes asynchronously
      *
      * ### Usage guidelines:
@@ -140,65 +159,67 @@ export type CustomerAlertsCursorPageWithoutLimit = CursorPageWithoutLimit<Custom
 export interface CustomerAlert {
     alert: CustomerAlert.Alert;
     /**
-     * The status of the customer alert. If the alert is archived, null will be
-     * returned.
+     * The status of the threshold notification. If the notification is archived, null
+     * will be returned.
      */
     customer_status: 'ok' | 'in_alarm' | 'evaluating' | null;
     /**
-     * If present, indicates the reason the alert was triggered.
+     * If present, indicates the reason the threshold notification was triggered.
      */
     triggered_by?: string | null;
 }
 export declare namespace CustomerAlert {
     interface Alert {
         /**
-         * the Metronome ID of the alert
+         * the Metronome ID of the threshold notification
          */
         id: string;
         /**
-         * Name of the alert
+         * Name of the threshold notification
          */
         name: string;
         /**
-         * Status of the alert
+         * Status of the threshold notification
          */
         status: 'enabled' | 'archived' | 'disabled';
         /**
-         * Threshold value of the alert policy
+         * Threshold value of the notification policy
          */
         threshold: number;
         /**
-         * Type of the alert
+         * Type of the threshold notification
          */
         type: 'low_credit_balance_reached' | 'spend_threshold_reached' | 'monthly_invoice_total_spend_threshold_reached' | 'low_remaining_days_in_plan_reached' | 'low_remaining_credit_percentage_reached' | 'usage_threshold_reached' | 'low_remaining_days_for_commit_segment_reached' | 'low_remaining_commit_balance_reached' | 'low_remaining_commit_percentage_reached' | 'low_remaining_days_for_contract_credit_segment_reached' | 'low_remaining_contract_credit_balance_reached' | 'low_remaining_contract_credit_percentage_reached' | 'low_remaining_contract_credit_and_commit_balance_reached' | 'invoice_total_reached';
         /**
-         * Timestamp for when the alert was last updated
+         * Timestamp for when the threshold notification was last updated
          */
         updated_at: string;
         /**
-         * An array of strings, representing a way to filter the credit grant this alert
-         * applies to, by looking at the credit_grant_type field on the credit grant. This
-         * field is only defined for CreditPercentage and CreditBalance alerts
+         * 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
+         * the credit grant. This field is only defined for CreditPercentage and
+         * CreditBalance notifications
          */
         credit_grant_type_filters?: Array<string>;
         credit_type?: Shared.CreditTypeData | null;
         /**
-         * A list of custom field filters for alert types that support advanced filtering
+         * A list of custom field filters for notification types that support advanced
+         * filtering
          */
         custom_field_filters?: Array<Alert.CustomFieldFilter>;
         /**
-         * Scopes alert evaluation to a specific presentation group key on individual line
-         * items. Only present for spend alerts.
+         * Scopes threshold notification evaluation to a specific presentation group key on
+         * individual line items. Only present for spend notifications.
          */
         group_key_filter?: Alert.GroupKeyFilter;
         /**
-         * Only present for `spend_threshold_reached` alerts. Scope alert to a specific
-         * group key on individual line items.
+         * Only present for `spend_threshold_reached` notifications. Scope notification to
+         * a specific group key on individual line items.
          */
         group_values?: Array<Alert.GroupValue>;
         /**
-         * Only supported for invoice_total_reached alerts. A list of invoice types to
-         * evaluate.
+         * Only supported for invoice_total_reached threshold notifications. A list of
+         * invoice types to evaluate.
          */
         invoice_types_filter?: Array<string>;
         /**
@@ -215,8 +236,8 @@ export declare namespace CustomerAlert {
             value: string;
         }
         /**
-         * Scopes alert evaluation to a specific presentation group key on individual line
-         * items. Only present for spend alerts.
+         * Scopes threshold notification evaluation to a specific presentation group key on
+         * individual line items. Only present for spend notifications.
          */
         interface GroupKeyFilter {
             key: string;
@@ -233,7 +254,7 @@ export interface AlertRetrieveResponse {
 }
 export interface AlertRetrieveParams {
     /**
-     * The Metronome ID of the alert
+     * The Metronome ID of the threshold notification
      */
     alert_id: string;
     /**
@@ -241,20 +262,20 @@ export interface AlertRetrieveParams {
      */
     customer_id: string;
     /**
-     * Only present for `spend_threshold_reached` alerts. Retrieve the alert for a
-     * specific group key-value pair.
+     * Only present for `spend_threshold_reached` notifications. Retrieve the
+     * notification for a specific group key-value pair.
      */
     group_values?: Array<AlertRetrieveParams.GroupValue>;
     /**
-     * When parallel alerts are enabled during migration, this flag denotes whether to
-     * fetch alerts for plans or contracts.
+     * When parallel threshold notifications are enabled during migration, this flag
+     * denotes whether to fetch notifications for plans or contracts.
      */
     plans_or_contracts?: 'PLANS' | 'CONTRACTS';
 }
 export declare namespace AlertRetrieveParams {
     /**
-     * Scopes alert evaluation to a specific presentation group key on individual line
-     * items. Only present for spend alerts.
+     * Scopes threshold notification evaluation to a specific presentation group key on
+     * individual line items. Only present for spend notifications.
      */
     interface GroupValue {
         key: string;
@@ -267,14 +288,14 @@ export interface AlertListParams extends CursorPageWithoutLimitParams {
      */
     customer_id: string;
     /**
-     * Body param: Optionally filter by alert status. If absent, only enabled alerts
-     * will be returned.
+     * Body param: Optionally filter by threshold notification status. If absent, only
+     * enabled notifications will be returned.
      */
     alert_statuses?: Array<'ENABLED' | 'DISABLED' | 'ARCHIVED'>;
 }
 export interface AlertResetParams {
     /**
-     * The Metronome ID of the alert
+     * The Metronome ID of the threshold notification
      */
     alert_id: string;
     /**

package/resources/v1/customers/alerts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/alerts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EACL,sBAAsB,EACtB,KAAK,4BAA4B,EACjC,WAAW,EACZ;OAEM,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,aAAa,CAAC;IAUnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO1E;AAED,MAAM,MAAM,oCAAoC,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAC;AAEzF,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;IAE3B;;;OAGG;IACH,eAAe,EAAE,IAAI,GAAG,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;QAE5C;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EACA,4BAA4B,GAC5B,yBAAyB,GACzB,+CAA+C,GAC/C,oCAAoC,GACpC,yCAAyC,GACzC,yBAAyB,GACzB,+CAA+C,GAC/C,sCAAsC,GACtC,yCAAyC,GACzC,wDAAwD,GACxD,+CAA+C,GAC/C,kDAAkD,GAClD,0DAA0D,GAC1D,uBAAuB,CAAC;QAE5B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1C,WAAW,CAAC,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAEtD;;;WAGG;QACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC;QAExC;;;WAGG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAEvC;;;WAGG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAErC;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,iBAAiB;YAChC,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,gBAAgB,CAAC;YAEjD,GAAG,EAAE,MAAM,CAAC;YAEZ,KAAK,EAAE,MAAM,CAAC;SACf;QAED;;;WAGG;QACH,UAAiB,cAAc;YAC7B,GAAG,EAAE,MAAM,CAAC;YAEZ,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,UAAU;YACzB,GAAG,EAAE,MAAM,CAAC;YAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAErD;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CAC5C;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,UAAU;QACzB,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,4BAA4B;IACnE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/alerts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EACL,sBAAsB,EACtB,KAAK,4BAA4B,EACjC,WAAW,EACZ;OAEM,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,aAAa,CAAC;IAUnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,KAAK,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO1E;AAED,MAAM,MAAM,oCAAoC,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAC;AAEzF,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;IAE3B;;;OAGG;IACH,eAAe,EAAE,IAAI,GAAG,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC;QAE5C;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EACA,4BAA4B,GAC5B,yBAAyB,GACzB,+CAA+C,GAC/C,oCAAoC,GACpC,yCAAyC,GACzC,yBAAyB,GACzB,+CAA+C,GAC/C,sCAAsC,GACtC,yCAAyC,GACzC,wDAAwD,GACxD,+CAA+C,GAC/C,kDAAkD,GAClD,0DAA0D,GAC1D,uBAAuB,CAAC;QAE5B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;;WAKG;QACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1C,WAAW,CAAC,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;QAE3C;;;WAGG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAEtD;;;WAGG;QACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC;QAExC;;;WAGG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAEvC;;;WAGG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAErC;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,iBAAiB;YAChC,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,gBAAgB,CAAC;YAEjD,GAAG,EAAE,MAAM,CAAC;YAEZ,KAAK,EAAE,MAAM,CAAC;SACf;QAED;;;WAGG;QACH,UAAiB,cAAc;YAC7B,GAAG,EAAE,MAAM,CAAC;YAEZ,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,UAAU;YACzB,GAAG,EAAE,MAAM,CAAC;YAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAErD;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CAC5C;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,UAAU;QACzB,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,4BAA4B;IACnE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,UAAU,GAAG,UAAU,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/v1/customers/alerts.js

@@ -7,17 +7,26 @@ const pagination_1 = require("../../../core/pagination.js");
 const headers_1 = require("../../../internal/headers.js");
 class Alerts extends resource_1.APIResource {
     /**
-     * Retrieve the real-time evaluation status for a specific alert-customer pair.
-     * This endpoint provides instant visibility into whether a customer has triggered
-     * an alert condition, enabling you to monitor account health and take proactive
-     * action based on current alert states.
+     * Retrieve the real-time evaluation status for a specific threshold
+     * notification-customer pair. This endpoint provides instant visibility into
+     * whether a customer has triggered a threshold notification condition, enabling
+     * you to monitor account health and take proactive action based on current
+     * threshold notification states.
      *
      * ### Use this endpoint to:
      *
-     * - Check if a specific customer is currently violating an alert threshold
+     * - Check if a specific customer is currently violating an threshold notification
      *   (`in_alarm` status)
-     * - Verify alert configuration details and threshold values for a customer
-     * - Integrate alert status checks into customer support tools or admin interfaces
+     * - Verify threshold notification configuration details and threshold values for a
+     *   customer
+     * - Monitor the evaluation state of newly created or recently modified threshold
+     *   notification
+     * - Build dashboards or automated workflows that respond to specific threshold
+     *   notification conditions
+     * - Validate threshold notification behavior before deploying to production
+     *   customers
+     * - Integrate threshold notification status checks into customer support tools or
+     *   admin interfaces
      *
      * ### Key response fields:
      *
@@ -26,29 +35,32 @@ class Alerts extends resource_1.APIResource {
      * - `customer_status`: The current evaluation state
      *
      * - `ok` - Customer is within acceptable thresholds
-     * - `in_alarm`- Customer has breached the alert threshold
-     * - `evaluating` - Alert has yet to be evaluated (typically due to a customer or
-     *   alert having just been created)
-     * - `null` - Alert has been archived
-     * - `triggered_by`: Additional context about what caused the alert to trigger
-     *   (when applicable)
-     * - alert: Complete alert configuration including:
-     *   - Alert ID, name, and type
+     * - `in_alarm` - Customer has breached the threshold for the notification
+     * - `evaluating` - Notification is currently being evaluated (typically during
+     *   initial setup)
+     * - `null` - Notification has been archived
+     * - `triggered_by`: Additional context about what caused the notification to
+     *   trigger (when applicable)
+     * - alert: Complete threshold notification configuration including:
+     *   - Notification ID, name, and type
      *   - Current threshold values and credit type information
-     *   - Alert status (enabled, disabled, or archived)
+     *   - Notification status (enabled, disabled, or archived)
      *   - Last update timestamp
      *   - Any applied filters (credit grant types, custom fields, group values)
      *
      * ### Usage guidelines:
      *
      * - Customer status: Returns the current evaluation state, not historical data.
-     *   For alert history, use webhook notifications or event logs
-     * - Archived alerts: Returns null for customer_status if the alert has been
-     *   archived, but still includes the alert configuration details
-     * - Integration patterns: This endpoint can be used to check a customer's alert
-     *   status, but shouldn't be scraped. You should instead rely on the webhook
-     *   notification to understand when customers are moved to IN_ALARM.
-     * - Error handling: Returns 404 if either the customer or alert ID doesn't exist
+     *   For threshold notification history, use webhook notifications or event logs
+     * - Required parameters: Both customer_id and alert_id must be valid UUIDs that
+     *   exist in your organization
+     * - Archived notifications: Returns null for customer_status if the notification
+     *   has been archived, but still includes the notification configuration details
+     * - Performance considerations: This endpoint queries live evaluation state,
+     *   making it ideal for real-time monitoring but not for bulk status checks
+     * - Integration patterns: Best used for on-demand status checks in response to
+     *   user actions or as part of targeted monitoring workflows
+     * - Error handling: Returns 404 if either the customer or alert_id doesn't exist
      *   or isn't accessible to your organization
      *
      * @example
@@ -63,31 +75,37 @@ class Alerts extends resource_1.APIResource {
         return this._client.post('/v1/customer-alerts/get', { body, ...options });
     }
     /**
-     * Retrieve all alert configurations and their current statuses for a specific
-     * customer in a single API call. This endpoint provides a comprehensive view of
-     * all alerts monitoring a customer account.
+     * Retrieve all threshold notification configurations and their current statuses
+     * for a specific customer in a single API call. This endpoint provides a
+     * comprehensive view of all threshold notification monitoring a customer account.
      *
      * ### Use this endpoint to:
      *
-     * - Display all active alerts for a customer in dashboards or admin panels
-     * - Quickly identify which alerts a customer is currently triggering
-     * - Audit alert coverage for specific accounts
-     * - Filter alerts by status (enabled, disabled, or archived)
+     * - Display all active threshold notifications for a customer in dashboards or
+     *   admin panels
+     * - Quickly identify which threshold notifications a customer is currently
+     *   triggering
+     * - Audit threshold notification coverage for specific accounts
+     * - Filter threshold notifications by status (enabled, disabled, or archived)
      *
      * ### Key response fields:
      *
      * - data: Array of CustomerAlert objects, each containing:
      *   - Current evaluation status (`ok`, `in_alarm`, `evaluating`, or `null`)
-     *   - Complete alert configuration and threshold details
-     *   - Alert metadata including type, name, and last update time
-     * - `next_page`: Pagination cursor for retrieving additional results
+     *   - Complete threshold notification configuration and threshold details
+     *   - Threshold notification metadata including type, name, and last update time
+     * - next_page: Pagination cursor for retrieving additional results
      *
      * ### Usage guidelines:
      *
-     * - Default behavior: Returns only enabled alerts unless alert_statuses filter is
-     *   specified
+     * - Default behavior: Returns only enabled threshold notifications unless
+     *   `alert_statuses` filter is specified
      * - Pagination: Use the `next_page` cursor to retrieve all results for customers
-     *   with many alerts
+     *   with many notifications
+     * - Performance: Efficiently retrieves multiple threshold notification statuses in
+     *   a single request instead of making individual calls
+     * - Filtering: Pass the `alert_statuses` array to include disabled or archived
+     *   threshold notifications in results
      *
      * @example
      * ```ts
@@ -109,23 +127,24 @@ class Alerts extends resource_1.APIResource {
         });
     }
     /**
-     * Force an immediate re-evaluation of a specific alert for a customer, clearing
-     * any previous state and triggering a fresh assessment against current thresholds.
-     * This endpoint ensures alert accuracy after configuration changes or data
-     * corrections.
+     * Force an immediate re-evaluation of a specific threshold notification for a
+     * customer, clearing any previous state and triggering a fresh assessment against
+     * current thresholds. This endpoint ensures threshold notification accuracy after
+     * configuration changes or data corrections.
      *
      * ### Use this endpoint to:
      *
-     * - Clear false positive alerts after fixing data issues
-     * - Re-evaluate alerts after adjusting customer balances or credits
-     * - Test alert behavior during development and debugging
-     * - Resolve stuck alerts that may be in an incorrect state
+     * - Clear false positive threshold notifications after fixing data issues
+     * - Re-evaluate threshold notifications after adjusting customer balances or
+     *   credits
+     * - Test threshold notification behavior during development and debugging
+     * - Resolve stuck threshold notification that may be in an incorrect state
      * - Trigger immediate evaluation after threshold modifications
      *
      * ### Key response fields:
      *
-     * - 200 Success: Confirmation that the alert has been reset and re-evaluation
-     *   initiated
+     * - 200 Success: Confirmation that the threshold notification has been reset and
+     *   re-evaluation initiated
      * - No response body is returned - the operation completes asynchronously
      *
      * ### Usage guidelines:

package/resources/v1/customers/alerts.js.map

@@ -1 +1 @@
-{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,4DAIkC;AAClC,0DAAyD;AAGzD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,CACF,MAAuB,EACvB,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAA,mCAAqC,CAAA,EAAE;YAChG,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,IAAsB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAzJD,wBAyJC"}
+{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,4DAIkC;AAClC,0DAAyD;AAGzD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,MAAuB,EACvB,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAA,mCAAqC,CAAA,EAAE;YAChG,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,KAAK,CAAC,IAAsB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA5KD,wBA4KC"}