@roarkanalytics/sdk 3.21.0 → 4.0.0

package/src/resources/customer-flow.ts

@@ -211,15 +211,32 @@ export class CustomerFlow extends APIResource {
  * flow's policy. Use it where one missed step makes the rest of the call
  * meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.
  *
- * Any step may set `requiredForValidRun`, which marks a step the flow requires a
- * run to reach for its result to count. A run that ends without ever reaching it
- * is invalidated: it stays in the report, labelled with the step it never reached
- * and where it stopped, and is left out of the run score and the success-criteria
- * verdict. Put it on the step where the test itself begins, typically the first
- * one after an IVR or a login, so an agent that never gets past the menu does not
- * fail every check in a scenario it never started. A path may have one; a
- * branching flow may mark one step per branch, and reaching any of them makes the
- * call valid. A path that marks none behaves exactly as before.
+ * Any step may set `stage`, the named phase of the flow it belongs to: the IVR,
+ * the login, the scenario itself. Steps in one stage are drawn as a group in the
+ * editor, and the name is yours: the reports say it back to you. The stage does
+ * not have to exist first, it is created the first time a step names it, and a
+ * name already in the project is matched ignoring case.
+ *
+ * A stage with `required: true` is a gate. A run that ends without getting PAST it
+ * never reached what was being measured, so it stays in the report, labelled with
+ * the stage it never completed and the one it stopped in, and is left out of the
+ * run score and the success-criteria verdict: an agent that never clears the IVR
+ * does not fail every check in a scenario it never started. `required` belongs to
+ * the stage rather than to the step, so a read returns it on every step in that
+ * stage, and a write that sets it on any one of them marks the whole stage. A flow
+ * that requires no stage is scored exactly as before.
+ *
+ * A stage with `analyze: false` is not measured. Its turns are kept out of the
+ * core call metrics (talk time, speech pace, turn and response timings), which is
+ * what an IVR usually wants alongside `required: true`: the run has to get through
+ * the menu, but how the agent sounded reading it is not what is being tested.
+ * Coverage is being extended package by package, so the judged metrics (quality,
+ * compliance, repetition, escalation, tone) still read the whole call for now.
+ * Nothing is cut and nothing is re-timed, so a turn at 4:10 is still at 4:10 with
+ * an earlier stage excluded, and rate metrics divide by the part of the call that
+ * was measured rather than by the whole of it. Defaults to true, belongs to the
+ * stage the same way `required` does, and turning it off on any one step turns it
+ * off for the stage.
  */
 export type FlowStep =
   | FlowStep.UnionMember0
@@ -247,7 +264,7 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
+    stage?: UnionMember0.Stage | null;
 
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
@@ -264,6 +281,14 @@ export namespace FlowStep {
 
       waitSeconds?: number | null;
     }
+
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
   }
 
   export interface UnionMember1 {
@@ -277,11 +302,21 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
+    stage?: UnionMember1.Stage | null;
 
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
 
+  export namespace UnionMember1 {
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
+  }
+
   export interface UnionMember2 {
     type: 'CUSTOMER_FIRST_MESSAGE';
 
@@ -293,11 +328,21 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
+    stage?: UnionMember2.Stage | null;
 
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
 
+  export namespace UnionMember2 {
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
+  }
+
   export interface UnionMember3 {
     type: 'CUSTOMER_VERBATIM_TURN';
 
@@ -309,11 +354,21 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
+    stage?: UnionMember3.Stage | null;
 
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
 
+  export namespace UnionMember3 {
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
+  }
+
   export interface UnionMember4 {
     type: 'CUSTOMER_SILENCE';
 
@@ -323,13 +378,23 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
-
     silenceDurationSeconds?: number | null;
 
+    stage?: UnionMember4.Stage | null;
+
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
 
+  export namespace UnionMember4 {
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
+  }
+
   export interface UnionMember5 {
     type: 'CUSTOMER_DTMF';
 
@@ -341,11 +406,21 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
+    stage?: UnionMember5.Stage | null;
 
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
 
+  export namespace UnionMember5 {
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
+  }
+
   export interface UnionMember6 {
     type: 'AGENT_DTMF';
 
@@ -357,11 +432,21 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
+    stage?: UnionMember6.Stage | null;
 
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
 
+  export namespace UnionMember6 {
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
+  }
+
   export interface UnionMember7 {
     type: 'VOICEMAIL';
 
@@ -371,11 +456,21 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
+    stage?: UnionMember7.Stage | null;
 
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
 
+  export namespace UnionMember7 {
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
+  }
+
   export interface UnionMember8 {
     type: 'CUSTOMER_HANDOFF';
 
@@ -387,11 +482,21 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
+    stage?: UnionMember8.Stage | null;
 
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
 
+  export namespace UnionMember8 {
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
+  }
+
   export interface UnionMember9 {
     type: 'SCENARIO_LINK';
 
@@ -405,10 +510,20 @@ export namespace FlowStep {
 
     ref?: string;
 
-    requiredForValidRun?: boolean;
+    stage?: UnionMember9.Stage | null;
 
     steps?: Array<CustomerFlowAPI.FlowStep>;
   }
+
+  export namespace UnionMember9 {
+    export interface Stage {
+      name: string;
+
+      analyze?: boolean;
+
+      required?: boolean;
+    }
+  }
 }
 
 export interface CustomerFlowCreateResponse {

package/src/resources/index.ts

@@ -29,20 +29,20 @@ export {
   type AgentPromptListVersionsParams,
 } from './agent-prompt';
 export {
-  AutoimproveFix,
+  AutoimproveJob,
   type AutoimproveLogEntry,
-  type AutoimproveFixCreateResponse,
-  type AutoimproveFixListResponse,
-  type AutoimproveFixAnswerQuestionResponse,
-  type AutoimproveFixCancelResponse,
-  type AutoimproveFixDismissResponse,
-  type AutoimproveFixGetByIDResponse,
-  type AutoimproveFixPromoteResponse,
-  type AutoimproveFixSendGuidanceResponse,
-  type AutoimproveFixCreateParams,
-  type AutoimproveFixAnswerQuestionParams,
-  type AutoimproveFixSendGuidanceParams,
-} from './autoimprove-fix';
+  type AutoimproveJobCreateResponse,
+  type AutoimproveJobListResponse,
+  type AutoimproveJobAnswerQuestionResponse,
+  type AutoimproveJobCancelResponse,
+  type AutoimproveJobDismissResponse,
+  type AutoimproveJobGetByIDResponse,
+  type AutoimproveJobPromoteResponse,
+  type AutoimproveJobSendGuidanceResponse,
+  type AutoimproveJobCreateParams,
+  type AutoimproveJobAnswerQuestionParams,
+  type AutoimproveJobSendGuidanceParams,
+} from './autoimprove-job';
 export {
   Benchmark,
   type BenchmarkGetLeaderboardResponse,

package/src/resources/simulation-job.ts

@@ -219,7 +219,7 @@ export namespace SimulationJobGetByIDResponse {
        * Why the result does not count. `SCRIPT_DIVERGED`: a strict flow went off script
        * at a step whose off-script policy is HANG_UP_INVALIDATE.
        */
-      reason: 'SCRIPT_DIVERGED' | 'REQUIRED_STEP_NOT_REACHED';
+      reason: 'SCRIPT_DIVERGED' | 'REQUIRED_STEP_NOT_REACHED' | 'REQUIRED_STAGE_INCOMPLETE';
 
       /**
        * One sentence: where the script was left and what your agent did instead.
@@ -682,7 +682,7 @@ export namespace SimulationJobLookupResponse {
        * Why the result does not count. `SCRIPT_DIVERGED`: a strict flow went off script
        * at a step whose off-script policy is HANG_UP_INVALIDATE.
        */
-      reason: 'SCRIPT_DIVERGED' | 'REQUIRED_STEP_NOT_REACHED';
+      reason: 'SCRIPT_DIVERGED' | 'REQUIRED_STEP_NOT_REACHED' | 'REQUIRED_STAGE_INCOMPLETE';
 
       /**
        * One sentence: where the script was left and what your agent did instead.

package/src/resources/simulation-run-plan-job.ts

@@ -399,7 +399,7 @@ export namespace SimulationRunPlanJobGetByIDResponse {
          * Why the result does not count. `SCRIPT_DIVERGED`: a strict flow went off script
          * at a step whose off-script policy is HANG_UP_INVALIDATE.
          */
-        reason: 'SCRIPT_DIVERGED' | 'REQUIRED_STEP_NOT_REACHED';
+        reason: 'SCRIPT_DIVERGED' | 'REQUIRED_STEP_NOT_REACHED' | 'REQUIRED_STAGE_INCOMPLETE';
 
         /**
          * One sentence: where the script was left and what your agent did instead.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.21.0'; // x-release-please-version
+export const VERSION = '4.0.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.21.0";
+export declare const VERSION = "4.0.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,WAAW,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.21.0";
+export declare const VERSION = "4.0.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,WAAW,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '3.21.0'; // x-release-please-version
+exports.VERSION = '4.0.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,QAAQ,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '3.21.0'; // x-release-please-version
+export const VERSION = '4.0.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,QAAQ,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}