phonic 0.30.5 → 0.30.7

package/dist/esm/api/resources/conversations/client/Socket.d.mts

@@ -0,0 +1,64 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core/index.mjs";
+import * as Phonic from "../../../index.mjs";
+export declare namespace ConversationsSocket {
+    interface Args {
+        socket: core.ReconnectingWebSocket;
+    }
+    type Response = Phonic.ReadyToStartConversationPayload | Phonic.ConversationCreatedPayload | Phonic.InputTextPayload | Phonic.InputCancelledPayload | Phonic.UserStartedSpeakingPayload | Phonic.UserFinishedSpeakingPayload | Phonic.DtmfPayload | Phonic.ToolCallPayload | Phonic.ToolCallOutputProcessedPayload | Phonic.ToolCallInterruptedPayload | Phonic.AssistantChoseNotToRespondPayload | Phonic.AssistantEndedConversationPayload | Phonic.ErrorPayload;
+    type EventHandlers = {
+        open?: () => void;
+        message?: (message: Response) => void;
+        close?: (event: core.CloseEvent) => void;
+        error?: (error: Error) => void;
+    };
+}
+export declare class ConversationsSocket {
+    readonly socket: core.ReconnectingWebSocket;
+    protected readonly eventHandlers: ConversationsSocket.EventHandlers;
+    private messageBuffer;
+    private handleOpen;
+    private handleMessage;
+    private handleClose;
+    private handleError;
+    constructor(args: ConversationsSocket.Args);
+    /** The current state of the connection; this is one of the readyState constants. */
+    get readyState(): number;
+    /**
+     * @param event - The event to attach to.
+     * @param callback - The callback to run when the event is triggered.
+     * Usage:
+     * ```typescript
+     * this.on('open', () => {
+     *     console.log('The websocket is open');
+     * });
+     * ```
+     */
+    on<T extends keyof ConversationsSocket.EventHandlers>(event: T, callback: ConversationsSocket.EventHandlers[T]): void;
+    sendConfig(message: Phonic.ConfigPayload): void;
+    sendAudioChunk(message: Phonic.AudioChunkPayload): void;
+    sendUpdateSystemPrompt(message: Phonic.UpdateSystemPromptPayload): void;
+    sendSetExternalId(message: Phonic.SetExternalIdPayload): void;
+    sendSetTwilioCallSid(message: Phonic.SetTwilioCallSidPayload): void;
+    sendToolCallOutput(message: Phonic.ToolCallOutputPayload): void;
+    /** Connect to the websocket and register event handlers. */
+    connect(): ConversationsSocket;
+    /** Close the websocket and unregister event handlers. */
+    close(): void;
+    /** Returns a promise that resolves when the websocket is open. */
+    waitForOpen(): Promise<core.ReconnectingWebSocket>;
+    /** Asserts that the websocket is open. */
+    private assertSocketIsOpen;
+    /** Send a message with buffering - if socket is not open, buffer the message. */
+    private sendWithBuffering;
+    /** Flush all buffered messages when the socket opens. */
+    private flushMessageBuffer;
+    /** Clear all buffered messages. */
+    private clearMessageBuffer;
+    /** Send a binary payload to the websocket. */
+    protected sendBinary(payload: ArrayBufferLike | Blob | ArrayBufferView): void;
+    /** Send a JSON payload to the websocket. */
+    protected sendJson(payload: Phonic.ConfigPayload | Phonic.AudioChunkPayload | Phonic.UpdateSystemPromptPayload | Phonic.SetExternalIdPayload | Phonic.SetTwilioCallSidPayload | Phonic.ToolCallOutputPayload): void;
+}

package/dist/esm/api/resources/conversations/client/Socket.mjs

@@ -0,0 +1,159 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as core from "../../../../core/index.mjs";
+import { fromJson, toJson } from "../../../../core/json.mjs";
+export class ConversationsSocket {
+    constructor(args) {
+        this.eventHandlers = {};
+        this.messageBuffer = [];
+        this.handleOpen = () => {
+            var _a, _b;
+            this.flushMessageBuffer();
+            (_b = (_a = this.eventHandlers).open) === null || _b === void 0 ? void 0 : _b.call(_a);
+        };
+        this.handleMessage = (event) => {
+            var _a, _b;
+            const data = fromJson(event.data);
+            (_b = (_a = this.eventHandlers).message) === null || _b === void 0 ? void 0 : _b.call(_a, data);
+        };
+        this.handleClose = (event) => {
+            var _a, _b;
+            (_b = (_a = this.eventHandlers).close) === null || _b === void 0 ? void 0 : _b.call(_a, event);
+        };
+        this.handleError = (event) => {
+            var _a, _b;
+            const message = event.message;
+            (_b = (_a = this.eventHandlers).error) === null || _b === void 0 ? void 0 : _b.call(_a, new Error(message));
+        };
+        this.socket = args.socket;
+        this.socket.addEventListener("open", this.handleOpen);
+        this.socket.addEventListener("message", this.handleMessage);
+        this.socket.addEventListener("close", this.handleClose);
+        this.socket.addEventListener("error", this.handleError);
+    }
+    /** The current state of the connection; this is one of the readyState constants. */
+    get readyState() {
+        return this.socket.readyState;
+    }
+    /**
+     * @param event - The event to attach to.
+     * @param callback - The callback to run when the event is triggered.
+     * Usage:
+     * ```typescript
+     * this.on('open', () => {
+     *     console.log('The websocket is open');
+     * });
+     * ```
+     */
+    on(event, callback) {
+        this.eventHandlers[event] = callback;
+    }
+    sendConfig(message) {
+        this.sendWithBuffering(() => this.sendJson(message));
+    }
+    sendAudioChunk(message) {
+        this.sendWithBuffering(() => this.sendJson(message));
+    }
+    sendUpdateSystemPrompt(message) {
+        this.sendWithBuffering(() => this.sendJson(message));
+    }
+    sendSetExternalId(message) {
+        this.sendWithBuffering(() => this.sendJson(message));
+    }
+    sendSetTwilioCallSid(message) {
+        this.sendWithBuffering(() => this.sendJson(message));
+    }
+    sendToolCallOutput(message) {
+        this.sendWithBuffering(() => this.sendJson(message));
+    }
+    /** Connect to the websocket and register event handlers. */
+    connect() {
+        this.socket.reconnect();
+        this.socket.addEventListener("open", this.handleOpen);
+        this.socket.addEventListener("message", this.handleMessage);
+        this.socket.addEventListener("close", this.handleClose);
+        this.socket.addEventListener("error", this.handleError);
+        return this;
+    }
+    /** Close the websocket and unregister event handlers. */
+    close() {
+        this.socket.close();
+        this.handleClose({ code: 1000 });
+        this.clearMessageBuffer();
+        this.socket.removeEventListener("open", this.handleOpen);
+        this.socket.removeEventListener("message", this.handleMessage);
+        this.socket.removeEventListener("close", this.handleClose);
+        this.socket.removeEventListener("error", this.handleError);
+    }
+    /** Returns a promise that resolves when the websocket is open. */
+    waitForOpen() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.socket.readyState === core.ReconnectingWebSocket.OPEN) {
+                return this.socket;
+            }
+            return new Promise((resolve, reject) => {
+                this.socket.addEventListener("open", () => {
+                    resolve(this.socket);
+                });
+                this.socket.addEventListener("error", (event) => {
+                    reject(event);
+                });
+            });
+        });
+    }
+    /** Asserts that the websocket is open. */
+    assertSocketIsOpen() {
+        if (!this.socket) {
+            throw new Error("Socket is not connected.");
+        }
+        if (this.socket.readyState !== core.ReconnectingWebSocket.OPEN) {
+            throw new Error("Socket is not open.");
+        }
+    }
+    /** Send a message with buffering - if socket is not open, buffer the message. */
+    sendWithBuffering(sendFn) {
+        if (this.socket.readyState === core.ReconnectingWebSocket.OPEN) {
+            sendFn();
+        }
+        else {
+            this.messageBuffer.push(sendFn);
+        }
+    }
+    /** Flush all buffered messages when the socket opens. */
+    flushMessageBuffer() {
+        while (this.messageBuffer.length > 0) {
+            const sendFn = this.messageBuffer.shift();
+            if (sendFn) {
+                try {
+                    sendFn();
+                }
+                catch (error) {
+                    console.error("Error sending buffered message:", error);
+                }
+            }
+        }
+    }
+    /** Clear all buffered messages. */
+    clearMessageBuffer() {
+        this.messageBuffer = [];
+    }
+    /** Send a binary payload to the websocket. */
+    sendBinary(payload) {
+        this.socket.send(payload);
+    }
+    /** Send a JSON payload to the websocket. */
+    sendJson(payload) {
+        const jsonPayload = toJson(payload);
+        this.socket.send(jsonPayload);
+    }
+}

package/dist/esm/api/resources/conversations/client/index.d.mts

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/conversations/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/conversations/client/requests/ConversationsListRequest.d.mts

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ *
+ * @example
+ *     {}
+ */
+export interface ConversationsListRequest {
+    /** The name of the project to list conversations for. */
+    project?: string;
+    /** Filter by external ID to get a specific conversation. */
+    external_id?: string;
+    /** Minimum duration in seconds. */
+    duration_min?: number;
+    /** Maximum duration in seconds. */
+    duration_max?: number;
+    /** Minimum start date/time. Valid examples: `2025-04-17`, `2025-04-17T02:48:52.708Z` */
+    started_at_min?: string;
+    /** Maximum start date/time. Valid examples: `2025-04-17`, `2025-04-17T02:48:52.708Z` */
+    started_at_max?: string;
+    /** Cursor for pagination (before). */
+    before?: string;
+    /** Cursor for pagination (after). */
+    after?: string;
+    /** Maximum number of conversations to return. */
+    limit?: number;
+}

package/dist/esm/api/resources/conversations/client/requests/ConversationsListRequest.mjs

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

package/dist/esm/api/resources/conversations/client/requests/ConversationsSipOutboundCallRequest.d.mts

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         "X-Sip-Address": "X-Sip-Address",
+ *         from_phone_number: "from_phone_number",
+ *         to_phone_number: "to_phone_number"
+ *     }
+ */
+export interface ConversationsSipOutboundCallRequest {
+    /** Optional session token used for STS authorization. */
+    token?: string;
+    /** Optional downstream STS WebSocket URL to override the default. */
+    downstream_websocket_url?: string;
+    /** SIP address of the user's SIP trunk. Required. */
+    "X-Sip-Address": string;
+    /** SIP auth username, if your provider requires it. */
+    "X-Sip-Auth-Username"?: string;
+    /** SIP auth password, if your provider requires it. */
+    "X-Sip-Auth-Password"?: string;
+    /** Caller ID phone number in E.164 format. */
+    from_phone_number: string;
+    /** Destination phone number in E.164 format. */
+    to_phone_number: string;
+    config?: Phonic.OutboundCallConfig;
+}

package/dist/esm/api/resources/conversations/client/requests/ConversationsSipOutboundCallRequest.mjs

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

package/dist/esm/api/resources/conversations/client/requests/EvaluateConversationRequest.d.mts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         prompt_id: "conv_eval_prompt_d7cfe45d-35db-4ef6-a254-81ab1da76ce0"
+ *     }
+ */
+export interface EvaluateConversationRequest {
+    /** ID of the evaluation prompt to use. */
+    prompt_id: string;
+}

package/dist/esm/api/resources/conversations/client/requests/EvaluateConversationRequest.mjs

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

package/dist/esm/api/resources/conversations/client/requests/ExtractDataRequest.d.mts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         schema_id: "conv_extract_schema_6458e4ac-533c-4bdf-8e6d-c2f06f87fd5c"
+ *     }
+ */
+export interface ExtractDataRequest {
+    /** ID of the extraction schema to use. */
+    schema_id: string;
+}

package/dist/esm/api/resources/conversations/client/requests/ExtractDataRequest.mjs

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

package/dist/esm/api/resources/conversations/client/requests/OutboundCallRequest.d.mts

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         to_phone_number: "+19189397081",
+ *         config: {
+ *             agent: "support-agent",
+ *             welcome_message: "Hi {{customer_name}}. How can I help you today?",
+ *             system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
+ *             template_variables: {
+ *                 "customer_name": "David",
+ *                 "subject": "Chess"
+ *             },
+ *             voice_id: "grant",
+ *             no_input_poke_sec: 30,
+ *             no_input_poke_text: "Are you still there?",
+ *             no_input_end_conversation_sec: 180,
+ *             boosted_keywords: ["Load ID", "dispatch"],
+ *             tools: ["keypad_input"]
+ *         }
+ *     }
+ */
+export interface OutboundCallRequest {
+    /** The phone number to call in E.164 format. */
+    to_phone_number: string;
+    config?: Phonic.OutboundCallConfig;
+}

package/dist/esm/api/resources/conversations/client/requests/OutboundCallRequest.mjs

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

package/dist/esm/api/resources/conversations/client/requests/index.d.mts

@@ -0,0 +1,5 @@
+export { type ConversationsListRequest } from "./ConversationsListRequest.mjs";
+export { type ExtractDataRequest } from "./ExtractDataRequest.mjs";
+export { type EvaluateConversationRequest } from "./EvaluateConversationRequest.mjs";
+export { type OutboundCallRequest } from "./OutboundCallRequest.mjs";
+export { type ConversationsSipOutboundCallRequest } from "./ConversationsSipOutboundCallRequest.mjs";

package/dist/esm/api/resources/conversations/client/requests/index.mjs

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

package/dist/esm/api/resources/conversations/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./types/index.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/conversations/index.mjs

@@ -0,0 +1,2 @@
+export * from "./types/index.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/conversations/types/ConversationsCancelResponse.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConversationsCancelResponse {
+    /** Whether the conversation was cancelled successfully. */
+    success: boolean;
+}

package/dist/esm/api/resources/conversations/types/ConversationsCancelResponse.mjs

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

package/dist/esm/api/resources/conversations/types/ConversationsExtractDataResponse.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConversationsExtractDataResponse {
+    /** The extracted data according to the schema. */
+    result: Record<string, unknown>;
+}

package/dist/esm/api/resources/conversations/types/ConversationsExtractDataResponse.mjs

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

package/dist/esm/api/resources/conversations/types/ConversationsGetAnalysisResponse.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../index.mjs";
+export interface ConversationsGetAnalysisResponse {
+    analysis: Phonic.ConversationAnalysis;
+}

package/dist/esm/api/resources/conversations/types/ConversationsGetAnalysisResponse.mjs

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

package/dist/esm/api/resources/conversations/types/ConversationsGetResponse.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../index.mjs";
+export interface ConversationsGetResponse {
+    conversation: Phonic.Conversation;
+}

package/dist/esm/api/resources/conversations/types/ConversationsGetResponse.mjs

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

package/dist/esm/api/resources/conversations/types/ConversationsListEvaluationsResponse.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../index.mjs";
+export interface ConversationsListEvaluationsResponse {
+    evals: Phonic.ConversationEvaluationResult[];
+}

package/dist/esm/api/resources/conversations/types/ConversationsListEvaluationsResponse.mjs

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

package/dist/esm/api/resources/conversations/types/ConversationsListExtractionsResponse.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../index.mjs";
+export interface ConversationsListExtractionsResponse {
+    extractions: Phonic.ConversationExtraction[];
+}

package/dist/esm/api/resources/conversations/types/ConversationsListExtractionsResponse.mjs

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

package/dist/esm/api/resources/conversations/types/ConversationsListResponse.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../index.mjs";
+export type ConversationsListResponse = {
+    conversations: Phonic.Conversation[];
+} | {
+    conversation: Phonic.Conversation;
+};

package/dist/esm/api/resources/conversations/types/ConversationsListResponse.mjs

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

package/dist/esm/api/resources/conversations/types/ConversationsOutboundCallResponse.d.mts

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

package/dist/esm/api/resources/conversations/types/ConversationsOutboundCallResponse.mjs

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

package/dist/esm/api/resources/conversations/types/ConversationsSipOutboundCallResponse.d.mts

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

package/dist/esm/api/resources/conversations/types/ConversationsSipOutboundCallResponse.mjs

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

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

@@ -0,0 +1,9 @@
+export * from "./ConversationsListResponse.mjs";
+export * from "./ConversationsGetResponse.mjs";
+export * from "./ConversationsCancelResponse.mjs";
+export * from "./ConversationsGetAnalysisResponse.mjs";
+export * from "./ConversationsListExtractionsResponse.mjs";
+export * from "./ConversationsExtractDataResponse.mjs";
+export * from "./ConversationsListEvaluationsResponse.mjs";
+export * from "./ConversationsOutboundCallResponse.mjs";
+export * from "./ConversationsSipOutboundCallResponse.mjs";

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

@@ -0,0 +1,9 @@
+export * from "./ConversationsListResponse.mjs";
+export * from "./ConversationsGetResponse.mjs";
+export * from "./ConversationsCancelResponse.mjs";
+export * from "./ConversationsGetAnalysisResponse.mjs";
+export * from "./ConversationsListExtractionsResponse.mjs";
+export * from "./ConversationsExtractDataResponse.mjs";
+export * from "./ConversationsListEvaluationsResponse.mjs";
+export * from "./ConversationsOutboundCallResponse.mjs";
+export * from "./ConversationsSipOutboundCallResponse.mjs";