hume 0.15.11 → 0.15.13

package/dist/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpec.d.ts

@@ -2,8 +2,12 @@
  * A specific event message configuration to be returned from the server
  */
 export interface ReturnEventMessageSpec {
-    /** Boolean indicating if this event message is enabled. */
+    /**
+     * Boolean indicating if this event message is enabled.
+     *
+     * If set to `true`, a message will be sent when the circumstances for the specific event are met.
+     */
     enabled: boolean;
-    /** Optional text that will be used as a verbatim event message. If the text is null and the event message is enabled, the system will generate a message based using the language model. */
+    /** Text to use as the event message when the corresponding event occurs. If no text is specified, EVI will generate an appropriate message based on its current context and the system prompt. */
     text?: string;
 }

package/dist/cjs/api/resources/empathicVoice/types/ReturnEventMessageSpecs.d.ts

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * Collection of event_message specs to be returned from the server
+ * Collection of event messages returned by the server.
+ *
+ * Event messages are sent by the server when specific events occur during a chat session. These messages are used to configure behaviors for EVI, such as controlling how EVI starts a new conversation.
  */
 export interface ReturnEventMessageSpecs {
     onInactivityTimeout?: Hume.empathicVoice.ReturnEventMessageSpec;

package/dist/cjs/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts

@@ -5,6 +5,10 @@ import type * as Hume from "../../../index.js";
 export interface ReturnLanguageModel {
     modelProvider?: Hume.empathicVoice.ModelProviderEnum;
     modelResource?: Hume.empathicVoice.LanguageModelType;
-    /** Model temperature. */
+    /**
+     * The model temperature, with values between 0 to 1 (inclusive).
+     *
+     * Controls the randomness of the LLM's output, with values closer to 0 yielding focused, deterministic responses and values closer to 1 producing more creative, diverse responses.
+     */
     temperature?: number;
 }

package/dist/cjs/api/resources/empathicVoice/types/ReturnNudgeSpec.d.ts

@@ -2,8 +2,8 @@
  * A specific nudge configuration returned from the server
  */
 export interface ReturnNudgeSpec {
-    /** EVI will nudge user after inactivity */
+    /** If true, EVI will 'nudge' the user to speak after a determined interval of silence. */
     enabled: boolean;
-    /** Time interval in seconds after which the nudge will be sent. */
+    /** The interval of inactivity (in seconds) before a nudge is triggered. */
     intervalSecs?: number;
 }

package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChatGroups.d.ts

@@ -3,9 +3,13 @@ import type * as Hume from "../../../index.js";
  * A paginated list of chat_groups returned from the server
  */
 export interface ReturnPagedChatGroups {
-    /** List of chat_groups and their metadata returned for the specified page number and page size. */
+    /** List of Chat Groups and their metadata returned for the specified `page_number` and `page_size`. */
     chatGroupsPage: Hume.empathicVoice.ReturnChatGroup[];
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.

package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedChats.d.ts

@@ -3,9 +3,13 @@ import type * as Hume from "../../../index.js";
  * A paginated list of chats returned from the server
  */
 export interface ReturnPagedChats {
-    /** List of chats and their metadata returned for the specified page number and page size. */
+    /** List of Chats and their metadata returned for the specified `page_number` and `page_size`. */
     chatsPage: Hume.empathicVoice.ReturnChat[];
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.

package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedConfigs.d.ts

@@ -3,9 +3,13 @@ import type * as Hume from "../../../index.js";
  * A paginated list of config versions returned from the server
  */
 export interface ReturnPagedConfigs {
-    /** List of prompts returned for the specified page number and page size. */
+    /** List of configs returned for the specified `page_number` and `page_size`. */
     configsPage?: Hume.empathicVoice.ReturnConfig[];
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber?: number;
     /**
      * The maximum number of items returned per page.

package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedPrompts.d.ts

@@ -3,7 +3,11 @@ import type * as Hume from "../../../index.js";
  * A paginated list of prompt versions returned from the server
  */
 export interface ReturnPagedPrompts {
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -11,7 +15,7 @@ export interface ReturnPagedPrompts {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** List of prompts returned for the specified page number and page size. */
+    /** List of prompts returned for the specified `page_number` and `page_size`. */
     promptsPage: (Hume.empathicVoice.ReturnPrompt | undefined)[];
     /** The total number of pages in the collection. */
     totalPages: number;

package/dist/cjs/api/resources/empathicVoice/types/ReturnPagedUserDefinedTools.d.ts

@@ -3,7 +3,11 @@ import type * as Hume from "../../../index.js";
  * A paginated list of user defined tool versions returned from the server
  */
 export interface ReturnPagedUserDefinedTools {
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.
@@ -11,7 +15,7 @@ export interface ReturnPagedUserDefinedTools {
      * This value corresponds to the `page_size` parameter specified in the request.
      */
     pageSize: number;
-    /** List of tools returned for the specified page number and page size. */
+    /** List of tools returned for the specified `page_number` and `page_size`. */
     toolsPage: (Hume.empathicVoice.ReturnUserDefinedTool | undefined)[];
     /** The total number of pages in the collection. */
     totalPages: number;

package/dist/cjs/api/resources/empathicVoice/types/ReturnPrompt.d.ts

@@ -2,19 +2,23 @@
  * A specific prompt version returned from the server
  */
 export interface ReturnPrompt {
-    /** The timestamp when the first version of this prompt was created. */
+    /** Time at which the Prompt was created. Measured in seconds since the Unix epoch. */
     createdOn: number;
     /** Identifier for a Prompt. Formatted as a UUID. */
     id: string;
-    /** The timestamp when this version of the prompt was created. */
+    /** Time at which the Prompt was last modified. Measured in seconds since the Unix epoch. */
     modifiedOn: number;
     /** Name applied to all versions of a particular Prompt. */
     name: string;
-    /** Text used for this version of the Prompt. */
+    /**
+     * Instructions used to shape EVI's behavior, responses, and style.
+     *
+     * You can use the Prompt to define a specific goal or role for EVI, specifying how it should act or what it should focus on during the conversation. For example, EVI can be instructed to act as a customer support representative, a fitness coach, or a travel advisor, each with its own set of behaviors and response styles. For help writing a system prompt, see our [Prompting Guide](/docs/speech-to-speech-evi/guides/prompting).
+     */
     text: string;
     /** Version number for a Prompt. Version numbers should be integers. The combination of configId and version number is unique. */
     version: number;
-    /** Description that is appended to a specific version of a Prompt. */
+    /** An optional description of the Prompt version. */
     versionDescription?: string;
     /** Indicates whether this prompt is using a fixed version number or auto-updating to the latest version. Values from the VersionType enum. */
     versionType: string;

package/dist/cjs/api/resources/empathicVoice/types/ReturnTimeoutSpec.d.ts

@@ -2,8 +2,12 @@
  * A specific timeout configuration to be returned from the server
  */
 export interface ReturnTimeoutSpec {
-    /** Duration in seconds for the timeout. */
+    /** Duration in seconds for the timeout (e.g. 600 seconds represents 10 minutes). */
     durationSecs?: number;
-    /** Boolean indicating if this event message is enabled. */
+    /**
+     * Boolean indicating if this timeout is enabled.
+     *
+     * If set to false, EVI will not timeout due to a specified duration being reached. However, the conversation will eventually disconnect after 1,800 seconds (30 minutes), which is the maximum WebSocket duration limit for EVI.
+     */
     enabled: boolean;
 }

package/dist/cjs/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * Collection of timeout specs to be returned from the server
+ * Collection of timeout specifications returned by the server.
+ *
+ * Timeouts are sent by the server when specific time-based events occur during a chat session. These specifications set the inactivity timeout and the maximum duration an EVI WebSocket connection can stay open before it is automatically disconnected.
  */
 export interface ReturnTimeoutSpecs {
     inactivity: Hume.empathicVoice.ReturnTimeoutSpec;

package/dist/cjs/api/resources/empathicVoice/types/ReturnUserDefinedTool.d.ts

@@ -5,22 +5,33 @@ import type * as Hume from "../../../index.js";
 export interface ReturnUserDefinedTool {
     /** The timestamp when the first version of this tool was created. */
     createdOn: number;
-    /** Text describing what the tool does. */
+    /** An optional description of what the Tool does, used by the supplemental LLM to choose when and how to call the function. */
     description?: string;
-    /** Text to use if the tool fails to generate content. */
+    /** Optional text passed to the supplemental LLM in place of the tool call result. The LLM then uses this text to generate a response back to the user, ensuring continuity in the conversation if the Tool errors. */
     fallbackContent?: string;
     /** Identifier for a Tool. Formatted as a UUID. */
     id: string;
     /** The timestamp when this version of the tool was created. */
     modifiedOn: number;
-    /** Name applied to all versions of a particular Tool. */
+    /**
+     * Name of the built-in tool to use. Hume supports the following built-in tools:
+     *
+     * - **web_search:** enables EVI to search the web for up-to-date information when applicable.
+     * - **hang_up:** closes the WebSocket connection when appropriate (e.g., after detecting a farewell in the conversation).
+     *
+     * For more information, see our guide on [using built-in tools](/docs/speech-to-speech-evi/features/tool-use#using-built-in-tools).
+     */
     name: string;
-    /** Stringified JSON defining the parameters used by this version of the Tool. */
+    /**
+     * Stringified JSON defining the parameters used by this version of the Tool.
+     *
+     * These parameters define the inputs needed for the Tool's execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the Tool receives data in the expected format.
+     */
     parameters: string;
     toolType: Hume.empathicVoice.ReturnUserDefinedToolToolType;
     /** Version number for a Tool. Version numbers should be integers. The combination of configId and version number is unique. */
     version: number;
-    /** Description that is appended to a specific version of a Tool. */
+    /** An optional description of the Tool version. */
     versionDescription?: string;
     versionType: Hume.empathicVoice.ReturnUserDefinedToolVersionType;
 }

package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookEventType.d.ts

@@ -1,4 +1,8 @@
-/** Events this URL is subscribed to */
+/**
+ * The list of events the specified URL is subscribed to.
+ *
+ * See our [webhooks guide](/docs/speech-to-speech-evi/configuration/build-a-configuration#supported-events) for more information on supported events.
+ */
 export declare const ReturnWebhookEventType: {
     readonly ChatStarted: "chat_started";
     readonly ChatEnded: "chat_ended";

package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookEventType.js

@@ -2,7 +2,11 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnWebhookEventType = void 0;
-/** Events this URL is subscribed to */
+/**
+ * The list of events the specified URL is subscribed to.
+ *
+ * See our [webhooks guide](/docs/speech-to-speech-evi/configuration/build-a-configuration#supported-events) for more information on supported events.
+ */
 exports.ReturnWebhookEventType = {
     ChatStarted: "chat_started",
     ChatEnded: "chat_ended",

package/dist/cjs/api/resources/empathicVoice/types/ReturnWebhookSpec.d.ts

@@ -3,8 +3,12 @@ import type * as Hume from "../../../index.js";
  * Collection of webhook URL endpoints to be returned from the server
  */
 export interface ReturnWebhookSpec {
-    /** Events this URL is subscribed to */
+    /**
+     * The list of events the specified URL is subscribed to.
+     *
+     * See our [webhooks guide](/docs/speech-to-speech-evi/configuration/build-a-configuration#supported-events) for more information on supported events.
+     */
     events: Hume.empathicVoice.ReturnWebhookEventType[];
-    /** Webhook URL to send the event updates to */
+    /** The URL where event payloads will be sent. This must be a valid https URL to ensure secure communication. The server at this URL must accept POST requests with a JSON payload. */
     url: string;
 }

package/dist/cjs/api/resources/empathicVoice/types/SessionSettings.d.ts

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * Settings for this chat session.
+ * **Settings for this chat session.** Session settings are temporary and apply only to the current Chat session.
+ *
+ * These settings can be adjusted dynamically based on the requirements of each session to ensure optimal performance and user experience. See our [Session Settings Guide](/docs/speech-to-speech-evi/configuration/session-settings) for a complete list of configurable settings.
  */
 export interface SessionSettings {
     /**
@@ -18,11 +20,11 @@ export interface SessionSettings {
      */
     builtinTools?: Hume.empathicVoice.BuiltinToolConfig[];
     /**
-     * Allows developers to inject additional context into the conversation, which is appended to the end of user messages for the session.
+     * Field for injecting additional context into the conversation, which is appended to the end of user messages for the session.
      *
      * When included in a Session Settings message, the provided context can be used to remind the LLM of its role in every user message, prevent it from forgetting important details, or add new relevant information to the conversation.
      *
-     * Set to `null` to disable context injection.
+     * Set to `null` to clear injected context.
      */
     context?: Hume.empathicVoice.Context;
     /**
@@ -64,7 +66,14 @@ export interface SessionSettings {
      * For more information, please refer to the [Session Settings section](/docs/empathic-voice-interface-evi/configuration#session-settings) on the EVI Configuration page.
      */
     type: "session_settings";
-    /** Dynamic values that can be used to populate EVI prompts. */
+    /**
+     * This field allows you to assign values to dynamic variables referenced in your system prompt.
+     *
+     * Each key represents the variable name, and the corresponding value is the specific content you wish to assign to that variable within the session. While the values for variables can be strings, numbers, or booleans, the value will ultimately be converted to a string when injected into your system prompt.
+     *
+     * Using this field, you can personalize responses based on session-specific details. For more guidance, see our [guide on using dynamic variables](/docs/speech-to-speech-evi/features/dynamic-variables).
+     */
     variables?: Record<string, Hume.empathicVoice.SessionSettingsVariablesValue>;
+    /** Allows you to change the voice during an active chat. Updating the voice does not affect chat context or conversation history. */
     voiceId?: string;
 }

package/dist/cjs/api/resources/empathicVoice/types/ToolCallMessage.d.ts

@@ -1,13 +1,19 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is a tool call.
+ * **Indicates that the supplemental LLM has detected a need to invoke the specified tool.** This message is only received for user-defined function tools.
+ *
+ * Contains the tool name, parameters (as a stringified JSON schema), whether a response is required from the developer (either in the form of a `ToolResponseMessage` or a `ToolErrorMessage`), the unique tool call ID for tracking the request and response, and the tool type. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details.
  */
 export interface ToolCallMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */
     customSessionId?: string;
     /** Name of the tool called. */
     name: string;
-    /** Parameters of the tool call. Is a stringified JSON schema. */
+    /**
+     * Parameters of the tool.
+     *
+     * These parameters define the inputs needed for the tool's execution, including the expected data type and description for each input field. Structured as a stringified JSON schema, this format ensures the tool receives data in the expected format.
+     */
     parameters: string;
     /** Indicates whether a response to the tool call is required from the developer, either in the form of a [Tool Response message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Response%20Message.type) or a [Tool Error message](/reference/empathic-voice-interface-evi/chat/chat#send.Tool%20Error%20Message.type). */
     responseRequired: boolean;

package/dist/cjs/api/resources/empathicVoice/types/ToolErrorMessage.d.ts

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is a function call error.
+ * **Error message from the tool call**, not exposed to the LLM or user. Upon receiving a Tool Call message and failing to invoke the function, this message is sent to notify EVI of the tool's failure.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage` if the tool fails. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details.
  */
 export interface ToolErrorMessage {
     /** Error code. Identifies the type of error encountered. */

package/dist/cjs/api/resources/empathicVoice/types/ToolResponseMessage.d.ts

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is a function call response.
+ * **Return value of the tool call.** Contains the output generated by the tool to pass back to EVI. Upon receiving a Tool Call message and successfully invoking the function, this message is sent to convey the result of the function call back to EVI.
+ *
+ * For built-in tools implemented on the server, you will receive this message type rather than a `ToolCallMessage`. See our [Tool Use Guide](/docs/speech-to-speech-evi/features/tool-use) for further details.
  */
 export interface ToolResponseMessage {
     /** Return value of the tool call. Contains the output generated by the tool to pass back to EVI. */

package/dist/cjs/api/resources/empathicVoice/types/UserInput.d.ts

@@ -1,5 +1,5 @@
 /**
- * User text to insert into the conversation. Text sent through a User Input message is treated as the user's speech to EVI. EVI processes this input and provides a corresponding response.
+ * **User text to insert into the conversation.** Text sent through a User Input message is treated as the user's speech to EVI. EVI processes this input and provides a corresponding response.
  *
  * Expression measurement results are not available for User Input messages, as the prosody model relies on audio input and cannot process text alone.
  */

package/dist/cjs/api/resources/empathicVoice/types/UserInterruption.d.ts

@@ -1,5 +1,7 @@
 /**
- * When provided, the output is an interruption.
+ * **Indicates the user has interrupted the assistant's response.** EVI detects the interruption in real-time and sends this message to signal the interruption event.
+ *
+ * This message allows the system to stop the current audio playback, clear the audio queue, and prepare to handle new user input. Contains a Unix timestamp of when the user interruption was detected. For more details, see our [Interruptibility Guide](/docs/speech-to-speech-evi/features/interruptibility)
  */
 export interface UserInterruption {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

package/dist/cjs/api/resources/empathicVoice/types/UserMessage.d.ts

@@ -1,6 +1,8 @@
 import type * as Hume from "../../../index.js";
 /**
- * When provided, the output is a user message.
+ * **Transcript of the user's message.** Contains the message role and content, along with a `from_text` field indicating if this message was inserted into the conversation as text from a `UserInput` message.
+ *
+ * Includes an `interim` field indicating whether the transcript is provisional (words may be repeated or refined in subsequent `UserMessage` responses as additional audio is processed) or final and complete. Interim transcripts are only sent when the `verbose_transcription` query parameter is set to true in the initial handshake.
  */
 export interface UserMessage {
     /** Used to manage conversational state, correlate frontend and backend data, and persist conversations across EVI sessions. */

package/dist/cjs/api/resources/empathicVoice/types/VoiceId.d.ts

@@ -5,7 +5,7 @@ export interface VoiceId {
     /**
      * Specifies the source provider associated with the chosen voice.
      *
-     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://app.hume.ai/voices), containing a variety of preset, shared voices.
+     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://app.hume.ai/tts/voice-library), containing a variety of preset, shared voices.
      * - **`CUSTOM_VOICE`**: Select from voices you've personally generated and saved in your account.
      *
      * If no provider is explicitly set, the default provider is `CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you must explicitly set the provider to `HUME_AI`.

package/dist/cjs/api/resources/empathicVoice/types/VoiceName.d.ts

@@ -5,7 +5,7 @@ export interface VoiceName {
     /**
      * Specifies the source provider associated with the chosen voice.
      *
-     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://app.hume.ai/voices), containing a variety of preset, shared voices.
+     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://app.hume.ai/tts/voice-library), containing a variety of preset, shared voices.
      * - **`CUSTOM_VOICE`**: Select from voices you've personally generated and saved in your account.
      *
      * If no provider is explicitly set, the default provider is `CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you must explicitly set the provider to `HUME_AI`.

package/dist/cjs/api/resources/empathicVoice/types/WebSocketError.d.ts

@@ -1,5 +1,7 @@
 /**
- * When provided, the output is an error message.
+ * **Indicates a disruption in the WebSocket connection**, such as an unexpected disconnection, protocol error, or data transmission issue.
+ *
+ * Contains an error code identifying the type of error encountered, a detailed description of the error, and a short, human-readable identifier and description (slug) for the error.
  */
 export interface WebSocketError {
     /** Error code. Identifies the type of error encountered. */

package/dist/cjs/api/resources/empathicVoice/types/WebhookEventChatEnded.d.ts

@@ -12,4 +12,6 @@ export interface WebhookEventChatEnded extends Hume.empathicVoice.WebhookEventBa
     endTime: number;
     /** Always `chat_ended`. */
     eventName?: "chat_ended";
+    /** Twilio metadata associated with the chat. This field is included only if the Chat was created via the [Twilio phone calling](/docs/empathic-voice-interface-evi/phone-calling) integration. Fields may include `call_sid`, `account_sid`, `from_number`, `to_number`, `caller_name`, `caller_number`, `from_city`, `from_state`, `from_zip`, `from_country`, `to_city`, `to_state`, `to_zip`, and `to_country`.If a specific metadata is not available, this field will be set to an empty string. */
+    twilioMetadata?: Record<string, string | undefined>;
 }

package/dist/cjs/api/resources/empathicVoice/types/WebhookEventChatStarted.d.ts

@@ -10,4 +10,6 @@ export interface WebhookEventChatStarted extends Hume.empathicVoice.WebhookEvent
     eventName?: "chat_started";
     /** Unix timestamp (in milliseconds) indicating when the session started. */
     startTime: number;
+    /** Twilio metadata associated with the chat. This field is included only if the Chat was created via the [Twilio phone calling](/docs/empathic-voice-interface-evi/phone-calling) integration. Fields may include `call_sid`, `account_sid`, `from_number`, `to_number`, `caller_name`, `caller_number`, `from_city`, `from_state`, `from_zip`, `from_country`, `to_city`, `to_state`, `to_zip`, and `to_country`. If a specific metadata is not available, this field will be set to an empty string. */
+    twilioMetadata?: Record<string, string | undefined>;
 }

package/dist/cjs/api/resources/empathicVoice/types/WebhookEventToolCall.d.ts

@@ -10,4 +10,6 @@ export interface WebhookEventToolCall extends Hume.empathicVoice.WebhookEventBas
     timestamp: number;
     /** The tool call. */
     toolCallMessage: Hume.empathicVoice.ToolCallMessage;
+    /** Twilio metadata associated with the chat. This field is included only if the Chat was created via the [Twilio phone calling](/docs/empathic-voice-interface-evi/phone-calling) integration. Fields may include `call_sid`, `account_sid`, `from_number`, `to_number`, `caller_name`, `caller_number`, `from_city`, `from_state`, `from_zip`, `from_country`, `to_city`, `to_state`, `to_zip`, and `to_country`.If a specific metadata is not available, this field will be set to an empty string. */
+    twilioMetadata?: Record<string, string | undefined>;
 }

package/dist/cjs/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.d.ts

@@ -5,6 +5,8 @@ export declare namespace StreamClient {
     type Options = BaseClientOptions;
     interface ConnectArgs {
         "X-Hume-Api-Key": string;
+        /** Additional query parameters to send with the websocket connect request. */
+        queryParams?: Record<string, unknown>;
         /** Arbitrary headers to send with the websocket connect request. */
         headers?: Record<string, string>;
         /** Enable debug mode on the websocket. Defaults to false. */

package/dist/cjs/api/resources/expressionMeasurement/resources/stream/resources/stream/client/Client.js

@@ -56,12 +56,12 @@ class StreamClient {
     connect(args) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
-            const { headers, debug, reconnectAttempts } = args;
+            const { queryParams, headers, debug, reconnectAttempts } = args;
             const _headers = (0, headers_js_1.mergeHeaders)((0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Hume-Api-Key": args["X-Hume-Api-Key"] }), headers);
             const socket = new core.ReconnectingWebSocket({
                 url: core.url.join((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Prod).stream, "/models"),
                 protocols: [],
-                queryParameters: {},
+                queryParameters: (queryParams !== null && queryParams !== void 0 ? queryParams : {}),
                 headers: _headers,
                 options: { debug: debug !== null && debug !== void 0 ? debug : false, maxRetries: reconnectAttempts !== null && reconnectAttempts !== void 0 ? reconnectAttempts : 30 },
             });

package/dist/cjs/api/resources/tts/resources/voices/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare class VoicesClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<VoicesClient.Options>;
     constructor(options?: VoicesClient.Options);
     /**
-     * Lists voices you have saved in your account, or voices from the [Voice Library](https://app.hume.ai/voices).
+     * Lists voices you have saved in your account, or voices from the [Voice Library](https://app.hume.ai/tts/voice-library).
      *
      * @param {Hume.tts.VoicesListRequest} request
      * @param {VoicesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/tts/resources/voices/client/Client.js

@@ -57,7 +57,7 @@ class VoicesClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
-     * Lists voices you have saved in your account, or voices from the [Voice Library](https://app.hume.ai/voices).
+     * Lists voices you have saved in your account, or voices from the [Voice Library](https://app.hume.ai/tts/voice-library).
      *
      * @param {Hume.tts.VoicesListRequest} request
      * @param {VoicesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/tts/resources/voices/client/requests/VoicesListRequest.d.ts

@@ -9,7 +9,7 @@ export interface VoicesListRequest {
     /**
      * Specify the voice provider to filter voices returned by the endpoint:
      *
-     * - **`HUME_AI`**: Lists preset, shared voices from Hume's [Voice Library](https://app.hume.ai/voices).
+     * - **`HUME_AI`**: Lists preset, shared voices from Hume's [Voice Library](https://app.hume.ai/tts/voice-library).
      * - **`CUSTOM_VOICE`**: Lists custom voices created and saved to your account.
      */
     provider: Hume.tts.VoiceProvider;

package/dist/cjs/api/resources/tts/types/PostedUtteranceVoiceWithId.d.ts

@@ -5,7 +5,7 @@ export interface PostedUtteranceVoiceWithId {
     /**
      * Specifies the source provider associated with the chosen voice.
      *
-     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://app.hume.ai/voices), containing a variety of preset, shared voices.
+     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://app.hume.ai/tts/voice-library), containing a variety of preset, shared voices.
      * - **`CUSTOM_VOICE`**: Select from voices you've personally generated and saved in your account.
      *
      * If no provider is explicitly set, the default provider is `CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you must explicitly set the provider to `HUME_AI`.

package/dist/cjs/api/resources/tts/types/PostedUtteranceVoiceWithName.d.ts

@@ -5,7 +5,7 @@ export interface PostedUtteranceVoiceWithName {
     /**
      * Specifies the source provider associated with the chosen voice.
      *
-     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://app.hume.ai/voices), containing a variety of preset, shared voices.
+     * - **`HUME_AI`**: Select voices from Hume's [Voice Library](https://app.hume.ai/tts/voice-library), containing a variety of preset, shared voices.
      * - **`CUSTOM_VOICE`**: Select from voices you've personally generated and saved in your account.
      *
      * If no provider is explicitly set, the default provider is `CUSTOM_VOICE`. When using voices from Hume's **Voice Library**, you must explicitly set the provider to `HUME_AI`.

package/dist/cjs/api/resources/tts/types/ReturnPagedVoices.d.ts

@@ -3,7 +3,11 @@ import type * as Hume from "../../../index.js";
  * A paginated list Octave voices available for text-to-speech
  */
 export interface ReturnPagedVoices {
-    /** The page number of the returned results. */
+    /**
+     * The page number of the returned list.
+     *
+     * This value corresponds to the `page_number` parameter specified in the request. Pagination uses zero-based indexing.
+     */
     pageNumber: number;
     /**
      * The maximum number of items returned per page.

package/dist/cjs/core/schemas/builders/object/object.js

@@ -197,6 +197,8 @@ function getObjectUtils(schema) {
             return Object.assign(Object.assign(Object.assign(Object.assign({}, baseSchema), (0, index_js_2.getSchemaUtils)(baseSchema)), (0, index_js_1.getObjectLikeUtils)(baseSchema)), getObjectUtils(baseSchema));
         },
         passthrough: () => {
+            const knownRawKeys = new Set(schema._getRawProperties());
+            const knownParsedKeys = new Set(schema._getParsedProperties());
             const baseSchema = {
                 _getParsedProperties: () => schema._getParsedProperties(),
                 _getRawProperties: () => schema._getRawProperties(),
@@ -205,9 +207,17 @@ function getObjectUtils(schema) {
                     if (!transformed.ok) {
                         return transformed;
                     }
+                    const extraProperties = {};
+                    if (typeof raw === "object" && raw != null) {
+                        for (const [key, value] of Object.entries(raw)) {
+                            if (!knownRawKeys.has(key)) {
+                                extraProperties[key] = value;
+                            }
+                        }
+                    }
                     return {
                         ok: true,
-                        value: Object.assign(Object.assign({}, raw), transformed.value),
+                        value: Object.assign(Object.assign({}, extraProperties), transformed.value),
                     };
                 },
                 json: (parsed, opts) => {
@@ -215,9 +225,17 @@ function getObjectUtils(schema) {
                     if (!transformed.ok) {
                         return transformed;
                     }
+                    const extraProperties = {};
+                    if (typeof parsed === "object" && parsed != null) {
+                        for (const [key, value] of Object.entries(parsed)) {
+                            if (!knownParsedKeys.has(key)) {
+                                extraProperties[key] = value;
+                            }
+                        }
+                    }
                     return {
                         ok: true,
-                        value: Object.assign(Object.assign({}, parsed), transformed.value),
+                        value: Object.assign(Object.assign({}, extraProperties), transformed.value),
                     };
                 },
                 getType: () => Schema_js_1.SchemaType.OBJECT,

package/dist/cjs/serialization/resources/empathicVoice/types/WebhookEventChatEnded.d.ts

@@ -12,5 +12,6 @@ export declare namespace WebhookEventChatEnded {
         end_reason: WebhookEventChatStatus.Raw;
         end_time: number;
         event_name?: "chat_ended" | null;
+        twilio_metadata?: Record<string, string | null | undefined> | null;
     }
 }