@roarkanalytics/sdk 3.7.0 → 3.9.0

package/src/resources/config.ts

@@ -49,6 +49,7 @@ export interface Bundle {
     | Bundle.ScriptedFlowConfig
     | Bundle.CollectorConfig
     | Bundle.MetricConfig
+    | Bundle.AlertConfig
   >;
 
   prune?: boolean;
@@ -362,6 +363,95 @@ export namespace Bundle {
       description?: string;
     }
   }
+
+  export interface AlertConfig {
+    kind: 'alert';
+
+    name: string;
+
+    trigger:
+      | AlertConfig.AlertThresholdTrigger
+      | AlertConfig.AlertEventTrigger
+      | AlertConfig.AlertSimulationTrigger;
+
+    actions?: AlertConfig.Actions;
+
+    enabled?: boolean;
+  }
+
+  export namespace AlertConfig {
+    export interface AlertThresholdTrigger {
+      aggregation: 'COUNT' | 'RATE_PER_MINUTE' | 'MEAN';
+
+      metric: string;
+
+      operator: 'GT' | 'GTE' | 'LT' | 'LTE';
+
+      thresholdValue: number;
+
+      type: 'threshold';
+
+      windowMinutes: number;
+
+      consecutiveOpen?: number;
+
+      consecutiveResolve?: number;
+
+      grouping?: 'NONE' | 'BY_AGENT';
+
+      metricVariant?: string;
+
+      minSampleSize?: number;
+    }
+
+    export interface AlertEventTrigger {
+      events: Array<
+        | 'CALL_ANALYSIS_COMPLETED'
+        | 'CALL_ANALYSIS_FAILED'
+        | 'CALL_ANALYSIS_CANCELLED'
+        | 'SIMULATION_RUN_PLAN_JOB_STARTED'
+        | 'SIMULATION_RUN_PLAN_JOB_COMPLETED'
+        | 'SIMULATION_RUN_PLAN_JOB_FAILED'
+        | 'SIMULATION_RUN_PLAN_JOB_CANCELLED'
+        | 'SIMULATION_JOB_STARTED'
+        | 'SIMULATION_JOB_COMPLETED'
+        | 'SIMULATION_JOB_FAILED'
+        | 'SIMULATION_JOB_CANCELLED'
+        | 'METRIC_COLLECTION_JOB_COMPLETED'
+        | 'METRIC_COLLECTION_JOB_FAILED'
+        | 'CHAT_ANALYSIS_COMPLETED'
+        | 'CHAT_ANALYSIS_FAILED'
+        | 'ISSUE_OPENED'
+        | 'ISSUE_RESOLVED'
+      >;
+
+      type: 'event';
+    }
+
+    export interface AlertSimulationTrigger {
+      conditions: Array<'SUCCESS' | 'FAILURE' | 'THRESHOLD_FAILED'>;
+
+      type: 'simulation';
+
+      deliveryFormat?: 'MESSAGE' | 'PDF';
+
+      runPlan?: string;
+    }
+
+    export interface Actions {
+      slack?: Array<Actions.Slack>;
+
+      webhooks?: Array<string>;
+    }
+
+    export namespace Actions {
+      export interface Slack {
+        channelId: string;
+
+        channelName: string;
+      }
+    }
+  }
 }
 
 export interface ConfigFlowStep {
@@ -405,7 +495,7 @@ export namespace ConfigApplyResponse {
     export interface Change {
       configKey: string;
 
-      kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric';
+      kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric' | 'alert';
 
       name: string;
 
@@ -449,7 +539,7 @@ export namespace ConfigDiffResponse {
     export interface Change {
       configKey: string;
 
-      kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric';
+      kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric' | 'alert';
 
       name: string;
 
@@ -478,6 +568,7 @@ export interface ConfigApplyParams {
     | ConfigApplyParams.ScriptedFlowConfig
     | ConfigApplyParams.CollectorConfig
     | ConfigApplyParams.MetricConfig
+    | ConfigApplyParams.AlertConfig
   >;
 
   prune?: boolean;
@@ -791,6 +882,95 @@ export namespace ConfigApplyParams {
       description?: string;
     }
   }
+
+  export interface AlertConfig {
+    kind: 'alert';
+
+    name: string;
+
+    trigger:
+      | AlertConfig.AlertThresholdTrigger
+      | AlertConfig.AlertEventTrigger
+      | AlertConfig.AlertSimulationTrigger;
+
+    actions?: AlertConfig.Actions;
+
+    enabled?: boolean;
+  }
+
+  export namespace AlertConfig {
+    export interface AlertThresholdTrigger {
+      aggregation: 'COUNT' | 'RATE_PER_MINUTE' | 'MEAN';
+
+      metric: string;
+
+      operator: 'GT' | 'GTE' | 'LT' | 'LTE';
+
+      thresholdValue: number;
+
+      type: 'threshold';
+
+      windowMinutes: number;
+
+      consecutiveOpen?: number;
+
+      consecutiveResolve?: number;
+
+      grouping?: 'NONE' | 'BY_AGENT';
+
+      metricVariant?: string;
+
+      minSampleSize?: number;
+    }
+
+    export interface AlertEventTrigger {
+      events: Array<
+        | 'CALL_ANALYSIS_COMPLETED'
+        | 'CALL_ANALYSIS_FAILED'
+        | 'CALL_ANALYSIS_CANCELLED'
+        | 'SIMULATION_RUN_PLAN_JOB_STARTED'
+        | 'SIMULATION_RUN_PLAN_JOB_COMPLETED'
+        | 'SIMULATION_RUN_PLAN_JOB_FAILED'
+        | 'SIMULATION_RUN_PLAN_JOB_CANCELLED'
+        | 'SIMULATION_JOB_STARTED'
+        | 'SIMULATION_JOB_COMPLETED'
+        | 'SIMULATION_JOB_FAILED'
+        | 'SIMULATION_JOB_CANCELLED'
+        | 'METRIC_COLLECTION_JOB_COMPLETED'
+        | 'METRIC_COLLECTION_JOB_FAILED'
+        | 'CHAT_ANALYSIS_COMPLETED'
+        | 'CHAT_ANALYSIS_FAILED'
+        | 'ISSUE_OPENED'
+        | 'ISSUE_RESOLVED'
+      >;
+
+      type: 'event';
+    }
+
+    export interface AlertSimulationTrigger {
+      conditions: Array<'SUCCESS' | 'FAILURE' | 'THRESHOLD_FAILED'>;
+
+      type: 'simulation';
+
+      deliveryFormat?: 'MESSAGE' | 'PDF';
+
+      runPlan?: string;
+    }
+
+    export interface Actions {
+      slack?: Array<Actions.Slack>;
+
+      webhooks?: Array<string>;
+    }
+
+    export namespace Actions {
+      export interface Slack {
+        channelId: string;
+
+        channelName: string;
+      }
+    }
+  }
 }
 
 export interface ConfigDiffParams {
@@ -801,6 +981,7 @@ export interface ConfigDiffParams {
     | ConfigDiffParams.ScriptedFlowConfig
     | ConfigDiffParams.CollectorConfig
     | ConfigDiffParams.MetricConfig
+    | ConfigDiffParams.AlertConfig
   >;
 
   prune?: boolean;
@@ -1114,6 +1295,95 @@ export namespace ConfigDiffParams {
       description?: string;
     }
   }
+
+  export interface AlertConfig {
+    kind: 'alert';
+
+    name: string;
+
+    trigger:
+      | AlertConfig.AlertThresholdTrigger
+      | AlertConfig.AlertEventTrigger
+      | AlertConfig.AlertSimulationTrigger;
+
+    actions?: AlertConfig.Actions;
+
+    enabled?: boolean;
+  }
+
+  export namespace AlertConfig {
+    export interface AlertThresholdTrigger {
+      aggregation: 'COUNT' | 'RATE_PER_MINUTE' | 'MEAN';
+
+      metric: string;
+
+      operator: 'GT' | 'GTE' | 'LT' | 'LTE';
+
+      thresholdValue: number;
+
+      type: 'threshold';
+
+      windowMinutes: number;
+
+      consecutiveOpen?: number;
+
+      consecutiveResolve?: number;
+
+      grouping?: 'NONE' | 'BY_AGENT';
+
+      metricVariant?: string;
+
+      minSampleSize?: number;
+    }
+
+    export interface AlertEventTrigger {
+      events: Array<
+        | 'CALL_ANALYSIS_COMPLETED'
+        | 'CALL_ANALYSIS_FAILED'
+        | 'CALL_ANALYSIS_CANCELLED'
+        | 'SIMULATION_RUN_PLAN_JOB_STARTED'
+        | 'SIMULATION_RUN_PLAN_JOB_COMPLETED'
+        | 'SIMULATION_RUN_PLAN_JOB_FAILED'
+        | 'SIMULATION_RUN_PLAN_JOB_CANCELLED'
+        | 'SIMULATION_JOB_STARTED'
+        | 'SIMULATION_JOB_COMPLETED'
+        | 'SIMULATION_JOB_FAILED'
+        | 'SIMULATION_JOB_CANCELLED'
+        | 'METRIC_COLLECTION_JOB_COMPLETED'
+        | 'METRIC_COLLECTION_JOB_FAILED'
+        | 'CHAT_ANALYSIS_COMPLETED'
+        | 'CHAT_ANALYSIS_FAILED'
+        | 'ISSUE_OPENED'
+        | 'ISSUE_RESOLVED'
+      >;
+
+      type: 'event';
+    }
+
+    export interface AlertSimulationTrigger {
+      conditions: Array<'SUCCESS' | 'FAILURE' | 'THRESHOLD_FAILED'>;
+
+      type: 'simulation';
+
+      deliveryFormat?: 'MESSAGE' | 'PDF';
+
+      runPlan?: string;
+    }
+
+    export interface Actions {
+      slack?: Array<Actions.Slack>;
+
+      webhooks?: Array<string>;
+    }
+
+    export namespace Actions {
+      export interface Slack {
+        channelId: string;
+
+        channelName: string;
+      }
+    }
+  }
 }
 
 export declare namespace Config {

package/src/resources/metric.ts

@@ -159,6 +159,16 @@ export namespace MetricCreateDefinitionResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -262,6 +272,16 @@ export namespace MetricCreateDefinitionResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -382,6 +402,16 @@ export namespace MetricCreateDefinitionResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -572,6 +602,16 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -670,6 +710,16 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -768,6 +818,16 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -901,6 +961,16 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -1021,6 +1091,16 @@ export namespace MetricListDefinitionsResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -1215,6 +1295,16 @@ export namespace MetricUpdateDefinitionResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -1318,6 +1408,16 @@ export namespace MetricUpdateDefinitionResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -1438,6 +1538,16 @@ export namespace MetricUpdateDefinitionResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */
@@ -1593,6 +1703,16 @@ export namespace MetricUpdateDefinitionResponse {
      */
     supportedConversationSources: Array<'SIMULATED' | 'LIVE'> | null;
 
+    /**
+     * Whether you can create a variant of this metric with POST
+     * /v1/metric/definitions/{idOrSlug}/variants. False for threshold metrics (their
+     * configuration comes from the metric they derive from), for provider-computed
+     * metrics whose calculation lives in the collector rather than an editable prompt,
+     * and for metrics in a package that manages its own variants. Most of Roark’s own
+     * metrics are false, so read this rather than discovering it from a 403.
+     */
+    supportsVariants: boolean;
+
     /**
      * Type of value this metric produces
      */

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

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

package/version.js

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

package/version.mjs

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