phonic 0.29.1 → 0.30.0-rc2

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,51 @@
+/**
+ * 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;
+}
+export declare namespace Tool {
+    interface Project {
+        id: string;
+        name: string;
+    }
+    /**
+     * The type of tool.
+     */
+    type Type = "custom_webhook" | "custom_websocket";
+    const Type: {
+        readonly CustomWebhook: "custom_webhook";
+        readonly CustomWebsocket: "custom_websocket";
+    };
+    /**
+     * 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,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var Tool;
+(function (Tool) {
+    Tool.Type = {
+        CustomWebhook: "custom_webhook",
+        CustomWebsocket: "custom_websocket",
+    };
+    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,44 @@
+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 "./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,44 @@
+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 "./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,23 @@
+type PhonicTool = "send_dtmf_tone" | "end_conversation" | (string & {});
+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 {};

package/dist/esm/api/types/overrides.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,
+        };
+    },
+};

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

@@ -0,0 +1,5 @@
+export type BearerToken = string;
+export declare const BearerToken: {
+    toAuthorizationHeader: (token: BearerToken | undefined) => string | undefined;
+    fromAuthorizationHeader: (header: string) => BearerToken;
+};

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

@@ -0,0 +1,12 @@
+const BEARER_AUTH_HEADER_PREFIX = /^Bearer /i;
+export const BearerToken = {
+    toAuthorizationHeader: (token) => {
+        if (token == null) {
+            return undefined;
+        }
+        return `Bearer ${token}`;
+    },
+    fromAuthorizationHeader: (header) => {
+        return header.replace(BEARER_AUTH_HEADER_PREFIX, "").trim();
+    },
+};

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

@@ -0,0 +1,2 @@
+export { BasicAuth } from "./BasicAuth.mjs";
+export { BearerToken } from "./BearerToken.mjs";

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

@@ -0,0 +1,2 @@
+export { BasicAuth } from "./BasicAuth.mjs";
+export { BearerToken } from "./BearerToken.mjs";

package/dist/esm/core/base64.d.mts

@@ -0,0 +1,2 @@
+export declare function base64Encode(input: string): string;
+export declare function base64Decode(input: string): string;

package/dist/esm/core/base64.mjs

@@ -0,0 +1,22 @@
+function base64ToBytes(base64) {
+    const binString = atob(base64);
+    return Uint8Array.from(binString, (m) => m.codePointAt(0));
+}
+function bytesToBase64(bytes) {
+    const binString = String.fromCodePoint(...bytes);
+    return btoa(binString);
+}
+export function base64Encode(input) {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "utf8").toString("base64");
+    }
+    const bytes = new TextEncoder().encode(input);
+    return bytesToBase64(bytes);
+}
+export function base64Decode(input) {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "base64").toString("utf8");
+    }
+    const bytes = base64ToBytes(input);
+    return new TextDecoder().decode(bytes);
+}

package/dist/esm/core/fetcher/APIResponse.d.mts

@@ -0,0 +1,20 @@
+import { RawResponse } from "./RawResponse.mjs";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}

package/dist/esm/core/fetcher/APIResponse.mjs

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

package/dist/esm/core/fetcher/BinaryResponse.d.mts

@@ -0,0 +1,20 @@
+import { ResponseWithBody } from "./ResponseWithBody.mjs";
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: boolean;
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => ReadableStream<Uint8Array>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => Promise<Blob>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): Promise<Uint8Array>;
+};
+export declare function getBinaryResponse(response: ResponseWithBody): BinaryResponse;

package/dist/esm/core/fetcher/BinaryResponse.mjs

@@ -0,0 +1,14 @@
+export function getBinaryResponse(response) {
+    const binaryResponse = {
+        get bodyUsed() {
+            return response.bodyUsed;
+        },
+        stream: () => response.body,
+        arrayBuffer: response.arrayBuffer.bind(response),
+        blob: response.blob.bind(response),
+    };
+    if ("bytes" in response && typeof response.bytes === "function") {
+        binaryResponse.bytes = response.bytes.bind(response);
+    }
+    return binaryResponse;
+}