@roarkanalytics/sdk 2.23.1 → 2.24.0

package/src/resources/index.ts

@@ -34,21 +34,7 @@ export {
   type CallGetTranscriptParams,
   type CallListMetricsParams,
 } from './call';
-export {
-  Evaluation,
-  type EvaluationCreateEvaluatorResponse,
-  type EvaluationCreateJobResponse,
-  type EvaluationGetEvaluatorByIDResponse,
-  type EvaluationGetJobResponse,
-  type EvaluationListEvaluatorsResponse,
-  type EvaluationListJobRunsResponse,
-  type EvaluationUpdateEvaluatorResponse,
-  type EvaluationCreateEvaluatorParams,
-  type EvaluationCreateJobParams,
-  type EvaluationListEvaluatorsParams,
-  type EvaluationListJobRunsParams,
-  type EvaluationUpdateEvaluatorParams,
-} from './evaluation';
+export { Evaluation } from './evaluation';
 export {
   HTTPRequestDefinition,
   type HTTPRequestDefinitionCreateResponse,
@@ -60,13 +46,7 @@ export {
   type HTTPRequestDefinitionListParams,
 } from './http-request-definition';
 export { Health, type HealthGetResponse } from './health';
-export {
-  Integrations,
-  type IntegrationCreateRetellCallResponse,
-  type IntegrationCreateVapiCallResponse,
-  type IntegrationCreateRetellCallParams,
-  type IntegrationCreateVapiCallParams,
-} from './integrations';
+export { Integrations } from './integrations';
 export { Metric, type MetricListDefinitionsResponse } from './metric';
 export {
   SimulationJob,
@@ -101,6 +81,7 @@ export {
   type SimulationRunPlanJobGetByIDResponse,
   type SimulationRunPlanJobStartResponse,
   type SimulationRunPlanJobListParams,
+  type SimulationRunPlanJobStartParams,
 } from './simulation-run-plan-job';
 export {
   SimulationScenario,

package/src/resources/integrations.ts

@@ -1,135 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
-import { RequestOptions } from '../internal/request-options';
 
-export class Integrations extends APIResource {
-  /**
-   * Process and upload a Retell call to Roark evaluation
-   *
-   * @example
-   * ```ts
-   * const response = await client.integrations.createRetellCall(
-   *   { retellCallEndedPayload: { event: 'bar', call: 'bar' } },
-   * );
-   * ```
-   */
-  createRetellCall(
-    body: IntegrationCreateRetellCallParams,
-    options?: RequestOptions,
-  ): APIPromise<IntegrationCreateRetellCallResponse> {
-    return this._client.post('/v1/retell/call', { body, ...options });
-  }
-
-  /**
-   * Process and upload a VAPI call to Roark evaluation
-   *
-   * @example
-   * ```ts
-   * const response = await client.integrations.createVapiCall({
-   *   vapiEndOfCallReportPayload: {
-   *     call: 'bar',
-   *     type: 'bar',
-   *     status: 'bar',
-   *     assistant: 'bar',
-   *     customer: 'bar',
-   *     phoneNumber: 'bar',
-   *     artifact: 'bar',
-   *     startedAt: 'bar',
-   *     endedAt: 'bar',
-   *     endedReason: 'bar',
-   *   },
-   * });
-   * ```
-   */
-  createVapiCall(
-    body: IntegrationCreateVapiCallParams,
-    options?: RequestOptions,
-  ): APIPromise<IntegrationCreateVapiCallResponse> {
-    return this._client.post('/v1/vapi/call', { body, ...options });
-  }
-}
-
-export interface IntegrationCreateRetellCallResponse {
-  /**
-   * Retell call upload response
-   */
-  data: IntegrationCreateRetellCallResponse.Data;
-}
-
-export namespace IntegrationCreateRetellCallResponse {
-  /**
-   * Retell call upload response
-   */
-  export interface Data {
-    /**
-     * ID of the uploaded call
-     */
-    callId: string;
-  }
-}
-
-export interface IntegrationCreateVapiCallResponse {
-  /**
-   * Vapi call upload response
-   */
-  data: IntegrationCreateVapiCallResponse.Data;
-}
-
-export namespace IntegrationCreateVapiCallResponse {
-  /**
-   * Vapi call upload response
-   */
-  export interface Data {
-    /**
-     * ID of the uploaded call
-     */
-    callId: string;
-  }
-}
-
-export interface IntegrationCreateRetellCallParams {
-  /**
-   * Raw Retell data forwarded directly from the Retell call_ended webhook
-   */
-  retellCallEndedPayload: { [key: string]: unknown };
-
-  /**
-   * Optional metadata (key-value pairs) to include with the call. Useful for
-   * filtering and display in call details.
-   */
-  properties?: { [key: string]: unknown };
-
-  /**
-   * Skip already imported Retell calls with the same Retell call id.
-   */
-  skipAlreadyImported?: boolean;
-}
-
-export interface IntegrationCreateVapiCallParams {
-  /**
-   * Raw Vapi data forwarded directly from the Vapi end-of-call-report webhook
-   */
-  vapiEndOfCallReportPayload: { [key: string]: unknown };
-
-  /**
-   * Optional metadata (key-value pairs) to include with the call. Useful for
-   * filtering and display in call details.
-   */
-  properties?: { [key: string]: unknown };
-
-  /**
-   * Skip already imported Vapi calls with the same Vapi call id.
-   */
-  skipAlreadyImported?: boolean;
-}
-
-export declare namespace Integrations {
-  export {
-    type IntegrationCreateRetellCallResponse as IntegrationCreateRetellCallResponse,
-    type IntegrationCreateVapiCallResponse as IntegrationCreateVapiCallResponse,
-    type IntegrationCreateRetellCallParams as IntegrationCreateRetellCallParams,
-    type IntegrationCreateVapiCallParams as IntegrationCreateVapiCallParams,
-  };
-}
+export class Integrations extends APIResource {}

package/src/resources/metric.ts

@@ -38,7 +38,7 @@ export namespace MetricListDefinitionsResponse {
     description: string;
 
     /**
-     * Stable metric identifier
+     * Stable metric identifier (e.g. "call_reason", "customer_satisfaction")
      */
     metricId: string;
 

package/src/resources/simulation-job.ts

@@ -223,6 +223,12 @@ export namespace SimulationJobGetByIDResponse {
        */
       properties: { [key: string]: unknown };
 
+      /**
+       * Controls how quickly the persona responds to pauses in conversation (QUICK,
+       * NORMAL, RELAXED)
+       */
+      responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
+
       /**
        * Speech clarity of the persona
        */
@@ -454,6 +460,12 @@ export namespace SimulationJobLookupResponse {
        */
       properties: { [key: string]: unknown };
 
+      /**
+       * Controls how quickly the persona responds to pauses in conversation (QUICK,
+       * NORMAL, RELAXED)
+       */
+      responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
+
       /**
        * Speech clarity of the persona
        */

package/src/resources/simulation-persona.ts

@@ -170,6 +170,12 @@ export namespace SimulationPersonaCreateResponse {
      */
     properties: { [key: string]: unknown };
 
+    /**
+     * Controls how quickly the persona responds to pauses in conversation (QUICK,
+     * NORMAL, RELAXED)
+     */
+    responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
+
     /**
      * Speech clarity of the persona
      */
@@ -297,6 +303,12 @@ export namespace SimulationPersonaUpdateResponse {
      */
     properties: { [key: string]: unknown };
 
+    /**
+     * Controls how quickly the persona responds to pauses in conversation (QUICK,
+     * NORMAL, RELAXED)
+     */
+    responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
+
     /**
      * Speech clarity of the persona
      */
@@ -426,6 +438,12 @@ export namespace SimulationPersonaListResponse {
      */
     properties: { [key: string]: unknown };
 
+    /**
+     * Controls how quickly the persona responds to pauses in conversation (QUICK,
+     * NORMAL, RELAXED)
+     */
+    responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
+
     /**
      * Speech clarity of the persona
      */
@@ -570,6 +588,12 @@ export namespace SimulationPersonaGetByIDResponse {
      */
     properties: { [key: string]: unknown };
 
+    /**
+     * Controls how quickly the persona responds to pauses in conversation (QUICK,
+     * NORMAL, RELAXED)
+     */
+    responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
+
     /**
      * Speech clarity of the persona
      */
@@ -692,6 +716,12 @@ export interface SimulationPersonaCreateParams {
    */
   properties?: { [key: string]: unknown };
 
+  /**
+   * Controls how quickly the persona responds to pauses in conversation (QUICK,
+   * NORMAL, RELAXED)
+   */
+  responseTiming?: 'RELAXED' | 'NORMAL' | 'QUICK';
+
   /**
    * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
    */
@@ -798,6 +828,12 @@ export interface SimulationPersonaUpdateParams {
    */
   properties?: { [key: string]: unknown };
 
+  /**
+   * Controls how quickly the persona responds to pauses in conversation (QUICK,
+   * NORMAL, RELAXED)
+   */
+  responseTiming?: 'RELAXED' | 'NORMAL' | 'QUICK';
+
   /**
    * Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
    */

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

@@ -39,7 +39,8 @@ export class SimulationRunPlanJob extends APIResource {
   }
 
   /**
-   * Create and execute a job for an existing simulation run plan
+   * Create and execute a job for an existing simulation run plan. Optionally provide
+   * runtime variables to override plan-defined variables.
    *
    * @example
    * ```ts
@@ -48,8 +49,12 @@ export class SimulationRunPlanJob extends APIResource {
    * );
    * ```
    */
-  start(planID: unknown, options?: RequestOptions): APIPromise<SimulationRunPlanJobStartResponse> {
-    return this._client.post(path`/v1/simulation/plan/${planID}/job`, options);
+  start(
+    planID: unknown,
+    body: SimulationRunPlanJobStartParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SimulationRunPlanJobStartResponse> {
+    return this._client.post(path`/v1/simulation/plan/${planID}/job`, { body, ...options });
   }
 }
 
@@ -210,6 +215,7 @@ export namespace SimulationRunPlanJobGetByIDResponse {
         | 'SIMULATING'
         | 'ANALYZING'
         | 'EVALUATING'
+        | 'COLLECTING_METRICS'
         | 'COMPLETED';
 
       /**
@@ -374,6 +380,12 @@ export namespace SimulationRunPlanJobGetByIDResponse {
          */
         properties: { [key: string]: unknown };
 
+        /**
+         * Controls how quickly the persona responds to pauses in conversation (QUICK,
+         * NORMAL, RELAXED)
+         */
+        responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
+
         /**
          * Speech clarity of the persona
          */
@@ -511,11 +523,41 @@ export interface SimulationRunPlanJobListParams {
     | 'CANCELLING';
 }
 
+export interface SimulationRunPlanJobStartParams {
+  /**
+   * Runtime variables that override plan-defined scenario variables. Accepts one of
+   * two formats:
+   *
+   * Option 1 — Global (flat key-value object, applies to ALL scenarios): {
+   * "orderNumber": "12345", "environment": "staging" }
+   *
+   * Option 2 — Per-scenario (array of objects with scenarioId + variables): [ {
+   * "scenarioId": "550e8400-...", "variables": { "orderNumber": "12345" } }, {
+   * "scenarioId": "7a3d2e1f-...", "variables": { "orderNumber": "67890" } } ]
+   */
+  variables?: { [key: string]: string } | Array<SimulationRunPlanJobStartParams.UnionMember1>;
+}
+
+export namespace SimulationRunPlanJobStartParams {
+  export interface UnionMember1 {
+    /**
+     * ID of the scenario to apply variables to
+     */
+    scenarioId: string;
+
+    /**
+     * Key-value pairs for this scenario
+     */
+    variables: { [key: string]: string };
+  }
+}
+
 export declare namespace SimulationRunPlanJob {
   export {
     type SimulationRunPlanJobListResponse as SimulationRunPlanJobListResponse,
     type SimulationRunPlanJobGetByIDResponse as SimulationRunPlanJobGetByIDResponse,
     type SimulationRunPlanJobStartResponse as SimulationRunPlanJobStartResponse,
     type SimulationRunPlanJobListParams as SimulationRunPlanJobListParams,
+    type SimulationRunPlanJobStartParams as SimulationRunPlanJobStartParams,
   };
 }

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

@@ -18,10 +18,10 @@ export class SimulationRunPlan extends APIResource {
    *       { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    *     ],
    *     direction: 'INBOUND',
-   *     evaluators: [
+   *     maxSimulationDurationSeconds: 300,
+   *     metrics: [
    *       { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    *     ],
-   *     maxSimulationDurationSeconds: 300,
    *     name: 'My Run Plan',
    *     personas: [
    *       { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
@@ -154,7 +154,12 @@ export namespace SimulationRunPlanCreateResponse {
       direction: 'INBOUND' | 'OUTBOUND';
 
       /**
-       * Evaluators included in this run plan
+       * Phrases that trigger end of call. Empty array means disabled.
+       */
+      endCallPhrases: Array<string>;
+
+      /**
+       * Deprecated: Use metrics instead. Evaluators included in this run plan.
        */
       evaluators: Array<RunPlan.Evaluator>;
 
@@ -178,6 +183,11 @@ export namespace SimulationRunPlanCreateResponse {
        */
       maxSimulationDurationSeconds: number;
 
+      /**
+       * Metric definitions included in this run plan
+       */
+      metrics: Array<RunPlan.Metric>;
+
       /**
        * Name of the run plan
        */
@@ -223,6 +233,10 @@ export namespace SimulationRunPlanCreateResponse {
         id: string;
       }
 
+      export interface Metric {
+        id: string;
+      }
+
       export interface Persona {
         id: string;
       }
@@ -302,7 +316,12 @@ export namespace SimulationRunPlanUpdateResponse {
     direction: 'INBOUND' | 'OUTBOUND';
 
     /**
-     * Evaluators included in this run plan
+     * Phrases that trigger end of call. Empty array means disabled.
+     */
+    endCallPhrases: Array<string>;
+
+    /**
+     * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
     evaluators: Array<Data.Evaluator>;
 
@@ -326,6 +345,11 @@ export namespace SimulationRunPlanUpdateResponse {
      */
     maxSimulationDurationSeconds: number;
 
+    /**
+     * Metric definitions included in this run plan
+     */
+    metrics: Array<Data.Metric>;
+
     /**
      * Name of the run plan
      */
@@ -371,6 +395,10 @@ export namespace SimulationRunPlanUpdateResponse {
       id: string;
     }
 
+    export interface Metric {
+      id: string;
+    }
+
     export interface Persona {
       id: string;
     }
@@ -416,7 +444,12 @@ export namespace SimulationRunPlanListResponse {
     direction: 'INBOUND' | 'OUTBOUND';
 
     /**
-     * Evaluators included in this run plan
+     * Phrases that trigger end of call. Empty array means disabled.
+     */
+    endCallPhrases: Array<string>;
+
+    /**
+     * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
     evaluators: Array<Data.Evaluator>;
 
@@ -440,6 +473,11 @@ export namespace SimulationRunPlanListResponse {
      */
     maxSimulationDurationSeconds: number;
 
+    /**
+     * Metric definitions included in this run plan
+     */
+    metrics: Array<Data.Metric>;
+
     /**
      * Name of the run plan
      */
@@ -485,6 +523,10 @@ export namespace SimulationRunPlanListResponse {
       id: string;
     }
 
+    export interface Metric {
+      id: string;
+    }
+
     export interface Persona {
       id: string;
     }
@@ -558,7 +600,12 @@ export namespace SimulationRunPlanGetByIDResponse {
     direction: 'INBOUND' | 'OUTBOUND';
 
     /**
-     * Evaluators included in this run plan
+     * Phrases that trigger end of call. Empty array means disabled.
+     */
+    endCallPhrases: Array<string>;
+
+    /**
+     * Deprecated: Use metrics instead. Evaluators included in this run plan.
      */
     evaluators: Array<Data.Evaluator>;
 
@@ -582,6 +629,11 @@ export namespace SimulationRunPlanGetByIDResponse {
      */
     maxSimulationDurationSeconds: number;
 
+    /**
+     * Metric definitions included in this run plan
+     */
+    metrics: Array<Data.Metric>;
+
     /**
      * Name of the run plan
      */
@@ -627,6 +679,10 @@ export namespace SimulationRunPlanGetByIDResponse {
       id: string;
     }
 
+    export interface Metric {
+      id: string;
+    }
+
     export interface Persona {
       id: string;
     }
@@ -649,14 +705,14 @@ export interface SimulationRunPlanCreateParams {
   direction: 'INBOUND' | 'OUTBOUND';
 
   /**
-   * Evaluators to include in this run plan
+   * Maximum duration in seconds for each simulation
    */
-  evaluators: Array<SimulationRunPlanCreateParams.Evaluator>;
+  maxSimulationDurationSeconds: number;
 
   /**
-   * Maximum duration in seconds for each simulation
+   * Metric definitions to include in this run plan
    */
-  maxSimulationDurationSeconds: number;
+  metrics: Array<SimulationRunPlanCreateParams.Metric>;
 
   /**
    * Name of the run plan
@@ -669,7 +725,8 @@ export interface SimulationRunPlanCreateParams {
   personas: Array<SimulationRunPlanCreateParams.Persona>;
 
   /**
-   * Scenarios to include in this run plan
+   * Scenarios to include in this run plan. The same scenario ID can appear multiple
+   * times with different variables.
    */
   scenarios: Array<SimulationRunPlanCreateParams.Scenario>;
 
@@ -683,6 +740,11 @@ export interface SimulationRunPlanCreateParams {
    */
   description?: string;
 
+  /**
+   * Phrases that trigger end of call. Empty array disables the feature.
+   */
+  endCallPhrases?: Array<string>;
+
   /**
    * Execution mode (PARALLEL or SEQUENTIAL)
    */
@@ -710,7 +772,7 @@ export namespace SimulationRunPlanCreateParams {
     id: string;
   }
 
-  export interface Evaluator {
+  export interface Metric {
     id: string;
   }
 
@@ -719,7 +781,16 @@ export namespace SimulationRunPlanCreateParams {
   }
 
   export interface Scenario {
+    /**
+     * Scenario ID
+     */
     id: string;
+
+    /**
+     * Template variables for this scenario instance. The same scenario can appear
+     * multiple times with different variables.
+     */
+    variables?: { [key: string]: string };
   }
 }
 
@@ -740,9 +811,9 @@ export interface SimulationRunPlanUpdateParams {
   direction?: 'INBOUND' | 'OUTBOUND';
 
   /**
-   * Evaluators to include in this run plan
+   * Phrases that trigger end of call. Empty array disables the feature.
    */
-  evaluators?: Array<SimulationRunPlanUpdateParams.Evaluator>;
+  endCallPhrases?: Array<string>;
 
   /**
    * Execution mode (PARALLEL or SEQUENTIAL)
@@ -765,6 +836,11 @@ export interface SimulationRunPlanUpdateParams {
    */
   maxSimulationDurationSeconds?: number;
 
+  /**
+   * Metric definitions to include in this run plan
+   */
+  metrics?: Array<SimulationRunPlanUpdateParams.Metric>;
+
   /**
    * Name of the run plan
    */
@@ -776,7 +852,8 @@ export interface SimulationRunPlanUpdateParams {
   personas?: Array<SimulationRunPlanUpdateParams.Persona>;
 
   /**
-   * Scenarios to include in this run plan
+   * Scenarios to include in this run plan. The same scenario ID can appear multiple
+   * times with different variables.
    */
   scenarios?: Array<SimulationRunPlanUpdateParams.Scenario>;
 
@@ -791,7 +868,7 @@ export namespace SimulationRunPlanUpdateParams {
     id: string;
   }
 
-  export interface Evaluator {
+  export interface Metric {
     id: string;
   }
 
@@ -800,7 +877,16 @@ export namespace SimulationRunPlanUpdateParams {
   }
 
   export interface Scenario {
+    /**
+     * Scenario ID
+     */
     id: string;
+
+    /**
+     * Template variables for this scenario instance. The same scenario can appear
+     * multiple times with different variables.
+     */
+    variables?: { [key: string]: string };
   }
 }