phonic 0.30.5 → 0.30.7

package/dist/cjs/api/resources/agents/client/requests/AgentsCreateRequest.d.ts

@@ -0,0 +1,72 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         project: "main",
+ *         name: "support-agent",
+ *         phone_number: "assign-automatically",
+ *         timezone: "America/Los_Angeles",
+ *         voice_id: "grant",
+ *         audio_speed: 1,
+ *         background_noise_level: 0,
+ *         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 AgentsCreateRequest {
+    /** The name of the project to create the agent in. */
+    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?: Phonic.CreateAgentRequest.AudioFormat;
+    /** The audio speed of the agent. */
+    audio_speed?: number;
+    /** The background noise level of the agent. */
+    background_noise_level?: 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, Phonic.CreateAgentRequest.TemplateVariables.Value>;
+    /** Array of built-in or custom tool names to use. */
+    tools?: Phonic.CreateAgentRequest.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?: Phonic.CreateAgentRequest.ConfigurationEndpoint;
+}

package/dist/cjs/api/resources/agents/client/requests/AgentsCreateRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/client/requests/AgentsDeleteRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         project: "main"
+ *     }
+ */
+export interface AgentsDeleteRequest {
+    /** The name of the project containing the agent. Only used when `nameOrId` is a name. */
+    project?: string;
+}

package/dist/cjs/api/resources/agents/client/requests/AgentsDeleteRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/client/requests/AgentsGetRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         project: "main"
+ *     }
+ */
+export interface AgentsGetRequest {
+    /** The name of the project containing the agent. Only used when `nameOrId` is a name. */
+    project?: string;
+}

package/dist/cjs/api/resources/agents/client/requests/AgentsGetRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/client/requests/AgentsListRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface AgentsListRequest {
+    /** The name of the project to list agents for. */
+    project?: string;
+}

package/dist/cjs/api/resources/agents/client/requests/AgentsListRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts

@@ -0,0 +1,105 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         project: "main",
+ *         name: "updated-support-agent",
+ *         phone_number: "assign-automatically",
+ *         timezone: "America/Los_Angeles",
+ *         voice_id: "grant",
+ *         audio_speed: 1,
+ *         background_noise_level: 0,
+ *         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;
+    /** The background noise level of the agent. */
+    background_noise_level?: 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/cjs/api/resources/agents/client/requests/UpdateAgentRequest.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateAgentRequest = void 0;
+var UpdateAgentRequest;
+(function (UpdateAgentRequest) {
+    UpdateAgentRequest.AudioFormat = {
+        Pcm44100: "pcm_44100",
+        Mulaw8000: "mulaw_8000",
+    };
+})(UpdateAgentRequest || (exports.UpdateAgentRequest = UpdateAgentRequest = {}));

package/dist/cjs/api/resources/agents/client/requests/UpsertAgentRequest.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Phonic from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         project: "main",
+ *         name: "support-agent",
+ *         phone_number: "assign-automatically",
+ *         timezone: "America/Los_Angeles",
+ *         voice_id: "grant",
+ *         audio_speed: 1,
+ *         background_noise_level: 0,
+ *         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/cjs/api/resources/agents/client/requests/UpsertAgentRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/client/requests/index.d.ts

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

package/dist/cjs/api/resources/agents/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/index.d.ts

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

package/dist/cjs/api/resources/agents/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/index.js"), exports);
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/agents/types/AgentsCreateResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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/cjs/api/resources/agents/types/AgentsCreateResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/types/AgentsDeleteResponse.d.ts

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

package/dist/cjs/api/resources/agents/types/AgentsDeleteResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/types/AgentsGetResponse.d.ts

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

package/dist/cjs/api/resources/agents/types/AgentsGetResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/types/AgentsListResponse.d.ts

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

package/dist/cjs/api/resources/agents/types/AgentsListResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/types/AgentsUpdateResponse.d.ts

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

package/dist/cjs/api/resources/agents/types/AgentsUpdateResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/types/AgentsUpsertResponse.d.ts

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

package/dist/cjs/api/resources/agents/types/AgentsUpsertResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/agents/types/index.d.ts

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

package/dist/cjs/api/resources/agents/types/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AgentsListResponse.js"), exports);
+__exportStar(require("./AgentsCreateResponse.js"), exports);
+__exportStar(require("./AgentsUpsertResponse.js"), exports);
+__exportStar(require("./AgentsGetResponse.js"), exports);
+__exportStar(require("./AgentsDeleteResponse.js"), exports);
+__exportStar(require("./AgentsUpdateResponse.js"), exports);