phonic 0.23.0 → 0.24.0

package/README.md

@@ -23,8 +23,8 @@ Node.js library for the Phonic API.
   - [List conversations](#list-conversations)
   - [Get conversation by id](#get-conversation-by-id)
   - [Get conversation by external id](#get-conversation-by-external-id)
-- [STS outbound call](#sts-outbound-call)
-- [STS outbound call using own Twilio account](#sts-outbound-call-using-own-twilio-account)
+  - [Outbound call](#outbound-call)
+  - [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)
 - [License](#license)
@@ -280,10 +280,10 @@ const conversationResult = await phonic.conversations.getByExternalId({
 });
 ```
 
-## STS outbound call
+### Outbound call
 
 ```ts
-const { data, error } = await phonic.sts.outboundCall("+19189396241", {
+const outboundCallResult = await phonic.conversations.outboundCall("+19189396241", {
   // Optional fields
   welcome_message: "Hello, how can I help you?",
   project: "main",
@@ -294,16 +294,16 @@ const { data, error } = await phonic.sts.outboundCall("+19189396241", {
   vad_min_speech_duration_ms: 40,
   vad_min_silence_duration_ms: 550,
   vad_threshold: 0.6,
-  tools: ["send_dtmf_tone", "end_conversation"], // these are the only available tools so far
+  tools: ["keypad_input", "natural_conversation_ending"]
 });
 ```
 
-## STS outbound call using own Twilio account
+### Outbound call using own Twilio account
 
 In Twilio, create a restricted API key with the following permissions: `voice -> calls -> read` and `voice -> calls -> create`.
 
 ```ts
-const { data, error } = await phonic.sts.twilio.outboundCall(
+const twilioOutboundCallResult = await phonic.conversations.twilio.outboundCall(
   {
     account_sid: "AC...",
     api_key_sid: "SK...",
@@ -322,7 +322,7 @@ const { data, error } = await phonic.sts.twilio.outboundCall(
     vad_min_speech_duration_ms: 40,
     vad_min_silence_duration_ms: 550,
     vad_threshold: 0.6,
-    tools: ["send_dtmf_tone", "end_conversation"], // these are the only available tools so far
+    tools: ["keypad_input", "natural_conversation_ending"]
   }
 );
 ```
@@ -346,7 +346,7 @@ const phonicWebSocket = phonic.sts.websocket({
   vad_min_speech_duration_ms: 40,
   vad_min_silence_duration_ms: 550,
   vad_threshold: 0.6,
-  tools: ["send_dtmf_tone", "end_conversation"], // these are the only available tools so far
+  tools: ["keypad_input", "natural_conversation_ending"]
 });
 ```
 

package/dist/index.d.mts

@@ -90,10 +90,6 @@ type PhonicSTSWebSocketResponseMessage = {
 type OnMessageCallback = (message: PhonicSTSWebSocketResponseMessage) => void;
 type OnCloseCallback = (event: WebSocket.CloseEvent) => void;
 type OnErrorCallback = (event: WebSocket.ErrorEvent) => void;
-type PhonicSTSOutboundCallConfig = Omit<PhonicSTSConfig, "input_format" | "output_format">;
-type OutboundCallSuccessResponse = {
-    success: true;
-};
 type PhonicTool = "send_dtmf_tone" | "end_conversation";
 type PhonicConfigurationEndpointRequestPayload = {
     project: {
@@ -263,41 +259,46 @@ type ConversationSuccessResponse = {
 type ConversationsSuccessResponse = {
     conversations: Array<Conversation>;
 };
+type OutboundCallConfig = Omit<PhonicSTSConfigWithAgent, "input_format" | "output_format"> | Omit<PhonicSTSConfigWithProject, "input_format" | "output_format">;
+type OutboundCallSuccessResponse = {
+    conversation_id: string;
+};
 
-declare class Conversations {
-    private readonly phonic;
-    constructor(phonic: Phonic);
-    get(id: string): DataOrError<ConversationSuccessResponse>;
-    getByExternalId({ project, externalId, }: {
-        project?: string;
-        externalId: string;
-    }): DataOrError<ConversationSuccessResponse>;
-    list({ project, durationMin, durationMax, startedAtMin, startedAtMax, }: {
-        project?: string;
-        durationMin?: number;
-        durationMax?: number;
-        startedAtMin?: ISODate | ISODateTime$1;
-        startedAtMax?: ISODate | ISODateTime$1;
-    }): DataOrError<ConversationsSuccessResponse>;
-}
-
-type PhonicSTSTwilioOutboundCallParams = {
+type TwilioOutboundCallParams = {
     account_sid: string;
     api_key_sid: string;
     api_key_secret: string;
     from_phone_number: string;
     to_phone_number: string;
 };
-type PhonicSTSTwilioOutboundCallConfig = PhonicSTSOutboundCallConfig;
+type TwilioOutboundCallConfig = OutboundCallConfig;
 type TwilioOutboundCallSuccessResponse = {
-    success: true;
     callSid: string;
 };
 
 declare class Twilio {
     private readonly phonic;
     constructor(phonic: Phonic);
-    outboundCall(params: PhonicSTSTwilioOutboundCallParams, config: PhonicSTSTwilioOutboundCallConfig): DataOrError<TwilioOutboundCallSuccessResponse>;
+    outboundCall(params: TwilioOutboundCallParams, config: TwilioOutboundCallConfig): DataOrError<TwilioOutboundCallSuccessResponse>;
+}
+
+declare class Conversations {
+    private readonly phonic;
+    readonly twilio: Twilio;
+    constructor(phonic: Phonic);
+    list({ project, durationMin, durationMax, startedAtMin, startedAtMax, }: {
+        project?: string;
+        durationMin?: number;
+        durationMax?: number;
+        startedAtMin?: ISODate | ISODateTime$1;
+        startedAtMax?: ISODate | ISODateTime$1;
+    }): DataOrError<ConversationsSuccessResponse>;
+    get(id: string): DataOrError<ConversationSuccessResponse>;
+    getByExternalId({ project, externalId, }: {
+        project?: string;
+        externalId: string;
+    }): DataOrError<ConversationSuccessResponse>;
+    outboundCall(toPhoneNumber: string, config: OutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
 }
 
 declare class PhonicSTSWebSocket {
@@ -326,10 +327,8 @@ declare class PhonicSTSWebSocket {
 
 declare class SpeechToSpeech {
     private readonly phonic;
-    readonly twilio: Twilio;
     constructor(phonic: Phonic);
     websocket(config: PhonicSTSConfig): PhonicSTSWebSocket;
-    outboundCall(toPhoneNumber: string, config: PhonicSTSOutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
 }
 
 interface ParameterBase {

package/dist/index.d.ts

@@ -90,10 +90,6 @@ type PhonicSTSWebSocketResponseMessage = {
 type OnMessageCallback = (message: PhonicSTSWebSocketResponseMessage) => void;
 type OnCloseCallback = (event: WebSocket.CloseEvent) => void;
 type OnErrorCallback = (event: WebSocket.ErrorEvent) => void;
-type PhonicSTSOutboundCallConfig = Omit<PhonicSTSConfig, "input_format" | "output_format">;
-type OutboundCallSuccessResponse = {
-    success: true;
-};
 type PhonicTool = "send_dtmf_tone" | "end_conversation";
 type PhonicConfigurationEndpointRequestPayload = {
     project: {
@@ -263,41 +259,46 @@ type ConversationSuccessResponse = {
 type ConversationsSuccessResponse = {
     conversations: Array<Conversation>;
 };
+type OutboundCallConfig = Omit<PhonicSTSConfigWithAgent, "input_format" | "output_format"> | Omit<PhonicSTSConfigWithProject, "input_format" | "output_format">;
+type OutboundCallSuccessResponse = {
+    conversation_id: string;
+};
 
-declare class Conversations {
-    private readonly phonic;
-    constructor(phonic: Phonic);
-    get(id: string): DataOrError<ConversationSuccessResponse>;
-    getByExternalId({ project, externalId, }: {
-        project?: string;
-        externalId: string;
-    }): DataOrError<ConversationSuccessResponse>;
-    list({ project, durationMin, durationMax, startedAtMin, startedAtMax, }: {
-        project?: string;
-        durationMin?: number;
-        durationMax?: number;
-        startedAtMin?: ISODate | ISODateTime$1;
-        startedAtMax?: ISODate | ISODateTime$1;
-    }): DataOrError<ConversationsSuccessResponse>;
-}
-
-type PhonicSTSTwilioOutboundCallParams = {
+type TwilioOutboundCallParams = {
     account_sid: string;
     api_key_sid: string;
     api_key_secret: string;
     from_phone_number: string;
     to_phone_number: string;
 };
-type PhonicSTSTwilioOutboundCallConfig = PhonicSTSOutboundCallConfig;
+type TwilioOutboundCallConfig = OutboundCallConfig;
 type TwilioOutboundCallSuccessResponse = {
-    success: true;
     callSid: string;
 };
 
 declare class Twilio {
     private readonly phonic;
     constructor(phonic: Phonic);
-    outboundCall(params: PhonicSTSTwilioOutboundCallParams, config: PhonicSTSTwilioOutboundCallConfig): DataOrError<TwilioOutboundCallSuccessResponse>;
+    outboundCall(params: TwilioOutboundCallParams, config: TwilioOutboundCallConfig): DataOrError<TwilioOutboundCallSuccessResponse>;
+}
+
+declare class Conversations {
+    private readonly phonic;
+    readonly twilio: Twilio;
+    constructor(phonic: Phonic);
+    list({ project, durationMin, durationMax, startedAtMin, startedAtMax, }: {
+        project?: string;
+        durationMin?: number;
+        durationMax?: number;
+        startedAtMin?: ISODate | ISODateTime$1;
+        startedAtMax?: ISODate | ISODateTime$1;
+    }): DataOrError<ConversationsSuccessResponse>;
+    get(id: string): DataOrError<ConversationSuccessResponse>;
+    getByExternalId({ project, externalId, }: {
+        project?: string;
+        externalId: string;
+    }): DataOrError<ConversationSuccessResponse>;
+    outboundCall(toPhoneNumber: string, config: OutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
 }
 
 declare class PhonicSTSWebSocket {
@@ -326,10 +327,8 @@ declare class PhonicSTSWebSocket {
 
 declare class SpeechToSpeech {
     private readonly phonic;
-    readonly twilio: Twilio;
     constructor(phonic: Phonic);
     websocket(config: PhonicSTSConfig): PhonicSTSWebSocket;
-    outboundCall(toPhoneNumber: string, config: PhonicSTSOutboundCallConfig): DataOrError<OutboundCallSuccessResponse>;
 }
 
 interface ParameterBase {

package/dist/index.js

@@ -35,7 +35,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // package.json
-var version = "0.23.0";
+var version = "0.24.0";
 
 // src/agents/index.ts
 var Agents = class {
@@ -144,30 +144,36 @@ var Agents = class {
   }
 };
 
-// src/conversations/index.ts
-var Conversations = class {
+// src/conversations/twilio/index.ts
+var Twilio = class {
   constructor(phonic) {
     this.phonic = phonic;
   }
-  async get(id) {
-    const response = await this.phonic.get(
-      `/conversations/${id}`
+  async outboundCall(params, config) {
+    const response = await this.phonic.post(
+      "/conversations/twilio/outbound_call",
+      {
+        from_phone_number: params.from_phone_number,
+        to_phone_number: params.to_phone_number,
+        config
+      },
+      {
+        "X-Twilio-Account-Sid": params.account_sid,
+        "X-Twilio-Api-Key-Sid": params.api_key_sid,
+        "X-Twilio-Api-Key-Secret": params.api_key_secret
+      }
     );
     return response;
   }
-  async getByExternalId({
-    project,
-    externalId
-  }) {
-    const queryString = new URLSearchParams({
-      ...project !== void 0 && { project },
-      external_id: externalId
-    }).toString();
-    const response = await this.phonic.get(
-      `/conversations?${queryString}`
-    );
-    return response;
+};
+
+// src/conversations/index.ts
+var Conversations = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+    this.twilio = new Twilio(phonic);
   }
+  twilio;
   async list({
     project,
     durationMin,
@@ -187,34 +193,40 @@ var Conversations = class {
     );
     return response;
   }
-};
-
-// src/sts/index.ts
-var import_ws = __toESM(require("ws"));
-
-// src/sts/twilio/index.ts
-var Twilio = class {
-  constructor(phonic) {
-    this.phonic = phonic;
+  async get(id) {
+    const response = await this.phonic.get(
+      `/conversations/${id}`
+    );
+    return response;
   }
-  async outboundCall(params, config) {
+  async getByExternalId({
+    project,
+    externalId
+  }) {
+    const queryString = new URLSearchParams({
+      ...project !== void 0 && { project },
+      external_id: externalId
+    }).toString();
+    const response = await this.phonic.get(
+      `/conversations?${queryString}`
+    );
+    return response;
+  }
+  async outboundCall(toPhoneNumber, config) {
     const response = await this.phonic.post(
-      "/sts/twilio/outbound_call",
+      "/conversations/outbound_call",
       {
-        from_phone_number: params.from_phone_number,
-        to_phone_number: params.to_phone_number,
+        to_phone_number: toPhoneNumber,
         config
-      },
-      {
-        "X-Twilio-Account-Sid": params.account_sid,
-        "X-Twilio-Api-Key-Sid": params.api_key_sid,
-        "X-Twilio-Api-Key-Secret": params.api_key_secret
       }
     );
     return response;
   }
 };
 
+// src/sts/index.ts
+var import_ws = __toESM(require("ws"));
+
 // src/sts/websocket.ts
 var PhonicSTSWebSocket = class {
   constructor(ws, config) {
@@ -318,9 +330,7 @@ var PhonicSTSWebSocket = class {
 var SpeechToSpeech = class {
   constructor(phonic) {
     this.phonic = phonic;
-    this.twilio = new Twilio(phonic);
   }
-  twilio;
   websocket(config) {
     const wsBaseUrl = this.phonic.baseUrl.replace(/^http/, "ws");
     const queryString = new URLSearchParams({
@@ -334,16 +344,6 @@ var SpeechToSpeech = class {
     });
     return new PhonicSTSWebSocket(ws, config);
   }
-  async outboundCall(toPhoneNumber, config) {
-    const response = await this.phonic.post(
-      "/sts/outbound_call",
-      {
-        to_phone_number: toPhoneNumber,
-        config
-      }
-    );
-    return response;
-  }
 };
 
 // src/tools/index.ts

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // package.json
-var version = "0.23.0";
+var version = "0.24.0";
 
 // src/agents/index.ts
 var Agents = class {
@@ -108,30 +108,36 @@ var Agents = class {
   }
 };
 
-// src/conversations/index.ts
-var Conversations = class {
+// src/conversations/twilio/index.ts
+var Twilio = class {
   constructor(phonic) {
     this.phonic = phonic;
   }
-  async get(id) {
-    const response = await this.phonic.get(
-      `/conversations/${id}`
+  async outboundCall(params, config) {
+    const response = await this.phonic.post(
+      "/conversations/twilio/outbound_call",
+      {
+        from_phone_number: params.from_phone_number,
+        to_phone_number: params.to_phone_number,
+        config
+      },
+      {
+        "X-Twilio-Account-Sid": params.account_sid,
+        "X-Twilio-Api-Key-Sid": params.api_key_sid,
+        "X-Twilio-Api-Key-Secret": params.api_key_secret
+      }
     );
     return response;
   }
-  async getByExternalId({
-    project,
-    externalId
-  }) {
-    const queryString = new URLSearchParams({
-      ...project !== void 0 && { project },
-      external_id: externalId
-    }).toString();
-    const response = await this.phonic.get(
-      `/conversations?${queryString}`
-    );
-    return response;
+};
+
+// src/conversations/index.ts
+var Conversations = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+    this.twilio = new Twilio(phonic);
   }
+  twilio;
   async list({
     project,
     durationMin,
@@ -151,34 +157,40 @@ var Conversations = class {
     );
     return response;
   }
-};
-
-// src/sts/index.ts
-import WebSocket from "ws";
-
-// src/sts/twilio/index.ts
-var Twilio = class {
-  constructor(phonic) {
-    this.phonic = phonic;
+  async get(id) {
+    const response = await this.phonic.get(
+      `/conversations/${id}`
+    );
+    return response;
   }
-  async outboundCall(params, config) {
+  async getByExternalId({
+    project,
+    externalId
+  }) {
+    const queryString = new URLSearchParams({
+      ...project !== void 0 && { project },
+      external_id: externalId
+    }).toString();
+    const response = await this.phonic.get(
+      `/conversations?${queryString}`
+    );
+    return response;
+  }
+  async outboundCall(toPhoneNumber, config) {
     const response = await this.phonic.post(
-      "/sts/twilio/outbound_call",
+      "/conversations/outbound_call",
       {
-        from_phone_number: params.from_phone_number,
-        to_phone_number: params.to_phone_number,
+        to_phone_number: toPhoneNumber,
         config
-      },
-      {
-        "X-Twilio-Account-Sid": params.account_sid,
-        "X-Twilio-Api-Key-Sid": params.api_key_sid,
-        "X-Twilio-Api-Key-Secret": params.api_key_secret
       }
     );
     return response;
   }
 };
 
+// src/sts/index.ts
+import WebSocket from "ws";
+
 // src/sts/websocket.ts
 var PhonicSTSWebSocket = class {
   constructor(ws, config) {
@@ -282,9 +294,7 @@ var PhonicSTSWebSocket = class {
 var SpeechToSpeech = class {
   constructor(phonic) {
     this.phonic = phonic;
-    this.twilio = new Twilio(phonic);
   }
-  twilio;
   websocket(config) {
     const wsBaseUrl = this.phonic.baseUrl.replace(/^http/, "ws");
     const queryString = new URLSearchParams({
@@ -298,16 +308,6 @@ var SpeechToSpeech = class {
     });
     return new PhonicSTSWebSocket(ws, config);
   }
-  async outboundCall(toPhoneNumber, config) {
-    const response = await this.phonic.post(
-      "/sts/outbound_call",
-      {
-        to_phone_number: toPhoneNumber,
-        config
-      }
-    );
-    return response;
-  }
 };
 
 // src/tools/index.ts

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "phonic",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Phonic Node.js SDK",
   "scripts": {
     "build": "tsup",
     "check": "biome check --write",
+    "ct": "bun check && bun tsc",
     "ci": "bun tsc && biome ci && bun test",
     "version": "changeset version && bun check",
     "release": "bun run build && changeset publish"