phonic 0.30.2-rc1 → 0.30.3

package/dist/esm/api/resources/agents/client/requests/AgentsListRequest.mjs

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

package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts

@@ -1,104 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Phonic from "../../../../index.mjs";
-/**
- * @example
- *     {
- *         project: "main",
- *         name: "updated-support-agent",
- *         phone_number: "assign-automatically",
- *         timezone: "America/Los_Angeles",
- *         voice_id: "sarah",
- *         audio_speed: 1,
- *         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": {},
- *             "subject": {
- *                 default_value: "Chess"
- *             }
- *         },
- *         tools: ["keypad_input"],
- *         no_input_poke_sec: 30,
- *         no_input_poke_text: "Are you still there?",
- *         boosted_keywords: ["Load ID", "dispatch"],
- *         configuration_endpoint: {
- *             url: "https://api.example.com/config",
- *             headers: {
- *                 "Authorization": "Bearer token123"
- *             },
- *             timeout_ms: 7000
- *         }
- *     }
- */
-export interface UpdateAgentRequest {
-    /**
-     * The name of the project containing the agent. Only used when `nameOrId` is a name.
-     */
-    project?: string;
-    /** The name of the agent. Can only contain lowercase letters, numbers and hyphens. Must be unique within the project. */
-    name?: string;
-    phone_number?: "assign-automatically";
-    /** The timezone of the agent. Used to format system variables like `{{system_time}}`. */
-    timezone?: string;
-    /** The voice ID to use. */
-    voice_id?: string;
-    /** The audio format of the agent. */
-    audio_format?: UpdateAgentRequest.AudioFormat;
-    /** The audio speed of the agent. */
-    audio_speed?: number;
-    /** 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, UpdateAgentRequest.TemplateVariables.Value>;
-    /** Array of built-in or custom tool names to use. */
-    tools?: UpdateAgentRequest.Tools.Item[];
-    /** Array of task objects with `name` and `description` fields. */
-    tasks?: Phonic.Task[];
-    /** 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[];
-    /** When not `null`, at the beginning of the conversation the agent will make a POST request to this endpoint when to get configuration options. */
-    configuration_endpoint?: UpdateAgentRequest.ConfigurationEndpoint;
-}
-export declare namespace UpdateAgentRequest {
-    /**
-     * The audio format of the agent.
-     */
-    type AudioFormat = "pcm_44100" | "mulaw_8000";
-    const AudioFormat: {
-        readonly Pcm44100: "pcm_44100";
-        readonly Mulaw8000: "mulaw_8000";
-    };
-    namespace TemplateVariables {
-        interface Value {
-            default_value?: string;
-        }
-    }
-    type Tools = Tools.Item[];
-    namespace Tools {
-        type Item = "keypad_input" | "natural_conversation_ending"
-        /**
-         * Custom tool */
-         | string;
-    }
-    /**
-     * When not `null`, at the beginning of the conversation the agent will make a POST request to this endpoint when to get configuration options.
-     */
-    interface ConfigurationEndpoint {
-        /** URL to call */
-        url: string;
-        /** Object of key-value pairs. */
-        headers?: Record<string, string>;
-        /** Timeout in milliseconds for the endpoint call. */
-        timeout_ms?: number;
-    }
-}

package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.mjs

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export var UpdateAgentRequest;
-(function (UpdateAgentRequest) {
-    UpdateAgentRequest.AudioFormat = {
-        Pcm44100: "pcm_44100",
-        Mulaw8000: "mulaw_8000",
-    };
-})(UpdateAgentRequest || (UpdateAgentRequest = {}));

package/dist/esm/api/resources/agents/client/requests/UpsertAgentRequest.d.mts

@@ -1,40 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Phonic from "../../../../index.mjs";
-/**
- * @example
- *     {
- *         project: "main",
- *         name: "support-agent",
- *         phone_number: "assign-automatically",
- *         timezone: "America/Los_Angeles",
- *         voice_id: "sarah",
- *         audio_speed: 1,
- *         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": {},
- *             "subject": {
- *                 default_value: "Chess"
- *             }
- *         },
- *         tools: ["keypad_input"],
- *         no_input_poke_sec: 30,
- *         no_input_poke_text: "Are you still there?",
- *         boosted_keywords: ["Load ID", "dispatch"],
- *         configuration_endpoint: {
- *             url: "https://api.example.com/config",
- *             headers: {
- *                 "Authorization": "Bearer token123"
- *             },
- *             timeout_ms: 7000
- *         }
- *     }
- */
-export interface UpsertAgentRequest extends Phonic.CreateAgentRequest {
-    /**
-     * The name of the project containing the agent.
-     */
-    project?: string;
-}

package/dist/esm/api/resources/agents/client/requests/UpsertAgentRequest.mjs

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

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

@@ -1,6 +0,0 @@
-export { type AgentsListRequest } from "./AgentsListRequest.mjs";
-export { type AgentsCreateRequest } from "./AgentsCreateRequest.mjs";
-export { type UpsertAgentRequest } from "./UpsertAgentRequest.mjs";
-export { type AgentsGetRequest } from "./AgentsGetRequest.mjs";
-export { type AgentsDeleteRequest } from "./AgentsDeleteRequest.mjs";
-export { type UpdateAgentRequest } from "./UpdateAgentRequest.mjs";

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

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

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

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

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

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

package/dist/esm/api/resources/agents/types/AgentsCreateResponse.d.mts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface AgentsCreateResponse {
-    /** The ID of the created agent. */
-    id: string;
-    /** The name of the created agent. */
-    name: string;
-}

package/dist/esm/api/resources/agents/types/AgentsCreateResponse.mjs

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

package/dist/esm/api/resources/agents/types/AgentsDeleteResponse.d.mts

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

package/dist/esm/api/resources/agents/types/AgentsDeleteResponse.mjs

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

package/dist/esm/api/resources/agents/types/AgentsGetResponse.d.mts

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

package/dist/esm/api/resources/agents/types/AgentsGetResponse.mjs

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

package/dist/esm/api/resources/agents/types/AgentsListResponse.d.mts

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

package/dist/esm/api/resources/agents/types/AgentsListResponse.mjs

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

package/dist/esm/api/resources/agents/types/AgentsUpdateResponse.d.mts

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

package/dist/esm/api/resources/agents/types/AgentsUpdateResponse.mjs

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

package/dist/esm/api/resources/agents/types/AgentsUpsertResponse.d.mts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Phonic from "../../../index.mjs";
-export interface AgentsUpsertResponse {
-    agent: Phonic.Agent;
-    /** Whether the agent was inserted. */
-    inserted: boolean;
-    /** Whether the agent was updated. */
-    updated: boolean;
-}

package/dist/esm/api/resources/agents/types/AgentsUpsertResponse.mjs

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

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

@@ -1,6 +0,0 @@
-export * from "./AgentsListResponse.mjs";
-export * from "./AgentsCreateResponse.mjs";
-export * from "./AgentsUpsertResponse.mjs";
-export * from "./AgentsGetResponse.mjs";
-export * from "./AgentsDeleteResponse.mjs";
-export * from "./AgentsUpdateResponse.mjs";

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

@@ -1,6 +0,0 @@
-export * from "./AgentsListResponse.mjs";
-export * from "./AgentsCreateResponse.mjs";
-export * from "./AgentsUpsertResponse.mjs";
-export * from "./AgentsGetResponse.mjs";
-export * from "./AgentsDeleteResponse.mjs";
-export * from "./AgentsUpdateResponse.mjs";

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

@@ -1,236 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments.mjs";
-import * as core from "../../../../core/index.mjs";
-import * as Phonic from "../../../index.mjs";
-import { ConversationsSocket } from "./Socket.mjs";
-export declare namespace Conversations {
-    interface Options {
-        environment?: core.Supplier<environments.PhonicEnvironment | environments.PhonicEnvironmentUrls>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<core.BearerToken | undefined>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional query string parameters to include in the request. */
-        queryParams?: Record<string, unknown>;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
-    }
-    interface ConnectArgs {
-        downstream_websocket_url?: string | undefined;
-        /** Arbitrary headers to send with the websocket connect request. */
-        headers?: Record<string, string>;
-        /** Enable debug mode on the websocket. Defaults to false. */
-        debug?: boolean;
-        /** Number of reconnect attempts. Defaults to 30. */
-        reconnectAttempts?: number;
-    }
-}
-export declare class Conversations {
-    protected readonly _options: Conversations.Options;
-    constructor(_options?: Conversations.Options);
-    /**
-     * Returns conversations with optional filtering.
-     *
-     * @param {Phonic.ConversationsListRequest} request
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.BadRequestError}
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.ForbiddenError}
-     * @throws {@link Phonic.NotFoundError}
-     * @throws {@link Phonic.InternalServerError}
-     *
-     * @example
-     *     await client.conversations.list()
-     */
-    list(request?: Phonic.ConversationsListRequest, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationsListResponse>;
-    private __list;
-    /**
-     * Returns a conversation by ID.
-     *
-     * @param {string} id - The ID of the conversation to get.
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.ForbiddenError}
-     * @throws {@link Phonic.NotFoundError}
-     * @throws {@link Phonic.InternalServerError}
-     *
-     * @example
-     *     await client.conversations.get("id")
-     */
-    get(id: string, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationsGetResponse>;
-    private __get;
-    /**
-     * Cancels an active conversation.
-     *
-     * @param {string} id - The ID of the conversation to cancel.
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.ForbiddenError}
-     * @throws {@link Phonic.NotFoundError}
-     * @throws {@link Phonic.ConflictError}
-     * @throws {@link Phonic.InternalServerError}
-     * @throws {@link Phonic.GatewayTimeoutError}
-     *
-     * @example
-     *     await client.conversations.cancel("id")
-     */
-    cancel(id: string, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationsCancelResponse>;
-    private __cancel;
-    /**
-     * Returns an analysis of the specified conversation.
-     *
-     * @param {string} id - The ID of the conversation to analyze.
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.ForbiddenError}
-     * @throws {@link Phonic.NotFoundError}
-     * @throws {@link Phonic.InternalServerError}
-     *
-     * @example
-     *     await client.conversations.getAnalysis("id")
-     */
-    getAnalysis(id: string, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationsGetAnalysisResponse>;
-    private __getAnalysis;
-    /**
-     * Returns all extractions for a conversation.
-     *
-     * @param {string} id - The ID of the conversation to get extractions for.
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.ForbiddenError}
-     * @throws {@link Phonic.NotFoundError}
-     * @throws {@link Phonic.InternalServerError}
-     *
-     * @example
-     *     await client.conversations.listExtractions("id")
-     */
-    listExtractions(id: string, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationsListExtractionsResponse>;
-    private __listExtractions;
-    /**
-     * Extracts data from a conversation using a schema.
-     *
-     * @param {string} id - The ID of the conversation to extract data from.
-     * @param {Phonic.ExtractDataRequest} request
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.BadRequestError}
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.ForbiddenError}
-     * @throws {@link Phonic.NotFoundError}
-     * @throws {@link Phonic.InternalServerError}
-     *
-     * @example
-     *     await client.conversations.extractData("id", {
-     *         schema_id: "conv_extract_schema_6458e4ac-533c-4bdf-8e6d-c2f06f87fd5c"
-     *     })
-     */
-    extractData(id: string, request: Phonic.ExtractDataRequest, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationsExtractDataResponse>;
-    private __extractData;
-    /**
-     * Returns all evaluations for a conversation.
-     *
-     * @param {string} id - The ID of the conversation to get evaluations for.
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.ForbiddenError}
-     * @throws {@link Phonic.NotFoundError}
-     * @throws {@link Phonic.InternalServerError}
-     *
-     * @example
-     *     await client.conversations.listEvaluations("id")
-     */
-    listEvaluations(id: string, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationsListEvaluationsResponse>;
-    private __listEvaluations;
-    /**
-     * Evaluates a conversation using an evaluation prompt.
-     *
-     * @param {string} id - The ID of the conversation to evaluate.
-     * @param {Phonic.EvaluateConversationRequest} request
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.BadRequestError}
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.ForbiddenError}
-     * @throws {@link Phonic.NotFoundError}
-     * @throws {@link Phonic.InternalServerError}
-     *
-     * @example
-     *     await client.conversations.evaluate("id", {
-     *         prompt_id: "conv_eval_prompt_d7cfe45d-35db-4ef6-a254-81ab1da76ce0"
-     *     })
-     */
-    evaluate(id: string, request: Phonic.EvaluateConversationRequest, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationEvaluationResult>;
-    private __evaluate;
-    /**
-     * Initiates a call to a given phone number using Phonic's Twilio account.
-     *
-     * @param {Phonic.OutboundCallRequest} request
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.BadRequestError}
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.NotFoundError}
-     * @throws {@link Phonic.InternalServerError}
-     *
-     * @example
-     *     await client.conversations.outboundCall({
-     *         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: "sarah",
-     *             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"]
-     *         }
-     *     })
-     */
-    outboundCall(request: Phonic.OutboundCallRequest, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationsOutboundCallResponse>;
-    private __outboundCall;
-    /**
-     * Initiates a SIP outbound call using user-supplied SIP credentials in headers.
-     *
-     * @param {Phonic.ConversationsSipOutboundCallRequest} request
-     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Phonic.BadRequestError}
-     * @throws {@link Phonic.UnauthorizedError}
-     * @throws {@link Phonic.InternalServerError}
-     *
-     * @example
-     *     await client.conversations.sipOutboundCall({
-     *         "X-Sip-Address": "X-Sip-Address",
-     *         from_phone_number: "from_phone_number",
-     *         to_phone_number: "to_phone_number"
-     *     })
-     */
-    sipOutboundCall(request: Phonic.ConversationsSipOutboundCallRequest, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Phonic.ConversationsSipOutboundCallResponse>;
-    private __sipOutboundCall;
-    connect(args?: Conversations.ConnectArgs): Promise<ConversationsSocket>;
-    protected _getAuthorizationHeader(): Promise<string>;
-}