@vapi-ai/web 2.4.0 → 2.5.1

package/dist/api.js

@@ -72,20 +72,15 @@ class HttpClient {
         [ContentType.Text]: (input) => input !== null && typeof input !== "string"
             ? JSON.stringify(input)
             : input,
-        [ContentType.FormData]: (input) => {
-            if (input instanceof FormData) {
-                return input;
-            }
-            return Object.keys(input || {}).reduce((formData, key) => {
-                const property = input[key];
-                formData.append(key, property instanceof Blob
-                    ? property
-                    : typeof property === "object" && property !== null
-                        ? JSON.stringify(property)
-                        : `${property}`);
-                return formData;
-            }, new FormData());
-        },
+        [ContentType.FormData]: (input) => Object.keys(input || {}).reduce((formData, key) => {
+            const property = input[key];
+            formData.append(key, property instanceof Blob
+                ? property
+                : typeof property === "object" && property !== null
+                    ? JSON.stringify(property)
+                    : `${property}`);
+            return formData;
+        }, new FormData()),
         [ContentType.UrlEncoded]: (input) => this.toQueryString(input),
     };
     mergeRequestParams(params1, params2) {
@@ -143,13 +138,12 @@ class HttpClient {
                 ? null
                 : payloadFormatter(body),
         }).then(async (response) => {
-            const r = response;
+            const r = response.clone();
             r.data = null;
             r.error = null;
-            const responseToParse = responseFormat ? response.clone() : response;
             const data = !responseFormat
                 ? r
-                : await responseToParse[responseFormat]()
+                : await response[responseFormat]()
                     .then((data) => {
                     if (r.ok) {
                         r.data = data;
@@ -642,10 +636,12 @@ class Api extends HttpClient {
          * @request DELETE:/call/{id}
          * @secure
          */
-        callControllerDeleteCallData: (id, params = {}) => this.request({
+        callControllerDeleteCallData: (id, data, params = {}) => this.request({
             path: `/call/${id}`,
             method: "DELETE",
+            body: data,
             secure: true,
+            type: ContentType.Json,
             format: "json",
             ...params,
         }),
@@ -1475,6 +1471,41 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
+        /**
+         * No description
+         *
+         * @tags Structured Outputs
+         * @name StructuredOutputControllerRun
+         * @summary Run Structured Output
+         * @request POST:/structured-output/run
+         * @secure
+         */
+        structuredOutputControllerRun: (data, params = {}) => this.request({
+            path: `/structured-output/run`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * @description Analyzes assistant configuration and generates contextual structured output recommendations
+         *
+         * @tags Structured Outputs
+         * @name StructuredOutputControllerSuggest
+         * @summary Generate AI-Powered Structured Output Suggestions
+         * @request POST:/structured-output/suggest
+         * @secure
+         */
+        structuredOutputControllerSuggest: (data, params = {}) => this.request({
+            path: `/structured-output/suggest`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            ...params,
+        }),
     };
     testSuite = {
         /**
@@ -1733,6 +1764,129 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    reporting = {
+        /**
+         * No description
+         *
+         * @tags Insight
+         * @name InsightControllerCreate
+         * @summary Create Insight
+         * @request POST:/reporting/insight
+         * @secure
+         */
+        insightControllerCreate: (data, params = {}) => this.request({
+            path: `/reporting/insight`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Insight
+         * @name InsightControllerFindAll
+         * @summary Get Insights
+         * @request GET:/reporting/insight
+         * @secure
+         */
+        insightControllerFindAll: (query, params = {}) => this.request({
+            path: `/reporting/insight`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Insight
+         * @name InsightControllerUpdate
+         * @summary Update Insight
+         * @request PATCH:/reporting/insight/{id}
+         * @secure
+         */
+        insightControllerUpdate: (id, data, params = {}) => this.request({
+            path: `/reporting/insight/${id}`,
+            method: "PATCH",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Insight
+         * @name InsightControllerFindOne
+         * @summary Get Insight
+         * @request GET:/reporting/insight/{id}
+         * @secure
+         */
+        insightControllerFindOne: (id, params = {}) => this.request({
+            path: `/reporting/insight/${id}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Insight
+         * @name InsightControllerRemove
+         * @summary Delete Insight
+         * @request DELETE:/reporting/insight/{id}
+         * @secure
+         */
+        insightControllerRemove: (id, params = {}) => this.request({
+            path: `/reporting/insight/${id}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Insight
+         * @name InsightControllerRun
+         * @summary Run Insight
+         * @request POST:/reporting/insight/{id}/run
+         * @secure
+         */
+        insightControllerRun: (id, data, params = {}) => this.request({
+            path: `/reporting/insight/${id}/run`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Insight
+         * @name InsightControllerPreview
+         * @summary Preview Insight
+         * @request POST:/reporting/insight/preview
+         * @secure
+         */
+        insightControllerPreview: (data, params = {}) => this.request({
+            path: `/reporting/insight/preview`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+    };
     eval = {
         /**
          * No description
@@ -1886,6 +2040,93 @@ class Api extends HttpClient {
             ...params,
         }),
     };
+    observability = {
+        /**
+         * No description
+         *
+         * @tags Observability/Scorecard
+         * @name ScorecardControllerGet
+         * @summary Get Scorecard
+         * @request GET:/observability/scorecard/{id}
+         * @secure
+         */
+        scorecardControllerGet: (id, params = {}) => this.request({
+            path: `/observability/scorecard/${id}`,
+            method: "GET",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Observability/Scorecard
+         * @name ScorecardControllerUpdate
+         * @summary Update Scorecard
+         * @request PATCH:/observability/scorecard/{id}
+         * @secure
+         */
+        scorecardControllerUpdate: (id, data, params = {}) => this.request({
+            path: `/observability/scorecard/${id}`,
+            method: "PATCH",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Observability/Scorecard
+         * @name ScorecardControllerRemove
+         * @summary Delete Scorecard
+         * @request DELETE:/observability/scorecard/{id}
+         * @secure
+         */
+        scorecardControllerRemove: (id, params = {}) => this.request({
+            path: `/observability/scorecard/${id}`,
+            method: "DELETE",
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Observability/Scorecard
+         * @name ScorecardControllerGetPaginated
+         * @summary List Scorecards
+         * @request GET:/observability/scorecard
+         * @secure
+         */
+        scorecardControllerGetPaginated: (query, params = {}) => this.request({
+            path: `/observability/scorecard`,
+            method: "GET",
+            query: query,
+            secure: true,
+            format: "json",
+            ...params,
+        }),
+        /**
+         * No description
+         *
+         * @tags Observability/Scorecard
+         * @name ScorecardControllerCreate
+         * @summary Create Scorecard
+         * @request POST:/observability/scorecard
+         * @secure
+         */
+        scorecardControllerCreate: (data, params = {}) => this.request({
+            path: `/observability/scorecard`,
+            method: "POST",
+            body: data,
+            secure: true,
+            type: ContentType.Json,
+            format: "json",
+            ...params,
+        }),
+    };
     org = {
         /**
          * No description
@@ -2257,56 +2498,6 @@ class Api extends HttpClient {
             format: "json",
             ...params,
         }),
-        /**
-         * No description
-         *
-         * @tags Credentials
-         * @name CredentialControllerGenerateSession
-         * @summary Generate a credential session
-         * @request POST:/credential/session
-         * @secure
-         */
-        credentialControllerGenerateSession: (data, params = {}) => this.request({
-            path: `/credential/session`,
-            method: "POST",
-            body: data,
-            secure: true,
-            type: ContentType.Json,
-            format: "json",
-            ...params,
-        }),
-        /**
-         * No description
-         *
-         * @tags Credentials
-         * @name CredentialControllerHandleWebhook
-         * @summary Handle credential webhook
-         * @request POST:/credential/webhook
-         */
-        credentialControllerHandleWebhook: (data, params = {}) => this.request({
-            path: `/credential/webhook`,
-            method: "POST",
-            body: data,
-            type: ContentType.Json,
-            ...params,
-        }),
-        /**
-         * No description
-         *
-         * @tags Credentials
-         * @name CredentialControllerTriggerCredentialAction
-         * @summary Trigger a credential action
-         * @request POST:/credential/trigger
-         * @secure
-         */
-        credentialControllerTriggerCredentialAction: (data, params = {}) => this.request({
-            path: `/credential/trigger`,
-            method: "POST",
-            body: data,
-            secure: true,
-            type: ContentType.Json,
-            ...params,
-        }),
     };
     template = {
         /**

package/dist/vapi.d.ts

@@ -2,6 +2,9 @@ import type { ChatCompletionMessageParam } from 'openai/resources';
 import { DailyCall, DailyAdvancedConfig, DailyFactoryOptions, DailyParticipant, DailyVideoSendSettings } from '@daily-co/daily-js';
 import EventEmitter from 'events';
 import { Call, CreateSquadDTO, CreateAssistantDTO, AssistantOverrides, CreateWorkflowDTO, WorkflowOverrides } from './api';
+export interface EndCallMessage {
+    type: 'end-call';
+}
 export interface AddMessageMessage {
     type: 'add-message';
     message: ChatCompletionMessageParam;
@@ -19,7 +22,7 @@ export interface SayMessage {
     interruptionsEnabled?: boolean;
     interruptAssistantEnabled?: boolean;
 }
-type VapiClientToServerMessage = AddMessageMessage | ControlMessages | SayMessage;
+type VapiClientToServerMessage = AddMessageMessage | ControlMessages | SayMessage | EndCallMessage;
 type VapiEventNames = 'call-end' | 'call-start' | 'volume-level' | 'speech-start' | 'speech-end' | 'message' | 'video' | 'error' | 'camera-error' | 'network-quality-change' | 'network-connection' | 'daily-participant-updated' | 'call-start-progress' | 'call-start-success' | 'call-start-failed';
 interface CallStartProgressEvent {
     stage: string;
@@ -58,6 +61,47 @@ type VapiEventListeners = {
     'call-start-success': (event: CallStartSuccessEvent) => void;
     'call-start-failed': (event: CallStartFailedEvent) => void;
 };
+type StartCallOptions = {
+    /**
+     * 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.
+     * If set to `true`, the room will be deleted and reconnection will not be allowed.
+     *
+     * Defaults to `true`.
+     * @example true
+     */
+    roomDeleteOnUserLeaveEnabled?: boolean;
+};
+type WebCall = {
+    /**
+     * The Vapi WebCall URL. This is the URL that the call will be joined on.
+     *
+     * call.webCallUrl or call.transport.callUrl
+     */
+    webCallUrl: string;
+    /**
+     * The Vapi WebCall ID. This is the ID of the call.
+     *
+     * call.id
+     */
+    id?: string;
+    /**
+     * The Vapi WebCall artifact plan. This is the artifact plan of the call.
+     */
+    artifactPlan?: {
+        videoRecordingEnabled?: boolean;
+    };
+    /**
+     * The Vapi WebCall assistant. This is the assistant of the call.
+     *
+     * call.assistant
+     */
+    assistant?: {
+        voice?: {
+            provider?: string;
+        };
+    };
+};
 declare class VapiEventEmitter extends EventEmitter {
     on<E extends VapiEventNames>(event: E, listener: VapiEventListeners[E]): this;
     once<E extends VapiEventNames>(event: E, listener: VapiEventListeners[E]): this;
@@ -76,19 +120,64 @@ export default class Vapi extends VapiEventEmitter {
     private cleanup;
     private isMobileDevice;
     private sleep;
-    start(assistant?: CreateAssistantDTO | string, assistantOverrides?: AssistantOverrides, squad?: CreateSquadDTO | string, workflow?: CreateWorkflowDTO | string, workflowOverrides?: WorkflowOverrides): Promise<Call | null>;
+    start(assistant?: CreateAssistantDTO | string, assistantOverrides?: AssistantOverrides, squad?: CreateSquadDTO | string, workflow?: CreateWorkflowDTO | string, workflowOverrides?: WorkflowOverrides, options?: StartCallOptions): Promise<Call | null>;
     private onAppMessage;
     private handleRemoteParticipantsAudioLevel;
+    /**
+     * Stops the call by destroying the Daily call object.
+     *
+     * If `roomDeleteOnUserLeaveEnabled` is set to `false`, the Vapi call will be kept alive, allowing reconnections to the same call using the `reconnect` method.
+     * If `roomDeleteOnUserLeaveEnabled` is set to `true`, the Vapi call will also be destroyed, preventing any reconnections.
+     */
     stop(): Promise<void>;
+    /**
+     * Sends a Live Call Control message to the Vapi server.
+     *
+     * Docs: https://docs.vapi.ai/calls/call-features
+     */
     send(message: VapiClientToServerMessage): void;
     setMuted(mute: boolean): void;
     isMuted(): boolean;
     say(message: string, endCallAfterSpoken?: boolean, interruptionsEnabled?: boolean, interruptAssistantEnabled?: boolean): void;
+    /**
+     * Ends the call immediately by sending a `end-call` message using Live Call Control, and destroys the Daily call object.
+     *
+     * This method always ends the call, regardless of the `roomDeleteOnUserLeaveEnabled` option.
+     */
+    end(): void;
     setInputDevicesAsync(options: Parameters<DailyCall['setInputDevicesAsync']>[0]): Promise<void>;
     increaseMicLevel(gain: number): Promise<void>;
     setOutputDeviceAsync(options: Parameters<DailyCall['setOutputDeviceAsync']>[0]): void;
     getDailyCallObject(): DailyCall | null;
     startScreenSharing(displayMediaOptions?: DisplayMediaStreamOptions, screenVideoSendSettings?: DailyVideoSendSettings): void;
     stopScreenSharing(): void;
+    /**
+     * Reconnects to an active call.
+     *
+     *
+     * @param webCall
+     */
+    reconnect(webCall: WebCall): Promise<void>;
+    /**
+     * Runs all network connectivity tests for pre-call diagnostics.
+     * Creates a temporary Daily call object for testing purposes.
+     *
+     * Tests performed:
+     * 1. Network connectivity (TURN server) - Tests if traffic can be relayed through TURN servers
+     * 2. Websocket connectivity - Tests if websocket connections can be established
+     * 3. Call quality - Tests overall call quality metrics (if available in SDK version)
+     *
+     * @returns {Promise<Record<string, any>>} Test results object with status for each test
+     *
+     * @example
+     * // Run pre-call network diagnostics
+     * const results = await Vapi.runNetworkTestsStandalone();
+     * if (results.networkConnectivity?.result === 'failed') {
+     *   console.warn('Network issues detected - calls may not work properly');
+     * }
+     *
+     * @static
+     */
+    static runNetworkTestsStandalone(): Promise<Record<string, any>>;
 }
 export {};