phonic 0.28.0 → 0.29.0

package/README.md

@@ -28,6 +28,12 @@ Node.js library for the Phonic API.
   - [Outbound call using own Twilio account](#outbound-call-using-own-twilio-account)
 - [STS via WebSocket](#sts-via-websocket)
   - [Messages that Phonic sends back to you](#messages-that-phonic-sends-back-to-you)
+- [Projects](#projects)
+  - [List projects](#list-projects)
+  - [Get project](#get-project)
+  - [Create project](#create-project)
+  - [Update project](#update-project)
+  - [Delete project](#delete-project)
 - [License](#license)
 
 ## Installation
@@ -51,19 +57,21 @@ const phonic = new Phonic("ph_...");
 ### List agents
 
 ```ts
-const agentsResult = await phonic.agents.list({ project: "main" });
+const result = await phonic.agents.list({ project: "main" });
 ```
 
 ### Get agent
 
+Returns an agent by name or ID.
+
 ```ts
-const agentResult = await phonic.agents.get("chris", { project: "main" });
+const result = await phonic.agents.get("chris", { project: "main" });
 ```
 
 ### Create agent
 
 ```ts
-const createAgentResult = await phonic.agents.create({
+const result = await phonic.agents.create({
   name: "chris",
   
   // Optional fields
@@ -100,7 +108,7 @@ const createAgentResult = await phonic.agents.create({
 ### Update agent
 
 ```ts
-const updateAgentResult = await phonic.agents.update("chris", {
+const result = await phonic.agents.update("chris", {
   name: "chris",
   
   // Optional fields
@@ -137,7 +145,7 @@ const updateAgentResult = await phonic.agents.update("chris", {
 ### Upsert agent
 
 ```ts
-const upsertAgentResult = await phonic.agents.upsert({
+const result = await phonic.agents.upsert({
   name: "chris",
   
   // Optional fields
@@ -174,7 +182,7 @@ const upsertAgentResult = await phonic.agents.upsert({
 ### Delete agent
 
 ```ts
-const deleteAgentResult = await phonic.agents.delete("chris", {
+const result = await phonic.agents.delete("chris", {
   // Optional fields
   project: "main",
 });
@@ -185,26 +193,28 @@ const deleteAgentResult = await phonic.agents.delete("chris", {
 ### List tools
 
 ```ts
-const toolsResult = await phonic.tools.list();
+const result = await phonic.tools.list({ 
+  project: "customer-support" // Optional. Defaults to "main".
+});
 ```
 
 ### Get tool
 
-Gets a tool by its ID or name.
+Returns a tool by name or ID.
 
 ```ts
-const toolResult = await phonic.tools.get("next_invoice");
-const toolByIdResult = await phonic.tools.get("tool_12cf6e88-c254-4d3e-a149-ddf1bdd2254c");
+const result = await phonic.tools.get("next_invoice", { 
+  project: "customer-support" // Optional. Defaults to "main".
+});
 ```
 
 ### Create tool
 
-Tools can be either webhook-based (HTTP endpoints) or WebSocket-based.
-
 #### Create webhook tool
 
 ```ts
-const createWebhookToolResult = await phonic.tools.create({
+const result = await phonic.tools.create({
+  project: "customer-support", // Optional. Defaults to "main".
   name: "next_invoice",
   description: "Returns the next invoice of the given user",
   type: "custom_webhook",
@@ -244,7 +254,8 @@ const createWebhookToolResult = await phonic.tools.create({
 WebSocket tools allow you to handle tool execution through the WebSocket connection. When the agent calls a WebSocket tool, you'll receive a `tool_call` message and must respond with a `tool_call_output` message that contains the tool result.
 
 ```ts
-const createWebSocketToolResult = await phonic.tools.create({
+const result = await phonic.tools.create({
+  project: "customer-support", // Optional. Defaults to "main".
   name: "get_product_recommendations",
   description: "Gets personalized product recommendations",
   type: "custom_websocket",
@@ -265,7 +276,7 @@ To use this tool in a conversation, add it to your agent or config:
 
 ```ts
 // When creating an agent
-const agent = await phonic.agents.create({
+const result = await phonic.agents.create({
   name: "shopping-assistant",
   tools: ["get_product_recommendations"],
   // ... other config
@@ -303,7 +314,8 @@ phonicWebSocket.onMessage(async (message) => {
 Updates a tool by ID or name. All fields are optional - only provided fields will be updated.
 
 ```ts
-const updateWebhookToolResult = await phonic.tools.update("next_invoice", {
+const result = await phonic.tools.update("next_invoice", {
+  project: "customer-support", // Optional. Defaults to "main".
   name: "next_invoice_updated",
   description: "Updated description.",
   type: "custom_webhook",
@@ -341,7 +353,7 @@ const updateWebhookToolResult = await phonic.tools.update("next_invoice", {
 For WebSocket tools, you would use `toolCallOutputTimeoutMs` instead of the endpoint fields:
 
 ```ts
-const updateWebSocketToolResult = await phonic.tools.update("get_product_recommendations", {
+const result = await phonic.tools.update("get_product_recommendations", {
   description: "Updated product recommendation tool",
   toolCallOutputTimeoutMs: 7000
 });
@@ -352,23 +364,24 @@ const updateWebSocketToolResult = await phonic.tools.update("get_product_recomme
 Deletes a tool by ID or name.
 
 ```ts
-const deleteToolResult = await phonic.tools.delete("next_invoice");
+const result = await phonic.tools.delete("next_invoice", { 
+  project: "customer-support" // Optional. Defaults to "main".
+});
 ```
 
-
 ## Voices
 
 ### List voices
 
 ```ts
-const voicesResult = await phonic.voices.list({ model: "merritt" });
+const result = await phonic.voices.list({ model: "merritt" });
 ```
 
 
 ### Get voice
 
 ```ts
-const voiceResult = await phonic.voices.get("grant");
+const result = await phonic.voices.get("grant");
 ```
 
 ## Conversations
@@ -376,7 +389,7 @@ const voiceResult = await phonic.voices.get("grant");
 ### List conversations
 
 ```ts
-const conversationsResult = await phonic.conversations.list({
+const result = await phonic.conversations.list({
   project: "main",
   durationMin: 10, // sec
   durationMax: 20, // sec
@@ -389,13 +402,13 @@ const conversationsResult = await phonic.conversations.list({
 ### Get conversation by id
 
 ```ts
-const conversationResult = await phonic.conversations.get("conv_b1804883-5be4-42fe-b1cf-aa84450d5c84");
+const result = await phonic.conversations.get("conv_b1804883-5be4-42fe-b1cf-aa84450d5c84");
 ```
 
 ### Get conversation by external id
 
 ```ts
-const conversationResult = await phonic.conversations.getByExternalId({
+const result = await phonic.conversations.getByExternalId({
   project: "main",
   externalId: "CAdb9c032c809fec7feb932ea4c96d71e1"
 });
@@ -404,7 +417,7 @@ const conversationResult = await phonic.conversations.getByExternalId({
 ### Outbound call
 
 ```ts
-const outboundCallResult = await phonic.conversations.outboundCall("+19189396241", {
+const result = await phonic.conversations.outboundCall("+19189396241", {
   // Optional fields
   agent: "chris",
   template_variables: {
@@ -419,7 +432,7 @@ const outboundCallResult = await phonic.conversations.outboundCall("+19189396241
 In Twilio, create a restricted API key with the following permissions: `voice -> calls -> read` and `voice -> calls -> create`.
 
 ```ts
-const twilioOutboundCallResult = await phonic.conversations.twilio.outboundCall(
+const result = await phonic.conversations.twilio.outboundCall(
   {
     account_sid: "AC...",
     api_key_sid: "SK...",
@@ -753,6 +766,45 @@ If the conversation is not a phone call, `call_info` will be `null`. If it is a
 
 Sent when an error occurs during the conversation.
 
+## Projects
+
+### List projects
+
+```ts
+const result = await phonic.projects.list();
+```
+
+### Get project
+
+Returns a project by name or ID.
+
+```ts
+const result = await phonic.projects.get("main");
+```
+
+### Create project
+
+```ts
+const result = await phonic.projects.create({
+  name: "customer-support",
+});
+```
+
+### Update project
+
+```ts
+const result = await phonic.projects.update("customer-support", {
+  name: "updated-customer-support",
+  defaultAgent: "another-agent"
+});
+```
+
+### Delete project
+
+```ts
+const result = await phonic.projects.delete("customer-support");
+```
+
 ## License
 
 MIT

package/dist/index.d.mts

@@ -479,13 +479,20 @@ interface WebSocketTool extends ToolBase {
     tool_call_output_timeout_ms: number;
 }
 type Tool = WebhookTool | WebSocketTool;
+type ListToolsParams = {
+    project?: string;
+};
 type ListToolsSuccessResponse = DataOrError<{
     tools: Array<Tool>;
 }>;
+type GetToolParams = {
+    project?: string;
+};
 type GetToolSuccessResponse = DataOrError<{
     tool: Tool;
 }>;
 interface CreateToolParamsBase {
+    project?: string;
     name: string;
     description: string;
     executionMode: ExecutionMode;
@@ -508,6 +515,7 @@ type CreateToolSuccessResponse = {
     name: string;
 };
 type UpdateToolParams = {
+    project?: string;
     name?: string;
     description?: string;
     type?: "custom_webhook" | "custom_websocket";
@@ -522,6 +530,9 @@ type UpdateToolParams = {
 type UpdateToolSuccessResponse = {
     success: true;
 };
+type DeleteToolParams = {
+    project?: string;
+};
 type DeleteToolSuccessResponse = {
     success: true;
 };
@@ -529,12 +540,13 @@ type DeleteToolSuccessResponse = {
 declare class Tools {
     private readonly phonic;
     constructor(phonic: Phonic);
+    private getQueryString;
     private getParametersForBody;
-    list(): DataOrError<ListToolsSuccessResponse>;
-    get(nameOrId: string): DataOrError<GetToolSuccessResponse>;
+    list(params?: ListToolsParams): DataOrError<ListToolsSuccessResponse>;
+    get(nameOrId: string, params?: GetToolParams): DataOrError<GetToolSuccessResponse>;
     create(params: CreateToolParams): DataOrError<CreateToolSuccessResponse>;
     update(nameOrId: string, params: UpdateToolParams): DataOrError<UpdateToolSuccessResponse>;
-    delete(nameOrId: string): DataOrError<DeleteToolSuccessResponse>;
+    delete(nameOrId: string, params?: DeleteToolParams): DataOrError<DeleteToolSuccessResponse>;
 }
 
 type Voice = {

package/dist/index.d.ts

@@ -479,13 +479,20 @@ interface WebSocketTool extends ToolBase {
     tool_call_output_timeout_ms: number;
 }
 type Tool = WebhookTool | WebSocketTool;
+type ListToolsParams = {
+    project?: string;
+};
 type ListToolsSuccessResponse = DataOrError<{
     tools: Array<Tool>;
 }>;
+type GetToolParams = {
+    project?: string;
+};
 type GetToolSuccessResponse = DataOrError<{
     tool: Tool;
 }>;
 interface CreateToolParamsBase {
+    project?: string;
     name: string;
     description: string;
     executionMode: ExecutionMode;
@@ -508,6 +515,7 @@ type CreateToolSuccessResponse = {
     name: string;
 };
 type UpdateToolParams = {
+    project?: string;
     name?: string;
     description?: string;
     type?: "custom_webhook" | "custom_websocket";
@@ -522,6 +530,9 @@ type UpdateToolParams = {
 type UpdateToolSuccessResponse = {
     success: true;
 };
+type DeleteToolParams = {
+    project?: string;
+};
 type DeleteToolSuccessResponse = {
     success: true;
 };
@@ -529,12 +540,13 @@ type DeleteToolSuccessResponse = {
 declare class Tools {
     private readonly phonic;
     constructor(phonic: Phonic);
+    private getQueryString;
     private getParametersForBody;
-    list(): DataOrError<ListToolsSuccessResponse>;
-    get(nameOrId: string): DataOrError<GetToolSuccessResponse>;
+    list(params?: ListToolsParams): DataOrError<ListToolsSuccessResponse>;
+    get(nameOrId: string, params?: GetToolParams): DataOrError<GetToolSuccessResponse>;
     create(params: CreateToolParams): DataOrError<CreateToolSuccessResponse>;
     update(nameOrId: string, params: UpdateToolParams): DataOrError<UpdateToolSuccessResponse>;
-    delete(nameOrId: string): DataOrError<DeleteToolSuccessResponse>;
+    delete(nameOrId: string, params?: DeleteToolParams): DataOrError<DeleteToolSuccessResponse>;
 }
 
 type Voice = {

package/dist/index.js

@@ -35,7 +35,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // package.json
-var version = "0.28.0";
+var version = "0.29.0";
 
 // src/agents/index.ts
 var Agents = class {
@@ -425,6 +425,13 @@ var Tools = class {
   constructor(phonic) {
     this.phonic = phonic;
   }
+  getQueryString(params) {
+    const project = params?.project;
+    const queryString = new URLSearchParams({
+      ...project !== void 0 && { project }
+    }).toString();
+    return queryString;
+  }
   getParametersForBody(parameters) {
     if (parameters === void 0) {
       return void 0;
@@ -441,13 +448,15 @@ var Tools = class {
       };
     });
   }
-  async list() {
-    const response = await this.phonic.get("/tools");
+  async list(params) {
+    const response = await this.phonic.get(
+      `/tools?${this.getQueryString(params)}`
+    );
     return response;
   }
-  async get(nameOrId) {
+  async get(nameOrId, params) {
     const response = await this.phonic.get(
-      `/tools/${nameOrId}`
+      `/tools/${nameOrId}?${this.getQueryString(params)}`
     );
     return response;
   }
@@ -469,14 +478,14 @@ var Tools = class {
       body.tool_call_output_timeout_ms = params.toolCallOutputTimeoutMs;
     }
     const response = await this.phonic.post(
-      "/tools",
+      `/tools?${this.getQueryString(params)}`,
       body
     );
     return response;
   }
   async update(nameOrId, params) {
     const response = await this.phonic.patch(
-      `/tools/${nameOrId}`,
+      `/tools/${nameOrId}?${this.getQueryString(params)}`,
       {
         name: params.name,
         description: params.description,
@@ -492,9 +501,9 @@ var Tools = class {
     );
     return response;
   }
-  async delete(nameOrId) {
+  async delete(nameOrId, params) {
     const response = await this.phonic.delete(
-      `/tools/${nameOrId}`
+      `/tools/${nameOrId}?${this.getQueryString(params)}`
     );
     return response;
   }

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // package.json
-var version = "0.28.0";
+var version = "0.29.0";
 
 // src/agents/index.ts
 var Agents = class {
@@ -389,6 +389,13 @@ var Tools = class {
   constructor(phonic) {
     this.phonic = phonic;
   }
+  getQueryString(params) {
+    const project = params?.project;
+    const queryString = new URLSearchParams({
+      ...project !== void 0 && { project }
+    }).toString();
+    return queryString;
+  }
   getParametersForBody(parameters) {
     if (parameters === void 0) {
       return void 0;
@@ -405,13 +412,15 @@ var Tools = class {
       };
     });
   }
-  async list() {
-    const response = await this.phonic.get("/tools");
+  async list(params) {
+    const response = await this.phonic.get(
+      `/tools?${this.getQueryString(params)}`
+    );
     return response;
   }
-  async get(nameOrId) {
+  async get(nameOrId, params) {
     const response = await this.phonic.get(
-      `/tools/${nameOrId}`
+      `/tools/${nameOrId}?${this.getQueryString(params)}`
     );
     return response;
   }
@@ -433,14 +442,14 @@ var Tools = class {
       body.tool_call_output_timeout_ms = params.toolCallOutputTimeoutMs;
     }
     const response = await this.phonic.post(
-      "/tools",
+      `/tools?${this.getQueryString(params)}`,
       body
     );
     return response;
   }
   async update(nameOrId, params) {
     const response = await this.phonic.patch(
-      `/tools/${nameOrId}`,
+      `/tools/${nameOrId}?${this.getQueryString(params)}`,
       {
         name: params.name,
         description: params.description,
@@ -456,9 +465,9 @@ var Tools = class {
     );
     return response;
   }
-  async delete(nameOrId) {
+  async delete(nameOrId, params) {
     const response = await this.phonic.delete(
-      `/tools/${nameOrId}`
+      `/tools/${nameOrId}?${this.getQueryString(params)}`
     );
     return response;
   }

package/package.json

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