phonic 0.30.5 → 0.30.7

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

@@ -0,0 +1,72 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../index.js";
+export interface CreateAgentRequest {
+    /** The name of the agent. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
+    name: string;
+    phone_number?: "assign-automatically";
+    /** The timezone of the agent. Used to format system variables like `{{system_time}}`. */
+    timezone?: string;
+    /** The voice ID to use. */
+    voice_id?: string;
+    /** The audio format of the agent. */
+    audio_format?: CreateAgentRequest.AudioFormat;
+    /** The audio speed of the agent. */
+    audio_speed?: number;
+    /** The background noise level of the agent. */
+    background_noise_level?: number;
+    /** Message to play when the conversation starts. Can contain template variables like `{{customer_name}}`. */
+    welcome_message?: string;
+    /** Instructions for the conversation. Can contain template variables like `{{subject}}`. */
+    system_prompt?: string;
+    /** Variables that can be used in the welcome message and the system prompt. */
+    template_variables?: Record<string, CreateAgentRequest.TemplateVariables.Value>;
+    /** Array of built-in or custom tool names to use. */
+    tools?: CreateAgentRequest.Tools.Item[];
+    /** Array of task objects with `name` and `description` fields. */
+    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`, at the beginning of the conversation the agent will make a POST request to this endpoint when to get configuration options. */
+    configuration_endpoint?: CreateAgentRequest.ConfigurationEndpoint;
+}
+export declare namespace CreateAgentRequest {
+    /**
+     * The audio format of the agent.
+     */
+    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`, at the beginning of the conversation the agent will make a POST request to this endpoint when to get configuration options.
+     */
+    interface ConfigurationEndpoint {
+        /** URL to call */
+        url: string;
+        /** Object of key-value pairs. */
+        headers?: Record<string, string>;
+        /** Timeout in milliseconds for the endpoint call. */
+        timeout_ms?: number;
+    }
+}

package/dist/cjs/api/types/CreateAgentRequest.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.CreateAgentRequest = void 0;
+var CreateAgentRequest;
+(function (CreateAgentRequest) {
+    CreateAgentRequest.AudioFormat = {
+        Pcm44100: "pcm_44100",
+        Mulaw8000: "mulaw_8000",
+    };
+})(CreateAgentRequest || (exports.CreateAgentRequest = CreateAgentRequest = {}));

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DtmfPayload {
+    type: "dtmf";
+    /** DTMF digits to play */
+    digits: string;
+}

package/dist/cjs/api/types/DtmfPayload.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/ErrorPayload.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ErrorPayload {
+    type: "error";
+    error: ErrorPayload.Error_;
+    /** Parameter-specific validation errors */
+    param_errors?: Record<string, string>;
+}
+export declare namespace ErrorPayload {
+    interface Error_ {
+        /** Error message */
+        message: string;
+        /** Error code */
+        code?: string;
+    }
+}

package/dist/cjs/api/types/ErrorPayload.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/Error_.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 Error_ = Phonic.BasicError | Phonic.ValidationError;

package/dist/cjs/api/types/Error_.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/ExtractionField.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ExtractionField {
+    /** The field name. */
+    name: string;
+    /** The field type. */
+    type: ExtractionField.Type;
+    /** Description of the field. */
+    description?: string;
+}
+export declare namespace ExtractionField {
+    /**
+     * The field type.
+     */
+    type Type = "string" | "int" | "float" | "bool";
+    const Type: {
+        readonly String: "string";
+        readonly Int: "int";
+        readonly Float: "float";
+        readonly Bool: "bool";
+    };
+}

package/dist/cjs/api/types/ExtractionField.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.ExtractionField = void 0;
+var ExtractionField;
+(function (ExtractionField) {
+    ExtractionField.Type = {
+        String: "string",
+        Int: "int",
+        Float: "float",
+        Bool: "bool",
+    };
+})(ExtractionField || (exports.ExtractionField = ExtractionField = {}));

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../index.js";
+export interface ExtractionSchema {
+    /** The ID of the extraction schema. */
+    id: string;
+    /** The name of the extraction schema. */
+    name: string;
+    /** Instructions for how to extract data from conversations. */
+    prompt: string;
+    /** Array of field definitions specifying what data to extract. */
+    fields: Phonic.ExtractionField[];
+}

package/dist/cjs/api/types/ExtractionSchema.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/InputCancelledPayload.d.ts

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

package/dist/cjs/api/types/InputCancelledPayload.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/InputTextPayload.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InputTextPayload {
+    type: "input_text";
+    /** Transcribed user speech */
+    text: string;
+}

package/dist/cjs/api/types/InputTextPayload.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/InterruptedResponsePayload.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InterruptedResponsePayload {
+    type: "interrupted_response";
+    /** Truncated AI response text at interruption point */
+    text: string;
+}

package/dist/cjs/api/types/InterruptedResponsePayload.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/IsUserSpeakingPayload.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface IsUserSpeakingPayload {
+    type: "is_user_speaking";
+    /** Whether the user is currently speaking */
+    is_user_speaking: boolean;
+}

package/dist/cjs/api/types/IsUserSpeakingPayload.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/OutboundCallConfig.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * When an `agent` is provided, these `config` options override the agent settings.
+ */
+export interface OutboundCallConfig {
+    /** The name of the agent to use for the call. */
+    agent?: string;
+    /** The name of the project to use for the call. */
+    project?: string;
+    /** Message to play when the conversation starts. Can contain template variables like `{{customer_name}}`. */
+    welcome_message?: string;
+    /** Instructions for the conversation. Can contain template variables like `{{subject}}`. */
+    system_prompt?: string;
+    /** Variables that can be used in the welcome message and the system prompt. */
+    template_variables?: Record<string, string>;
+    /** The voice ID to use for the agent. */
+    voice_id?: string;
+    /** 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[];
+    /** Array of built-in or custom tool names to use. */
+    tools?: OutboundCallConfig.Tools.Item[];
+}
+export declare namespace OutboundCallConfig {
+    type Tools = Tools.Item[];
+    namespace Tools {
+        type Item = "keypad_input" | "natural_conversation_ending"
+        /**
+         * Custom tool */
+         | string;
+    }
+}

package/dist/cjs/api/types/OutboundCallConfig.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/Project.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Project {
+    /** The ID of the project. */
+    id: string;
+    /** The name of the project. */
+    name: string;
+    /** The project's default agent. */
+    default_agent?: Project.DefaultAgent;
+}
+export declare namespace Project {
+    /**
+     * The project's default agent.
+     */
+    interface DefaultAgent {
+        /** The ID of the project's default agent. */
+        id: string;
+        /** The name of the project's default agent. */
+        name: string;
+    }
+}

package/dist/cjs/api/types/Project.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/ReadyToStartConversationPayload.d.ts

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

package/dist/cjs/api/types/ReadyToStartConversationPayload.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/SetExternalIdPayload.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SetExternalIdPayload {
+    type: "set_external_id";
+    /** External ID to associate with conversation */
+    external_id: string;
+}

package/dist/cjs/api/types/SetExternalIdPayload.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/SetTwilioCallSidPayload.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SetTwilioCallSidPayload {
+    type: "set_twilio_call_sid";
+    /** Encrypted Twilio call data */
+    encrypted_data: string;
+}

package/dist/cjs/api/types/SetTwilioCallSidPayload.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/Task.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Task {
+    /** The name of the task. */
+    name: string;
+    /** The description of the task. */
+    description: string;
+}

package/dist/cjs/api/types/Task.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/Tool.d.ts

@@ -0,0 +1,54 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../index.js";
+export interface Tool {
+    /** The ID of the tool. */
+    id: string;
+    /** The name of the tool. */
+    name: string;
+    /** Description of what the tool does. */
+    description: string;
+    project: Tool.Project;
+    /** The type of tool. */
+    type: Tool.Type;
+    /** Mode of operation - sync waits for response, async continues without waiting. */
+    execution_mode: Tool.ExecutionMode;
+    /** Array of parameter definitions for the tool. */
+    parameters: Phonic.ToolParameter[];
+    /** HTTP method for webhook tools. */
+    endpoint_method?: "POST";
+    /** URL for webhook tools. */
+    endpoint_url?: string;
+    /** Headers for webhook tools. */
+    endpoint_headers?: Record<string, string>;
+    /** Timeout in milliseconds for webhook tools. */
+    endpoint_timeout_ms?: number;
+    /** Timeout in milliseconds for WebSocket tool responses. */
+    tool_call_output_timeout_ms?: number;
+    /** The E.164 formatted phone number to transfer calls to. Required for built_in_transfer_to_phone_number tools. */
+    phone_number?: string;
+}
+export declare namespace Tool {
+    interface Project {
+        id: string;
+        name: string;
+    }
+    /**
+     * The type of tool.
+     */
+    type Type = "custom_webhook" | "custom_websocket" | "built_in_transfer_to_phone_number";
+    const Type: {
+        readonly CustomWebhook: "custom_webhook";
+        readonly CustomWebsocket: "custom_websocket";
+        readonly BuiltInTransferToPhoneNumber: "built_in_transfer_to_phone_number";
+    };
+    /**
+     * Mode of operation - sync waits for response, async continues without waiting.
+     */
+    type ExecutionMode = "sync" | "async";
+    const ExecutionMode: {
+        readonly Sync: "sync";
+        readonly Async: "async";
+    };
+}

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

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tool = void 0;
+var Tool;
+(function (Tool) {
+    Tool.Type = {
+        CustomWebhook: "custom_webhook",
+        CustomWebsocket: "custom_websocket",
+        BuiltInTransferToPhoneNumber: "built_in_transfer_to_phone_number",
+    };
+    Tool.ExecutionMode = {
+        Sync: "sync",
+        Async: "async",
+    };
+})(Tool || (exports.Tool = Tool = {}));

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ToolCallInterruptedPayload {
+    type: "tool_call_interrupted";
+    /** ID of the interrupted tool call */
+    tool_call_id: string;
+    /** Name of the interrupted tool */
+    tool_name: string;
+    /** Description of why the tool call was interrupted */
+    error_message: string;
+}

package/dist/cjs/api/types/ToolCallInterruptedPayload.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/ToolCallOutputPayload.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ToolCallOutputPayload {
+    type: "tool_call_output";
+    /** ID of the tool call being responded to */
+    tool_call_id: string;
+    output?: unknown;
+}

package/dist/cjs/api/types/ToolCallOutputPayload.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/ToolCallOutputProcessedPayload.d.ts

@@ -0,0 +1,35 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ToolCallOutputProcessedPayload {
+    type: "tool_call_output_processed";
+    /** ID of the completed tool call */
+    tool_call_id: string;
+    tool: ToolCallOutputProcessedPayload.Tool;
+    /** Webhook endpoint URL (null for WebSocket tools) */
+    endpoint_url?: string;
+    /** Webhook timeout in milliseconds (null for WebSocket tools) */
+    endpoint_timeout_ms?: number;
+    /** When webhook was called (null for WebSocket tools) */
+    endpoint_called_at?: string;
+    /** Webhook request body (null for WebSocket tools) */
+    request_body?: Record<string, unknown>;
+    response_body?: unknown;
+    /** WebSocket tool parameters (null for webhook tools) */
+    parameters?: Record<string, unknown>;
+    output?: unknown;
+    /** Webhook HTTP status code (null for WebSocket tools) */
+    response_status_code?: number;
+    /** Whether the tool call timed out */
+    timed_out?: boolean;
+    /** Error message if tool call failed */
+    error_message?: string;
+}
+export declare namespace ToolCallOutputProcessedPayload {
+    interface Tool {
+        /** Tool ID */
+        id: string;
+        /** Human-readable tool name */
+        name: string;
+    }
+}

package/dist/cjs/api/types/ToolCallOutputProcessedPayload.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/ToolCallPayload.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ToolCallPayload {
+    type: "tool_call";
+    /** Unique ID for this tool call */
+    tool_call_id: string;
+    /** Name of the tool to execute */
+    tool_name: string;
+    /** Parameters for tool execution */
+    parameters: Record<string, unknown>;
+}

package/dist/cjs/api/types/ToolCallPayload.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/ToolParameter.d.ts

@@ -0,0 +1,38 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ToolParameter {
+    /** The parameter type. */
+    type: ToolParameter.Type;
+    /** Required only when type is "array". The type of items in the array. */
+    item_type?: ToolParameter.ItemType;
+    /** The parameter name. */
+    name: string;
+    /** Description of the parameter. */
+    description: string;
+    /** Whether the parameter is required. */
+    is_required: boolean;
+}
+export declare namespace ToolParameter {
+    /**
+     * The parameter type.
+     */
+    type Type = "string" | "integer" | "number" | "boolean" | "array";
+    const Type: {
+        readonly String: "string";
+        readonly Integer: "integer";
+        readonly Number: "number";
+        readonly Boolean: "boolean";
+        readonly Array: "array";
+    };
+    /**
+     * Required only when type is "array". The type of items in the array.
+     */
+    type ItemType = "string" | "integer" | "number" | "boolean";
+    const ItemType: {
+        readonly String: "string";
+        readonly Integer: "integer";
+        readonly Number: "number";
+        readonly Boolean: "boolean";
+    };
+}

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

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolParameter = void 0;
+var ToolParameter;
+(function (ToolParameter) {
+    ToolParameter.Type = {
+        String: "string",
+        Integer: "integer",
+        Number: "number",
+        Boolean: "boolean",
+        Array: "array",
+    };
+    ToolParameter.ItemType = {
+        String: "string",
+        Integer: "integer",
+        Number: "number",
+        Boolean: "boolean",
+    };
+})(ToolParameter || (exports.ToolParameter = ToolParameter = {}));