@roarkanalytics/sdk 5.4.0 → 5.5.0

package/resources/customer-flow.d.ts

@@ -495,6 +495,12 @@ export declare namespace CustomerFlowCreateResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -708,6 +714,12 @@ export declare namespace CustomerFlowCreateResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -1014,6 +1026,12 @@ export declare namespace CustomerFlowCreateResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<EdgeCase.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -1370,6 +1388,12 @@ export declare namespace CustomerFlowCreateResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<HappyPath.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -1790,6 +1814,12 @@ export declare namespace CustomerFlowCreateResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -1997,6 +2027,12 @@ export declare namespace CustomerFlowCreateResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -2320,6 +2356,12 @@ export declare namespace CustomerFlowUpdateResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -2533,6 +2575,12 @@ export declare namespace CustomerFlowUpdateResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -2839,6 +2887,12 @@ export declare namespace CustomerFlowUpdateResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<EdgeCase.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -3195,6 +3249,12 @@ export declare namespace CustomerFlowUpdateResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<HappyPath.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -3615,6 +3675,12 @@ export declare namespace CustomerFlowUpdateResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -3822,6 +3888,12 @@ export declare namespace CustomerFlowUpdateResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -4146,6 +4218,12 @@ export declare namespace CustomerFlowListResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -4359,6 +4437,12 @@ export declare namespace CustomerFlowListResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -4665,6 +4749,12 @@ export declare namespace CustomerFlowListResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<EdgeCase.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -5021,6 +5111,12 @@ export declare namespace CustomerFlowListResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<HappyPath.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -5441,6 +5537,12 @@ export declare namespace CustomerFlowListResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -5648,6 +5750,12 @@ export declare namespace CustomerFlowListResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -5996,6 +6104,12 @@ export declare namespace CustomerFlowDuplicateResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -6209,6 +6323,12 @@ export declare namespace CustomerFlowDuplicateResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -6515,6 +6635,12 @@ export declare namespace CustomerFlowDuplicateResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<EdgeCase.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -6871,6 +6997,12 @@ export declare namespace CustomerFlowDuplicateResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<HappyPath.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -7291,6 +7423,12 @@ export declare namespace CustomerFlowDuplicateResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -7498,6 +7636,12 @@ export declare namespace CustomerFlowDuplicateResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -7821,6 +7965,12 @@ export declare namespace CustomerFlowGetByIDResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -8034,6 +8184,12 @@ export declare namespace CustomerFlowGetByIDResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -8340,6 +8496,12 @@ export declare namespace CustomerFlowGetByIDResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<EdgeCase.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -8696,6 +8858,12 @@ export declare namespace CustomerFlowGetByIDResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<HappyPath.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -9116,6 +9284,12 @@ export declare namespace CustomerFlowGetByIDResponse {
              * project.
              */
             environment: EdgeCase.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -9323,6 +9497,12 @@ export declare namespace CustomerFlowGetByIDResponse {
              * project.
              */
             environment: HappyPath.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -9555,6 +9735,12 @@ export declare namespace CustomerFlowReplaceGraphResponse {
              * project.
              */
             environment: ScriptedFlowVariant.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -9772,6 +9958,12 @@ export declare namespace CustomerFlowReplaceGraphResponse {
              * when the brief inherits the happy path's: read the happy path's list.
              */
             handoffPersonas: Array<ImprovFlowVariant.HandoffPersona>;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -10123,6 +10315,12 @@ export declare namespace CustomerFlowReplaceGraphResponse {
              * project.
              */
             environment: VoicemailFlowVariant.Environment | null;
+            /**
+             * Whether this variant is graded on the flow's agentExpectations as well as its
+             * additionalExpectations. False grades it on its additionalExpectations only.
+             * Always true on the happy path.
+             */
+            includeFlowExpectations: boolean;
             isGenerated: boolean;
             /**
              * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -10340,6 +10538,12 @@ export declare namespace CustomerFlowUpdateHappyPathResponse {
          * project.
          */
         environment: ScriptedFlowVariant.Environment | null;
+        /**
+         * Whether this variant is graded on the flow's agentExpectations as well as its
+         * additionalExpectations. False grades it on its additionalExpectations only.
+         * Always true on the happy path.
+         */
+        includeFlowExpectations: boolean;
         isGenerated: boolean;
         /**
          * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -10557,6 +10761,12 @@ export declare namespace CustomerFlowUpdateHappyPathResponse {
          * when the brief inherits the happy path's: read the happy path's list.
          */
         handoffPersonas: Array<ImprovFlowVariant.HandoffPersona>;
+        /**
+         * Whether this variant is graded on the flow's agentExpectations as well as its
+         * additionalExpectations. False grades it on its additionalExpectations only.
+         * Always true on the happy path.
+         */
+        includeFlowExpectations: boolean;
         isGenerated: boolean;
         /**
          * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -10908,6 +11118,12 @@ export declare namespace CustomerFlowUpdateHappyPathResponse {
          * project.
          */
         environment: VoicemailFlowVariant.Environment | null;
+        /**
+         * Whether this variant is graded on the flow's agentExpectations as well as its
+         * additionalExpectations. False grades it on its additionalExpectations only.
+         * Always true on the happy path.
+         */
+        includeFlowExpectations: boolean;
         isGenerated: boolean;
         /**
          * The persona this runs as instead of the happy path's. Null means it inherits.
@@ -11246,6 +11462,12 @@ export declare namespace CustomerFlowCreateParams {
              */
             additionalExpectations?: Array<EdgeCase.AdditionalExpectation>;
             environmentId?: string | null;
+            /**
+             * Whether this edge case is graded on the flow's agentExpectations as well as its
+             * own additionalExpectations. Defaults to true; false grades it on its
+             * additionalExpectations only.
+             */
+            includeFlowExpectations?: boolean;
             /**
              * The persona this runs as. Omit to inherit the happy path's.
              */
@@ -11377,6 +11599,12 @@ export interface CustomerFlowUpdateHappyPathParams {
      */
     additionalExpectations?: Array<CustomerFlowUpdateHappyPathParams.AdditionalExpectation>;
     environmentId?: string | null;
+    /**
+     * Whether this edge case is graded on the flow's agentExpectations as well as its
+     * own additionalExpectations. Defaults to true; false grades it on its
+     * additionalExpectations only.
+     */
+    includeFlowExpectations?: boolean;
     /**
      * The persona this runs as. Null on an edge case inherits the happy path's.
      */