retell-sdk 2.2.1 → 2.2.3

package/src/models/operations/createphonecall.ts

@@ -12,7 +12,7 @@ export type PhoneNumber = {
     /**
      * Phone number you purchased in E.164 format. It would have an agent id associated with it.
      */
-    from?: any | undefined;
+    from: string;
     /**
      * Callee phone number in E.164 format.
      */
@@ -21,9 +21,12 @@ export type PhoneNumber = {
 
 export type CreatePhoneCallRequestBody = {
     /**
-     * Supply values to your agent prompt parameters. If the given key value cannot match any param in prompt, it would have have any effect. Learn more about [Agent Prompt Parameters](/features/agent-prompt-parameter).
+     * Supply values to your agent prompt parameters. If the given key value cannot match any param in prompt, it would have have any effect.
      */
     agentPromptParams?: Array<components.AgentPromptParams> | undefined;
+    /**
+     * Phone number associated with the call.
+     */
     phoneNumber: PhoneNumber;
 };
 
@@ -69,6 +72,9 @@ export type CreatePhoneCallResponseBody = {
      * Web call or phone call.
      */
     callType: CreatePhoneCallCallType;
+    /**
+     * Phone number associated with the call.
+     */
     phoneNumber: components.CallPhoneNumber;
     /**
      * Begin timestamp (milliseconds since epoch) of the call.
@@ -98,35 +104,35 @@ export type CreatePhoneCallResponse = {
 /** @internal */
 export namespace PhoneNumber$ {
     export type Inbound = {
-        from?: any | undefined;
+        from: string;
         to: string;
     };
 
     export const inboundSchema: z.ZodType<PhoneNumber, z.ZodTypeDef, Inbound> = z
         .object({
-            from: z.any().optional(),
+            from: z.string(),
             to: z.string(),
         })
         .transform((v) => {
             return {
-                ...(v.from === undefined ? null : { from: v.from }),
+                from: v.from,
                 to: v.to,
             };
         });
 
     export type Outbound = {
-        from?: any | undefined;
+        from: string;
         to: string;
     };
 
     export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, PhoneNumber> = z
         .object({
-            from: z.any().optional(),
+            from: z.string(),
             to: z.string(),
         })
         .transform((v) => {
             return {
-                ...(v.from === undefined ? null : { from: v.from }),
+                from: v.from,
                 to: v.to,
             };
         });
@@ -256,7 +262,7 @@ export namespace CreatePhoneCallResponse$ {
         ContentType: string;
         StatusCode: number;
         RawResponse: Response;
-        object?: CreatePhoneCallResponseBody$.Inbound | undefined;
+        callDetail?: CreatePhoneCallResponseBody$.Inbound | undefined;
     };
 
     export const inboundSchema: z.ZodType<CreatePhoneCallResponse, z.ZodTypeDef, Inbound> = z
@@ -264,14 +270,14 @@ export namespace CreatePhoneCallResponse$ {
             ContentType: z.string(),
             StatusCode: z.number().int(),
             RawResponse: z.instanceof(Response),
-            object: z.lazy(() => CreatePhoneCallResponseBody$.inboundSchema).optional(),
+            callDetail: z.lazy(() => CreatePhoneCallResponseBody$.inboundSchema).optional(),
         })
         .transform((v) => {
             return {
                 contentType: v.ContentType,
                 statusCode: v.StatusCode,
                 rawResponse: v.RawResponse,
-                ...(v.object === undefined ? null : { object: v.object }),
+                ...(v.callDetail === undefined ? null : { callDetail: v.callDetail }),
             };
         });
 
@@ -279,7 +285,7 @@ export namespace CreatePhoneCallResponse$ {
         ContentType: string;
         StatusCode: number;
         RawResponse: never;
-        object?: CreatePhoneCallResponseBody$.Outbound | undefined;
+        callDetail?: CreatePhoneCallResponseBody$.Outbound | undefined;
     };
 
     export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreatePhoneCallResponse> = z
@@ -289,14 +295,14 @@ export namespace CreatePhoneCallResponse$ {
             rawResponse: z.instanceof(Response).transform(() => {
                 throw new Error("Response cannot be serialized");
             }),
-            object: z.lazy(() => CreatePhoneCallResponseBody$.outboundSchema).optional(),
+            callDetail: z.lazy(() => CreatePhoneCallResponseBody$.outboundSchema).optional(),
         })
         .transform((v) => {
             return {
                 ContentType: v.contentType,
                 StatusCode: v.statusCode,
                 RawResponse: v.rawResponse,
-                ...(v.object === undefined ? null : { object: v.object }),
+                ...(v.callDetail === undefined ? null : { callDetail: v.callDetail }),
             };
         });
 }

package/src/models/operations/createphonenumber.ts

@@ -7,7 +7,7 @@ import { z } from "zod";
 
 export type CreatePhoneNumberRequestBody = {
     /**
-     * Unique agent id to associate with this phone number. Can be updated with [Update Phone Agent](/api/update-phone-agent).
+     * Unique agent id to associate with this phone number. Can be updated.
      */
     agentId: string;
     /**

package/src/models/operations/createwebcall.ts

@@ -0,0 +1,16 @@
+import * as components from "../../models/components";
+
+export type CreateWebCallRequestBody = {
+    /**
+     * Unique agent id to associate with this phone number. Can be updated.
+     */
+    agentId: string;
+    /**
+     * Supply values to your agent prompt parameters. If the given key value cannot match any param in prompt, it would have have any effect.
+     */
+    agentPromptParams?: Array<components.AgentPromptParams> | undefined;
+    /**
+     * Sample rate for the call.
+     */
+    sampleRate?: number | undefined;
+};

package/src/models/operations/index.ts

@@ -4,6 +4,7 @@
 
 export * from "./createagent";
 export * from "./createphonecall";
+export * from "./createwebcall";
 export * from "./createphonenumber";
 export * from "./deleteagent";
 export * from "./deletephonenumber";

package/src/models/operations/listagents.ts

@@ -21,7 +21,7 @@ export type ListAgentsResponse = {
     /**
      * Successfully retrieved all agents.
      */
-    classes?: Array<components.Agent> | undefined;
+    agents?: Array<components.Agent> | undefined;
 };
 
 /** @internal */
@@ -30,7 +30,7 @@ export namespace ListAgentsResponse$ {
         ContentType: string;
         StatusCode: number;
         RawResponse: Response;
-        classes?: Array<components.Agent$.Inbound> | undefined;
+        agents?: Array<components.Agent$.Inbound> | undefined;
     };
 
     export const inboundSchema: z.ZodType<ListAgentsResponse, z.ZodTypeDef, Inbound> = z
@@ -38,14 +38,14 @@ export namespace ListAgentsResponse$ {
             ContentType: z.string(),
             StatusCode: z.number().int(),
             RawResponse: z.instanceof(Response),
-            classes: z.array(components.Agent$.inboundSchema).optional(),
+            agents: z.array(components.Agent$.inboundSchema).optional(),
         })
         .transform((v) => {
             return {
                 contentType: v.ContentType,
                 statusCode: v.StatusCode,
                 rawResponse: v.RawResponse,
-                ...(v.classes === undefined ? null : { classes: v.classes }),
+                ...(v.agents === undefined ? null : { agents: v.agents }),
             };
         });
 
@@ -53,7 +53,7 @@ export namespace ListAgentsResponse$ {
         ContentType: string;
         StatusCode: number;
         RawResponse: never;
-        classes?: Array<components.Agent$.Outbound> | undefined;
+        agents?: Array<components.Agent$.Outbound> | undefined;
     };
 
     export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ListAgentsResponse> = z
@@ -63,14 +63,14 @@ export namespace ListAgentsResponse$ {
             rawResponse: z.instanceof(Response).transform(() => {
                 throw new Error("Response cannot be serialized");
             }),
-            classes: z.array(components.Agent$.outboundSchema).optional(),
+            agents: z.array(components.Agent$.outboundSchema).optional(),
         })
         .transform((v) => {
             return {
                 ContentType: v.contentType,
                 StatusCode: v.statusCode,
                 RawResponse: v.rawResponse,
-                ...(v.classes === undefined ? null : { classes: v.classes }),
+                ...(v.agents === undefined ? null : { agents: v.agents }),
             };
         });
 }

package/src/models/operations/listcalls.ts

@@ -74,7 +74,7 @@ export type ListCallsResponse = {
     /**
      * Successfully retrieved all agents.
      */
-    classes?: Array<components.CallDetail> | undefined;
+    calls?: Array<components.CallDetail> | undefined;
 };
 
 /** @internal */
@@ -209,7 +209,7 @@ export namespace ListCallsResponse$ {
         ContentType: string;
         StatusCode: number;
         RawResponse: Response;
-        classes?: Array<components.CallDetail$.Inbound> | undefined;
+        calls?: Array<components.CallDetail$.Inbound> | undefined;
     };
 
     export const inboundSchema: z.ZodType<ListCallsResponse, z.ZodTypeDef, Inbound> = z
@@ -217,14 +217,14 @@ export namespace ListCallsResponse$ {
             ContentType: z.string(),
             StatusCode: z.number().int(),
             RawResponse: z.instanceof(Response),
-            classes: z.array(components.CallDetail$.inboundSchema).optional(),
+            calls: z.array(components.CallDetail$.inboundSchema).optional(),
         })
         .transform((v) => {
             return {
                 contentType: v.ContentType,
                 statusCode: v.StatusCode,
                 rawResponse: v.RawResponse,
-                ...(v.classes === undefined ? null : { classes: v.classes }),
+                ...(v.calls === undefined ? null : { calls: v.calls }),
             };
         });
 
@@ -232,7 +232,7 @@ export namespace ListCallsResponse$ {
         ContentType: string;
         StatusCode: number;
         RawResponse: never;
-        classes?: Array<components.CallDetail$.Outbound> | undefined;
+        calls?: Array<components.CallDetail$.Outbound> | undefined;
     };
 
     export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ListCallsResponse> = z
@@ -242,14 +242,14 @@ export namespace ListCallsResponse$ {
             rawResponse: z.instanceof(Response).transform(() => {
                 throw new Error("Response cannot be serialized");
             }),
-            classes: z.array(components.CallDetail$.outboundSchema).optional(),
+            calls: z.array(components.CallDetail$.outboundSchema).optional(),
         })
         .transform((v) => {
             return {
                 ContentType: v.contentType,
                 StatusCode: v.statusCode,
                 RawResponse: v.rawResponse,
-                ...(v.classes === undefined ? null : { classes: v.classes }),
+                ...(v.calls === undefined ? null : { calls: v.calls }),
             };
         });
 }

package/src/models/operations/listphonenumbers.ts

@@ -21,7 +21,7 @@ export type ListPhoneNumbersResponse = {
     /**
      * Successfully retrieved all phone number objects.
      */
-    classes?: Array<components.PhoneNumber> | undefined;
+    phoneNumbers?: Array<components.PhoneNumber> | undefined;
 };
 
 /** @internal */
@@ -30,7 +30,7 @@ export namespace ListPhoneNumbersResponse$ {
         ContentType: string;
         StatusCode: number;
         RawResponse: Response;
-        classes?: Array<components.PhoneNumber$.Inbound> | undefined;
+        phoneNumbers?: Array<components.PhoneNumber$.Inbound> | undefined;
     };
 
     export const inboundSchema: z.ZodType<ListPhoneNumbersResponse, z.ZodTypeDef, Inbound> = z
@@ -38,14 +38,14 @@ export namespace ListPhoneNumbersResponse$ {
             ContentType: z.string(),
             StatusCode: z.number().int(),
             RawResponse: z.instanceof(Response),
-            classes: z.array(components.PhoneNumber$.inboundSchema).optional(),
+            phoneNumbers: z.array(components.PhoneNumber$.inboundSchema).optional(),
         })
         .transform((v) => {
             return {
                 contentType: v.ContentType,
                 statusCode: v.StatusCode,
                 rawResponse: v.RawResponse,
-                ...(v.classes === undefined ? null : { classes: v.classes }),
+                ...(v.phoneNumbers === undefined ? null : { phoneNumbers: v.phoneNumbers }),
             };
         });
 
@@ -53,7 +53,7 @@ export namespace ListPhoneNumbersResponse$ {
         ContentType: string;
         StatusCode: number;
         RawResponse: never;
-        classes?: Array<components.PhoneNumber$.Outbound> | undefined;
+        phoneNumbers?: Array<components.PhoneNumber$.Outbound> | undefined;
     };
 
     export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ListPhoneNumbersResponse> = z
@@ -63,14 +63,14 @@ export namespace ListPhoneNumbersResponse$ {
             rawResponse: z.instanceof(Response).transform(() => {
                 throw new Error("Response cannot be serialized");
             }),
-            classes: z.array(components.PhoneNumber$.outboundSchema).optional(),
+            phoneNumbers: z.array(components.PhoneNumber$.outboundSchema).optional(),
         })
         .transform((v) => {
             return {
                 ContentType: v.contentType,
                 StatusCode: v.statusCode,
                 RawResponse: v.rawResponse,
-                ...(v.classes === undefined ? null : { classes: v.classes }),
+                ...(v.phoneNumbers === undefined ? null : { phoneNumbers: v.phoneNumbers }),
             };
         });
 }

package/src/models/operations/updateagent.ts

@@ -3,10 +3,90 @@
  */
 
 import * as components from "../../models/components";
+import { Function } from "../../models/components";
 import { z } from "zod";
 
+export type UpdateAgentRequestBody = {
+    /**
+     * The name of the agent. Only used for your own reference.
+     */
+    agentName?: string | undefined;
+    /*
+    * Determines how to generate the response in the call. Currently supports using our in-house LLM response system or your own custom  
+    * response generation system.
+    */
+    llmSetting?: components.RetellLlmSetting | components.CustomLlmSetting | undefined;
+    /**
+     * Setting combination that controls interaction flow, like begin and end logic.
+     */
+    interactionSetting?: components.InteractionSettingRequest | undefined;
+    /**
+     * Unique voice id used for the agent. Find list of available voices in documentation.
+     */
+    voiceId?: string | undefined;
+    /**
+     * Functions are the actions that the agent can perform, like booking appointments, retriving information, etc. By setting this field, either OpenAI's function calling feature or your own custom LLM's logic would determine when the function shall get called, and our server would make the call.
+     */
+    functions?: Function[] | undefined;
+};
+
+/** @internal */
+export namespace UpdateAgentRequestBody$ {
+    export type Inbound = {
+        agent_name?: string | undefined;
+        llm_setting?: components.RetellLlmSetting$.Inbound | components.CustomLlmSetting$.Inbound | undefined;
+        interaction_setting?: components.InteractionSettingRequest$.Inbound | undefined;
+        voice_id?: string | undefined;
+        functions?: Function[] | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<UpdateAgentRequestBody, z.ZodTypeDef, Inbound> = z
+        .object({
+            agent_name: z.string().optional(),
+            llm_setting: z.union([components.RetellLlmSetting$.inboundSchema, components.CustomLlmSetting$.inboundSchema]).optional(),
+            interaction_setting: components.InteractionSettingRequest$.inboundSchema.optional(),
+            voice_id: z.string().optional(),
+            functions: z.array(components.Function$.inboundSchema).optional(),
+        })
+        .transform((v) => {
+            return {
+                ...(v.agent_name === undefined ? null : { agentName: v.agent_name }),
+                ...(v.llm_setting === undefined ? null : { llmSetting: v.llm_setting }),
+                ...(v.interaction_setting === undefined ? null : { interactionSetting: v.interaction_setting }),
+                ...(v.voice_id === undefined ? null : { voiceId: v.voice_id }),
+                ...(v.functions === undefined ? null : { functions: v.functions }),
+            };
+        });
+
+    export type Outbound = {
+        agent_name?: string | undefined;
+        llm_setting?: components.RetellLlmSetting$.Outbound | components.CustomLlmSetting$.Outbound | undefined;
+        interaction_setting?: components.InteractionSettingRequest$.Outbound | undefined;
+        voice_id?: string | undefined;
+        functions?: Function[] | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateAgentRequestBody> = z
+        .object({
+            agentName: z.string().optional(),
+            llmSetting: z.union([components.RetellLlmSetting$.outboundSchema, components.CustomLlmSetting$.outboundSchema]).optional(),
+            interactionSetting: components.InteractionSettingRequest$.outboundSchema.optional(),
+            voiceId: z.string().optional(),
+            functions: z.array(components.Function$.inboundSchema).optional(),
+        })
+        .transform((v) => {
+            return {
+                ...(v.agentName === undefined ? null : { agent_name: v.agentName }),
+                ...(v.llmSetting === undefined ? null : { llm_setting: v.llmSetting }),
+                ...(v.interactionSetting === undefined ? null : { interaction_setting: v.interactionSetting }),
+                ...(v.voiceId === undefined ? null : { voice_id: v.voiceId }),
+                ...(v.functions === undefined ? null : { functions: v.functions }),
+            };
+        });
+}
+
 export type UpdateAgentRequest = {
-    agentNoDefaultNoRequired: components.AgentNoDefaultNoRequired;
+    requestBody: UpdateAgentRequestBody;
     /**
      * Unique id of the agent to be updated.
      */
@@ -35,35 +115,35 @@ export type UpdateAgentResponse = {
 /** @internal */
 export namespace UpdateAgentRequest$ {
     export type Inbound = {
-        AgentNoDefaultNoRequired: components.AgentNoDefaultNoRequired$.Inbound;
+        RequestBody: UpdateAgentRequestBody$.Inbound;
         agent_id: string;
     };
 
     export const inboundSchema: z.ZodType<UpdateAgentRequest, z.ZodTypeDef, Inbound> = z
         .object({
-            AgentNoDefaultNoRequired: components.AgentNoDefaultNoRequired$.inboundSchema,
+            RequestBody: UpdateAgentRequestBody$.inboundSchema,
             agent_id: z.string(),
         })
         .transform((v) => {
             return {
-                agentNoDefaultNoRequired: v.AgentNoDefaultNoRequired,
+                requestBody: v.RequestBody,
                 agentId: v.agent_id,
             };
         });
 
     export type Outbound = {
-        AgentNoDefaultNoRequired: components.AgentNoDefaultNoRequired$.Outbound;
+        RequestBody: UpdateAgentRequestBody$.Outbound;
         agent_id: string;
     };
 
     export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateAgentRequest> = z
         .object({
-            agentNoDefaultNoRequired: components.AgentNoDefaultNoRequired$.outboundSchema,
+            requestBody: UpdateAgentRequestBody$.outboundSchema,
             agentId: z.string(),
         })
         .transform((v) => {
             return {
-                AgentNoDefaultNoRequired: v.agentNoDefaultNoRequired,
+                RequestBody: v.requestBody,
                 agent_id: v.agentId,
             };
         });

package/src/sdk/liveClient.ts

@@ -1,5 +1,8 @@
 import { EventEmitter } from "eventemitter3";
 import WebSocket, { MessageEvent } from "isomorphic-ws";
+import * as operations from "../models/operations";
+
+const baseEndpoint = "wss://api.re-tell.ai";
 
 export class LiveClient extends EventEmitter {
   private ws: WebSocket;
@@ -7,10 +10,7 @@ export class LiveClient extends EventEmitter {
 
   constructor(
     apiKey: string,
-    agentId: string,
-    sampleRate: number,
-    agentPromptParams: { name: string; value: string }[],
-    baseEndpoint: string
+    input: operations.CreateWebCallRequestBody
   ) {
     super();
 
@@ -19,10 +19,13 @@ export class LiveClient extends EventEmitter {
       "/create-web-call?api_key=" +
       apiKey +
       "&agent_id=" +
-      agentId +
-      "&sample_rate=" +
-      sampleRate;
-    endpoint += "&agent_prompt_params=" + encodeURIComponent(JSON.stringify(agentPromptParams));
+      input.agentId;
+    if (input.sampleRate != null) {
+      endpoint += "&sample_rate=" + input.sampleRate;
+    }
+    if (input.agentPromptParams != null) {
+      endpoint += "&agent_prompt_params=" + encodeURIComponent(JSON.stringify(input.agentPromptParams));
+    }
     this.ws = new WebSocket(endpoint);
     this.ws.binaryType = "arraybuffer";
   }

package/src/sdk/sdk.ts

@@ -6,7 +6,6 @@ import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "../lib/config";
 import * as enc$ from "../lib/encodings";
 import { HTTPClient } from "../lib/http";
 import { ClientSDK, RequestOptions } from "../lib/sdks";
-import * as components from "../models/components";
 import * as errors from "../models/errors";
 import * as operations from "../models/operations";
 import { LiveClient } from "./liveClient";
@@ -25,17 +24,11 @@ export class RetellClient extends ClientSDK {
     }
 
     async createWebCall(
-        agentId: string,
-        sampleRate = 16000,
-        agentPromptParams: { name: string; value: string }[] = [],
-        websocketEndpoint: string = "wss://api.re-tell.ai"
+        input: operations.CreateWebCallRequestBody
       ): Promise<LiveClient> {
         const liveClient = new LiveClient(
           this.options$.apiKey as unknown as string,
-          agentId,
-          sampleRate,
-          agentPromptParams,
-          websocketEndpoint
+          input
         );
         await liveClient.waitForReady();
         return liveClient;
@@ -174,7 +167,7 @@ export class RetellClient extends ClientSDK {
             const responseBody = await response.json();
             const result = operations.CreatePhoneCallResponse$.inboundSchema.parse({
                 ...responseFields$,
-                object: responseBody,
+                callDetail: responseBody,
             });
             return result;
         } else if (this.matchResponse(response, 400, "application/json")) {
@@ -813,7 +806,7 @@ export class RetellClient extends ClientSDK {
             const responseBody = await response.json();
             const result = operations.ListAgentsResponse$.inboundSchema.parse({
                 ...responseFields$,
-                classes: responseBody,
+                agents: responseBody,
             });
             return result;
         } else if (this.matchResponse(response, 401, "application/json")) {
@@ -860,7 +853,7 @@ export class RetellClient extends ClientSDK {
         const path$ = this.templateURLComponent("/list-calls")();
 
         const query$ = [
-            enc$.encodeForm("filter_criteria", payload$.filter_criteria, {
+            enc$.encodeForm("filter_criteria", JSON.stringify(payload$.filter_criteria), {
                 explode: true,
                 charEncoding: "percent",
             }),
@@ -905,7 +898,7 @@ export class RetellClient extends ClientSDK {
             const responseBody = await response.json();
             const result = operations.ListCallsResponse$.inboundSchema.parse({
                 ...responseFields$,
-                classes: responseBody,
+                calls: responseBody,
             });
             return result;
         } else if (this.matchResponse(response, 400, "application/json")) {
@@ -970,7 +963,7 @@ export class RetellClient extends ClientSDK {
             const responseBody = await response.json();
             const result = operations.ListPhoneNumbersResponse$.inboundSchema.parse({
                 ...responseFields$,
-                classes: responseBody,
+                phoneNumbers: responseBody,
             });
             return result;
         } else if (this.matchResponse(response, 400, "application/json")) {
@@ -1004,12 +997,12 @@ export class RetellClient extends ClientSDK {
      * Update an existing agent
      */
     async updateAgent(
-        agentNoDefaultNoRequired: components.AgentNoDefaultNoRequired,
+        requestBody: operations.UpdateAgentRequestBody,
         agentId: string,
         options?: RequestOptions
     ): Promise<operations.UpdateAgentResponse> {
         const input$: operations.UpdateAgentRequest = {
-            agentNoDefaultNoRequired: agentNoDefaultNoRequired,
+            requestBody: requestBody,
             agentId: agentId,
         };
         const headers$ = new Headers();
@@ -1019,7 +1012,7 @@ export class RetellClient extends ClientSDK {
 
         const payload$ = operations.UpdateAgentRequest$.outboundSchema.parse(input$);
 
-        const body$ = enc$.encodeJSON("body", payload$.AgentNoDefaultNoRequired, { explode: true });
+        const body$ = enc$.encodeJSON("body", payload$.RequestBody, { explode: true });
 
         const pathParams$ = {
             agent_id: enc$.encodeSimple("agent_id", payload$.agent_id, {