phonic 0.30.5 → 0.30.6

package/dist/cjs/api/resources/voices/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./VoicesListResponse.js";
+export * from "./VoicesGetResponse.js";

package/dist/cjs/api/resources/voices/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./VoicesListResponse.js"), exports);
+__exportStar(require("./VoicesGetResponse.js"), exports);

package/dist/cjs/api/types/Agent.d.ts

@@ -0,0 +1,80 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../index.js";
+export interface Agent {
+    /** The ID of the agent. */
+    id: string;
+    /** The name of the agent. */
+    name: string;
+    /** The phone number that the agent uses to accept and initiate phone calls. `null` if the agent is not associated with a phone number, in which can the agent can be used via WebSockets. */
+    phone_number?: string;
+    /** The project the agent belongs to. */
+    project: Agent.Project;
+    /** The timezone of the agent. Used to format system variables like `{{system_time}}`. */
+    timezone: string;
+    /** The voice ID of the agent. */
+    voice_id: string;
+    /** The audio format of the agent. If the agent has a phone number, the audio format will be `mulaw_8000`. */
+    audio_format: Agent.AudioFormat;
+    /** The audio speed of the agent. Must be a multiple of 0.1. */
+    audio_speed: number;
+    /** Message to play when the conversation starts. */
+    welcome_message?: string;
+    /** Instructions for the conversation. */
+    system_prompt: string;
+    /** Template variables that the agent can use in the welcome message and the system prompt. */
+    template_variables: Record<string, Agent.TemplateVariables.Value>;
+    /** List of tools available to the agent. */
+    tools: Agent.Tools.Item[];
+    /** Tasks for the agent to complete during the conversation. */
+    tasks: Phonic.Task[];
+    /** Number of seconds of silence before sending a poke message. `null` disables the poke message. */
+    no_input_poke_sec?: number;
+    /** The message to send after the specified silence. */
+    no_input_poke_text: string;
+    /** Seconds of silence before ending the conversation. */
+    no_input_end_conversation_sec: number;
+    /** These words, or short phrases, will be more accurately recognized by the agent. */
+    boosted_keywords: string[];
+    /** When not `null`, the agent will call this endpoint to get configuration options. */
+    configuration_endpoint?: Agent.ConfigurationEndpoint;
+}
+export declare namespace Agent {
+    /**
+     * The project the agent belongs to.
+     */
+    interface Project {
+        id: string;
+        name: string;
+    }
+    /**
+     * The audio format of the agent. If the agent has a phone number, the audio format will be `mulaw_8000`.
+     */
+    type AudioFormat = "pcm_44100" | "mulaw_8000";
+    const AudioFormat: {
+        readonly Pcm44100: "pcm_44100";
+        readonly Mulaw8000: "mulaw_8000";
+    };
+    namespace TemplateVariables {
+        interface Value {
+            default_value?: string;
+        }
+    }
+    type Tools = Tools.Item[];
+    namespace Tools {
+        type Item = "keypad_input" | "natural_conversation_ending"
+        /**
+         * Custom tool */
+         | string;
+    }
+    /**
+     * When not `null`, the agent will call this endpoint to get configuration options.
+     */
+    interface ConfigurationEndpoint {
+        url: string;
+        headers: Record<string, string>;
+        /** The timeout for the configuration endpoint in milliseconds. */
+        timeout_ms: number;
+    }
+}

package/dist/cjs/api/types/Agent.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Agent = void 0;
+var Agent;
+(function (Agent) {
+    Agent.AudioFormat = {
+        Pcm44100: "pcm_44100",
+        Mulaw8000: "mulaw_8000",
+    };
+})(Agent || (exports.Agent = Agent = {}));

package/dist/cjs/api/types/AssistantChoseNotToRespondPayload.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AssistantChoseNotToRespondPayload {
+    type: "assistant_chose_not_to_respond";
+}

package/dist/cjs/api/types/AssistantChoseNotToRespondPayload.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/AssistantEndedConversationPayload.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AssistantEndedConversationPayload {
+    type: "assistant_ended_conversation";
+}

package/dist/cjs/api/types/AssistantEndedConversationPayload.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/AudioChunkPayload.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AudioChunkPayload {
+    type: "audio_chunk";
+    /** Base64-encoded audio data (Int16Array for PCM, Uint8Array for mulaw) */
+    audio: string;
+    /** ISO 8601 timestamp (required for first chunk only) */
+    iso_date_time?: string;
+}

package/dist/cjs/api/types/AudioChunkPayload.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/AudioChunkResponsePayload.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AudioChunkResponsePayload {
+    type: "audio_chunk";
+    /** Base64-encoded AI audio data */
+    audio: string;
+    /** Text corresponding to audio chunk */
+    text: string;
+}

package/dist/cjs/api/types/AudioChunkResponsePayload.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/AudioFinishedPayload.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AudioFinishedPayload {
+    type: "audio_finished";
+}

package/dist/cjs/api/types/AudioFinishedPayload.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/BadRequestErrorBody.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../index.js";
+export type BadRequestErrorBody = Phonic.ValidationError | Phonic.BasicError;

package/dist/cjs/api/types/BadRequestErrorBody.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/BasicError.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BasicError {
+    error?: BasicError.Error_;
+}
+export declare namespace BasicError {
+    interface Error_ {
+        /** Error message */
+        message: string;
+        /** Error code */
+        code?: string;
+    }
+}

package/dist/cjs/api/types/BasicError.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConfigPayload.d.ts

@@ -0,0 +1,66 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConfigPayload {
+    type: "config";
+    /** Agent name to use for conversation */
+    agent?: string;
+    /** Project name */
+    project?: string;
+    /** STS model to use */
+    model?: "merritt";
+    /** System prompt for AI assistant */
+    system_prompt?: string;
+    /** Audio playback speed */
+    audio_speed?: number;
+    /** Message to play when conversation starts */
+    welcome_message?: string;
+    /** Voice ID to use for speech synthesis */
+    voice_id?: string;
+    /** Audio input format */
+    input_format?: ConfigPayload.InputFormat;
+    /** Audio output format */
+    output_format?: ConfigPayload.OutputFormat;
+    /** Voice activity detection prebuffer duration */
+    vad_prebuffer_duration_ms?: number;
+    /** Minimum speech duration for VAD */
+    vad_min_speech_duration_ms?: number;
+    /** Minimum silence duration for VAD */
+    vad_min_silence_duration_ms?: number;
+    /** Voice activity detection threshold */
+    vad_threshold?: number;
+    /** Enable document RAG */
+    enable_documents_rag?: boolean;
+    /** Enable transcript RAG */
+    enable_transcripts_rag?: boolean;
+    /** Seconds of silence before poke message */
+    no_input_poke_sec?: number;
+    /** Poke message text */
+    no_input_poke_text?: string;
+    /** Seconds of silence before ending conversation */
+    no_input_end_conversation_sec?: number;
+    /** Keywords to boost in speech recognition */
+    boosted_keywords?: string[];
+    /** Tools available to the assistant */
+    tools?: string[];
+    /** Template variables for system prompt and welcome message */
+    template_variables?: Record<string, string>;
+}
+export declare namespace ConfigPayload {
+    /**
+     * Audio input format
+     */
+    type InputFormat = "pcm_44100" | "mulaw_8000";
+    const InputFormat: {
+        readonly Pcm44100: "pcm_44100";
+        readonly Mulaw8000: "mulaw_8000";
+    };
+    /**
+     * Audio output format
+     */
+    type OutputFormat = "pcm_44100" | "mulaw_8000";
+    const OutputFormat: {
+        readonly Pcm44100: "pcm_44100";
+        readonly Mulaw8000: "mulaw_8000";
+    };
+}

package/dist/cjs/api/types/ConfigPayload.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigPayload = void 0;
+var ConfigPayload;
+(function (ConfigPayload) {
+    ConfigPayload.InputFormat = {
+        Pcm44100: "pcm_44100",
+        Mulaw8000: "mulaw_8000",
+    };
+    ConfigPayload.OutputFormat = {
+        Pcm44100: "pcm_44100",
+        Mulaw8000: "mulaw_8000",
+    };
+})(ConfigPayload || (exports.ConfigPayload = ConfigPayload = {}));

package/dist/cjs/api/types/Conversation.d.ts

@@ -0,0 +1,64 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../index.js";
+export interface Conversation {
+    /** The conversation ID. */
+    id: string;
+    /** The agent associated with the conversation. */
+    agent?: Conversation.Agent;
+    /** The organization/workspace name. */
+    workspace: string;
+    /** The project associated with the conversation. */
+    project: Conversation.Project;
+    /** External ID for conversation tracking. */
+    external_id?: string;
+    /** The STS model used. */
+    model: string;
+    /** Welcome message played at start. */
+    welcome_message?: string;
+    /** Template variables used in the conversation. */
+    template_variables: Record<string, string>;
+    /** Audio input format. */
+    input_format: string;
+    /** Audio output format. */
+    output_format: string;
+    /** Live transcript of the conversation. */
+    live_transcript: string;
+    /** Post-call processed transcript. */
+    post_call_transcript?: string;
+    /** Duration of the conversation in milliseconds. */
+    duration_ms: number;
+    /** Presigned URL to the conversation audio file. */
+    audio_url?: string;
+    /** When the conversation started. */
+    started_at: string;
+    /** When the conversation ended. */
+    ended_at?: string;
+    /** Array of conversation items (turns). */
+    items: Phonic.ConversationItem[];
+    /** Results from conversation evaluations and extractions. */
+    task_results: Record<string, unknown>;
+}
+export declare namespace Conversation {
+    /**
+     * The agent associated with the conversation.
+     */
+    interface Agent {
+        /** The ID of the agent. */
+        id: string;
+        /** The name of the agent. */
+        name: string;
+        /** Whether the agent has been deleted. */
+        is_deleted: boolean;
+    }
+    /**
+     * The project associated with the conversation.
+     */
+    interface Project {
+        /** The ID of the project. */
+        id: string;
+        /** The name of the project. */
+        name: string;
+    }
+}

package/dist/cjs/api/types/Conversation.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConversationAnalysis.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConversationAnalysis {
+    /** Latencies between turns in milliseconds. */
+    latencies_ms: number[];
+    /** Number of interruptions in the conversation. */
+    interruptions_count: number;
+}

package/dist/cjs/api/types/ConversationAnalysis.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConversationCreatedPayload.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConversationCreatedPayload {
+    type: "conversation_created";
+    /** ID of the created conversation */
+    conversation_id: string;
+}

package/dist/cjs/api/types/ConversationCreatedPayload.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConversationEval.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ConversationEval = unknown;

package/dist/cjs/api/types/ConversationEval.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConversationEvalPrompt.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConversationEvalPrompt {
+    /** The evaluation prompt ID. */
+    id: string;
+    /** The evaluation prompt name. */
+    name: string;
+    /** The evaluation prompt text. */
+    prompt: string;
+}

package/dist/cjs/api/types/ConversationEvalPrompt.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConversationEvaluation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../index.js";
+export interface ConversationEvaluation {
+    /** The evaluation result. */
+    result: Phonic.ConversationEvaluationResult;
+}

package/dist/cjs/api/types/ConversationEvaluation.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConversationEvaluationResult.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConversationEvaluationResult {
+    /** The evaluation ID. */
+    id: string;
+    /** The evaluation result. */
+    result: ConversationEvaluationResult.Result;
+    /** The evaluation prompt information. */
+    prompt: ConversationEvaluationResult.Prompt;
+    /** When the evaluation was created. */
+    created_at: string;
+}
+export declare namespace ConversationEvaluationResult {
+    /**
+     * The evaluation result.
+     */
+    type Result = "successful" | "unsuccessful" | "undecided" | "error";
+    const Result: {
+        readonly Successful: "successful";
+        readonly Unsuccessful: "unsuccessful";
+        readonly Undecided: "undecided";
+        readonly Error: "error";
+    };
+    /**
+     * The evaluation prompt information.
+     */
+    interface Prompt {
+        id: string;
+        name: string;
+    }
+}

package/dist/cjs/api/types/ConversationEvaluationResult.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationEvaluationResult = void 0;
+var ConversationEvaluationResult;
+(function (ConversationEvaluationResult) {
+    ConversationEvaluationResult.Result = {
+        Successful: "successful",
+        Unsuccessful: "unsuccessful",
+        Undecided: "undecided",
+        Error: "error",
+    };
+})(ConversationEvaluationResult || (exports.ConversationEvaluationResult = ConversationEvaluationResult = {}));

package/dist/cjs/api/types/ConversationExtraction.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConversationExtraction {
+    /** The extraction ID. */
+    id: string;
+    /** The conversation ID. */
+    conversation_id?: string;
+    schema: ConversationExtraction.Schema;
+    /** The extracted data. */
+    result: Record<string, unknown>;
+    /** Error message if extraction failed. */
+    error?: string;
+    /** When the extraction was created. */
+    created_at: string;
+}
+export declare namespace ConversationExtraction {
+    interface Schema {
+        id: string;
+        name: string;
+    }
+}

package/dist/cjs/api/types/ConversationExtraction.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ConversationItem.d.ts

@@ -0,0 +1,75 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConversationItem {
+    /** Index of the item in the conversation. */
+    item_idx: number;
+    /** Who spoke in this turn. */
+    role: ConversationItem.Role;
+    /** Live transcript of this turn. */
+    live_transcript: string;
+    /** Post-call processed transcript. */
+    post_call_transcript?: string;
+    /** Duration of this turn in milliseconds. */
+    duration_ms: number;
+    /** When this turn started. */
+    started_at: string;
+    /** Voice ID used (assistant only). */
+    voice_id?: string;
+    /** Audio speed used (assistant only). */
+    audio_speed?: number;
+    /** System prompt used for this assistant turn. */
+    system_prompt?: string;
+    /** Tool calls made by the assistant. */
+    tool_calls?: ConversationItem.ToolCalls.Item[];
+}
+export declare namespace ConversationItem {
+    /**
+     * Who spoke in this turn.
+     */
+    type Role = "user" | "assistant";
+    const Role: {
+        readonly User: "user";
+        readonly Assistant: "assistant";
+    };
+    type ToolCalls = ToolCalls.Item[];
+    namespace ToolCalls {
+        interface Item {
+            /** The tool call ID. */
+            id: string;
+            tool: Item.Tool;
+            /** HTTP method for webhook tool calls. */
+            endpoint_method?: string;
+            /** URL for webhook tool calls. */
+            endpoint_url?: string;
+            /** Headers for webhook tool calls. */
+            endpoint_headers?: Record<string, string | undefined>;
+            /** Timeout in milliseconds for webhook tool calls. */
+            endpoint_timeout_ms?: number;
+            /** When the webhook endpoint was called (null on error). */
+            endpoint_called_at?: string;
+            /** Query parameters for webhook tool calls (null on error or when no params). */
+            query_params?: Record<string, unknown>;
+            /** HTTP response status code for webhook tool calls (null on error). */
+            response_status_code?: number;
+            /** Timeout in milliseconds for websocket tool calls. */
+            tool_call_output_timeout_ms?: number;
+            /** The request body sent to the tool. */
+            request_body?: Record<string, unknown>;
+            /** The response body received from the tool. */
+            response_body?: Record<string, unknown>;
+            /** Whether the tool call timed out. */
+            timed_out?: boolean;
+            /** Error message if the tool call failed. */
+            error_message?: string;
+        }
+        namespace Item {
+            interface Tool {
+                /** The tool ID. */
+                id: string;
+                /** The tool name. */
+                name: string;
+            }
+        }
+    }
+}

package/dist/cjs/api/types/ConversationItem.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationItem = void 0;
+var ConversationItem;
+(function (ConversationItem) {
+    ConversationItem.Role = {
+        User: "user",
+        Assistant: "assistant",
+    };
+})(ConversationItem || (exports.ConversationItem = ConversationItem = {}));