phonic 0.32.11 → 0.32.13

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

@@ -3,6 +3,8 @@ export interface ToolParameter {
     type: ToolParameter.Type;
     /** Required only when type is "array". The type of items in the array. */
     item_type?: ToolParameter.ItemType | undefined;
+    /** Required only when type is "enum". The fixed set of allowed string values for the parameter. Values must be unique and non-empty. */
+    enum_values?: string[] | undefined;
     /** The parameter name. */
     name: string;
     /** Description of the parameter. */
@@ -14,7 +16,7 @@ export interface ToolParameter {
      * - For GET webhooks: defaults to `"query_string"` and `"request_body"` is not allowed.
      * - For POST webhooks: required, can be either `"request_body"` or `"query_string"`.
      * - Not allowed for `custom_websocket`, `built_in_transfer_to_phone_number`, or `built_in_transfer_to_agent` tools.
-     * When updating a tool's type or endpoint_method, all parameters must include explicit `location` values.
+     * When switching a webhook tool's `endpoint_method` from POST to GET, its request body parameters must be re-sent with `"query_string"` locations.
      */
     location?: ToolParameter.Location | undefined;
 }
@@ -26,6 +28,7 @@ export declare namespace ToolParameter {
         readonly Number: "number";
         readonly Boolean: "boolean";
         readonly Array: "array";
+        readonly Enum: "enum";
     };
     type Type = (typeof Type)[keyof typeof Type];
     /** Required only when type is "array". The type of items in the array. */
@@ -41,7 +44,7 @@ export declare namespace ToolParameter {
      * - For GET webhooks: defaults to `"query_string"` and `"request_body"` is not allowed.
      * - For POST webhooks: required, can be either `"request_body"` or `"query_string"`.
      * - Not allowed for `custom_websocket`, `built_in_transfer_to_phone_number`, or `built_in_transfer_to_agent` tools.
-     * When updating a tool's type or endpoint_method, all parameters must include explicit `location` values.
+     * When switching a webhook tool's `endpoint_method` from POST to GET, its request body parameters must be re-sent with `"query_string"` locations.
      */
     const Location: {
         readonly RequestBody: "request_body";

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

@@ -8,6 +8,7 @@ export var ToolParameter;
         Number: "number",
         Boolean: "boolean",
         Array: "array",
+        Enum: "enum",
     };
     /** Required only when type is "array". The type of items in the array. */
     ToolParameter.ItemType = {
@@ -21,7 +22,7 @@ export var ToolParameter;
      * - For GET webhooks: defaults to `"query_string"` and `"request_body"` is not allowed.
      * - For POST webhooks: required, can be either `"request_body"` or `"query_string"`.
      * - Not allowed for `custom_websocket`, `built_in_transfer_to_phone_number`, or `built_in_transfer_to_agent` tools.
-     * When updating a tool's type or endpoint_method, all parameters must include explicit `location` values.
+     * When switching a webhook tool's `endpoint_method` from POST to GET, its request body parameters must be re-sent with `"query_string"` locations.
      */
     ToolParameter.Location = {
         RequestBody: "request_body",

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

@@ -0,0 +1,15 @@
+/**
+ * A tool's parameters expressed as a raw JSON Schema object, for parameters that the flat `ToolParameter` list cannot express: nested objects, arrays of objects, `anyOf` variants, `null`, and non-string enums.
+ * Each entry in `properties` is a JSON Schema value supporting `type` (`"string"`, `"integer"`, `"number"`, `"boolean"`, `"null"`, `"array"`, `"object"`), `description`, `enum` (string parameters only), `items` (for arrays), `properties`/`required`/`additionalProperties` (for objects) and `anyOf`. Values may be nested up to 5 levels deep.
+ * Parameter names cannot be any of the reserved names that Phonic injects into every tool call: `call_info`, `conversation_id`, `from_phone_number`, `to_phone_number`, `twilio_call_sid`.
+ * For `custom_webhook` tools, parameter placement is supplied separately in `parameter_locations` rather than inline on the schema.
+ */
+export interface ToolParametersJsonSchema {
+    type: "object";
+    /** The tool's top-level parameters, as a map from parameter name to its JSON Schema. */
+    properties: Record<string, unknown>;
+    /** The names of the required top-level parameters. Every name must be defined in `properties`. */
+    required?: string[] | undefined;
+    /** Must be `false`. Tool parameter schemas do not allow properties beyond the ones declared. */
+    additionalProperties?: false | undefined;
+}

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

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

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

@@ -33,6 +33,7 @@ export * from "./DataRetentionPolicy.mjs";
 export * from "./DtmfPayload.mjs";
 export * from "./Error_.mjs";
 export * from "./ErrorPayload.mjs";
+export * from "./ExternalStoragePolicy.mjs";
 export * from "./ExtractionField.mjs";
 export * from "./ExtractionSchema.mjs";
 export * from "./GenerateReplyPayload.mjs";
@@ -67,6 +68,7 @@ export * from "./ToolCallPayload.mjs";
 export * from "./ToolDefinition.mjs";
 export * from "./ToolName.mjs";
 export * from "./ToolParameter.mjs";
+export * from "./ToolParametersJsonSchema.mjs";
 export * from "./UnmutePayload.mjs";
 export * from "./UpdateSystemPromptPayload.mjs";
 export * from "./UpdateToolsSubsetPayload.mjs";

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

@@ -33,6 +33,7 @@ export * from "./DataRetentionPolicy.mjs";
 export * from "./DtmfPayload.mjs";
 export * from "./Error_.mjs";
 export * from "./ErrorPayload.mjs";
+export * from "./ExternalStoragePolicy.mjs";
 export * from "./ExtractionField.mjs";
 export * from "./ExtractionSchema.mjs";
 export * from "./GenerateReplyPayload.mjs";
@@ -67,6 +68,7 @@ export * from "./ToolCallPayload.mjs";
 export * from "./ToolDefinition.mjs";
 export * from "./ToolName.mjs";
 export * from "./ToolParameter.mjs";
+export * from "./ToolParametersJsonSchema.mjs";
 export * from "./UnmutePayload.mjs";
 export * from "./UpdateSystemPromptPayload.mjs";
 export * from "./UpdateToolsSubsetPayload.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.32.11";
+export declare const SDK_VERSION = "0.32.13";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.32.11";
+export const SDK_VERSION = "0.32.13";

package/dist/index.d.mts

@@ -0,0 +1,240 @@
+import WebSocket from 'ws';
+
+type PhonicConfig = {
+    baseUrl?: string;
+    headers?: Record<string, string>;
+    __downstreamWebSocketUrl?: string;
+};
+type FetchOptions = {
+    method: "GET";
+    headers?: Record<string, string>;
+} | {
+    method: "POST";
+    headers?: Record<string, string>;
+    body: string;
+};
+type DataOrError<T> = Promise<{
+    data: T;
+    error: null;
+} | {
+    data: null;
+    error: {
+        message: string;
+        code?: string;
+    };
+}>;
+type ISODate = `${string}-${string}-${string}`;
+type ISODateTime$1 = `${string}Z`;
+
+type ISODateTime = `${string}Z`;
+type ConversationItem = {
+    role: "user";
+    item_idx: number;
+    text: string;
+    duration_ms: number;
+    started_at: string;
+} | {
+    role: "assistant";
+    item_idx: number;
+    text: string;
+    voice_id: string;
+    system_prompt: string;
+    output_audio_speed: number;
+    duration_ms: number;
+    started_at: string;
+};
+type Conversation = {
+    id: string;
+    external_id: string | null;
+    model: string;
+    welcome_message: string | null;
+    input_format: "pcm_44100" | "mulaw_8000";
+    output_format: "pcm_44100" | "mulaw_8000";
+    text: string;
+    duration_ms: number;
+    started_at: ISODateTime;
+    ended_at: ISODateTime;
+    items: Array<ConversationItem>;
+};
+type ConversationSuccessResponse = {
+    conversation: Conversation;
+};
+type ConversationsSuccessResponse = {
+    conversations: Array<Conversation>;
+};
+
+declare class Conversations {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    get(id: string): DataOrError<ConversationSuccessResponse>;
+    getByExternalId({ project, externalId, }: {
+        project?: string;
+        externalId: string;
+    }): DataOrError<ConversationSuccessResponse>;
+    list({ project, durationMin, durationMax, startedAtMin, startedAtMax, }: {
+        project?: string;
+        durationMin?: number;
+        durationMax?: number;
+        startedAtMin?: ISODate | ISODateTime$1;
+        startedAtMax?: ISODate | ISODateTime$1;
+    }): DataOrError<ConversationsSuccessResponse>;
+}
+
+type PhonicSTSConfig = {
+    project: string;
+    input_format: "pcm_44100" | "mulaw_8000";
+    system_prompt?: string;
+    welcome_message?: string;
+    voice_id?: string;
+    output_format?: "pcm_44100" | "mulaw_8000";
+    enable_silent_audio_fallback?: boolean;
+    experimental_params?: Record<string, unknown>;
+    tools?: string[];
+    vad_prebuffer_duration_ms?: number;
+    vad_min_speech_duration_ms?: number;
+    vad_min_silence_duration_ms?: number;
+    vad_threshold?: number;
+};
+type PhonicSTSWebSocketResponseMessage = {
+    type: "ready_to_start_conversation";
+} | {
+    type: "input_text";
+    text: string;
+} | {
+    type: "audio_chunk";
+    text: string;
+    audio: string;
+} | {
+    type: "is_user_speaking";
+    isUserSpeaking: boolean;
+} | {
+    type: "interrupted_response";
+    interruptedResponse: string;
+} | {
+    type: "assistant_ended_conversation";
+} | {
+    type: "error";
+    error: {
+        message: string;
+        code?: string;
+    };
+    param_errors?: {
+        input_format?: string;
+        system_prompt?: string;
+        welcome_message?: string;
+        voice_id?: string;
+        output_format?: string;
+    };
+};
+type OnMessageCallback = (message: PhonicSTSWebSocketResponseMessage) => void;
+type OnCloseCallback = (event: WebSocket.CloseEvent) => void;
+type OnErrorCallback = (event: WebSocket.ErrorEvent) => void;
+type PhonicSTSOutboundCallConfig = Omit<PhonicSTSConfig, "input_format" | "output_format">;
+type OutboundCallSuccessResponse = {
+    success: true;
+};
+
+type PhonicSTSTwilioOutboundCallParams = {
+    account_sid: string;
+    api_key_sid: string;
+    api_key_secret: string;
+    from_phone_number: string;
+    to_phone_number: string;
+};
+type PhonicSTSTwilioOutboundCallConfig = PhonicSTSOutboundCallConfig;
+type TwilioOutboundCallSuccessResponse = {
+    success: true;
+    callSid: string;
+};
+
+declare class Twilio {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    outboundCall(params: PhonicSTSTwilioOutboundCallParams, config: PhonicSTSTwilioOutboundCallConfig): DataOrError<TwilioOutboundCallSuccessResponse>;
+}
+
+declare class PhonicSTSWebSocket {
+    private readonly ws;
+    private readonly config;
+    private onMessageCallback;
+    private onCloseCallback;
+    private onErrorCallback;
+    private buffer;
+    private isOpen;
+    constructor(ws: WebSocket, config: PhonicSTSConfig);
+    onMessage(callback: OnMessageCallback): void;
+    onClose(callback: OnCloseCallback): void;
+    onError(callback: OnErrorCallback): void;
+    audioChunk({ audio }: {
+        audio: string;
+    }): void;
+    updateSystemPrompt({ systemPrompt }: {
+        systemPrompt: string;
+    }): void;
+    setExternalId({ externalId }: {
+        externalId: string;
+    }): void;
+    close(code?: number): void;
+}
+
+declare class SpeechToSpeech {
+    private readonly phonic;
+    readonly twilio: Twilio;
+    constructor(phonic: Phonic);
+    websocket(config: PhonicSTSConfig): PhonicSTSWebSocket;
+    outboundCall(toPhoneNumber: string, config: PhonicSTSOutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
+}
+
+type Voice = {
+    id: string;
+    name: string;
+};
+type VoicesSuccessResponse = {
+    voices: Array<Voice>;
+};
+type VoiceSuccessResponse = {
+    voice: Voice;
+};
+
+declare class Voices {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    list({ model }: {
+        model: string;
+    }): DataOrError<VoicesSuccessResponse>;
+    get(id: string): DataOrError<VoiceSuccessResponse>;
+}
+
+declare class Phonic {
+    readonly apiKey: string;
+    readonly baseUrl: string;
+    readonly __downstreamWebSocketUrl: string | null;
+    readonly headers: Record<string, string>;
+    readonly conversations: Conversations;
+    readonly voices: Voices;
+    readonly sts: SpeechToSpeech;
+    constructor(apiKey: string, config?: PhonicConfig);
+    fetchRequest<T>(path: string, options: FetchOptions): DataOrError<T>;
+    get<T>(path: string): Promise<{
+        data: null;
+        error: {
+            message: string;
+            code?: string;
+        };
+    } | {
+        data: T;
+        error: null;
+    }>;
+    post<T>(path: string, body: Record<string, unknown>, headers?: Record<string, string>): Promise<{
+        data: null;
+        error: {
+            message: string;
+            code?: string;
+        };
+    } | {
+        data: T;
+        error: null;
+    }>;
+}
+
+export { Phonic, type PhonicSTSConfig, PhonicSTSWebSocket };

package/dist/index.d.ts

@@ -0,0 +1,240 @@
+import WebSocket from 'ws';
+
+type PhonicConfig = {
+    baseUrl?: string;
+    headers?: Record<string, string>;
+    __downstreamWebSocketUrl?: string;
+};
+type FetchOptions = {
+    method: "GET";
+    headers?: Record<string, string>;
+} | {
+    method: "POST";
+    headers?: Record<string, string>;
+    body: string;
+};
+type DataOrError<T> = Promise<{
+    data: T;
+    error: null;
+} | {
+    data: null;
+    error: {
+        message: string;
+        code?: string;
+    };
+}>;
+type ISODate = `${string}-${string}-${string}`;
+type ISODateTime$1 = `${string}Z`;
+
+type ISODateTime = `${string}Z`;
+type ConversationItem = {
+    role: "user";
+    item_idx: number;
+    text: string;
+    duration_ms: number;
+    started_at: string;
+} | {
+    role: "assistant";
+    item_idx: number;
+    text: string;
+    voice_id: string;
+    system_prompt: string;
+    output_audio_speed: number;
+    duration_ms: number;
+    started_at: string;
+};
+type Conversation = {
+    id: string;
+    external_id: string | null;
+    model: string;
+    welcome_message: string | null;
+    input_format: "pcm_44100" | "mulaw_8000";
+    output_format: "pcm_44100" | "mulaw_8000";
+    text: string;
+    duration_ms: number;
+    started_at: ISODateTime;
+    ended_at: ISODateTime;
+    items: Array<ConversationItem>;
+};
+type ConversationSuccessResponse = {
+    conversation: Conversation;
+};
+type ConversationsSuccessResponse = {
+    conversations: Array<Conversation>;
+};
+
+declare class Conversations {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    get(id: string): DataOrError<ConversationSuccessResponse>;
+    getByExternalId({ project, externalId, }: {
+        project?: string;
+        externalId: string;
+    }): DataOrError<ConversationSuccessResponse>;
+    list({ project, durationMin, durationMax, startedAtMin, startedAtMax, }: {
+        project?: string;
+        durationMin?: number;
+        durationMax?: number;
+        startedAtMin?: ISODate | ISODateTime$1;
+        startedAtMax?: ISODate | ISODateTime$1;
+    }): DataOrError<ConversationsSuccessResponse>;
+}
+
+type PhonicSTSConfig = {
+    project: string;
+    input_format: "pcm_44100" | "mulaw_8000";
+    system_prompt?: string;
+    welcome_message?: string;
+    voice_id?: string;
+    output_format?: "pcm_44100" | "mulaw_8000";
+    enable_silent_audio_fallback?: boolean;
+    experimental_params?: Record<string, unknown>;
+    tools?: string[];
+    vad_prebuffer_duration_ms?: number;
+    vad_min_speech_duration_ms?: number;
+    vad_min_silence_duration_ms?: number;
+    vad_threshold?: number;
+};
+type PhonicSTSWebSocketResponseMessage = {
+    type: "ready_to_start_conversation";
+} | {
+    type: "input_text";
+    text: string;
+} | {
+    type: "audio_chunk";
+    text: string;
+    audio: string;
+} | {
+    type: "is_user_speaking";
+    isUserSpeaking: boolean;
+} | {
+    type: "interrupted_response";
+    interruptedResponse: string;
+} | {
+    type: "assistant_ended_conversation";
+} | {
+    type: "error";
+    error: {
+        message: string;
+        code?: string;
+    };
+    param_errors?: {
+        input_format?: string;
+        system_prompt?: string;
+        welcome_message?: string;
+        voice_id?: string;
+        output_format?: string;
+    };
+};
+type OnMessageCallback = (message: PhonicSTSWebSocketResponseMessage) => void;
+type OnCloseCallback = (event: WebSocket.CloseEvent) => void;
+type OnErrorCallback = (event: WebSocket.ErrorEvent) => void;
+type PhonicSTSOutboundCallConfig = Omit<PhonicSTSConfig, "input_format" | "output_format">;
+type OutboundCallSuccessResponse = {
+    success: true;
+};
+
+type PhonicSTSTwilioOutboundCallParams = {
+    account_sid: string;
+    api_key_sid: string;
+    api_key_secret: string;
+    from_phone_number: string;
+    to_phone_number: string;
+};
+type PhonicSTSTwilioOutboundCallConfig = PhonicSTSOutboundCallConfig;
+type TwilioOutboundCallSuccessResponse = {
+    success: true;
+    callSid: string;
+};
+
+declare class Twilio {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    outboundCall(params: PhonicSTSTwilioOutboundCallParams, config: PhonicSTSTwilioOutboundCallConfig): DataOrError<TwilioOutboundCallSuccessResponse>;
+}
+
+declare class PhonicSTSWebSocket {
+    private readonly ws;
+    private readonly config;
+    private onMessageCallback;
+    private onCloseCallback;
+    private onErrorCallback;
+    private buffer;
+    private isOpen;
+    constructor(ws: WebSocket, config: PhonicSTSConfig);
+    onMessage(callback: OnMessageCallback): void;
+    onClose(callback: OnCloseCallback): void;
+    onError(callback: OnErrorCallback): void;
+    audioChunk({ audio }: {
+        audio: string;
+    }): void;
+    updateSystemPrompt({ systemPrompt }: {
+        systemPrompt: string;
+    }): void;
+    setExternalId({ externalId }: {
+        externalId: string;
+    }): void;
+    close(code?: number): void;
+}
+
+declare class SpeechToSpeech {
+    private readonly phonic;
+    readonly twilio: Twilio;
+    constructor(phonic: Phonic);
+    websocket(config: PhonicSTSConfig): PhonicSTSWebSocket;
+    outboundCall(toPhoneNumber: string, config: PhonicSTSOutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
+}
+
+type Voice = {
+    id: string;
+    name: string;
+};
+type VoicesSuccessResponse = {
+    voices: Array<Voice>;
+};
+type VoiceSuccessResponse = {
+    voice: Voice;
+};
+
+declare class Voices {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    list({ model }: {
+        model: string;
+    }): DataOrError<VoicesSuccessResponse>;
+    get(id: string): DataOrError<VoiceSuccessResponse>;
+}
+
+declare class Phonic {
+    readonly apiKey: string;
+    readonly baseUrl: string;
+    readonly __downstreamWebSocketUrl: string | null;
+    readonly headers: Record<string, string>;
+    readonly conversations: Conversations;
+    readonly voices: Voices;
+    readonly sts: SpeechToSpeech;
+    constructor(apiKey: string, config?: PhonicConfig);
+    fetchRequest<T>(path: string, options: FetchOptions): DataOrError<T>;
+    get<T>(path: string): Promise<{
+        data: null;
+        error: {
+            message: string;
+            code?: string;
+        };
+    } | {
+        data: T;
+        error: null;
+    }>;
+    post<T>(path: string, body: Record<string, unknown>, headers?: Record<string, string>): Promise<{
+        data: null;
+        error: {
+            message: string;
+            code?: string;
+        };
+    } | {
+        data: T;
+        error: null;
+    }>;
+}
+
+export { Phonic, type PhonicSTSConfig, PhonicSTSWebSocket };