phonic 0.21.1 → 0.23.0

package/README.md

@@ -10,6 +10,12 @@ Node.js library for the Phonic API.
   - [Create agent](#create-agent)
   - [Update agent](#update-agent)
   - [Delete agent](#delete-agent)
+- [Tools](#tools)
+  - [List tools](#list-tools)
+  - [Get tool](#get-tool)
+  - [Create tool](#create-tool)
+  - [Update tool](#update-tool)
+  - [Delete tool](#delete-tool)
 - [Voices](#voices)
   - [List voices](#list-voices)
   - [Get voice](#get-voice)
@@ -62,6 +68,7 @@ const createAgentResult = await phonic.agents.create({
   // Optional fields
   project: "my-project", // Defaults to "main"
   phoneNumber: "assign-automatically", // Defaults to null
+  timezone: "Australia/Melbourne", // Defaults to "America/Los_Angeles"
   audioFormat: "mulaw_8000", // Defaults to "pcm_44100". Must be "mulaw_8000" when `phoneNumber` is "assign-automatically"
   voiceId: "sarah", // Defaults to "grant"
   welcomeMessage: "Hello, how can I help you?", // Defaults to ""
@@ -98,6 +105,7 @@ const updateAgentResult = await phonic.agents.update("my-agent", {
   // Optional fields
   project: "my-project",
   phoneNumber: "assign-automatically", // or null
+  timezone: "Australia/Melbourne",
   voiceId: "sarah",
   audioFormat: "mulaw_8000", // Must be "mulaw_8000" when `phoneNumber` is "assign-automatically"
   welcomeMessage: "Hello, how can I help you?",
@@ -136,6 +144,97 @@ const deleteAgentResult = await phonic.agents.delete({
 });
 ```
 
+## Tools
+
+### List tools
+
+```ts
+const toolsResult = await phonic.tools.list();
+```
+
+### Get tool
+
+```ts
+const toolResult = await phonic.tools.get("next_invoice");
+```
+
+### Create tool
+
+```ts
+const createToolResult = await phonic.tools.create({
+  name: "next_invoice",
+  description: "Returns the next invoice of the given user",
+  endpointUrl: "https://myapp.com/webhooks/next-invoice",
+  endpointHeaders: {
+    Authorization: "Bearer 123"
+  },
+  endpointTimeoutMs: 20000, // Optional, defaults to 15000
+  parameters: [
+    {
+      type: "string",
+      name: "user",
+      description: "Full name of the user to get the invoice for",
+      isRequired: true
+    },
+    {
+      type: "array",
+      itemType: "string",
+      name: "invoice_items",
+      description: "List of invoice items",
+      isRequired: false
+    },
+    {
+      type: "number",
+      name: "invoice_total",
+      description: "Total invoice amount in USD",
+      isRequired: true
+    },
+  ]
+});
+```
+
+### Update tool
+
+```ts
+const updateToolResult = await phonic.tools.update("next_invoice", {
+  name: "next_invoice_updated",
+  description: "Updated description.",
+  endpointUrl: "https://myapp.com/webhooks/next-invoice-updated",
+  endpointHeaders: {
+    Authorization: "Bearer 456"
+  },
+  endpointTimeoutMs: 30000,
+  parameters: [
+    {
+      type: "string",
+      name: "user",
+      description: "Full name of the user to get the invoice for",
+      isRequired: true
+    },
+    {
+      type: "array",
+      itemType: "string",
+      name: "invoice_items",
+      description: "List of invoice items",
+      isRequired: true
+    },
+    {
+      type: "number",
+      name: "invoice_total",
+      description: "Total invoice amount in USD",
+      isRequired: true
+    },
+  ]
+});
+```
+
+### Delete tool
+
+```ts
+const deleteToolResult = await phonic.tools.delete("next_invoice");
+```
+
+
 ## Voices
 
 ### List voices
@@ -181,7 +280,6 @@ const conversationResult = await phonic.conversations.getByExternalId({
 });
 ```
 
-
 ## STS outbound call
 
 ```ts

package/dist/index.d.mts

@@ -144,10 +144,10 @@ type Agent = {
         timeout_ms: number;
     } | null;
 };
-type ListAgentParams = {
+type ListAgentsParams = {
     project?: string;
 };
-type ListAgentSuccessResponse = DataOrError<{
+type ListAgentsSuccessResponse = DataOrError<{
     agents: Array<Agent>;
 }>;
 type GetAgentParams = {
@@ -158,6 +158,7 @@ type GetAgentSuccessResponse = DataOrError<{
 }>;
 interface AgentOptionalParams {
     project?: string;
+    timezone?: string;
     voiceId?: string;
     welcomeMessage?: string;
     systemPrompt?: string;
@@ -219,7 +220,7 @@ declare class Agents {
     private getQueryString;
     private getTemplateVariablesForBody;
     private getConfigurationEndpointForBody;
-    list(params?: ListAgentParams): DataOrError<ListAgentSuccessResponse>;
+    list(params?: ListAgentsParams): DataOrError<ListAgentsSuccessResponse>;
     get(name: string, params?: GetAgentParams): DataOrError<GetAgentSuccessResponse>;
     create(params: CreateAgentParams): DataOrError<CreateAgentSuccessResponse>;
     update(name: string, params: UpdateAgentParams): DataOrError<UpdateAgentSuccessResponse>;
@@ -331,6 +332,72 @@ declare class SpeechToSpeech {
     outboundCall(toPhoneNumber: string, config: PhonicSTSOutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
 }
 
+interface ParameterBase {
+    name: string;
+    description: string;
+    isRequired: boolean;
+}
+interface PrimitiveParameter extends ParameterBase {
+    type: "string" | "integer" | "number" | "boolean";
+}
+interface ArrayParameter extends ParameterBase {
+    type: "array";
+    itemType: "string" | "integer" | "number" | "boolean";
+}
+type ToolParameters = Array<PrimitiveParameter | ArrayParameter>;
+type Tool = {
+    id: string;
+    name: string;
+    description: string;
+    endpoint_url: string;
+    endpoint_headers: Record<string, string>;
+    endpoint_timeout_ms: number;
+    parameters: ToolParameters;
+};
+type ListToolsSuccessResponse = DataOrError<{
+    tools: Array<Tool>;
+}>;
+type GetToolSuccessResponse = DataOrError<{
+    tool: Tool;
+}>;
+type CreateToolParams = {
+    name: string;
+    description: string;
+    endpointUrl: string;
+    endpointHeaders?: Record<string, string>;
+    endpointTimeoutMs?: number;
+    parameters?: ToolParameters;
+};
+type CreateToolSuccessResponse = {
+    id: string;
+    name: string;
+};
+type UpdateToolParams = {
+    name?: string;
+    description?: string;
+    endpointUrl?: string;
+    endpointHeaders?: Record<string, string>;
+    endpointTimeoutMs?: number;
+    parameters?: Array<PrimitiveParameter | ArrayParameter>;
+};
+type UpdateToolSuccessResponse = {
+    success: true;
+};
+type DeleteToolSuccessResponse = {
+    success: true;
+};
+
+declare class Tools {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    private getParametersForBody;
+    list(): DataOrError<ListToolsSuccessResponse>;
+    get(name: string): DataOrError<GetToolSuccessResponse>;
+    create(params: CreateToolParams): DataOrError<CreateToolSuccessResponse>;
+    update(name: string, params: UpdateToolParams): DataOrError<UpdateToolSuccessResponse>;
+    delete(name: string): DataOrError<DeleteToolSuccessResponse>;
+}
+
 type Voice = {
     id: string;
     name: string;
@@ -358,6 +425,7 @@ declare class Phonic {
     readonly headers: Record<string, string>;
     readonly agents: Agents;
     readonly conversations: Conversations;
+    readonly tools: Tools;
     readonly voices: Voices;
     readonly sts: SpeechToSpeech;
     constructor(apiKey: string, config?: PhonicConfig);

package/dist/index.d.ts

@@ -144,10 +144,10 @@ type Agent = {
         timeout_ms: number;
     } | null;
 };
-type ListAgentParams = {
+type ListAgentsParams = {
     project?: string;
 };
-type ListAgentSuccessResponse = DataOrError<{
+type ListAgentsSuccessResponse = DataOrError<{
     agents: Array<Agent>;
 }>;
 type GetAgentParams = {
@@ -158,6 +158,7 @@ type GetAgentSuccessResponse = DataOrError<{
 }>;
 interface AgentOptionalParams {
     project?: string;
+    timezone?: string;
     voiceId?: string;
     welcomeMessage?: string;
     systemPrompt?: string;
@@ -219,7 +220,7 @@ declare class Agents {
     private getQueryString;
     private getTemplateVariablesForBody;
     private getConfigurationEndpointForBody;
-    list(params?: ListAgentParams): DataOrError<ListAgentSuccessResponse>;
+    list(params?: ListAgentsParams): DataOrError<ListAgentsSuccessResponse>;
     get(name: string, params?: GetAgentParams): DataOrError<GetAgentSuccessResponse>;
     create(params: CreateAgentParams): DataOrError<CreateAgentSuccessResponse>;
     update(name: string, params: UpdateAgentParams): DataOrError<UpdateAgentSuccessResponse>;
@@ -331,6 +332,72 @@ declare class SpeechToSpeech {
     outboundCall(toPhoneNumber: string, config: PhonicSTSOutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
 }
 
+interface ParameterBase {
+    name: string;
+    description: string;
+    isRequired: boolean;
+}
+interface PrimitiveParameter extends ParameterBase {
+    type: "string" | "integer" | "number" | "boolean";
+}
+interface ArrayParameter extends ParameterBase {
+    type: "array";
+    itemType: "string" | "integer" | "number" | "boolean";
+}
+type ToolParameters = Array<PrimitiveParameter | ArrayParameter>;
+type Tool = {
+    id: string;
+    name: string;
+    description: string;
+    endpoint_url: string;
+    endpoint_headers: Record<string, string>;
+    endpoint_timeout_ms: number;
+    parameters: ToolParameters;
+};
+type ListToolsSuccessResponse = DataOrError<{
+    tools: Array<Tool>;
+}>;
+type GetToolSuccessResponse = DataOrError<{
+    tool: Tool;
+}>;
+type CreateToolParams = {
+    name: string;
+    description: string;
+    endpointUrl: string;
+    endpointHeaders?: Record<string, string>;
+    endpointTimeoutMs?: number;
+    parameters?: ToolParameters;
+};
+type CreateToolSuccessResponse = {
+    id: string;
+    name: string;
+};
+type UpdateToolParams = {
+    name?: string;
+    description?: string;
+    endpointUrl?: string;
+    endpointHeaders?: Record<string, string>;
+    endpointTimeoutMs?: number;
+    parameters?: Array<PrimitiveParameter | ArrayParameter>;
+};
+type UpdateToolSuccessResponse = {
+    success: true;
+};
+type DeleteToolSuccessResponse = {
+    success: true;
+};
+
+declare class Tools {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    private getParametersForBody;
+    list(): DataOrError<ListToolsSuccessResponse>;
+    get(name: string): DataOrError<GetToolSuccessResponse>;
+    create(params: CreateToolParams): DataOrError<CreateToolSuccessResponse>;
+    update(name: string, params: UpdateToolParams): DataOrError<UpdateToolSuccessResponse>;
+    delete(name: string): DataOrError<DeleteToolSuccessResponse>;
+}
+
 type Voice = {
     id: string;
     name: string;
@@ -358,6 +425,7 @@ declare class Phonic {
     readonly headers: Record<string, string>;
     readonly agents: Agents;
     readonly conversations: Conversations;
+    readonly tools: Tools;
     readonly voices: Voices;
     readonly sts: SpeechToSpeech;
     constructor(apiKey: string, config?: PhonicConfig);

package/dist/index.js

@@ -35,7 +35,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // package.json
-var version = "0.21.1";
+var version = "0.23.0";
 
 // src/agents/index.ts
 var Agents = class {
@@ -90,6 +90,7 @@ var Agents = class {
       {
         name: params.name,
         phone_number: params.phoneNumber,
+        timezone: params.timezone,
         audio_format: params.phoneNumber === "assign-automatically" ? "mulaw_8000" : params.audioFormat,
         voice_id: params.voiceId,
         welcome_message: params.welcomeMessage,
@@ -115,6 +116,7 @@ var Agents = class {
       {
         name: params.name,
         phone_number: params.phoneNumber,
+        timezone: params.timezone,
         audio_format: params.phoneNumber === "assign-automatically" ? "mulaw_8000" : params.audioFormat,
         voice_id: params.voiceId,
         welcome_message: params.welcomeMessage,
@@ -344,6 +346,73 @@ var SpeechToSpeech = class {
   }
 };
 
+// src/tools/index.ts
+var Tools = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  getParametersForBody(parameters) {
+    if (parameters === void 0) {
+      return void 0;
+    }
+    return parameters.map((parameter) => {
+      return {
+        type: parameter.type,
+        name: parameter.name,
+        description: parameter.description,
+        is_required: parameter.isRequired,
+        ...parameter.type === "array" && {
+          item_type: parameter.itemType
+        }
+      };
+    });
+  }
+  async list() {
+    const response = await this.phonic.get("/tools");
+    return response;
+  }
+  async get(name) {
+    const response = await this.phonic.get(
+      `/tools/${name}`
+    );
+    return response;
+  }
+  async create(params) {
+    const response = await this.phonic.post(
+      "/tools",
+      {
+        name: params.name,
+        description: params.description,
+        endpoint_url: params.endpointUrl,
+        endpoint_headers: params.endpointHeaders,
+        endpoint_timeout_ms: params.endpointTimeoutMs,
+        parameters: this.getParametersForBody(params.parameters)
+      }
+    );
+    return response;
+  }
+  async update(name, params) {
+    const response = await this.phonic.patch(
+      `/tools/${name}`,
+      {
+        name: params.name,
+        description: params.description,
+        endpoint_url: params.endpointUrl,
+        endpoint_headers: params.endpointHeaders,
+        endpoint_timeout_ms: params.endpointTimeoutMs,
+        parameters: this.getParametersForBody(params.parameters)
+      }
+    );
+    return response;
+  }
+  async delete(name) {
+    const response = await this.phonic.delete(
+      `/tools/${name}`
+    );
+    return response;
+  }
+};
+
 // src/voices/index.ts
 var Voices = class {
   constructor(phonic) {
@@ -393,6 +462,7 @@ var Phonic = class {
   headers;
   agents = new Agents(this);
   conversations = new Conversations(this);
+  tools = new Tools(this);
   voices = new Voices(this);
   sts = new SpeechToSpeech(this);
   async fetchRequest(path, options) {

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // package.json
-var version = "0.21.1";
+var version = "0.23.0";
 
 // src/agents/index.ts
 var Agents = class {
@@ -54,6 +54,7 @@ var Agents = class {
       {
         name: params.name,
         phone_number: params.phoneNumber,
+        timezone: params.timezone,
         audio_format: params.phoneNumber === "assign-automatically" ? "mulaw_8000" : params.audioFormat,
         voice_id: params.voiceId,
         welcome_message: params.welcomeMessage,
@@ -79,6 +80,7 @@ var Agents = class {
       {
         name: params.name,
         phone_number: params.phoneNumber,
+        timezone: params.timezone,
         audio_format: params.phoneNumber === "assign-automatically" ? "mulaw_8000" : params.audioFormat,
         voice_id: params.voiceId,
         welcome_message: params.welcomeMessage,
@@ -308,6 +310,73 @@ var SpeechToSpeech = class {
   }
 };
 
+// src/tools/index.ts
+var Tools = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  getParametersForBody(parameters) {
+    if (parameters === void 0) {
+      return void 0;
+    }
+    return parameters.map((parameter) => {
+      return {
+        type: parameter.type,
+        name: parameter.name,
+        description: parameter.description,
+        is_required: parameter.isRequired,
+        ...parameter.type === "array" && {
+          item_type: parameter.itemType
+        }
+      };
+    });
+  }
+  async list() {
+    const response = await this.phonic.get("/tools");
+    return response;
+  }
+  async get(name) {
+    const response = await this.phonic.get(
+      `/tools/${name}`
+    );
+    return response;
+  }
+  async create(params) {
+    const response = await this.phonic.post(
+      "/tools",
+      {
+        name: params.name,
+        description: params.description,
+        endpoint_url: params.endpointUrl,
+        endpoint_headers: params.endpointHeaders,
+        endpoint_timeout_ms: params.endpointTimeoutMs,
+        parameters: this.getParametersForBody(params.parameters)
+      }
+    );
+    return response;
+  }
+  async update(name, params) {
+    const response = await this.phonic.patch(
+      `/tools/${name}`,
+      {
+        name: params.name,
+        description: params.description,
+        endpoint_url: params.endpointUrl,
+        endpoint_headers: params.endpointHeaders,
+        endpoint_timeout_ms: params.endpointTimeoutMs,
+        parameters: this.getParametersForBody(params.parameters)
+      }
+    );
+    return response;
+  }
+  async delete(name) {
+    const response = await this.phonic.delete(
+      `/tools/${name}`
+    );
+    return response;
+  }
+};
+
 // src/voices/index.ts
 var Voices = class {
   constructor(phonic) {
@@ -357,6 +426,7 @@ var Phonic = class {
   headers;
   agents = new Agents(this);
   conversations = new Conversations(this);
+  tools = new Tools(this);
   voices = new Voices(this);
   sts = new SpeechToSpeech(this);
   async fetchRequest(path, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phonic",
-  "version": "0.21.1",
+  "version": "0.23.0",
   "description": "Phonic Node.js SDK",
   "scripts": {
     "build": "tsup",