retell-sdk 2.2.2 → 2.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. package/example.js +61 -7
  2. package/example.js.map +1 -1
  3. package/lib/config.d.ts.map +1 -1
  4. package/lib/config.js.map +1 -1
  5. package/lib/sdks.d.ts.map +1 -1
  6. package/lib/sdks.js.map +1 -1
  7. package/lib/security.d.ts.map +1 -1
  8. package/lib/security.js +5 -1
  9. package/lib/security.js.map +1 -1
  10. package/models/components/agent.d.ts +62 -0
  11. package/models/components/agent.d.ts.map +1 -1
  12. package/models/components/agent.js +95 -15
  13. package/models/components/agent.js.map +1 -1
  14. package/models/components/agentpromptparams.d.ts.map +1 -1
  15. package/models/components/agentpromptparams.js.map +1 -1
  16. package/models/components/calldetail.d.ts.map +1 -1
  17. package/models/components/calldetail.js +18 -6
  18. package/models/components/calldetail.js.map +1 -1
  19. package/models/components/callphonenumber.d.ts.map +1 -1
  20. package/models/components/callphonenumber.js.map +1 -1
  21. package/models/components/phonenumber.d.ts.map +1 -1
  22. package/models/components/phonenumber.js.map +1 -1
  23. package/models/components/security.d.ts.map +1 -1
  24. package/models/errors/createagent.d.ts.map +1 -1
  25. package/models/errors/createagent.js +36 -12
  26. package/models/errors/createagent.js.map +1 -1
  27. package/models/errors/createphonecall.d.ts.map +1 -1
  28. package/models/errors/createphonecall.js +54 -18
  29. package/models/errors/createphonecall.js.map +1 -1
  30. package/models/errors/createphonenumber.d.ts.map +1 -1
  31. package/models/errors/createphonenumber.js +42 -14
  32. package/models/errors/createphonenumber.js.map +1 -1
  33. package/models/errors/deleteagent.d.ts.map +1 -1
  34. package/models/errors/deleteagent.js +36 -12
  35. package/models/errors/deleteagent.js.map +1 -1
  36. package/models/errors/deletephonenumber.d.ts.map +1 -1
  37. package/models/errors/deletephonenumber.js +33 -11
  38. package/models/errors/deletephonenumber.js.map +1 -1
  39. package/models/errors/getagent.d.ts.map +1 -1
  40. package/models/errors/getagent.js +36 -12
  41. package/models/errors/getagent.js.map +1 -1
  42. package/models/errors/getcall.d.ts.map +1 -1
  43. package/models/errors/getcall.js +30 -10
  44. package/models/errors/getcall.js.map +1 -1
  45. package/models/errors/getphonenumber.d.ts.map +1 -1
  46. package/models/errors/getphonenumber.js +36 -12
  47. package/models/errors/getphonenumber.js.map +1 -1
  48. package/models/errors/listagents.d.ts.map +1 -1
  49. package/models/errors/listagents.js +15 -5
  50. package/models/errors/listagents.js.map +1 -1
  51. package/models/errors/listcalls.d.ts.map +1 -1
  52. package/models/errors/listcalls.js +24 -8
  53. package/models/errors/listcalls.js.map +1 -1
  54. package/models/errors/listphonenumbers.d.ts.map +1 -1
  55. package/models/errors/listphonenumbers.js +27 -9
  56. package/models/errors/listphonenumbers.js.map +1 -1
  57. package/models/errors/updateagent.d.ts.map +1 -1
  58. package/models/errors/updateagent.js +36 -12
  59. package/models/errors/updateagent.js.map +1 -1
  60. package/models/errors/updatephoneagent.d.ts.map +1 -1
  61. package/models/errors/updatephoneagent.js +36 -12
  62. package/models/errors/updatephoneagent.js.map +1 -1
  63. package/models/operations/createagent.d.ts +7 -0
  64. package/models/operations/createagent.d.ts.map +1 -1
  65. package/models/operations/createagent.js +18 -4
  66. package/models/operations/createagent.js.map +1 -1
  67. package/models/operations/createphonecall.d.ts.map +1 -1
  68. package/models/operations/createphonecall.js +18 -6
  69. package/models/operations/createphonecall.js.map +1 -1
  70. package/models/operations/createphonenumber.d.ts.map +1 -1
  71. package/models/operations/createphonenumber.js +6 -2
  72. package/models/operations/createphonenumber.js.map +1 -1
  73. package/models/operations/createwebcall.d.ts.map +1 -1
  74. package/models/operations/deleteagent.d.ts.map +1 -1
  75. package/models/operations/deleteagent.js.map +1 -1
  76. package/models/operations/deletephonenumber.d.ts.map +1 -1
  77. package/models/operations/deletephonenumber.js.map +1 -1
  78. package/models/operations/getagent.d.ts.map +1 -1
  79. package/models/operations/getagent.js.map +1 -1
  80. package/models/operations/getcall.d.ts.map +1 -1
  81. package/models/operations/getcall.js.map +1 -1
  82. package/models/operations/getphonenumber.d.ts.map +1 -1
  83. package/models/operations/getphonenumber.js +6 -2
  84. package/models/operations/getphonenumber.js.map +1 -1
  85. package/models/operations/listagents.d.ts.map +1 -1
  86. package/models/operations/listagents.js.map +1 -1
  87. package/models/operations/listcalls.d.ts.map +1 -1
  88. package/models/operations/listcalls.js +6 -2
  89. package/models/operations/listcalls.js.map +1 -1
  90. package/models/operations/listphonenumbers.d.ts.map +1 -1
  91. package/models/operations/listphonenumbers.js +6 -2
  92. package/models/operations/listphonenumbers.js.map +1 -1
  93. package/models/operations/updateagent.d.ts +7 -0
  94. package/models/operations/updateagent.d.ts.map +1 -1
  95. package/models/operations/updateagent.js +22 -4
  96. package/models/operations/updateagent.js.map +1 -1
  97. package/models/operations/updatephoneagent.d.ts.map +1 -1
  98. package/models/operations/updatephoneagent.js +6 -2
  99. package/models/operations/updatephoneagent.js.map +1 -1
  100. package/package.json +1 -1
  101. package/sdk/liveClient.d.ts.map +1 -1
  102. package/sdk/liveClient.js +7 -2
  103. package/sdk/liveClient.js.map +1 -1
  104. package/sdk/sdk.d.ts.map +1 -1
  105. package/sdk/sdk.js +22 -5
  106. package/sdk/sdk.js.map +1 -1
  107. package/src/example.ts +122 -65
  108. package/src/lib/config.ts +32 -32
  109. package/src/lib/sdks.ts +91 -82
  110. package/src/lib/security.ts +133 -118
  111. package/src/models/components/agent.ts +482 -303
  112. package/src/models/components/agentpromptparams.ts +46 -38
  113. package/src/models/components/calldetail.ts +137 -125
  114. package/src/models/components/callphonenumber.ts +46 -38
  115. package/src/models/components/phonenumber.ts +69 -68
  116. package/src/models/components/security.ts +1 -1
  117. package/src/models/errors/createagent.ts +359 -311
  118. package/src/models/errors/createphonecall.ts +537 -472
  119. package/src/models/errors/createphonenumber.ts +447 -395
  120. package/src/models/errors/deleteagent.ts +359 -311
  121. package/src/models/errors/deletephonenumber.ts +357 -315
  122. package/src/models/errors/getagent.ts +358 -302
  123. package/src/models/errors/getcall.ts +348 -294
  124. package/src/models/errors/getphonenumber.ts +357 -312
  125. package/src/models/errors/listagents.ts +174 -147
  126. package/src/models/errors/listcalls.ts +251 -211
  127. package/src/models/errors/listphonenumbers.ts +252 -217
  128. package/src/models/errors/updateagent.ts +359 -311
  129. package/src/models/errors/updatephoneagent.ts +357 -312
  130. package/src/models/operations/createagent.ts +166 -119
  131. package/src/models/operations/createphonecall.ts +283 -238
  132. package/src/models/operations/createphonenumber.ts +118 -98
  133. package/src/models/operations/createwebcall.ts +13 -13
  134. package/src/models/operations/deleteagent.ts +94 -78
  135. package/src/models/operations/deletephonenumber.ts +94 -78
  136. package/src/models/operations/getagent.ts +104 -88
  137. package/src/models/operations/getcall.ts +101 -88
  138. package/src/models/operations/getphonenumber.ts +108 -88
  139. package/src/models/operations/listagents.ts +68 -60
  140. package/src/models/operations/listcalls.ts +238 -213
  141. package/src/models/operations/listphonenumbers.ts +72 -60
  142. package/src/models/operations/updateagent.ts +227 -163
  143. package/src/models/operations/updatephoneagent.ts +160 -132
  144. package/src/sdk/liveClient.ts +11 -7
  145. package/src/sdk/sdk.ts +1313 -1160
@@ -3,143 +3,190 @@
3
3
  */
4
4
 
5
5
  import * as components from "../../models/components";
6
+ import { Function } from "../../models/components";
6
7
  import { z } from "zod";
7
8
 
8
9
  export type CreateAgentRequestBody = {
9
- /**
10
- * The name of the agent. Only used for your own reference.
11
- */
12
- agentName?: string | undefined;
13
- /*
14
- * Determines how to generate the response in the call. Currently supports using our in-house LLM response system or your own custom
15
- * response generation system.
16
- */
17
- llmSetting: components.RetellLlmSetting | components.CustomLlmSetting;
18
- /**
19
- * Setting combination that controls interaction flow, like begin and end logic.
20
- */
21
- interactionSetting?: components.InteractionSettingRequest | undefined;
22
- /**
23
- * Unique voice id used for the agent. Find list of available voices in documentation.
24
- */
25
- voiceId: string;
10
+ /**
11
+ * The name of the agent. Only used for your own reference.
12
+ */
13
+ agentName?: string | undefined;
14
+ /*
15
+ * Determines how to generate the response in the call. Currently supports using our in-house LLM response system or your own custom
16
+ * response generation system.
17
+ */
18
+ llmSetting: components.RetellLlmSetting | components.CustomLlmSetting;
19
+ /**
20
+ * Setting combination that controls interaction flow, like begin and end logic.
21
+ */
22
+ interactionSetting?: components.InteractionSettingRequest | undefined;
23
+ /**
24
+ * Unique voice id used for the agent. Find list of available voices in documentation.
25
+ */
26
+ voiceId: string;
27
+ /**
28
+ * 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.
29
+ */
30
+ functions?: Function[] | undefined;
26
31
  };
27
32
 
28
33
  export type CreateAgentResponse = {
29
- /**
30
- * Successfully created a new agent.
31
- */
32
- agent?: components.Agent | undefined;
33
- /**
34
- * HTTP response content type for this operation
35
- */
36
- contentType: string;
37
- /**
38
- * HTTP response status code for this operation
39
- */
40
- statusCode: number;
41
- /**
42
- * Raw HTTP response; suitable for custom response parsing
43
- */
44
- rawResponse: Response;
34
+ /**
35
+ * Successfully created a new agent.
36
+ */
37
+ agent?: components.Agent | undefined;
38
+ /**
39
+ * HTTP response content type for this operation
40
+ */
41
+ contentType: string;
42
+ /**
43
+ * HTTP response status code for this operation
44
+ */
45
+ statusCode: number;
46
+ /**
47
+ * Raw HTTP response; suitable for custom response parsing
48
+ */
49
+ rawResponse: Response;
45
50
  };
46
51
 
47
52
  /** @internal */
48
53
  export namespace CreateAgentRequestBody$ {
49
- export type Inbound = {
50
- agent_name?: string | undefined;
51
- llm_setting: components.RetellLlmSetting$.Inbound | components.CustomLlmSetting$.Inbound;
52
- interaction_setting?: components.InteractionSettingRequest$.Inbound | undefined;
53
- voice_id: string;
54
- };
54
+ export type Inbound = {
55
+ agent_name?: string | undefined;
56
+ llm_setting:
57
+ | components.RetellLlmSetting$.Inbound
58
+ | components.CustomLlmSetting$.Inbound;
59
+ interaction_setting?:
60
+ | components.InteractionSettingRequest$.Inbound
61
+ | undefined;
62
+ voice_id: string;
63
+ functions?: Function[] | undefined;
64
+ };
55
65
 
56
- export const inboundSchema: z.ZodType<CreateAgentRequestBody, z.ZodTypeDef, Inbound> = z
57
- .object({
58
- agent_name: z.string().optional(),
59
- llm_setting: z.union([components.RetellLlmSetting$.inboundSchema, components.CustomLlmSetting$.inboundSchema]),
60
- interaction_setting: components.InteractionSettingRequest$.inboundSchema.optional(),
61
- voice_id: z.string(),
62
- })
63
- .transform((v) => {
64
- return {
65
- ...(v.agent_name === undefined ? null : { agentName: v.agent_name }),
66
- llmSetting: v.llm_setting,
67
- ...(v.interaction_setting === undefined ? null : { interactionSetting: v.interaction_setting }),
68
- voiceId: v.voice_id,
69
- };
70
- });
66
+ export const inboundSchema: z.ZodType<
67
+ CreateAgentRequestBody,
68
+ z.ZodTypeDef,
69
+ Inbound
70
+ > = z
71
+ .object({
72
+ agent_name: z.string().optional(),
73
+ llm_setting: z.union([
74
+ components.RetellLlmSetting$.inboundSchema,
75
+ components.CustomLlmSetting$.inboundSchema,
76
+ ]),
77
+ interaction_setting:
78
+ components.InteractionSettingRequest$.inboundSchema.optional(),
79
+ voice_id: z.string(),
80
+ functions: z.array(components.Function$.inboundSchema).optional(),
81
+ })
82
+ .transform((v) => {
83
+ return {
84
+ ...(v.agent_name === undefined ? null : { agentName: v.agent_name }),
85
+ llmSetting: v.llm_setting,
86
+ ...(v.interaction_setting === undefined
87
+ ? null
88
+ : { interactionSetting: v.interaction_setting }),
89
+ voiceId: v.voice_id,
90
+ ...(v.functions === undefined ? null : { functions: v.functions }),
91
+ };
92
+ });
71
93
 
72
- export type Outbound = {
73
- agent_name?: string | undefined;
74
- llm_setting: components.RetellLlmSetting$.Inbound | components.CustomLlmSetting$.Inbound;
75
- interaction_setting?: components.InteractionSettingRequest$.Inbound | undefined;
76
- voice_id: string;
77
- };
94
+ export type Outbound = {
95
+ agent_name?: string | undefined;
96
+ llm_setting:
97
+ | components.RetellLlmSetting$.Inbound
98
+ | components.CustomLlmSetting$.Inbound;
99
+ interaction_setting?:
100
+ | components.InteractionSettingRequest$.Inbound
101
+ | undefined;
102
+ voice_id: string;
103
+ functions?: Function[] | undefined;
104
+ };
78
105
 
79
- export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreateAgentRequestBody> = z
80
- .object({
81
- agentName: z.string().optional(),
82
- llmSetting: z.union([components.RetellLlmSetting$.outboundSchema, components.CustomLlmSetting$.outboundSchema]),
83
- interactionSetting: components.InteractionSettingRequest$.outboundSchema.optional(),
84
- voiceId: z.string(),
85
- })
86
- .transform((v) => {
87
- return {
88
- ...(v.agentName === undefined ? null : { agent_name: v.agentName }),
89
- llm_setting: v.llmSetting,
90
- ...(v.interactionSetting === undefined ? null : { interaction_setting: v.interactionSetting }),
91
- voice_id: v.voiceId,
92
- };
93
- });
106
+ export const outboundSchema: z.ZodType<
107
+ Outbound,
108
+ z.ZodTypeDef,
109
+ CreateAgentRequestBody
110
+ > = z
111
+ .object({
112
+ agentName: z.string().optional(),
113
+ llmSetting: z.union([
114
+ components.RetellLlmSetting$.outboundSchema,
115
+ components.CustomLlmSetting$.outboundSchema,
116
+ ]),
117
+ interactionSetting:
118
+ components.InteractionSettingRequest$.outboundSchema.optional(),
119
+ voiceId: z.string(),
120
+ functions: z.array(components.Function$.inboundSchema).optional(),
121
+ })
122
+ .transform((v) => {
123
+ return {
124
+ ...(v.agentName === undefined ? null : { agent_name: v.agentName }),
125
+ llm_setting: v.llmSetting,
126
+ ...(v.interactionSetting === undefined
127
+ ? null
128
+ : { interaction_setting: v.interactionSetting }),
129
+ voice_id: v.voiceId,
130
+ ...(v.functions === undefined ? null : { functions: v.functions }),
131
+ };
132
+ });
94
133
  }
95
134
 
96
135
  /** @internal */
97
136
  export namespace CreateAgentResponse$ {
98
- export type Inbound = {
99
- Agent?: components.Agent$.Inbound | undefined;
100
- ContentType: string;
101
- StatusCode: number;
102
- RawResponse: Response;
103
- };
137
+ export type Inbound = {
138
+ Agent?: components.Agent$.Inbound | undefined;
139
+ ContentType: string;
140
+ StatusCode: number;
141
+ RawResponse: Response;
142
+ };
104
143
 
105
- export const inboundSchema: z.ZodType<CreateAgentResponse, z.ZodTypeDef, Inbound> = z
106
- .object({
107
- Agent: components.Agent$.inboundSchema.optional(),
108
- ContentType: z.string(),
109
- StatusCode: z.number().int(),
110
- RawResponse: z.instanceof(Response),
111
- })
112
- .transform((v) => {
113
- return {
114
- ...(v.Agent === undefined ? null : { agent: v.Agent }),
115
- contentType: v.ContentType,
116
- statusCode: v.StatusCode,
117
- rawResponse: v.RawResponse,
118
- };
119
- });
144
+ export const inboundSchema: z.ZodType<
145
+ CreateAgentResponse,
146
+ z.ZodTypeDef,
147
+ Inbound
148
+ > = z
149
+ .object({
150
+ Agent: components.Agent$.inboundSchema.optional(),
151
+ ContentType: z.string(),
152
+ StatusCode: z.number().int(),
153
+ RawResponse: z.instanceof(Response),
154
+ })
155
+ .transform((v) => {
156
+ return {
157
+ ...(v.Agent === undefined ? null : { agent: v.Agent }),
158
+ contentType: v.ContentType,
159
+ statusCode: v.StatusCode,
160
+ rawResponse: v.RawResponse,
161
+ };
162
+ });
120
163
 
121
- export type Outbound = {
122
- Agent?: components.Agent$.Outbound | undefined;
123
- ContentType: string;
124
- StatusCode: number;
125
- RawResponse: never;
126
- };
164
+ export type Outbound = {
165
+ Agent?: components.Agent$.Outbound | undefined;
166
+ ContentType: string;
167
+ StatusCode: number;
168
+ RawResponse: never;
169
+ };
127
170
 
128
- export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreateAgentResponse> = z
129
- .object({
130
- agent: components.Agent$.outboundSchema.optional(),
131
- contentType: z.string(),
132
- statusCode: z.number().int(),
133
- rawResponse: z.instanceof(Response).transform(() => {
134
- throw new Error("Response cannot be serialized");
135
- }),
136
- })
137
- .transform((v) => {
138
- return {
139
- ...(v.agent === undefined ? null : { Agent: v.agent }),
140
- ContentType: v.contentType,
141
- StatusCode: v.statusCode,
142
- RawResponse: v.rawResponse,
143
- };
144
- });
171
+ export const outboundSchema: z.ZodType<
172
+ Outbound,
173
+ z.ZodTypeDef,
174
+ CreateAgentResponse
175
+ > = z
176
+ .object({
177
+ agent: components.Agent$.outboundSchema.optional(),
178
+ contentType: z.string(),
179
+ statusCode: z.number().int(),
180
+ rawResponse: z.instanceof(Response).transform(() => {
181
+ throw new Error("Response cannot be serialized");
182
+ }),
183
+ })
184
+ .transform((v) => {
185
+ return {
186
+ ...(v.agent === undefined ? null : { Agent: v.agent }),
187
+ ContentType: v.contentType,
188
+ StatusCode: v.statusCode,
189
+ RawResponse: v.rawResponse,
190
+ };
191
+ });
145
192
  }