phonic 0.25.4 → 0.26.0

package/README.md

@@ -9,6 +9,7 @@ Node.js library for the Phonic API.
   - [Get agent](#get-agent)
   - [Create agent](#create-agent)
   - [Update agent](#update-agent)
+  - [Upsert agent](#upsert-agent)
   - [Delete agent](#delete-agent)
 - [Tools](#tools)
   - [List tools](#list-tools)
@@ -133,6 +134,43 @@ const updateAgentResult = await phonic.agents.update("chris", {
 });
 ```
 
+### Upsert agent
+
+```ts
+const upsertAgentResult = await phonic.agents.upsert({
+  name: "chris",
+  
+  // Optional fields
+  project: "main",
+  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?",
+  systemPrompt: "You are an expert in {{subject}}. Be kind to {{user_name}}.",
+  templateVariables: {
+    subject: {
+      defaultValue: "Maths"
+    },
+    user_name: {
+      defaultValue: null
+    }
+  },
+  tools: ["keypad_input", "natural_conversation_ending", "my-custom-tool"],
+  noInputPokeSec: 30,
+  noInputPokeText: "Hey, are you with me?",
+  noInputEndConversationSec: 150,
+  boostedKeywords: ["Salamanca Market", "Bonorong Wildlife Sanctuary"],
+  configurationEndpoint: {
+    url: "https://myapp.com/webhooks/phonic-config",
+    headers: {
+      Authorization: "Bearer 123"
+    },
+    timeoutMs: 7000
+  }
+});
+```
+
 ### Delete agent
 
 ```ts

package/dist/index.d.mts

@@ -16,6 +16,10 @@ type FetchOptions = {
     method: "PATCH";
     headers?: Record<string, string>;
     body: string;
+} | {
+    method: "PUT";
+    headers?: Record<string, string>;
+    body: string;
 } | {
     method: "DELETE";
     headers?: Record<string, string>;
@@ -239,6 +243,26 @@ type UpdateAgentParams = UpdateAgentWithPhoneNumberParams | UpdateAgentWithoutPh
 type UpdateAgentSuccessResponse = {
     success: true;
 };
+interface UpsertAgentBaseParams extends AgentOptionalParams {
+    name: string;
+}
+interface UpsertAgentWithPhoneNumberParams extends UpsertAgentBaseParams, AgentPhoneNumberParams {
+}
+interface UpsertAgentWithoutPhoneNumberParams extends UpsertAgentBaseParams, AgentNoPhoneNumberParams {
+}
+type UpsertAgentParams = UpsertAgentWithPhoneNumberParams | UpsertAgentWithoutPhoneNumberParams;
+interface UpsertAgentSuccessResponseBase {
+    agent: Agent;
+}
+interface UpsertAgentInsertedSuccessResponse extends UpsertAgentSuccessResponseBase {
+    inserted: true;
+    updated: false;
+}
+interface UpsertAgentUpdatedSuccessResponse extends UpsertAgentSuccessResponseBase {
+    inserted: false;
+    updated: true;
+}
+type UpsertAgentSuccessResponse = UpsertAgentInsertedSuccessResponse | UpsertAgentUpdatedSuccessResponse;
 type DeleteAgentParams = {
     project?: string;
 };
@@ -256,6 +280,7 @@ declare class Agents {
     get(name: string, params?: GetAgentParams): DataOrError<GetAgentSuccessResponse>;
     create(params: CreateAgentParams): DataOrError<CreateAgentSuccessResponse>;
     update(name: string, params: UpdateAgentParams): DataOrError<UpdateAgentSuccessResponse>;
+    upsert(params: UpsertAgentParams): DataOrError<UpsertAgentSuccessResponse>;
     delete(name: string, params?: DeleteAgentParams): DataOrError<DeleteAgentSuccessResponse>;
 }
 
@@ -501,6 +526,17 @@ declare class Phonic {
         data: T;
         error: null;
     }>;
+    put<T>(path: string, body: Record<string, unknown>, headers?: Record<string, string>): Promise<{
+        data: null;
+        error: {
+            message: string;
+            code?: string;
+            param_errors?: Record<string, string>;
+        };
+    } | {
+        data: T;
+        error: null;
+    }>;
     delete<T>(path: string, headers?: Record<string, string>): Promise<{
         data: null;
         error: {

package/dist/index.d.ts

@@ -16,6 +16,10 @@ type FetchOptions = {
     method: "PATCH";
     headers?: Record<string, string>;
     body: string;
+} | {
+    method: "PUT";
+    headers?: Record<string, string>;
+    body: string;
 } | {
     method: "DELETE";
     headers?: Record<string, string>;
@@ -239,6 +243,26 @@ type UpdateAgentParams = UpdateAgentWithPhoneNumberParams | UpdateAgentWithoutPh
 type UpdateAgentSuccessResponse = {
     success: true;
 };
+interface UpsertAgentBaseParams extends AgentOptionalParams {
+    name: string;
+}
+interface UpsertAgentWithPhoneNumberParams extends UpsertAgentBaseParams, AgentPhoneNumberParams {
+}
+interface UpsertAgentWithoutPhoneNumberParams extends UpsertAgentBaseParams, AgentNoPhoneNumberParams {
+}
+type UpsertAgentParams = UpsertAgentWithPhoneNumberParams | UpsertAgentWithoutPhoneNumberParams;
+interface UpsertAgentSuccessResponseBase {
+    agent: Agent;
+}
+interface UpsertAgentInsertedSuccessResponse extends UpsertAgentSuccessResponseBase {
+    inserted: true;
+    updated: false;
+}
+interface UpsertAgentUpdatedSuccessResponse extends UpsertAgentSuccessResponseBase {
+    inserted: false;
+    updated: true;
+}
+type UpsertAgentSuccessResponse = UpsertAgentInsertedSuccessResponse | UpsertAgentUpdatedSuccessResponse;
 type DeleteAgentParams = {
     project?: string;
 };
@@ -256,6 +280,7 @@ declare class Agents {
     get(name: string, params?: GetAgentParams): DataOrError<GetAgentSuccessResponse>;
     create(params: CreateAgentParams): DataOrError<CreateAgentSuccessResponse>;
     update(name: string, params: UpdateAgentParams): DataOrError<UpdateAgentSuccessResponse>;
+    upsert(params: UpsertAgentParams): DataOrError<UpsertAgentSuccessResponse>;
     delete(name: string, params?: DeleteAgentParams): DataOrError<DeleteAgentSuccessResponse>;
 }
 
@@ -501,6 +526,17 @@ declare class Phonic {
         data: T;
         error: null;
     }>;
+    put<T>(path: string, body: Record<string, unknown>, headers?: Record<string, string>): Promise<{
+        data: null;
+        error: {
+            message: string;
+            code?: string;
+            param_errors?: Record<string, string>;
+        };
+    } | {
+        data: T;
+        error: null;
+    }>;
     delete<T>(path: string, headers?: Record<string, string>): Promise<{
         data: null;
         error: {

package/dist/index.js

@@ -35,7 +35,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // package.json
-var version = "0.25.4";
+var version = "0.26.0";
 
 // src/agents/index.ts
 var Agents = class {
@@ -136,6 +136,32 @@ var Agents = class {
     );
     return response;
   }
+  async upsert(params) {
+    const response = await this.phonic.put(
+      `/agents/upsert?${this.getQueryString(params)}`,
+      {
+        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,
+        system_prompt: params.systemPrompt,
+        template_variables: this.getTemplateVariablesForBody(
+          params.templateVariables
+        ),
+        tools: params.tools,
+        no_input_poke_sec: params.noInputPokeSec,
+        no_input_poke_text: params.noInputPokeText,
+        no_input_end_conversation_sec: params.noInputEndConversationSec,
+        boosted_keywords: params.boostedKeywords,
+        configuration_endpoint: this.getConfigurationEndpointForBody(
+          params.configurationEndpoint
+        )
+      }
+    );
+    return response;
+  }
   async delete(name, params) {
     const response = await this.phonic.delete(
       `/agents/${name}?${this.getQueryString(params)}`
@@ -525,6 +551,13 @@ var Phonic = class {
       headers
     });
   }
+  async put(path, body, headers) {
+    return this.fetchRequest(path, {
+      method: "PUT",
+      body: JSON.stringify(body),
+      headers
+    });
+  }
   async delete(path, headers) {
     return this.fetchRequest(path, {
       method: "DELETE",

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // package.json
-var version = "0.25.4";
+var version = "0.26.0";
 
 // src/agents/index.ts
 var Agents = class {
@@ -100,6 +100,32 @@ var Agents = class {
     );
     return response;
   }
+  async upsert(params) {
+    const response = await this.phonic.put(
+      `/agents/upsert?${this.getQueryString(params)}`,
+      {
+        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,
+        system_prompt: params.systemPrompt,
+        template_variables: this.getTemplateVariablesForBody(
+          params.templateVariables
+        ),
+        tools: params.tools,
+        no_input_poke_sec: params.noInputPokeSec,
+        no_input_poke_text: params.noInputPokeText,
+        no_input_end_conversation_sec: params.noInputEndConversationSec,
+        boosted_keywords: params.boostedKeywords,
+        configuration_endpoint: this.getConfigurationEndpointForBody(
+          params.configurationEndpoint
+        )
+      }
+    );
+    return response;
+  }
   async delete(name, params) {
     const response = await this.phonic.delete(
       `/agents/${name}?${this.getQueryString(params)}`
@@ -489,6 +515,13 @@ var Phonic = class {
       headers
     });
   }
+  async put(path, body, headers) {
+    return this.fetchRequest(path, {
+      method: "PUT",
+      body: JSON.stringify(body),
+      headers
+    });
+  }
   async delete(path, headers) {
     return this.fetchRequest(path, {
       method: "DELETE",

package/package.json

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