@vapi-ai/web 3.0.0 → 3.1.0

package/dist/api.js

@@ -218,6 +218,24 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * No description
+         *
+         * @tags Assistants
+         * @name AssistantControllerValidateBackgroundSoundUrl
+         * @summary Validate Background Sound URL
+         * @request POST:/assistant/background-sound/validate
+         * @secure
+         */
+        assistantControllerValidateBackgroundSoundUrl: (data, params = {}) => this.request({
+            path: `/assistant/background-sound/validate`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * No description
          *
@@ -441,6 +459,24 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * No description
+         *
+         * @tags Assistants
+         * @name AssistantControllerUpsertDraft
+         * @summary Upsert Assistant Draft
+         * @request PUT:/assistant/{id}/draft
+         * @secure
+         */
+        assistantControllerUpsertDraft: (id, data, params = {}) => this.request({
+            path: `/assistant/${id}/draft`,
+            method: "PUT",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * No description
          *
@@ -680,6 +716,23 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * No description
+         *
+         * @tags Files
+         * @name FileV2ControllerFindAllPaginated
+         * @summary List Files with pagination
+         * @request GET:/v2/file
+         * @secure
+         */
+        fileV2ControllerFindAllPaginated: (query, params = {}) => this.request({
+            path: `/v2/file`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * No description
          *
@@ -918,6 +971,56 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Returns the version history for the squad.
+         *
+         * @tags Squads
+         * @name SquadControllerFindAllVersions
+         * @summary List Squad Versions
+         * @request GET:/squad/{id}/versions
+         * @secure
+         */
+        squadControllerFindAllVersions: (id, query, params = {}) => this.request({
+            path: `/squad/${id}/versions`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Squads
+         * @name SquadControllerFindOneVersion
+         * @summary Get Squad Version
+         * @request GET:/squad/{id}/versions/{version}
+         * @secure
+         */
+        squadControllerFindOneVersion: (id, version, query, params = {}) => this.request({
+            path: `/squad/${id}/versions/${version}`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Deletes the selected version and rolls the squad back to the highest remaining live version. Deleting a version that is already deleted returns 200 with that version.
+         *
+         * @tags Squads
+         * @name SquadControllerSoftDeleteVersion
+         * @summary Delete Squad Version
+         * @request DELETE:/squad/{id}/versions/{version}
+         * @secure
+         */
+        squadControllerSoftDeleteVersion: (id, version, params = {}) => this.request({
+            path: `/squad/${id}/versions/${version}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
     };
     workflow = {
         /**
@@ -1235,6 +1338,41 @@ class Api extends HttpClient {
             secure: true,
             ...params,
         }),
+        /**
+         * No description
+         *
+         * @tags Calls
+         * @name GoalEvaluationCurrentControllerCurrentGet
+         * @summary Get the current goal evaluation for a call
+         * @request GET:/call/{id}/goal-evaluation
+         * @secure
+         */
+        goalEvaluationCurrentControllerCurrentGet: (id, query, params = {}) => this.request({
+            path: `/call/${id}/goal-evaluation`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Calls
+         * @name GoalEvaluationCurrentControllerCurrentBatchGet
+         * @summary Get current goal evaluations for up to 100 call/goal pairs
+         * @request POST:/call/goal-evaluation/batch
+         * @secure
+         */
+        goalEvaluationCurrentControllerCurrentBatchGet: (data, params = {}) => this.request({
+            path: `/call/goal-evaluation/batch`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
     };
     chat = {
         /**
@@ -1565,6 +1703,93 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    trafficAllocations = {
+        /**
+         * @description Creates a new traffic allocation for an assistant, replacing the one currently in effect. To start or adjust a split, send targets naming published versions (such as "v7") with percentages totaling 100; allocationIntent is inferred as 'explicit'. To stop splitting and send every call to the newest published version, send allocationIntent 'follow-latest' with no targets field; stopping always names its intent, so a dropped targets field can never end a split by accident.
+         *
+         * @tags Traffic Allocations
+         * @name TrafficAllocationControllerCreate
+         * @summary Create traffic allocation
+         * @request POST:/traffic-allocations
+         * @secure
+         */
+        trafficAllocationControllerCreate: (data, params = {}) => this.request({
+            path: `/traffic-allocations`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description The append-only history of an assistant's allocations, newest first.
+         *
+         * @tags Traffic Allocations
+         * @name TrafficAllocationControllerFindAllPaginated
+         * @summary List traffic allocations
+         * @request GET:/traffic-allocations
+         * @secure
+         */
+        trafficAllocationControllerFindAllPaginated: (query, params = {}) => this.request({
+            path: `/traffic-allocations`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description The allocation currently in effect for the assistant, with its targets. The response carries no allocation field when traffic splitting has never been configured.
+         *
+         * @tags Traffic Allocations
+         * @name TrafficAllocationControllerLatestGet
+         * @summary Get latest traffic allocation
+         * @request GET:/traffic-allocations/latest
+         * @secure
+         */
+        trafficAllocationControllerLatestGet: (query, params = {}) => this.request({
+            path: `/traffic-allocations/latest`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Per-assistant-version call metrics over a time window: call counts, configured vs actual traffic share, duration, cost per minute, latency, ended reasons, a bucketed timeseries, and optional structured output aggregations. Calls with no assistant version are reported as an 'unversioned' row.
+         *
+         * @tags Traffic Allocations
+         * @name TrafficAllocationControllerMetricsGet
+         * @summary Get traffic split metrics
+         * @request GET:/traffic-allocations/metrics
+         * @secure
+         */
+        trafficAllocationControllerMetricsGet: (query, params = {}) => this.request({
+            path: `/traffic-allocations/metrics`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Returns a single allocation by id, including its targets and actor attribution.
+         *
+         * @tags Traffic Allocations
+         * @name TrafficAllocationControllerFindOne
+         * @summary Get traffic allocation
+         * @request GET:/traffic-allocations/{id}
+         * @secure
+         */
+        trafficAllocationControllerFindOne: (id, params = {}) => this.request({
+            path: `/traffic-allocations/${id}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+    };
     phoneNumber = {
         /**
          * @description Use POST /phone-number instead.
@@ -1862,6 +2087,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Restores the selected version as the current configuration and publishes it as a new version. Deletes any drafts for this tool.
+         *
+         * @tags Tools
+         * @name ToolControllerToolVersionRestore
+         * @summary Restore Tool Version
+         * @request POST:/tool/{id}/restore/{version}
+         * @secure
+         */
+        toolControllerToolVersionRestore: (id, version, params = {}) => this.request({
+            path: `/tool/${id}/restore/${version}`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * No description
          *
@@ -2826,7 +3067,7 @@ class Api extends HttpClient {
             ...params,
         }),
         /**
-         * No description
+         * @description Returns a pagination envelope when page, limit, name, assistantId, or squadId is supplied; otherwise returns the legacy array.
          *
          * @tags Simulation Suites
          * @name SimulationSuiteControllerFindAll
@@ -2842,6 +3083,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * No description
+         *
+         * @tags Simulation Suites
+         * @name SimulationSuiteControllerDuplicate
+         * @summary Duplicate simulation suite
+         * @request POST:/eval/simulation/suite/{id}/duplicate
+         * @secure
+         */
+        simulationSuiteControllerDuplicate: (id, params = {}) => this.request({
+            path: `/eval/simulation/suite/${id}/duplicate`,
+            method: "POST",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * No description
          *
@@ -2910,6 +3167,60 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Generate draft test requirements from an assistant's prompt, tools, and handoff configuration. The response includes numbered requirements describing expected behavior and open questions about behavior that needs clarification. Use this endpoint before generating a simulation suite. Review the requirements and resolve any open questions. To revise a draft, send it as `previousDraft` together with natural-language `feedback` describing the changes or answers. Once the requirements are ready, pass them to `POST /eval/simulation/onboarding/suite`. Requests can take up to 2 minutes. Each organization can draft requirements 60 times per UTC day, shared with the dashboard. A 429 `SIMULATION_ONBOARDING_QUOTA_EXCEEDED` response means the daily limit has been reached. Wait until the limit resets at 00:00 UTC before retrying.
+         *
+         * @tags Simulation Suites
+         * @name SimulationOnboardingControllerRequirementsDraft
+         * @summary Draft simulation requirements
+         * @request POST:/eval/simulation/onboarding/requirements
+         * @secure
+         */
+        simulationOnboardingControllerRequirementsDraft: (data, params = {}) => this.request({
+            path: `/eval/simulation/onboarding/requirements`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Generate and save a simulation suite from reviewed test requirements, and assign it to an assistant. First draft requirements with `POST /eval/simulation/onboarding/requirements`. The response includes the saved suite, its simulations, and requirement coverage, including any gaps. Requests can take up to 3 minutes. Set a client timeout of at least 200 seconds. Use a unique `idempotencyKey` for each suite generation request. Retrying with the same key does not create a duplicate suite: - On a timeout or a 5xx (502, 504, 524), retry with the same key. You get the saved suite, a 409 while it is still generating, or a fresh generation if the first one never saved. - On a 409 `SIMULATION_ONBOARDING_GENERATION_IN_PROGRESS`, the first request is still generating. Wait `Retry-After` seconds (15) and retry with the same key. - On a 409 `SIMULATION_ONBOARDING_IDEMPOTENCY_KEY_REUSED`, the key was used for a different assistant or requirements. Send a new key. Review the generated simulations and coverage gaps. Revise the suite with `PATCH /eval/simulation/onboarding/suite/{suiteId}`, then run it with `POST /eval/simulation/run`. Each organization can generate 20 suites per UTC day, shared with the dashboard, and 2 at a time. A retry that returns a saved suite does not count toward these limits. On a 429 `SIMULATION_ONBOARDING_CONCURRENCY_LIMITED`, wait `Retry-After` seconds (30) before retrying. On a 429 `SIMULATION_ONBOARDING_QUOTA_EXCEEDED`, wait until the daily limit resets at 00:00 UTC before retrying.
+         *
+         * @tags Simulation Suites
+         * @name SimulationOnboardingControllerSuiteCreate
+         * @summary Generate a simulation suite
+         * @request POST:/eval/simulation/onboarding/suite
+         * @secure
+         */
+        simulationOnboardingControllerSuiteCreate: (data, params = {}) => this.request({
+            path: `/eval/simulation/onboarding/suite`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Revise a suite created by `POST /eval/simulation/onboarding/suite`. Remove simulations, rewrite scenarios using natural-language instructions, or set `retryFailed` to regenerate scenarios that failed or exceeded generation limits. The response includes the updated suite and requirement coverage. Requests can take up to 2 minutes. Send a new `patchKey` for each edit. Replaying an applied key changes nothing and returns the current suite, with `failedEditSimulationIds` listing the simulations that edit could not rewrite, so retry a timeout or a 5xx with the same key. A suite remembers its last 50 keys, so never reuse one. Each organization can make 60 edits per UTC day, shared with the dashboard. Requests that only remove simulations and replays of applied edits do not count toward this limit. On a 429 `SIMULATION_ONBOARDING_QUOTA_EXCEEDED`, wait until the daily limit resets at 00:00 UTC before retrying.
+         *
+         * @tags Simulation Suites
+         * @name SimulationOnboardingControllerSuiteUpdate
+         * @summary Edit a generated simulation suite
+         * @request PATCH:/eval/simulation/onboarding/suite/{suiteId}
+         * @secure
+         */
+        simulationOnboardingControllerSuiteUpdate: (suiteId, data, params = {}) => this.request({
+            path: `/eval/simulation/onboarding/suite/${suiteId}`,
+            method: "PATCH",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
         /**
          * No description
          *
@@ -2945,6 +3256,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * No description
+         *
+         * @tags Simulations
+         * @name SimulationControllerGetConcurrency
+         * @summary Get Simulation Concurrency
+         * @request GET:/eval/simulation/concurrency
+         * @secure
+         */
+        simulationControllerGetConcurrency: (params = {}) => this.request({
+            path: `/eval/simulation/concurrency`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * No description
          *
@@ -2995,22 +3322,6 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
-        /**
-         * No description
-         *
-         * @tags Simulations
-         * @name SimulationControllerGetConcurrency
-         * @summary Get Simulation Concurrency
-         * @request GET:/eval/simulation/concurrency
-         * @secure
-         */
-        simulationControllerGetConcurrency: (params = {}) => this.request({
-            path: `/eval/simulation/concurrency`,
-            method: "GET",
-            secure: true,
-            format: "json",
-            ...params,
-        }),
         /**
          * No description
          *
@@ -3143,6 +3454,7 @@ class Api extends HttpClient {
             body: data,
             secure: true,
             type: ContentType.Json,
+            format: "json",
             ...params,
         }),
         /**
@@ -3526,6 +3838,22 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * @description Returns the call concurrency limits and API rate limit usage for the authenticated org. Read-only and cheap enough to poll every few seconds. The X-RateLimit-* response headers describe this endpoint's own polling ceiling, not the API budget reported in apiLimits.
+         *
+         * @tags Orgs
+         * @name OrgControllerLimitsGet
+         * @summary Get org limits
+         * @request GET:/org/limits
+         * @secure
+         */
+        orgControllerLimitsGet: (params = {}) => this.request({
+            path: `/org/limits`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
         /**
          * No description
          *

package/dist/jest.config.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const config = {
     preset: 'ts-jest',
+    transform: {
+        '^.+\\.tsx?$': ['ts-jest', { tsconfig: { types: ['jest', 'node'] } }],
+    },
     testEnvironment: 'node',
     // Your Jest configuration options here
     // For example, to match test files:

package/dist/vapi.d.ts

@@ -1,7 +1,7 @@
 import type { ChatCompletionMessageParam } from 'openai/resources';
 import { DailyCall, DailyAdvancedConfig, DailyFactoryOptions, DailyEventObjectNoPayload, DailyEventObjectRecordingError, DailyEventObjectRecordingStarted, DailyEventObjectRecordingStopped, DailyParticipant, DailyVideoSendSettings } from '@daily-co/daily-js';
 import EventEmitter from 'events';
-import { Call, CreateSquadDTO, CreateAssistantDTO, AssistantOverrides, CreateWorkflowDTO, WorkflowOverrides } from './api';
+import { Call, CreateSquadDTO, CreateAssistantDTO, AssistantOverrides, CreateWebCallDTO, CreateWorkflowDTO, WorkflowOverrides } from './api';
 export interface EndCallMessage {
     type: 'end-call';
 }
@@ -69,7 +69,10 @@ type VapiEventListeners = {
     'recording-error': (event: DailyEventObjectRecordingError) => void;
     'recording-upload-completed': (event: DailyEventObjectNoPayload) => void;
 };
+type VideoRecordingStartMode = NonNullable<CreateWebCallDTO['videoRecordingStartMode']>;
 type StartCallOptions = {
+    /** Acquire the microphone before creating a backend call. Defaults to true. */
+    microphonePreflightEnabled?: boolean;
     /**
      * This determines whether the daily room will be deleted and all participants will be kicked once the user leaves the room.
      * If set to `false`, the room will be kept alive even after the user leaves, allowing clients to reconnect to the same room.
@@ -79,6 +82,25 @@ type StartCallOptions = {
      * @example true
      */
     roomDeleteOnUserLeaveEnabled?: boolean;
+    /**
+     * This determines who starts the video recording. Only applies when video
+     * recording is enabled (`artifactPlan.videoRecordingEnabled`).
+     *
+     * - `client`: the web client starts the recording when it joins.
+     * - `server`: Vapi starts the recording once the user has joined, so a weak
+     *   client connection can't stop it from starting. If Vapi can't set up the
+     *   server-side start, or the start itself fails, the SDK emits
+     *   `recording-error`.
+     *
+     * In `server` mode the SDK never calls `startRecording()` itself. If the
+     * server-side start couldn't be set up, calling it yourself may still start
+     * the recording.
+     *
+     * Requires a Vapi API that supports this field; older servers reject the
+     * request. The server defaults to `client` when it is not set.
+     * @example "server"
+     */
+    videoRecordingStartMode?: VideoRecordingStartMode;
 };
 type WebCall = {
     /**
@@ -111,13 +133,21 @@ type WebCall = {
     };
     /**
      * The Vapi WebCall transport. When video recording is enabled, the server
-     * sets `callToken` to a Daily meeting token that auto-starts the cloud
-     * recording on join.
+     * sets `callToken` to the Daily meeting token to join with. In `client` mode
+     * the token auto-starts the cloud recording on join; in `server` mode it
+     * starts nothing and Vapi starts the recording. If there is no token, the
+     * SDK emits `recording-error` and starts nothing, though `startRecording()`
+     * may still start the recording from the client.
+     *
+     * `videoRecordingStartMode` is `server` when Vapi starts the recording, and
+     * is absent when video recording is off or the server-side start couldn't
+     * be set up.
      *
      * call.transport
      */
     transport?: {
         callToken?: string;
+        videoRecordingStartMode?: VideoRecordingStartMode;
     };
 };
 declare class VapiEventEmitter extends EventEmitter {
@@ -138,6 +168,9 @@ export default class Vapi extends VapiEventEmitter {
     private speakingTimeout;
     private dailyCallConfig;
     private dailyCallObject;
+    private microphoneTrack;
+    private cancelMicrophonePreflight;
+    private microphoneAcquire;
     private hasEmittedCallEndedStatus;
     constructor(apiToken: string, apiBaseUrl?: string, dailyCallConfig?: Pick<DailyAdvancedConfig, 'avoidEval' | 'alwaysIncludeMicInPermissionPrompt'>, dailyCallObject?: Pick<DailyFactoryOptions, 'audioSource' | 'startAudioOff'>);
     private cleanup;
@@ -215,6 +248,16 @@ export default class Vapi extends VapiEventEmitter {
      * which EventEmitter throws on when nothing is listening.
      */
     private emitToConsumer;
+    /**
+     * Reported in a later task, like Daily's own recording-error: start() or
+     * reconnect() has resolved and the caller's await continuation has run, so a
+     * listener registered right after it still hears this, and one that calls
+     * stop() can't interrupt call setup. Skipped if that call was stopped or
+     * replaced.
+     */
+    private recordingTokenMissingReportSchedule;
+    /** The fields are read defensively: the app message is untrusted JSON. */
+    private videoRecordingStartFailedReport;
     /** Drops the reference before removing, so nothing hands out a detached element. */
     private detachAudioPlayer;
     /**