phonic 0.32.1 → 0.32.3

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

@@ -86,6 +86,20 @@ export interface Conversation {
     call_info: Conversation.CallInfo | null;
     /** Analysis of the conversation including latencies and interruptions. */
     analysis: Phonic.ConversationAnalysis;
+    /** Whether PII and PHI have been redacted from the conversation. */
+    is_redacted?: boolean | undefined;
+    /** The redacted transcript of the conversation. `null` when the conversation is not redacted. */
+    redacted_transcript?: (string | null) | undefined;
+    /** Arbitrary metadata associated with the conversation. */
+    metadata?: (Record<string, unknown> | null) | undefined;
+    /** Controls how long transcripts and audio recordings are retained before deletion. */
+    data_retention_policy?: Phonic.DataRetentionPolicy | undefined;
+    /** Information about when transcripts and audio recordings are or were scheduled to be deleted. */
+    deletion_info?: Conversation.DeletionInfo | undefined;
+    /** Whether the assistant produced backchannel responses during the conversation. */
+    enable_assistant_backchannel?: boolean | undefined;
+    /** How aggressively the assistant produced backchannel responses during the conversation. */
+    assistant_backchannel_aggressiveness?: number | undefined;
 }
 export declare namespace Conversation {
     /**
@@ -130,6 +144,10 @@ export declare namespace Conversation {
         readonly UserCanceled: "user_canceled";
         readonly UserValidationFailed: "user_validation_failed";
         readonly Assistant: "assistant";
+        readonly AssistantSilenceLimitReached: "assistant_silence_limit_reached";
+        readonly ConfigurationEndpointTimedOut: "configuration_endpoint_timed_out";
+        readonly ConfigurationEndpointError: "configuration_endpoint_error";
+        readonly ConfigurationEndpointInvalidResponse: "configuration_endpoint_invalid_response";
         readonly Error: "error";
     };
     type EndedBy = (typeof EndedBy)[keyof typeof EndedBy];
@@ -158,4 +176,13 @@ export declare namespace Conversation {
         /** Twilio Call SID. Only present for user SIP trunking calls. */
         twilio_call_sid?: string | undefined;
     }
+    /**
+     * Information about when transcripts and audio recordings are or were scheduled to be deleted.
+     */
+    interface DeletionInfo {
+        /** When the transcripts were deleted. `null` if not deleted. */
+        transcripts_deleted_at: string | null;
+        /** When the audio recordings were deleted. `null` if not deleted. */
+        audio_recordings_deleted_at: string | null;
+    }
 }

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

@@ -21,6 +21,10 @@ export var Conversation;
         UserCanceled: "user_canceled",
         UserValidationFailed: "user_validation_failed",
         Assistant: "assistant",
+        AssistantSilenceLimitReached: "assistant_silence_limit_reached",
+        ConfigurationEndpointTimedOut: "configuration_endpoint_timed_out",
+        ConfigurationEndpointError: "configuration_endpoint_error",
+        ConfigurationEndpointInvalidResponse: "configuration_endpoint_invalid_response",
         Error: "error",
     };
     /** If `"auto"`, each user audio is automatically identified for the language to respond in. If `"request"`, user must request to change language (recommended). If `"initial"` the first turn user audio determines the language for the rest of the conversation. */

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

@@ -1 +1,22 @@
-export type ConversationEval = unknown;
+import type * as Phonic from "../index.mjs";
+export interface ConversationEval {
+    /** The evaluation ID. */
+    id: string;
+    /** The ID of the conversation that was evaluated. */
+    conversation_id: string;
+    prompt: Phonic.ConversationEvalPromptInfo;
+    /** The evaluation result. */
+    result: ConversationEval.Result;
+    /** When the evaluation was created. */
+    created_at: string;
+}
+export declare namespace ConversationEval {
+    /** The evaluation result. */
+    const Result: {
+        readonly Successful: "successful";
+        readonly Unsuccessful: "unsuccessful";
+        readonly Undecided: "undecided";
+        readonly Error: "error";
+    };
+    type Result = (typeof Result)[keyof typeof Result];
+}

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

@@ -1,2 +1,11 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var ConversationEval;
+(function (ConversationEval) {
+    /** The evaluation result. */
+    ConversationEval.Result = {
+        Successful: "successful",
+        Unsuccessful: "unsuccessful",
+        Undecided: "undecided",
+        Error: "error",
+    };
+})(ConversationEval || (ConversationEval = {}));

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

@@ -0,0 +1,7 @@
+/**
+ * The evaluation prompt information.
+ */
+export interface ConversationEvalPromptInfo {
+    id: string;
+    name: string;
+}

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

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

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

@@ -1,13 +1,9 @@
 export interface ConversationExtraction {
     /** The extraction ID. */
     id: string;
-    /** The conversation ID. */
-    conversation_id?: string | undefined;
     schema: ConversationExtraction.Schema;
     /** The extracted data. */
     result: Record<string, unknown>;
-    /** Error message if extraction failed. */
-    error: string | null;
     /** When the extraction was created. */
     created_at: string;
 }
@@ -15,5 +11,7 @@ export declare namespace ConversationExtraction {
     interface Schema {
         id: string;
         name: string;
+        /** Whether the extraction schema has been deleted. */
+        isDeleted: boolean;
     }
 }

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

@@ -5,10 +5,12 @@ export interface ConversationItem {
     item_idx: number;
     /** Who spoke in this turn. */
     role: ConversationItem.Role;
-    /** Live transcript of this turn. */
-    live_transcript: string;
+    /** Live transcript of this turn. `null` when the turn has been redacted. */
+    live_transcript: string | null;
     /** Post-call processed transcript. */
     post_call_transcript: string | null;
+    /** The redacted transcript of this turn. `null` when the turn is not redacted. */
+    redacted_transcript?: (string | null) | undefined;
     /** Duration of this turn in milliseconds. */
     duration_ms: number;
     /** When this turn started. */

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

@@ -2,6 +2,8 @@ import type * as Phonic from "../index.mjs";
 export interface CreateAgentRequest {
     /** The name of the agent. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
     name: string;
+    /** URL-friendly agent slug. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
+    slug?: string | undefined;
     /** When set to `null`, the agent will not be associated with a phone number. When set to `"assign-automatically"`, the agent will be assigned a random phone number. When set to `"custom"`, you must provide `custom_phone_numbers`. */
     phone_number?: (CreateAgentRequest.PhoneNumber | null) | undefined;
     /** The custom phone number to use for the agent in E.164 format (e.g., +1234567890). This field is deprecated. Use `custom_phone_numbers` instead. */
@@ -42,6 +44,12 @@ export interface CreateAgentRequest {
     no_input_poke_text?: string | undefined;
     /** Seconds of silence before ending the conversation. */
     no_input_end_conversation_sec?: number | undefined;
+    /** When `true`, the assistant will produce backchannel responses (e.g. "mm-hmm") while the user is speaking. */
+    enable_assistant_backchannel?: boolean | undefined;
+    /** How aggressively the assistant produces backchannel responses. Only relevant when `enable_assistant_backchannel` is `true`. */
+    assistant_backchannel_aggressiveness?: number | undefined;
+    /** Controls how long transcripts and audio recordings are retained before deletion. */
+    data_retention_policy?: Phonic.DataRetentionPolicy | undefined;
     /** ISO 639-1 language code that sets the agent's default language to recognize and speak. Welcome message and no input poke text should be in this language. */
     default_language?: Phonic.LanguageCode | undefined;
     /** Array of additional ISO 639-1 language codes that the agent should be able to recognize and speak. Should not include `default_language`. */

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

@@ -0,0 +1,21 @@
+/**
+ * Controls how long transcripts and audio recordings are retained before deletion.
+ * When `zero_data_retention` is `true`, nothing is retained and `transcripts`/`audio_recordings` are omitted.
+ */
+export type DataRetentionPolicy = 
+/**
+ * Zero data retention mode. No transcripts or audio recordings are retained. */
+{
+    zero_data_retention: true;
+}
+/**
+ * Standard data retention with configurable deletion windows. */
+ | {
+    zero_data_retention: false;
+    transcripts: {
+        delete_after_hours: number | null;
+    };
+    audio_recordings: {
+        delete_after_hours: number | null;
+    };
+};

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

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

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

@@ -2,4 +2,6 @@ export interface DtmfPayload {
     type: "dtmf";
     /** DTMF digits to play */
     digits: string;
+    /** Optional latency-breakdown metrics for the message, expressed as named millisecond durations. */
+    timings?: Record<string, number> | undefined;
 }

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

@@ -3,8 +3,8 @@ export interface ExtractionField {
     name: string;
     /** The field type. */
     type: ExtractionField.Type;
-    /** Description of the field. */
-    description?: (string | null) | undefined;
+    /** Description of the field. May be null, but the property must be present. */
+    description: string | null;
 }
 export declare namespace ExtractionField {
     /** The field type. */

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

@@ -7,7 +7,11 @@ export interface OutboundCallConfig {
     agent?: string | undefined;
     /** The name of the project to use for the call. */
     project?: string | undefined;
-    /** Message to play when the conversation starts. Can contain template variables like `{{customer_name}}`. */
+    /** When `true`, the welcome message will be automatically generated and the `welcome_message` field will be ignored. */
+    generate_welcome_message?: boolean | undefined;
+    /** When `false`, the welcome message will not be interruptible by the user. */
+    is_welcome_message_interruptible?: boolean | undefined;
+    /** Message to play when the conversation starts. Can contain template variables like `{{customer_name}}`. Ignored when `generate_welcome_message` is `true`. */
     welcome_message?: (string | null) | undefined;
     /** Instructions for the conversation. Can contain template variables like `{{subject}}`. */
     system_prompt?: string | undefined;
@@ -43,6 +47,28 @@ export interface OutboundCallConfig {
     tools?: OutboundCallConfig.Tools.Item[] | undefined;
     /** When `true`, PII and PHI are redacted from text transcripts (e.g. replaced with tags like `[PHONE NUMBER]`) and bleeped from audio recordings after the conversation ends. */
     enable_redaction?: boolean | undefined;
+    /** The speech-to-speech model to use. */
+    model?: "merritt" | undefined;
+    /** The audio speed of the agent. */
+    audio_speed?: number | undefined;
+    /** The background noise type. Can be "office", "call-center", "coffee-shop", or null. */
+    background_noise?: (OutboundCallConfig.BackgroundNoise | null) | undefined;
+    /** The background noise level of the agent. */
+    background_noise_level?: number | undefined;
+    /** Array of MCP server names to use. */
+    mcp_servers?: string[] | undefined;
+    /** Array of task objects with `name` and `description` fields. */
+    tasks?: Phonic.Task[] | undefined;
+    /** Pool of phone numbers used for outbound calls. */
+    outbound_number_pool?: (Phonic.OutboundNumberPool | null) | undefined;
+    /** When `true`, the assistant will produce backchannel responses (e.g. "mm-hmm") while the user is speaking. */
+    enable_assistant_backchannel?: boolean | undefined;
+    /** How aggressively the assistant produces backchannel responses. Only relevant when `enable_assistant_backchannel` is `true`. */
+    assistant_backchannel_aggressiveness?: number | undefined;
+    /** When not `null`, at the beginning of the conversation the agent will make a POST request to this endpoint to get configuration options. */
+    configuration_endpoint?: (OutboundCallConfig.ConfigurationEndpoint | null) | undefined;
+    /** Controls how long transcripts and audio recordings are retained before deletion. */
+    data_retention_policy?: Phonic.DataRetentionPolicy | undefined;
 }
 export declare namespace OutboundCallConfig {
     /** If `"auto"`, each user audio is automatically identified for the language to respond in. If `"request"`, user must request to change language (recommended). If `"initial"` the first turn user audio determines the language for the rest of the conversation. */
@@ -66,4 +92,22 @@ export declare namespace OutboundCallConfig {
          * Custom tool */
          | string;
     }
+    /** The background noise type. Can be "office", "call-center", "coffee-shop", or null. */
+    const BackgroundNoise: {
+        readonly Office: "office";
+        readonly CallCenter: "call-center";
+        readonly CoffeeShop: "coffee-shop";
+    };
+    type BackgroundNoise = (typeof BackgroundNoise)[keyof typeof BackgroundNoise];
+    /**
+     * When not `null`, at the beginning of the conversation the agent will make a POST request to this endpoint to get configuration options.
+     */
+    interface ConfigurationEndpoint {
+        /** URL to call */
+        url: string;
+        /** Object of key-value pairs. */
+        headers?: Record<string, string> | undefined;
+        /** Timeout in milliseconds for the endpoint call. */
+        timeout_ms?: number | undefined;
+    }
 }

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

@@ -7,4 +7,10 @@ export var OutboundCallConfig;
         Request: "request",
         Initial: "initial",
     };
+    /** The background noise type. Can be "office", "call-center", "coffee-shop", or null. */
+    OutboundCallConfig.BackgroundNoise = {
+        Office: "office",
+        CallCenter: "call-center",
+        CoffeeShop: "coffee-shop",
+    };
 })(OutboundCallConfig || (OutboundCallConfig = {}));

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

@@ -0,0 +1,9 @@
+/**
+ * Pool of phone numbers used for outbound calls.
+ */
+export interface OutboundNumberPool {
+    /** E.164 formatted phone numbers available for outbound calls. */
+    active: string[];
+    /** E.164 formatted phone numbers that are blocked from being used. */
+    blocked: string[];
+}

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

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

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

@@ -10,7 +10,7 @@ export interface Tool {
     /** The type of tool. */
     type: Tool.Type;
     /** Mode of operation - sync waits for response, async continues without waiting. */
-    execution_mode: Tool.ExecutionMode;
+    execution_mode?: Tool.ExecutionMode | undefined;
     /** Array of parameter definitions for the tool. */
     parameters: Phonic.ToolParameter[];
     /** HTTP method for webhook tools. */
@@ -43,6 +43,8 @@ export interface Tool {
     allow_tool_chaining?: boolean | undefined;
     /** The agent doesn't typically wait for the response of async custom_websocket tools. When true, makes the agent wait for a response, not call other tools and inform the user of the result. Only available for async custom_websocket tools. */
     wait_for_response?: boolean | undefined;
+    /** The static context returned to the agent. Only present for custom_context tools. */
+    context?: string | undefined;
 }
 export declare namespace Tool {
     interface Project {

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

@@ -1,5 +1,7 @@
 export * from "./AddSystemMessagePayload.mjs";
 export * from "./Agent.mjs";
+export * from "./AgentIntegration.mjs";
+export * from "./ApiKeyWithSecret.mjs";
 export * from "./AssistantChoseNotToRespondPayload.mjs";
 export * from "./AssistantEndedConversationPayload.mjs";
 export * from "./AssistantFinishedSpeakingPayload.mjs";
@@ -15,6 +17,7 @@ export * from "./ConversationAnalysis.mjs";
 export * from "./ConversationCreatedPayload.mjs";
 export * from "./ConversationEval.mjs";
 export * from "./ConversationEvalPrompt.mjs";
+export * from "./ConversationEvalPromptInfo.mjs";
 export * from "./ConversationEvaluation.mjs";
 export * from "./ConversationEvaluationResult.mjs";
 export * from "./ConversationExtraction.mjs";
@@ -23,6 +26,7 @@ export * from "./ConversationsListResponseConversation.mjs";
 export * from "./ConversationsListResponseConversations.mjs";
 export * from "./ConversationsListResponseConversationsPagination.mjs";
 export * from "./CreateAgentRequest.mjs";
+export * from "./DataRetentionPolicy.mjs";
 export * from "./DtmfPayload.mjs";
 export * from "./Error_.mjs";
 export * from "./ErrorPayload.mjs";
@@ -40,6 +44,7 @@ export * from "./OpenAiTool.mjs";
 export * from "./OutboundCallConfig.mjs";
 export * from "./OutboundCallInitiatedResponse.mjs";
 export * from "./OutboundDryRunResponse.mjs";
+export * from "./OutboundNumberPool.mjs";
 export * from "./Project.mjs";
 export * from "./ReadyToStartConversationPayload.mjs";
 export * from "./ReplayConversationItemResponse.mjs";

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

@@ -1,5 +1,7 @@
 export * from "./AddSystemMessagePayload.mjs";
 export * from "./Agent.mjs";
+export * from "./AgentIntegration.mjs";
+export * from "./ApiKeyWithSecret.mjs";
 export * from "./AssistantChoseNotToRespondPayload.mjs";
 export * from "./AssistantEndedConversationPayload.mjs";
 export * from "./AssistantFinishedSpeakingPayload.mjs";
@@ -15,6 +17,7 @@ export * from "./ConversationAnalysis.mjs";
 export * from "./ConversationCreatedPayload.mjs";
 export * from "./ConversationEval.mjs";
 export * from "./ConversationEvalPrompt.mjs";
+export * from "./ConversationEvalPromptInfo.mjs";
 export * from "./ConversationEvaluation.mjs";
 export * from "./ConversationEvaluationResult.mjs";
 export * from "./ConversationExtraction.mjs";
@@ -23,6 +26,7 @@ export * from "./ConversationsListResponseConversation.mjs";
 export * from "./ConversationsListResponseConversations.mjs";
 export * from "./ConversationsListResponseConversationsPagination.mjs";
 export * from "./CreateAgentRequest.mjs";
+export * from "./DataRetentionPolicy.mjs";
 export * from "./DtmfPayload.mjs";
 export * from "./Error_.mjs";
 export * from "./ErrorPayload.mjs";
@@ -40,6 +44,7 @@ export * from "./OpenAiTool.mjs";
 export * from "./OutboundCallConfig.mjs";
 export * from "./OutboundCallInitiatedResponse.mjs";
 export * from "./OutboundDryRunResponse.mjs";
+export * from "./OutboundNumberPool.mjs";
 export * from "./Project.mjs";
 export * from "./ReadyToStartConversationPayload.mjs";
 export * from "./ReplayConversationItemResponse.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.32.1";
+export declare const SDK_VERSION = "0.32.3";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.32.1";
+export const SDK_VERSION = "0.32.3";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "phonic",
-    "version": "0.32.1",
+    "version": "0.32.3",
     "private": false,
     "repository": {
         "type": "git",
@@ -78,6 +78,17 @@
             },
             "default": "./dist/cjs/api/resources/workspace/exports.js"
         },
+        "./apiKeys": {
+            "import": {
+                "types": "./dist/esm/api/resources/apiKeys/exports.d.mts",
+                "default": "./dist/esm/api/resources/apiKeys/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/apiKeys/exports.d.ts",
+                "default": "./dist/cjs/api/resources/apiKeys/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/apiKeys/exports.js"
+        },
         "./conversationItems": {
             "import": {
                 "types": "./dist/esm/api/resources/conversationItems/exports.d.mts",