retell-sdk 1.15.21 → 2.2.2

package/src/models/components/agent.ts

@@ -0,0 +1,356 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { z } from "zod";
+
+export type RetellLlmSetting = {
+    /**
+     * Retell picked LLM based conversation response.
+     */
+    provider: "retell";
+    /**
+     * The prompt agent will follow. Can use `${YOUR_PARAM_NAME}` to represent dynamic data that would get injected at each call.
+     */
+    prompt: string;
+}
+
+/** @internal */
+export namespace RetellLlmSetting$ {
+    export type Inbound = {
+        provider: "retell";
+        prompt: string;
+    };
+
+    export const inboundSchema: z.ZodType<RetellLlmSetting, z.ZodTypeDef, Inbound> = z
+        .object({
+            provider: z.literal("retell"),
+            prompt: z.string(),
+        })
+        .transform((v) => {
+            return {
+                provider: v.provider,
+                prompt: v.prompt,
+            };
+        });
+
+    export type Outbound = {
+        provider: "retell";
+        prompt: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, RetellLlmSetting> = z
+        .object({
+            provider: z.literal("retell"),
+            prompt: z.string(),
+        })
+        .transform((v) => {
+            return {
+                provider: v.provider,
+                prompt: v.prompt,
+            };
+        });
+}
+
+export type CustomLlmSetting = {
+    /**
+     * Custom response system, usually your custom LLM. Note that you may see a higher latency if provided server is slow.
+     */
+    provider: "custom";
+    /**
+     * The URL we will call for getting response, usually your server.
+     */
+    url: string;
+    /**
+     * Whether the provided URL support return response via Server Sent Events.
+     */
+    stream: boolean;
+}
+
+/** @internal */
+export namespace CustomLlmSetting$ {
+    export type Inbound = {
+        provider: "custom";
+        url: string;
+        stream: boolean;
+    };
+
+    export const inboundSchema: z.ZodType<CustomLlmSetting, z.ZodTypeDef, Inbound> = z
+        .object({
+            provider: z.literal("custom"),
+            url: z.string(),
+            stream: z.boolean(),
+        })
+        .transform((v) => {
+            return {
+                provider: v.provider,
+                url: v.url,
+                stream: v.stream
+            };
+        });
+
+    export type Outbound = {
+        provider: "custom";
+        url: string;
+        stream: boolean;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CustomLlmSetting> = z
+        .object({
+            provider: z.literal("custom"),
+            url: z.string(),
+            stream: z.boolean(),
+        })
+        .transform((v) => {
+            return {
+                provider: v.provider,
+                url: v.url,
+                stream: v.stream
+            };
+        });
+}
+
+export type InteractionSettingRequest = {
+    /**
+     * Whether the agent begins the call with a pre-defined message. When this is false, the agent will still start the call, but with a dynamic message. If you wish for user to be the first to talk, set this to true and set `begin_message` as empty string.
+     */
+    enableBeginMessage?: boolean | undefined;
+    /**
+     * Pre-defined message for agent to say in the begining of call. Only used when `enable_begin_message` is true. When empty, agent would wait for user to talk first.
+     */
+    beginMessage?: string | undefined;
+    /**
+     * Whether the agent can end a call. If false, the agent would never end a call.
+     */
+    enableEndCall?: boolean | undefined;
+    /**
+     * Whether the agent attempts to end the call with a pre-defined message. When this is false, the agent might still be the last one speaking in the call, but the massage can be dynamic.
+     */
+    enableEndMessage?: boolean | undefined;
+    /**
+     * Pre-defined message for agent to say when agent ends the call. Only used when `enable_end_call` and `enable_end_message` is true. If you wish for agent to hang up without saying anything, set this to empty string.
+     */
+    endMessage?: string | undefined;
+}
+
+/** @internal */
+export namespace InteractionSettingRequest$ {
+    export type Inbound = {
+        enable_begin_message?: boolean | undefined;
+        begin_message?: string | undefined;
+        enable_end_call?: boolean | undefined;
+        enable_end_message?: boolean | undefined;
+        end_message?: string | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<InteractionSettingRequest, z.ZodTypeDef, Inbound> = z
+        .object({
+            enable_begin_message: z.boolean().optional(),
+            begin_message: z.string().optional(),
+            enable_end_call: z.boolean().optional(),
+            enable_end_message: z.boolean().optional(),
+            end_message: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                ...(v.enable_begin_message === undefined ? null : { enableBeginMessage: v.enable_begin_message }),
+                ...(v.begin_message === undefined ? null : { beginMessage: v.begin_message }),
+                ...(v.enable_end_call === undefined ? null : { enableEndCall: v.enable_end_call }),
+                ...(v.enable_end_message === undefined ? null : { enableEndMessage: v.enable_end_message }),
+                ...(v.end_message === undefined ? null : { endMessage: v.end_message }),
+            };
+        });
+
+    export type Outbound = {
+        enable_begin_message?: boolean | undefined;
+        begin_message?: string | undefined;
+        enable_end_call?: boolean | undefined;
+        enable_end_message?: boolean | undefined;
+        end_message?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, InteractionSettingRequest> = z
+        .object({
+            enableBeginMessage: z.boolean().optional(),
+            beginMessage: z.string().optional(),
+            enableEndCall: z.boolean().optional(),
+            enableEndMessage: z.boolean().optional(),
+            endMessage: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                ...(v.enableBeginMessage === undefined ? null : { enable_begin_message: v.enableBeginMessage }),
+                ...(v.beginMessage === undefined ? null : { begin_message: v.beginMessage }),
+                ...(v.enableEndCall === undefined ? null : { enable_end_call: v.enableEndCall }),
+                ...(v.enableEndMessage === undefined ? null : { enable_end_message: v.enableEndMessage }),
+                ...(v.endMessage === undefined ? null : { end_message: v.endMessage }),
+            };
+        });
+}
+
+export type InteractionSettingResponse = {
+    /**
+     * Whether the agent begins the call with a pre-defined message. When this is false, the agent will still start the call, but with a dynamic message. If you wish for user to be the first to talk, set this to true and set `begin_message` as empty string.
+     */
+    enableBeginMessage: boolean;
+    /**
+     * Pre-defined message for agent to say in the begining of call. Only used when `enable_begin_message` is true. When empty, agent would wait for user to talk first.
+     */
+     beginMessage?: string | undefined;
+    /**
+     * Whether the agent can end a call. If false, the agent would never end a call.
+     */
+    enableEndCall: boolean;
+    /**
+     * Whether the agent attempts to end the call with a pre-defined message. When this is false, the agent might still be the last one speaking in the call, but the massage can be dynamic.
+     */
+    enableEndMessage: boolean;
+    /**
+     * Pre-defined message for agent to say when agent ends the call. Only used when `enable_end_call` and `enable_end_message` is true. If you wish for agent to hang up without saying anything, set this to empty string.
+     */
+    endMessage?: string | undefined;
+}
+
+/** @internal */
+export namespace InteractionSettingResponse$ {
+    export type Inbound = {
+        enable_begin_message: boolean;
+        begin_message?: string | undefined;
+        enable_end_call: boolean;
+        enable_end_message: boolean;
+        end_message?: string | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<InteractionSettingResponse, z.ZodTypeDef, Inbound> = z
+        .object({
+            enable_begin_message: z.boolean(),
+            begin_message: z.string().optional(),
+            enable_end_call: z.boolean(),
+            enable_end_message: z.boolean(),
+            end_message: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                enableBeginMessage: v.enable_begin_message,
+                ...(v.begin_message === undefined ? null : { beginMessage: v.begin_message }),
+                enableEndCall: v.enable_end_call,
+                enableEndMessage: v.enable_end_message,
+                ...(v.end_message === undefined ? null : { endMessage: v.end_message }),
+            };
+        });
+
+    export type Outbound = {
+        enable_begin_message: boolean;
+        begin_message?: string | undefined;
+        enable_end_call: boolean;
+        enable_end_message: boolean;
+        end_message?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, InteractionSettingResponse> = z
+        .object({
+            enableBeginMessage: z.boolean(),
+            beginMessage: z.string().optional(),
+            enableEndCall: z.boolean(),
+            enableEndMessage: z.boolean(),
+            endMessage: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                enable_begin_message: v.enableBeginMessage,
+                ...(v.beginMessage === undefined ? null : { begin_message: v.beginMessage }),
+                enable_end_call: v.enableEndCall,
+                enable_end_message: v.enableEndMessage,
+                ...(v.endMessage === undefined ? null : { end_message: v.endMessage }),
+            };
+        });
+}
+
+export type Agent = {
+    /**
+     * Unique id of agent.
+     */
+    agentId: string;
+    /**
+     * 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: RetellLlmSetting | CustomLlmSetting;
+    /**
+     * Setting combination that controls interaction flow, like begin and end logic.
+     */
+    interactionSetting: InteractionSettingResponse;
+    /**
+     * Unique voice id used for the agent. Find list of available voices in documentation.
+     */
+    voiceId: string;
+    /**
+     * Last modification timestamp (milliseconds since epoch). Either the time of last update or creation if no updates available.
+     */
+    lastModificationTimestamp: number;
+};
+
+/** @internal */
+export namespace Agent$ {
+    export type Inbound = {
+        agent_id: string;
+        agent_name?: string | undefined;
+        llm_setting: RetellLlmSetting$.Inbound | CustomLlmSetting$.Inbound;
+        interaction_setting: InteractionSettingResponse$.Inbound;
+        voice_id: string;
+        last_modification_timestamp: number;
+    };
+
+    export const inboundSchema: z.ZodType<Agent, z.ZodTypeDef, Inbound> = z
+        .object({
+            agent_id: z.string(),
+            agent_name: z.string().optional(),
+            llm_setting: z.union([RetellLlmSetting$.inboundSchema, CustomLlmSetting$.inboundSchema]),
+            interaction_setting: InteractionSettingResponse$.inboundSchema,
+            voice_id: z.string(),
+            last_modification_timestamp: z.number().int(),
+        })
+        .transform((v) => {
+            return {
+                agentId: v.agent_id,
+                ...(v.agent_name === undefined ? null : { agentName: v.agent_name }),
+                llmSetting: v.llm_setting,
+                interactionSetting: v.interaction_setting,
+                voiceId: v.voice_id,
+                lastModificationTimestamp: v.last_modification_timestamp,
+            };
+        });
+
+    export type Outbound = {
+        agent_id: string;
+        agent_name?: string | undefined;
+        llm_setting: RetellLlmSetting$.Outbound | CustomLlmSetting$.Outbound;
+        interaction_setting: InteractionSettingResponse$.Outbound;
+        voice_id: string;
+        last_modification_timestamp: number;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, Agent> = z
+        .object({
+            agentId: z.string(),
+            agentName: z.string().optional(),
+            llmSetting: z.union([RetellLlmSetting$.outboundSchema, CustomLlmSetting$.outboundSchema]),
+            interactionSetting: InteractionSettingResponse$.outboundSchema,
+            voiceId: z.string(),
+            lastModificationTimestamp: z.number().int(),
+        })
+        .transform((v) => {
+            return {
+                agent_id: v.agentId,
+                ...(v.agentName === undefined ? null : { agent_name: v.agentName }),
+                llm_setting: v.llmSetting,
+                interaction_setting: v.interactionSetting,
+                voice_id: v.voiceId,
+                last_modification_timestamp: v.lastModificationTimestamp,                
+            };
+        });
+}

package/src/models/components/agentpromptparams.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { z } from "zod";
+
+export type AgentPromptParams = {
+    /**
+     * The name of the parameter enclosed as `${YOUR_PARAM_NAME}` in agent prompt.
+     */
+    name: string;
+    /**
+     * The value of parameter to substitute in agent prompt.
+     */
+    value: string;
+};
+
+/** @internal */
+export namespace AgentPromptParams$ {
+    export type Inbound = {
+        name: string;
+        value: string;
+    };
+
+    export const inboundSchema: z.ZodType<AgentPromptParams, z.ZodTypeDef, Inbound> = z
+        .object({
+            name: z.string(),
+            value: z.string(),
+        })
+        .transform((v) => {
+            return {
+                name: v.name,
+                value: v.value,
+            };
+        });
+
+    export type Outbound = {
+        name: string;
+        value: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, AgentPromptParams> = z
+        .object({
+            name: z.string(),
+            value: z.string(),
+        })
+        .transform((v) => {
+            return {
+                name: v.name,
+                value: v.value,
+            };
+        });
+}

package/src/models/components/calldetail.ts

@@ -0,0 +1,160 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { AgentPromptParams, AgentPromptParams$ } from "./agentpromptparams";
+import { CallPhoneNumber, CallPhoneNumber$ } from "./callphonenumber";
+import { z } from "zod";
+
+/**
+ * Status of call.
+ */
+export enum CallStatus {
+    Ongoing = "ongoing",
+    Ended = "ended",
+    Error = "error",
+}
+
+/**
+ * Web call or phone call.
+ */
+export enum CallType {
+    InboundPhoneCall = "inbound_phone_call",
+    OutboundPhoneCall = "outbound_phone_call",
+    WebCall = "web_call",
+}
+
+export type CallDetail = {
+    /**
+     * Corresponding agent id of this call.
+     */
+    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. Learn more about [Agent Prompt Parameters](/features/agent-prompt-parameter).
+     */
+    agentPromptParams?: Array<AgentPromptParams> | undefined;
+    /**
+     * Unique id of the call.
+     */
+    callId: string;
+    /**
+     * Status of call.
+     */
+    callStatus: CallStatus;
+    /**
+     * Web call or phone call.
+     */
+    callType: CallType;
+    /**
+     * End timestamp (milliseconds since epoch) of the call. Available after call ends.
+     */
+    endTimestamp?: number | undefined;
+    phoneNumber?: CallPhoneNumber | undefined;
+    /**
+     * Recording of the call. Available after call ends.
+     */
+    recordingUrl?: string | undefined;
+    /**
+     * Begin timestamp (milliseconds since epoch) of the call.
+     */
+    startTimestamp: number;
+    /**
+     * Transcription of the call. Available after call ends.
+     */
+    transcript?: string | undefined;
+};
+
+/** @internal */
+export const CallStatus$ = z.nativeEnum(CallStatus);
+
+/** @internal */
+export const CallType$ = z.nativeEnum(CallType);
+
+/** @internal */
+export namespace CallDetail$ {
+    export type Inbound = {
+        agent_id: string;
+        agent_prompt_params?: Array<AgentPromptParams$.Inbound> | undefined;
+        call_id: string;
+        call_status: CallStatus;
+        call_type: CallType;
+        end_timestamp?: number | undefined;
+        phone_number?: CallPhoneNumber$.Inbound | undefined;
+        recording_url?: string | undefined;
+        start_timestamp: number;
+        transcript?: string | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<CallDetail, z.ZodTypeDef, Inbound> = z
+        .object({
+            agent_id: z.string(),
+            agent_prompt_params: z.array(AgentPromptParams$.inboundSchema).optional(),
+            call_id: z.string(),
+            call_status: CallStatus$,
+            call_type: CallType$,
+            end_timestamp: z.number().int().optional(),
+            phone_number: CallPhoneNumber$.inboundSchema.optional(),
+            recording_url: z.string().optional(),
+            start_timestamp: z.number().int(),
+            transcript: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                agentId: v.agent_id,
+                ...(v.agent_prompt_params === undefined
+                    ? null
+                    : { agentPromptParams: v.agent_prompt_params }),
+                callId: v.call_id,
+                callStatus: v.call_status,
+                callType: v.call_type,
+                ...(v.end_timestamp === undefined ? null : { endTimestamp: v.end_timestamp }),
+                ...(v.phone_number === undefined ? null : { phoneNumber: v.phone_number }),
+                ...(v.recording_url === undefined ? null : { recordingUrl: v.recording_url }),
+                startTimestamp: v.start_timestamp,
+                ...(v.transcript === undefined ? null : { transcript: v.transcript }),
+            };
+        });
+
+    export type Outbound = {
+        agent_id: string;
+        agent_prompt_params?: Array<AgentPromptParams$.Outbound> | undefined;
+        call_id: string;
+        call_status: CallStatus;
+        call_type: CallType;
+        end_timestamp?: number | undefined;
+        phone_number?: CallPhoneNumber$.Outbound | undefined;
+        recording_url?: string | undefined;
+        start_timestamp: number;
+        transcript?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CallDetail> = z
+        .object({
+            agentId: z.string(),
+            agentPromptParams: z.array(AgentPromptParams$.outboundSchema).optional(),
+            callId: z.string(),
+            callStatus: CallStatus$,
+            callType: CallType$,
+            endTimestamp: z.number().int().optional(),
+            phoneNumber: CallPhoneNumber$.outboundSchema.optional(),
+            recordingUrl: z.string().optional(),
+            startTimestamp: z.number().int(),
+            transcript: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                agent_id: v.agentId,
+                ...(v.agentPromptParams === undefined
+                    ? null
+                    : { agent_prompt_params: v.agentPromptParams }),
+                call_id: v.callId,
+                call_status: v.callStatus,
+                call_type: v.callType,
+                ...(v.endTimestamp === undefined ? null : { end_timestamp: v.endTimestamp }),
+                ...(v.phoneNumber === undefined ? null : { phone_number: v.phoneNumber }),
+                ...(v.recordingUrl === undefined ? null : { recording_url: v.recordingUrl }),
+                start_timestamp: v.startTimestamp,
+                ...(v.transcript === undefined ? null : { transcript: v.transcript }),
+            };
+        });
+}

package/src/models/components/callphonenumber.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { z } from "zod";
+
+/**
+ * Phone number associated with the call. Only populated when call_type is `inbound_phone_call` or `outbound_phone_call`.
+ */
+export type CallPhoneNumber = {
+    /**
+     * Caller phone number in E.164 format.
+     */
+    from: string;
+    /**
+     * Callee phone number in E.164 format.
+     */
+    to: string;
+};
+
+/** @internal */
+export namespace CallPhoneNumber$ {
+    export type Inbound = {
+        from: string;
+        to: string;
+    };
+
+    export const inboundSchema: z.ZodType<CallPhoneNumber, z.ZodTypeDef, Inbound> = z
+        .object({
+            from: z.string(),
+            to: z.string(),
+        })
+        .transform((v) => {
+            return {
+                from: v.from,
+                to: v.to,
+            };
+        });
+
+    export type Outbound = {
+        from: string;
+        to: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CallPhoneNumber> = z
+        .object({
+            from: z.string(),
+            to: z.string(),
+        })
+        .transform((v) => {
+            return {
+                from: v.from,
+                to: v.to,
+            };
+        });
+}

package/src/models/components/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+export * from "./agent";
+export * from "./agentpromptparams";
+export * from "./calldetail";
+export * from "./callphonenumber";
+export * from "./phonenumber";
+export * from "./security";