Merge pull request #18 from VapiAI/fern-bot/05-28-2025-1215AM

🌿 Fern Regeneration -- May 28, 2025

Author: elizabethtrykin

src/api/types/AssistantMessage.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Vapi from "../index";
+
+export interface AssistantMessage {
+    /** This is the role of the message author */
+    role: "assistant";
+    /** This is the content of the assistant message */
+    content?: string;
+    /** This is the refusal message generated by the model */
+    refusal?: string;
+    /** This is the tool calls generated by the model */
+    tool_calls?: Vapi.ToolCall[];
+    /** This is an optional name for the participant */
+    name?: string;
+}

src/api/types/BashTool.ts

@@ -24,6 +24,17 @@ export interface BashTool {
     type: "bash";
     /** The sub type of tool. */
     subType: "bash_20241022";
+    /**
+     *   This is the server where a `tool-calls` webhook will be sent.
+     *
+     *   Notes:
+     *   - Webhook is sent to this server when a tool call is made.
+     *   - Webhook contains the call, assistant, and phone number objects.
+     *   - Webhook contains the variables set on the assistant.
+     *   - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.
+     *   - Webhook expects a response with tool call result.
+     */
+    server?: Vapi.Server;
     /** This is the unique identifier for the tool. */
     id: string;
     /** This is the unique identifier for the organization that this tool belongs to. */
@@ -40,14 +51,6 @@ export interface BashTool {
      * An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument "reason". Then, in `messages` array, you can have many "request-complete" messages. One of these messages will be triggered if the `messages[].conditions` matches the "reason" argument.
      */
     function?: Vapi.OpenAiFunction;
-    /**
-     * This is the server that will be hit when this tool is requested by the model.
-     *
-     * All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
-     *
-     * This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
-     */
-    server?: Vapi.Server;
     /** The name of the tool, fixed to 'bash' */
     name: "bash";
 }

src/api/types/BashToolWithToolCall.ts

@@ -25,6 +25,17 @@ export interface BashToolWithToolCall {
     type: "bash";
     /** The sub type of tool. */
     subType: "bash_20241022";
+    /**
+     *   This is the server where a `tool-calls` webhook will be sent.
+     *
+     *   Notes:
+     *   - Webhook is sent to this server when a tool call is made.
+     *   - Webhook contains the call, assistant, and phone number objects.
+     *   - Webhook contains the variables set on the assistant.
+     *   - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.
+     *   - Webhook expects a response with tool call result.
+     */
+    server?: Vapi.Server;
     toolCall: Vapi.ToolCall;
     /** The name of the tool, fixed to 'bash' */
     name: "bash";
@@ -36,12 +47,4 @@ export interface BashToolWithToolCall {
      * An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument "reason". Then, in `messages` array, you can have many "request-complete" messages. One of these messages will be triggered if the `messages[].conditions` matches the "reason" argument.
      */
     function?: Vapi.OpenAiFunction;
-    /**
-     * This is the server that will be hit when this tool is requested by the model.
-     *
-     * All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
-     *
-     * This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
-     */
-    server?: Vapi.Server;
 }

src/api/types/Chat.ts

@@ -0,0 +1,44 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Vapi from "../index";
+
+export interface Chat {
+    /** This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead. */
+    assistantId?: string;
+    /** This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead. */
+    assistant?: Vapi.CreateAssistantDto;
+    /** This is the name of the chat. This is just for your own reference. */
+    name?: string;
+    /**
+     * This is the ID of the session that will be used for the chat.
+     * Mutually exclusive with previousChatId.
+     */
+    sessionId?: string;
+    /** Chat input as a string or an array of messages. When using message array, each message requires a role and content. */
+    input?: Vapi.ChatInput;
+    /**
+     * This is a flag that determines whether the response should be streamed.
+     * When true, the response will be sent as chunks of text.
+     */
+    stream?: boolean;
+    /**
+     * This is the ID of the chat that will be used as context for the new chat.
+     * The messages from the previous chat will be used as context.
+     * Mutually exclusive with sessionId.
+     */
+    previousChatId?: string;
+    /** This is the unique identifier for the chat. */
+    id: string;
+    /** This is the unique identifier for the org that this chat belongs to. */
+    orgId: string;
+    /** Array of messages used as context for the chat */
+    messages?: Vapi.ChatMessagesItem[];
+    /** Output messages generated by the system in response to the input */
+    output?: Vapi.ChatOutputItem[];
+    /** This is the ISO 8601 date-time string of when the chat was created. */
+    createdAt: string;
+    /** This is the ISO 8601 date-time string of when the chat was last updated. */
+    updatedAt: string;
+}

src/api/types/ChatCompletionMessageMetadata.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Vapi from "../index";
+
+/**
+ * Chat input as a string or an array of messages. When using message array, each message requires a role and content.
+ */
+export type ChatInput = string | Vapi.ChatInputItem[];

src/api/types/ChatCompletionMessageWorkflows.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Vapi from "../index";
+
+export type ChatInputItem =
+    | Vapi.SystemMessage
+    | Vapi.UserMessage
+    | Vapi.AssistantMessage
+    | Vapi.ToolMessage
+    | Vapi.DeveloperMessage;

src/api/types/ChatCompletionsDto.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Vapi from "../index";
+
+export type ChatMessagesItem =
+    | Vapi.SystemMessage
+    | Vapi.UserMessage
+    | Vapi.AssistantMessage
+    | Vapi.ToolMessage
+    | Vapi.DeveloperMessage;

src/api/types/ChatInput.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Vapi from "../index";
+
+export type ChatOutputItem =
+    | Vapi.SystemMessage
+    | Vapi.UserMessage
+    | Vapi.AssistantMessage
+    | Vapi.ToolMessage
+    | Vapi.DeveloperMessage;

src/api/types/ChatInputItem.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Vapi from "../index";
+
+export interface ChatPaginatedResponse {
+    results: Vapi.Chat[];
+    metadata: Vapi.PaginationMeta;
+}

src/api/types/ChatMessagesItem.ts

@@ -24,6 +24,17 @@ export interface ComputerTool {
     type: "computer";
     /** The sub type of tool. */
     subType: "computer_20241022";
+    /**
+     *   This is the server where a `tool-calls` webhook will be sent.
+     *
+     *   Notes:
+     *   - Webhook is sent to this server when a tool call is made.
+     *   - Webhook contains the call, assistant, and phone number objects.
+     *   - Webhook contains the variables set on the assistant.
+     *   - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.
+     *   - Webhook expects a response with tool call result.
+     */
+    server?: Vapi.Server;
     /** This is the unique identifier for the tool. */
     id: string;
     /** This is the unique identifier for the organization that this tool belongs to. */
@@ -40,14 +51,6 @@ export interface ComputerTool {
      * An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument "reason". Then, in `messages` array, you can have many "request-complete" messages. One of these messages will be triggered if the `messages[].conditions` matches the "reason" argument.
      */
     function?: Vapi.OpenAiFunction;
-    /**
-     * This is the server that will be hit when this tool is requested by the model.
-     *
-     * All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
-     *
-     * This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
-     */
-    server?: Vapi.Server;
     /** The name of the tool, fixed to 'computer' */
     name: "computer";
     /** The display width in pixels */

src/api/types/ChatOutputItem.ts

@@ -25,6 +25,17 @@ export interface ComputerToolWithToolCall {
     type: "computer";
     /** The sub type of tool. */
     subType: "computer_20241022";
+    /**
+     *   This is the server where a `tool-calls` webhook will be sent.
+     *
+     *   Notes:
+     *   - Webhook is sent to this server when a tool call is made.
+     *   - Webhook contains the call, assistant, and phone number objects.
+     *   - Webhook contains the variables set on the assistant.
+     *   - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.
+     *   - Webhook expects a response with tool call result.
+     */
+    server?: Vapi.Server;
     toolCall: Vapi.ToolCall;
     /** The name of the tool, fixed to 'computer' */
     name: "computer";
@@ -42,12 +53,4 @@ export interface ComputerToolWithToolCall {
      * An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument "reason". Then, in `messages` array, you can have many "request-complete" messages. One of these messages will be triggered if the `messages[].conditions` matches the "reason" argument.
      */
     function?: Vapi.OpenAiFunction;
-    /**
-     * This is the server that will be hit when this tool is requested by the model.
-     *
-     * All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
-     *
-     * This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
-     */
-    server?: Vapi.Server;
 }

src/api/types/ChatPaginatedResponse.ts

@@ -37,7 +37,7 @@ export interface CreateApiRequestToolDto {
     /** This is where the request will be sent. */
     url: string;
     /** This is the body of the request. */
-    body: Vapi.JsonSchema;
+    body?: Vapi.JsonSchema;
     /** These are the headers to send in the request. */
     headers?: Vapi.JsonSchema;
     /**
@@ -54,12 +54,4 @@ export interface CreateApiRequestToolDto {
      * An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument "reason". Then, in `messages` array, you can have many "request-complete" messages. One of these messages will be triggered if the `messages[].conditions` matches the "reason" argument.
      */
     function?: Vapi.OpenAiFunction;
-    /**
-     * This is the server that will be hit when this tool is requested by the model.
-     *
-     * All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
-     *
-     * This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
-     */
-    server?: Vapi.Server;
 }

src/api/types/ChatServiceResponse.ts

@@ -24,6 +24,17 @@ export interface CreateBashToolDto {
     type: "bash";
     /** The sub type of tool. */
     subType: "bash_20241022";
+    /**
+     *   This is the server where a `tool-calls` webhook will be sent.
+     *
+     *   Notes:
+     *   - Webhook is sent to this server when a tool call is made.
+     *   - Webhook contains the call, assistant, and phone number objects.
+     *   - Webhook contains the variables set on the assistant.
+     *   - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.
+     *   - Webhook expects a response with tool call result.
+     */
+    server?: Vapi.Server;
     /** The name of the tool, fixed to 'bash' */
     name: "bash";
     /**
@@ -34,12 +45,4 @@ export interface CreateBashToolDto {
      * An example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument "reason". Then, in `messages` array, you can have many "request-complete" messages. One of these messages will be triggered if the `messages[].conditions` matches the "reason" argument.
      */
     function?: Vapi.OpenAiFunction;
-    /**
-     * This is the server that will be hit when this tool is requested by the model.
-     *
-     * All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.
-     *
-     * This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.
-     */
-    server?: Vapi.Server;
 }

src/api/types/ComputerTool.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Vapi from "../index";
+
+export interface CreateChatDto {
+    /** This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead. */
+    assistantId?: string;
+    /** This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead. */
+    assistant?: Vapi.CreateAssistantDto;
+    /** This is the name of the chat. This is just for your own reference. */
+    name?: string;
+    /**
+     * This is the ID of the session that will be used for the chat.
+     * Mutually exclusive with previousChatId.
+     */
+    sessionId?: string;
+    /** Chat input as a string or an array of messages. When using message array, each message requires a role and content. */
+    input: Vapi.CreateChatDtoInput;
+    /**
+     * This is a flag that determines whether the response should be streamed.
+     * When true, the response will be sent as chunks of text.
+     */
+    stream?: boolean;
+    /**
+     * This is the ID of the chat that will be used as context for the new chat.
+     * The messages from the previous chat will be used as context.
+     * Mutually exclusive with sessionId.
+     */
+    previousChatId?: string;
+}

src/api/types/ComputerToolWithToolCall.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Vapi from "../index";
+
+/**
+ * Chat input as a string or an array of messages. When using message array, each message requires a role and content.
+ */
+export type CreateChatDtoInput = string | Vapi.CreateChatDtoInputItem[];