// This file was auto-generated by Fern from our API Definition.

import type * as Vapi from "../index.js";

export interface Scenario {
    /** This is the unique identifier for the scenario. */
    id: string;
    /** This is the unique identifier for the organization this scenario belongs to. */
    orgId: string;
    /** This is the ISO 8601 date-time string of when the scenario was created. */
    createdAt: string;
    /** This is the ISO 8601 date-time string of when the scenario was last updated. */
    updatedAt: string;
    /** This is the name of the scenario. */
    name: string;
    /** This is the script/instructions for the tester to follow during the simulation. */
    instructions: string;
    /**
     * This is the structured output-based evaluation plan for the simulation.
     * Each item defines a structured output to extract and evaluate against an expected value.
     */
    evaluations: Vapi.EvaluationPlanItem[];
    /** Hooks to run on simulation lifecycle events */
    hooks?: Vapi.ScenarioHooksItem[] | undefined;
    /** Overrides to inject into the simulated target assistant or squad */
    targetOverrides?: Vapi.AssistantOverrides | undefined;
    /** Scenario-level tool call mocks to use during simulations. */
    toolMocks?: Vapi.ScenarioToolMock[] | undefined;
    /**
     * Optional folder path for organizing scenarios.
     * Supports up to 3 levels (e.g., "dept/feature/variant").
     * Maps to GitOps resource folder structure.
     */
    path?: (string | null) | undefined;
}
