phonic 0.30.3 → 0.30.4

package/dist/esm/api/types/OutboundCallConfig.d.mts

@@ -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/esm/api/types/OutboundCallConfig.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/Project.d.mts

@@ -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/esm/api/types/Project.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ReadyToStartConversationPayload.d.mts

@@ -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/esm/api/types/ReadyToStartConversationPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SetExternalIdPayload.d.mts

@@ -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/esm/api/types/SetExternalIdPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SetTwilioCallSidPayload.d.mts

@@ -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/esm/api/types/SetTwilioCallSidPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/Task.d.mts

@@ -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/esm/api/types/Task.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/Tool.d.mts

@@ -0,0 +1,54 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../index.mjs";
+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/esm/api/types/Tool.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export 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 || (Tool = {}));

package/dist/esm/api/types/ToolCallInterruptedPayload.d.mts

@@ -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/esm/api/types/ToolCallInterruptedPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ToolCallOutputPayload.d.mts

@@ -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/esm/api/types/ToolCallOutputPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ToolCallOutputProcessedPayload.d.mts

@@ -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/esm/api/types/ToolCallOutputProcessedPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ToolCallPayload.d.mts

@@ -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/esm/api/types/ToolCallPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ToolParameter.d.mts

@@ -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/esm/api/types/ToolParameter.mjs

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export 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 || (ToolParameter = {}));

package/dist/esm/api/types/UpdateSystemPromptPayload.d.mts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UpdateSystemPromptPayload {
+    type: "update_system_prompt";
+    /** New system prompt (cannot contain template variables) */
+    system_prompt: string;
+}

package/dist/esm/api/types/UpdateSystemPromptPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/UserFinishedSpeakingPayload.d.mts

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

package/dist/esm/api/types/UserFinishedSpeakingPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/UserStartedSpeakingPayload.d.mts

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

package/dist/esm/api/types/UserStartedSpeakingPayload.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ValidationError.d.mts

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

package/dist/esm/api/types/ValidationError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/Voice.d.mts

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

package/dist/esm/api/types/Voice.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/index.d.mts

@@ -0,0 +1,45 @@
+export * from "./BadRequestErrorBody.mjs";
+export * from "./Error_.mjs";
+export * from "./BasicError.mjs";
+export * from "./ValidationError.mjs";
+export * from "./Agent.mjs";
+export * from "./CreateAgentRequest.mjs";
+export * from "./Tool.mjs";
+export * from "./ToolParameter.mjs";
+export * from "./Voice.mjs";
+export * from "./Project.mjs";
+export * from "./OutboundCallConfig.mjs";
+export * from "./ExtractionSchema.mjs";
+export * from "./ExtractionField.mjs";
+export * from "./Conversation.mjs";
+export * from "./ConversationItem.mjs";
+export * from "./ConversationAnalysis.mjs";
+export * from "./ConversationExtraction.mjs";
+export * from "./ConversationEvaluationResult.mjs";
+export * from "./ConversationEvaluation.mjs";
+export * from "./ConversationEvalPrompt.mjs";
+export * from "./Task.mjs";
+export * from "./ConversationEval.mjs";
+export * from "./ConfigPayload.mjs";
+export * from "./AudioChunkPayload.mjs";
+export * from "./UpdateSystemPromptPayload.mjs";
+export * from "./SetExternalIdPayload.mjs";
+export * from "./SetTwilioCallSidPayload.mjs";
+export * from "./ToolCallOutputPayload.mjs";
+export * from "./ReadyToStartConversationPayload.mjs";
+export * from "./ConversationCreatedPayload.mjs";
+export * from "./InputTextPayload.mjs";
+export * from "./InputCancelledPayload.mjs";
+export * from "./AudioChunkResponsePayload.mjs";
+export * from "./AudioFinishedPayload.mjs";
+export * from "./UserStartedSpeakingPayload.mjs";
+export * from "./UserFinishedSpeakingPayload.mjs";
+export * from "./IsUserSpeakingPayload.mjs";
+export * from "./InterruptedResponsePayload.mjs";
+export * from "./DtmfPayload.mjs";
+export * from "./ToolCallPayload.mjs";
+export * from "./ToolCallOutputProcessedPayload.mjs";
+export * from "./ToolCallInterruptedPayload.mjs";
+export * from "./AssistantChoseNotToRespondPayload.mjs";
+export * from "./AssistantEndedConversationPayload.mjs";
+export * from "./ErrorPayload.mjs";

package/dist/esm/api/types/index.mjs

@@ -0,0 +1,45 @@
+export * from "./BadRequestErrorBody.mjs";
+export * from "./Error_.mjs";
+export * from "./BasicError.mjs";
+export * from "./ValidationError.mjs";
+export * from "./Agent.mjs";
+export * from "./CreateAgentRequest.mjs";
+export * from "./Tool.mjs";
+export * from "./ToolParameter.mjs";
+export * from "./Voice.mjs";
+export * from "./Project.mjs";
+export * from "./OutboundCallConfig.mjs";
+export * from "./ExtractionSchema.mjs";
+export * from "./ExtractionField.mjs";
+export * from "./Conversation.mjs";
+export * from "./ConversationItem.mjs";
+export * from "./ConversationAnalysis.mjs";
+export * from "./ConversationExtraction.mjs";
+export * from "./ConversationEvaluationResult.mjs";
+export * from "./ConversationEvaluation.mjs";
+export * from "./ConversationEvalPrompt.mjs";
+export * from "./Task.mjs";
+export * from "./ConversationEval.mjs";
+export * from "./ConfigPayload.mjs";
+export * from "./AudioChunkPayload.mjs";
+export * from "./UpdateSystemPromptPayload.mjs";
+export * from "./SetExternalIdPayload.mjs";
+export * from "./SetTwilioCallSidPayload.mjs";
+export * from "./ToolCallOutputPayload.mjs";
+export * from "./ReadyToStartConversationPayload.mjs";
+export * from "./ConversationCreatedPayload.mjs";
+export * from "./InputTextPayload.mjs";
+export * from "./InputCancelledPayload.mjs";
+export * from "./AudioChunkResponsePayload.mjs";
+export * from "./AudioFinishedPayload.mjs";
+export * from "./UserStartedSpeakingPayload.mjs";
+export * from "./UserFinishedSpeakingPayload.mjs";
+export * from "./IsUserSpeakingPayload.mjs";
+export * from "./InterruptedResponsePayload.mjs";
+export * from "./DtmfPayload.mjs";
+export * from "./ToolCallPayload.mjs";
+export * from "./ToolCallOutputProcessedPayload.mjs";
+export * from "./ToolCallInterruptedPayload.mjs";
+export * from "./AssistantChoseNotToRespondPayload.mjs";
+export * from "./AssistantEndedConversationPayload.mjs";
+export * from "./ErrorPayload.mjs";

package/dist/esm/api/types/overrides.d.mts

@@ -0,0 +1,50 @@
+import type { Conversation } from "./Conversation";
+type PhonicTool = "send_dtmf_tone" | "end_conversation" | (string & {});
+type ISODateTime = `${string}Z`;
+export type PhonicConfigurationEndpointRequestPayload = {
+    project: {
+        name: string;
+    };
+    agent: {
+        name: string;
+        welcome_message: string;
+        system_prompt: string;
+        tools: Array<PhonicTool>;
+        boosted_keywords: string[];
+    };
+    from_phone_number?: string;
+    to_phone_number?: string;
+};
+export type PhonicConfigurationEndpointResponsePayload = {
+    welcome_message?: string | null;
+    system_prompt?: string;
+    template_variables?: Record<string, string>;
+    tools?: Array<PhonicTool>;
+    boosted_keywords?: string[];
+};
+export type ConversationEndedWebhookPayload = {
+    event_type: "conversation.ended";
+    created_at: ISODateTime;
+    data: {
+        conversation: Conversation;
+        call_info: {
+            from_phone_number: string;
+            to_phone_number: string;
+        } | null;
+    };
+};
+export type ConversationAnalysisWebhookPayload = {
+    event_type: "conversation.analysis";
+    created_at: ISODateTime;
+    data: {
+        conversation: {
+            latencies_ms: number[];
+            interruptions_count: number;
+        };
+        call_info: {
+            from_phone_number: string;
+            to_phone_number: string;
+        } | null;
+    };
+};
+export {};

package/dist/esm/api/types/overrides.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/auth/AuthProvider.d.mts

@@ -0,0 +1,4 @@
+import { AuthRequest } from "./AuthRequest.mjs";
+export interface AuthProvider {
+    getAuthRequest(): Promise<AuthRequest>;
+}

package/dist/esm/core/auth/AuthProvider.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/auth/AuthRequest.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Request parameters for authentication requests.
+ */
+export interface AuthRequest {
+    /**
+     * The headers to be included in the request.
+     */
+    headers: Record<string, string>;
+}

package/dist/esm/core/auth/AuthRequest.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/auth/BasicAuth.d.mts

@@ -0,0 +1,8 @@
+export interface BasicAuth {
+    username: string;
+    password: string;
+}
+export declare const BasicAuth: {
+    toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;
+    fromAuthorizationHeader: (header: string) => BasicAuth;
+};

package/dist/esm/core/auth/BasicAuth.mjs

@@ -0,0 +1,23 @@
+import { base64Decode, base64Encode } from "../base64.mjs";
+const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
+export const BasicAuth = {
+    toAuthorizationHeader: (basicAuth) => {
+        if (basicAuth == null) {
+            return undefined;
+        }
+        const token = base64Encode(`${basicAuth.username}:${basicAuth.password}`);
+        return `Basic ${token}`;
+    },
+    fromAuthorizationHeader: (header) => {
+        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
+        const decoded = base64Decode(credentials);
+        const [username, password] = decoded.split(":", 2);
+        if (username == null || password == null) {
+            throw new Error("Invalid basic auth");
+        }
+        return {
+            username,
+            password,
+        };
+    },
+};