@roarkanalytics/sdk 3.17.0 → 3.19.0

package/resources/customer-flow.d.ts

@@ -163,6 +163,16 @@ export declare class CustomerFlow extends APIResource {
  * replaces the flow-level one at that step. Omit it (or send null) to follow the
  * 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.
  */
 export type FlowStep = FlowStep.UnionMember0 | FlowStep.UnionMember1 | FlowStep.UnionMember2 | FlowStep.UnionMember3 | FlowStep.UnionMember4 | FlowStep.UnionMember5 | FlowStep.UnionMember6 | FlowStep.UnionMember7 | FlowStep.UnionMember8 | FlowStep.UnionMember9;
 export declare namespace FlowStep {
@@ -173,6 +183,7 @@ export declare namespace FlowStep {
         nodeId?: string;
         offScriptPolicy?: UnionMember0.OffScriptPolicy | null;
         ref?: string;
+        requiredForValidRun?: boolean;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
     namespace UnionMember0 {
@@ -190,6 +201,7 @@ export declare namespace FlowStep {
         mergeIntoNodeIds?: Array<string>;
         nodeId?: string;
         ref?: string;
+        requiredForValidRun?: boolean;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
     interface UnionMember2 {
@@ -198,6 +210,7 @@ export declare namespace FlowStep {
         mergeIntoNodeIds?: Array<string>;
         nodeId?: string;
         ref?: string;
+        requiredForValidRun?: boolean;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
     interface UnionMember3 {
@@ -206,6 +219,7 @@ export declare namespace FlowStep {
         mergeIntoNodeIds?: Array<string>;
         nodeId?: string;
         ref?: string;
+        requiredForValidRun?: boolean;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
     interface UnionMember4 {
@@ -213,6 +227,7 @@ export declare namespace FlowStep {
         mergeIntoNodeIds?: Array<string>;
         nodeId?: string;
         ref?: string;
+        requiredForValidRun?: boolean;
         silenceDurationSeconds?: number | null;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
@@ -222,6 +237,7 @@ export declare namespace FlowStep {
         mergeIntoNodeIds?: Array<string>;
         nodeId?: string;
         ref?: string;
+        requiredForValidRun?: boolean;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
     interface UnionMember6 {
@@ -230,6 +246,7 @@ export declare namespace FlowStep {
         mergeIntoNodeIds?: Array<string>;
         nodeId?: string;
         ref?: string;
+        requiredForValidRun?: boolean;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
     interface UnionMember7 {
@@ -237,6 +254,7 @@ export declare namespace FlowStep {
         mergeIntoNodeIds?: Array<string>;
         nodeId?: string;
         ref?: string;
+        requiredForValidRun?: boolean;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
     interface UnionMember8 {
@@ -245,6 +263,7 @@ export declare namespace FlowStep {
         mergeIntoNodeIds?: Array<string>;
         nodeId?: string;
         ref?: string;
+        requiredForValidRun?: boolean;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
     interface UnionMember9 {
@@ -254,6 +273,7 @@ export declare namespace FlowStep {
         mergeIntoNodeIds?: Array<string>;
         nodeId?: string;
         ref?: string;
+        requiredForValidRun?: boolean;
         steps?: Array<CustomerFlowAPI.FlowStep>;
     }
 }