retell-sdk 1.15.21 → 2.2.2

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 (466) hide show
  1. package/README.md +3 -629
  2. package/example.d.ts +2 -0
  3. package/example.d.ts.map +1 -0
  4. package/example.js +74 -0
  5. package/example.js.map +1 -0
  6. package/index.d.ts +3 -0
  7. package/index.d.ts.map +1 -0
  8. package/{dist/index.js → index.js} +2 -0
  9. package/index.js.map +1 -0
  10. package/lib/base64.d.ts +10 -0
  11. package/lib/base64.d.ts.map +1 -0
  12. package/lib/base64.js +61 -0
  13. package/lib/base64.js.map +1 -0
  14. package/lib/config.d.ts +31 -0
  15. package/lib/config.d.ts.map +1 -0
  16. package/lib/config.js +36 -0
  17. package/lib/config.js.map +1 -0
  18. package/lib/encodings.d.ts +41 -0
  19. package/lib/encodings.d.ts.map +1 -0
  20. package/lib/encodings.js +308 -0
  21. package/lib/encodings.js.map +1 -0
  22. package/lib/http.d.ts +45 -0
  23. package/lib/http.d.ts.map +1 -0
  24. package/lib/http.js +136 -0
  25. package/lib/http.js.map +1 -0
  26. package/lib/retries.d.ts +18 -0
  27. package/lib/retries.d.ts.map +1 -0
  28. package/lib/retries.js +136 -0
  29. package/lib/retries.js.map +1 -0
  30. package/lib/sdks.d.ts +32 -0
  31. package/lib/sdks.d.ts.map +1 -0
  32. package/lib/sdks.js +90 -0
  33. package/lib/sdks.js.map +1 -0
  34. package/lib/security.d.ts +57 -0
  35. package/lib/security.d.ts.map +1 -0
  36. package/lib/security.js +99 -0
  37. package/lib/security.js.map +1 -0
  38. package/lib/url.d.ts +4 -0
  39. package/lib/url.d.ts.map +1 -0
  40. package/lib/url.js +26 -0
  41. package/lib/url.js.map +1 -0
  42. package/models/components/agent.d.ts +180 -0
  43. package/models/components/agent.d.ts.map +1 -0
  44. package/models/components/agent.js +182 -0
  45. package/models/components/agent.js.map +1 -0
  46. package/models/components/agentnodefaultnorequired.d.ts +61 -0
  47. package/models/components/agentnodefaultnorequired.d.ts.map +1 -0
  48. package/models/components/agentnodefaultnorequired.js +66 -0
  49. package/models/components/agentnodefaultnorequired.js.map +1 -0
  50. package/models/components/agentpromptparams.d.ts +25 -0
  51. package/models/components/agentpromptparams.d.ts.map +1 -0
  52. package/models/components/agentpromptparams.js +34 -0
  53. package/models/components/agentpromptparams.js.map +1 -0
  54. package/models/components/calldetail.d.ts +92 -0
  55. package/models/components/calldetail.d.ts.map +1 -0
  56. package/models/components/calldetail.js +94 -0
  57. package/models/components/calldetail.js.map +1 -0
  58. package/models/components/callphonenumber.d.ts +28 -0
  59. package/models/components/callphonenumber.d.ts.map +1 -0
  60. package/models/components/callphonenumber.js +34 -0
  61. package/models/components/callphonenumber.js.map +1 -0
  62. package/{dist/models → models}/components/index.d.ts +1 -1
  63. package/models/components/index.d.ts.map +1 -0
  64. package/{dist/models → models}/components/index.js +1 -1
  65. package/models/components/index.js.map +1 -0
  66. package/{dist/models → models}/components/phonenumber.d.ts +22 -2
  67. package/models/components/phonenumber.d.ts.map +1 -0
  68. package/models/components/phonenumber.js +46 -0
  69. package/models/components/phonenumber.js.map +1 -0
  70. package/models/components/security.d.ts +4 -0
  71. package/models/components/security.d.ts.map +1 -0
  72. package/models/components/security.js +6 -0
  73. package/models/components/security.js.map +1 -0
  74. package/models/errors/createagent.d.ts +146 -0
  75. package/models/errors/createagent.d.ts.map +1 -0
  76. package/models/errors/createagent.js +236 -0
  77. package/models/errors/createagent.js.map +1 -0
  78. package/models/errors/createphonecall.d.ts +218 -0
  79. package/models/errors/createphonecall.d.ts.map +1 -0
  80. package/models/errors/createphonecall.js +350 -0
  81. package/models/errors/createphonecall.js.map +1 -0
  82. package/models/errors/createphonenumber.d.ts +182 -0
  83. package/models/errors/createphonenumber.d.ts.map +1 -0
  84. package/models/errors/createphonenumber.js +295 -0
  85. package/models/errors/createphonenumber.js.map +1 -0
  86. package/models/errors/deleteagent.d.ts +146 -0
  87. package/models/errors/deleteagent.d.ts.map +1 -0
  88. package/models/errors/deleteagent.js +236 -0
  89. package/models/errors/deleteagent.js.map +1 -0
  90. package/models/errors/deletephonenumber.d.ts +146 -0
  91. package/models/errors/deletephonenumber.d.ts.map +1 -0
  92. package/models/errors/deletephonenumber.js +238 -0
  93. package/models/errors/deletephonenumber.js.map +1 -0
  94. package/models/errors/getagent.d.ts +146 -0
  95. package/models/errors/getagent.d.ts.map +1 -0
  96. package/models/errors/getagent.js +236 -0
  97. package/models/errors/getagent.js.map +1 -0
  98. package/models/errors/getcall.d.ts +146 -0
  99. package/models/errors/getcall.d.ts.map +1 -0
  100. package/models/errors/getcall.js +240 -0
  101. package/models/errors/getcall.js.map +1 -0
  102. package/models/errors/getphonenumber.d.ts +146 -0
  103. package/models/errors/getphonenumber.d.ts.map +1 -0
  104. package/models/errors/getphonenumber.js +236 -0
  105. package/models/errors/getphonenumber.js.map +1 -0
  106. package/{dist/models → models}/errors/index.d.ts +1 -0
  107. package/models/errors/index.d.ts.map +1 -0
  108. package/{dist/models → models}/errors/index.js +1 -0
  109. package/models/errors/index.js.map +1 -0
  110. package/models/errors/listagents.d.ts +74 -0
  111. package/models/errors/listagents.d.ts.map +1 -0
  112. package/models/errors/listagents.js +124 -0
  113. package/models/errors/listagents.js.map +1 -0
  114. package/models/errors/listcalls.d.ts +110 -0
  115. package/models/errors/listcalls.d.ts.map +1 -0
  116. package/models/errors/listcalls.js +181 -0
  117. package/models/errors/listcalls.js.map +1 -0
  118. package/models/errors/listphonenumbers.d.ts +110 -0
  119. package/models/errors/listphonenumbers.d.ts.map +1 -0
  120. package/models/errors/listphonenumbers.js +179 -0
  121. package/models/errors/listphonenumbers.js.map +1 -0
  122. package/models/errors/sdkerror.d.ts +7 -0
  123. package/models/errors/sdkerror.d.ts.map +1 -0
  124. package/models/errors/sdkerror.js +22 -0
  125. package/models/errors/sdkerror.js.map +1 -0
  126. package/models/errors/updateagent.d.ts +146 -0
  127. package/models/errors/updateagent.d.ts.map +1 -0
  128. package/models/errors/updateagent.js +236 -0
  129. package/models/errors/updateagent.js.map +1 -0
  130. package/models/errors/updatephoneagent.d.ts +146 -0
  131. package/models/errors/updatephoneagent.d.ts.map +1 -0
  132. package/models/errors/updatephoneagent.js +236 -0
  133. package/models/errors/updatephoneagent.js.map +1 -0
  134. package/models/operations/createagent.d.ts +70 -0
  135. package/models/operations/createagent.d.ts.map +1 -0
  136. package/models/operations/createagent.js +102 -0
  137. package/models/operations/createagent.js.map +1 -0
  138. package/models/operations/createphonecall.d.ts +163 -0
  139. package/models/operations/createphonecall.d.ts.map +1 -0
  140. package/models/operations/createphonecall.js +196 -0
  141. package/models/operations/createphonecall.js.map +1 -0
  142. package/models/operations/createphonenumber.d.ts +61 -0
  143. package/models/operations/createphonenumber.d.ts.map +1 -0
  144. package/models/operations/createphonenumber.js +94 -0
  145. package/models/operations/createphonenumber.js.map +1 -0
  146. package/models/operations/createwebcall.d.ts +16 -0
  147. package/models/operations/createwebcall.d.ts.map +1 -0
  148. package/models/operations/createwebcall.js +3 -0
  149. package/models/operations/createwebcall.js.map +1 -0
  150. package/models/operations/deleteagent.d.ts +48 -0
  151. package/models/operations/deleteagent.d.ts.map +1 -0
  152. package/models/operations/deleteagent.js +62 -0
  153. package/models/operations/deleteagent.js.map +1 -0
  154. package/models/operations/deletephonenumber.d.ts +48 -0
  155. package/models/operations/deletephonenumber.d.ts.map +1 -0
  156. package/models/operations/deletephonenumber.js +62 -0
  157. package/models/operations/deletephonenumber.js.map +1 -0
  158. package/models/operations/getagent.d.ts +55 -0
  159. package/models/operations/getagent.d.ts.map +1 -0
  160. package/models/operations/getagent.js +90 -0
  161. package/models/operations/getagent.js.map +1 -0
  162. package/models/operations/getcall.d.ts +55 -0
  163. package/models/operations/getcall.d.ts.map +1 -0
  164. package/models/operations/getcall.js +90 -0
  165. package/models/operations/getcall.js.map +1 -0
  166. package/models/operations/getphonenumber.d.ts +55 -0
  167. package/models/operations/getphonenumber.d.ts.map +1 -0
  168. package/models/operations/getphonenumber.js +90 -0
  169. package/models/operations/getphonenumber.js.map +1 -0
  170. package/{dist/models → models}/operations/index.d.ts +2 -0
  171. package/models/operations/index.d.ts.map +1 -0
  172. package/{dist/models → models}/operations/index.js +2 -0
  173. package/models/operations/index.js.map +1 -0
  174. package/models/operations/listagents.d.ts +38 -0
  175. package/models/operations/listagents.d.ts.map +1 -0
  176. package/models/operations/listagents.js +68 -0
  177. package/models/operations/listagents.js.map +1 -0
  178. package/models/operations/listcalls.d.ts +127 -0
  179. package/models/operations/listcalls.d.ts.map +1 -0
  180. package/models/operations/listcalls.js +174 -0
  181. package/models/operations/listcalls.js.map +1 -0
  182. package/models/operations/listphonenumbers.d.ts +38 -0
  183. package/models/operations/listphonenumbers.d.ts.map +1 -0
  184. package/models/operations/listphonenumbers.js +68 -0
  185. package/models/operations/listphonenumbers.js.map +1 -0
  186. package/models/operations/updateagent.d.ts +90 -0
  187. package/models/operations/updateagent.d.ts.map +1 -0
  188. package/models/operations/updateagent.js +128 -0
  189. package/models/operations/updateagent.js.map +1 -0
  190. package/models/operations/updatephoneagent.d.ts +75 -0
  191. package/models/operations/updatephoneagent.d.ts.map +1 -0
  192. package/models/operations/updatephoneagent.js +116 -0
  193. package/models/operations/updatephoneagent.js.map +1 -0
  194. package/package.json +27 -30
  195. package/sdk/index.d.ts +3 -0
  196. package/sdk/index.d.ts.map +1 -0
  197. package/{dist/sdk → sdk}/index.js +2 -0
  198. package/sdk/index.js.map +1 -0
  199. package/sdk/liveClient.d.ts +14 -0
  200. package/sdk/liveClient.d.ts.map +1 -0
  201. package/sdk/liveClient.js +98 -0
  202. package/sdk/liveClient.js.map +1 -0
  203. package/sdk/sdk.d.ts +62 -0
  204. package/sdk/sdk.d.ts.map +1 -0
  205. package/sdk/sdk.js +1137 -0
  206. package/sdk/sdk.js.map +1 -0
  207. package/src/example.ts +79 -0
  208. package/src/index.ts +6 -0
  209. package/src/lib/base64.ts +37 -0
  210. package/src/lib/config.ts +57 -0
  211. package/src/lib/encodings.ts +379 -0
  212. package/src/lib/http.ts +203 -0
  213. package/src/lib/retries.ts +207 -0
  214. package/src/lib/sdks.ts +107 -0
  215. package/src/lib/security.ts +164 -0
  216. package/src/lib/url.ts +31 -0
  217. package/src/models/components/agent.ts +356 -0
  218. package/src/models/components/agentpromptparams.ts +53 -0
  219. package/src/models/components/calldetail.ts +160 -0
  220. package/src/models/components/callphonenumber.ts +56 -0
  221. package/src/models/components/index.ts +10 -0
  222. package/src/models/components/phonenumber.ts +83 -0
  223. package/src/models/components/security.ts +7 -0
  224. package/src/models/errors/createagent.ts +394 -0
  225. package/src/models/errors/createphonecall.ts +597 -0
  226. package/src/models/errors/createphonenumber.ts +500 -0
  227. package/src/models/errors/deleteagent.ts +394 -0
  228. package/src/models/errors/deletephonenumber.ts +400 -0
  229. package/src/models/errors/getagent.ts +383 -0
  230. package/src/models/errors/getcall.ts +379 -0
  231. package/src/models/errors/getphonenumber.ts +397 -0
  232. package/src/models/errors/index.ts +18 -0
  233. package/src/models/errors/listagents.ts +192 -0
  234. package/src/models/errors/listcalls.ts +289 -0
  235. package/src/models/errors/listphonenumbers.ts +297 -0
  236. package/src/models/errors/sdkerror.ts +24 -0
  237. package/src/models/errors/updateagent.ts +394 -0
  238. package/src/models/errors/updatephoneagent.ts +397 -0
  239. package/src/models/operations/createagent.ts +145 -0
  240. package/src/models/operations/createphonecall.ts +308 -0
  241. package/src/models/operations/createphonenumber.ts +124 -0
  242. package/src/models/operations/createwebcall.ts +16 -0
  243. package/src/models/operations/deleteagent.ts +103 -0
  244. package/src/models/operations/deletephonenumber.ts +103 -0
  245. package/src/models/operations/getagent.ts +114 -0
  246. package/src/models/operations/getcall.ts +114 -0
  247. package/src/models/operations/getphonenumber.ts +114 -0
  248. package/src/models/operations/index.ts +18 -0
  249. package/src/models/operations/listagents.ts +76 -0
  250. package/src/models/operations/listcalls.ts +255 -0
  251. package/src/models/operations/listphonenumbers.ts +76 -0
  252. package/src/models/operations/updateagent.ts +190 -0
  253. package/src/models/operations/updatephoneagent.ts +159 -0
  254. package/src/sdk/index.ts +6 -0
  255. package/src/sdk/liveClient.ts +109 -0
  256. package/src/sdk/sdk.ts +1191 -0
  257. package/src/types/blobs.ts +30 -0
  258. package/src/types/decimal.ts +5 -0
  259. package/src/types/index.ts +8 -0
  260. package/src/types/operations.ts +6 -0
  261. package/src/types/rfcdate.ts +54 -0
  262. package/types/blobs.d.ts +4 -0
  263. package/types/blobs.d.ts.map +1 -0
  264. package/types/blobs.js +52 -0
  265. package/types/blobs.js.map +1 -0
  266. package/types/decimal.d.ts +2 -0
  267. package/types/decimal.d.ts.map +1 -0
  268. package/{dist/types/index.js → types/decimal.js} +2 -1
  269. package/types/decimal.js.map +1 -0
  270. package/types/index.d.ts +5 -0
  271. package/types/index.d.ts.map +1 -0
  272. package/types/index.js +14 -0
  273. package/types/index.js.map +1 -0
  274. package/types/operations.d.ts +5 -0
  275. package/types/operations.d.ts.map +1 -0
  276. package/types/operations.js +6 -0
  277. package/types/operations.js.map +1 -0
  278. package/types/rfcdate.d.ts +21 -0
  279. package/types/rfcdate.d.ts.map +1 -0
  280. package/types/rfcdate.js +46 -0
  281. package/types/rfcdate.js.map +1 -0
  282. package/dist/index.d.ts +0 -1
  283. package/dist/internal/utils/contenttype.d.ts +0 -1
  284. package/dist/internal/utils/contenttype.js +0 -33
  285. package/dist/internal/utils/headers.d.ts +0 -4
  286. package/dist/internal/utils/headers.js +0 -92
  287. package/dist/internal/utils/index.d.ts +0 -8
  288. package/dist/internal/utils/index.js +0 -27
  289. package/dist/internal/utils/pathparams.d.ts +0 -2
  290. package/dist/internal/utils/pathparams.js +0 -53
  291. package/dist/internal/utils/queryparams.d.ts +0 -2
  292. package/dist/internal/utils/queryparams.js +0 -182
  293. package/dist/internal/utils/requestbody.d.ts +0 -2
  294. package/dist/internal/utils/requestbody.js +0 -328
  295. package/dist/internal/utils/retries.d.ts +0 -20
  296. package/dist/internal/utils/retries.js +0 -250
  297. package/dist/internal/utils/security.d.ts +0 -5
  298. package/dist/internal/utils/security.js +0 -196
  299. package/dist/internal/utils/utils.d.ts +0 -37
  300. package/dist/internal/utils/utils.js +0 -368
  301. package/dist/models/components/agent.d.ts +0 -43
  302. package/dist/models/components/agent.js +0 -90
  303. package/dist/models/components/agentnodefaultnorequired.d.ts +0 -35
  304. package/dist/models/components/agentnodefaultnorequired.js +0 -80
  305. package/dist/models/components/agentpromptparams.d.ts +0 -11
  306. package/dist/models/components/agentpromptparams.js +0 -50
  307. package/dist/models/components/calldetail.d.ts +0 -58
  308. package/dist/models/components/calldetail.js +0 -112
  309. package/dist/models/components/callphonenumber.d.ts +0 -14
  310. package/dist/models/components/callphonenumber.js +0 -53
  311. package/dist/models/components/phonenumber.js +0 -65
  312. package/dist/models/components/security.d.ts +0 -4
  313. package/dist/models/components/security.js +0 -45
  314. package/dist/models/errors/createagent.d.ts +0 -45
  315. package/dist/models/errors/createagent.js +0 -144
  316. package/dist/models/errors/createphonecall.d.ts +0 -67
  317. package/dist/models/errors/createphonecall.js +0 -200
  318. package/dist/models/errors/createphonenumber.d.ts +0 -56
  319. package/dist/models/errors/createphonenumber.js +0 -172
  320. package/dist/models/errors/deleteagent.d.ts +0 -45
  321. package/dist/models/errors/deleteagent.js +0 -144
  322. package/dist/models/errors/deletephonenumber.d.ts +0 -45
  323. package/dist/models/errors/deletephonenumber.js +0 -144
  324. package/dist/models/errors/getagent.d.ts +0 -45
  325. package/dist/models/errors/getagent.js +0 -144
  326. package/dist/models/errors/getcall.d.ts +0 -45
  327. package/dist/models/errors/getcall.js +0 -144
  328. package/dist/models/errors/getphonenumber.d.ts +0 -45
  329. package/dist/models/errors/getphonenumber.js +0 -144
  330. package/dist/models/errors/listagents.d.ts +0 -23
  331. package/dist/models/errors/listagents.js +0 -88
  332. package/dist/models/errors/listcalls.d.ts +0 -34
  333. package/dist/models/errors/listcalls.js +0 -116
  334. package/dist/models/errors/listphonenumbers.d.ts +0 -34
  335. package/dist/models/errors/listphonenumbers.js +0 -116
  336. package/dist/models/errors/sdkerror.d.ts +0 -7
  337. package/dist/models/errors/sdkerror.js +0 -40
  338. package/dist/models/errors/updateagent.d.ts +0 -45
  339. package/dist/models/errors/updateagent.js +0 -144
  340. package/dist/models/errors/updatephoneagent.d.ts +0 -45
  341. package/dist/models/errors/updatephoneagent.js +0 -144
  342. package/dist/models/operations/createagent.d.ts +0 -55
  343. package/dist/models/operations/createagent.js +0 -128
  344. package/dist/models/operations/createphonecall.d.ts +0 -87
  345. package/dist/models/operations/createphonecall.js +0 -187
  346. package/dist/models/operations/createphonenumber.d.ts +0 -31
  347. package/dist/models/operations/createphonenumber.js +0 -98
  348. package/dist/models/operations/deleteagent.d.ts +0 -22
  349. package/dist/models/operations/deleteagent.js +0 -63
  350. package/dist/models/operations/deletephonenumber.d.ts +0 -22
  351. package/dist/models/operations/deletephonenumber.js +0 -63
  352. package/dist/models/operations/getagent.d.ts +0 -27
  353. package/dist/models/operations/getagent.js +0 -91
  354. package/dist/models/operations/getcall.d.ts +0 -27
  355. package/dist/models/operations/getcall.js +0 -91
  356. package/dist/models/operations/getphonenumber.d.ts +0 -27
  357. package/dist/models/operations/getphonenumber.js +0 -91
  358. package/dist/models/operations/listagents.d.ts +0 -21
  359. package/dist/models/operations/listagents.js +0 -79
  360. package/dist/models/operations/listcalls.d.ts +0 -70
  361. package/dist/models/operations/listcalls.js +0 -145
  362. package/dist/models/operations/listphonenumbers.d.ts +0 -21
  363. package/dist/models/operations/listphonenumbers.js +0 -79
  364. package/dist/models/operations/updateagent.d.ts +0 -28
  365. package/dist/models/operations/updateagent.js +0 -95
  366. package/dist/models/operations/updatephoneagent.d.ts +0 -34
  367. package/dist/models/operations/updatephoneagent.js +0 -109
  368. package/dist/sdk/index.d.ts +0 -1
  369. package/dist/sdk/sdk.d.ts +0 -115
  370. package/dist/sdk/sdk.js +0 -1625
  371. package/dist/types/index.d.ts +0 -1
  372. package/dist/types/rfcdate.d.ts +0 -9
  373. package/dist/types/rfcdate.js +0 -59
  374. package/docs/models/components/agent.md +0 -17
  375. package/docs/models/components/agentnodefaultnorequired.md +0 -15
  376. package/docs/models/components/agentpromptparams.md +0 -9
  377. package/docs/models/components/calldetail.md +0 -17
  378. package/docs/models/components/callphonenumber.md +0 -11
  379. package/docs/models/components/callstatus.md +0 -12
  380. package/docs/models/components/calltype.md +0 -12
  381. package/docs/models/components/phonenumber.md +0 -12
  382. package/docs/models/components/security.md +0 -8
  383. package/docs/models/errors/createagentresponse422responsebody.md +0 -11
  384. package/docs/models/errors/createagentresponse500responsebody.md +0 -11
  385. package/docs/models/errors/createagentresponsebody.md +0 -11
  386. package/docs/models/errors/createagentresponseresponsebody.md +0 -11
  387. package/docs/models/errors/createphonecallresponse402responsebody.md +0 -11
  388. package/docs/models/errors/createphonecallresponse422responsebody.md +0 -11
  389. package/docs/models/errors/createphonecallresponse429responsebody.md +0 -11
  390. package/docs/models/errors/createphonecallresponse500responsebody.md +0 -11
  391. package/docs/models/errors/createphonecallresponsebody.md +0 -11
  392. package/docs/models/errors/createphonecallresponseresponsebody.md +0 -11
  393. package/docs/models/errors/createphonenumberresponse402responsebody.md +0 -11
  394. package/docs/models/errors/createphonenumberresponse422responsebody.md +0 -11
  395. package/docs/models/errors/createphonenumberresponse500responsebody.md +0 -11
  396. package/docs/models/errors/createphonenumberresponsebody.md +0 -11
  397. package/docs/models/errors/createphonenumberresponseresponsebody.md +0 -11
  398. package/docs/models/errors/deleteagentresponse422responsebody.md +0 -11
  399. package/docs/models/errors/deleteagentresponse500responsebody.md +0 -11
  400. package/docs/models/errors/deleteagentresponsebody.md +0 -11
  401. package/docs/models/errors/deleteagentresponseresponsebody.md +0 -11
  402. package/docs/models/errors/deletephonenumberresponse422responsebody.md +0 -11
  403. package/docs/models/errors/deletephonenumberresponse500responsebody.md +0 -11
  404. package/docs/models/errors/deletephonenumberresponsebody.md +0 -11
  405. package/docs/models/errors/deletephonenumberresponseresponsebody.md +0 -11
  406. package/docs/models/errors/getagentresponse422responsebody.md +0 -11
  407. package/docs/models/errors/getagentresponse500responsebody.md +0 -11
  408. package/docs/models/errors/getagentresponsebody.md +0 -11
  409. package/docs/models/errors/getagentresponseresponsebody.md +0 -11
  410. package/docs/models/errors/getcallresponse422responsebody.md +0 -11
  411. package/docs/models/errors/getcallresponse500responsebody.md +0 -11
  412. package/docs/models/errors/getcallresponsebody.md +0 -11
  413. package/docs/models/errors/getcallresponseresponsebody.md +0 -11
  414. package/docs/models/errors/getphonenumberresponse422responsebody.md +0 -11
  415. package/docs/models/errors/getphonenumberresponse500responsebody.md +0 -11
  416. package/docs/models/errors/getphonenumberresponsebody.md +0 -11
  417. package/docs/models/errors/getphonenumberresponseresponsebody.md +0 -11
  418. package/docs/models/errors/listagentsresponsebody.md +0 -11
  419. package/docs/models/errors/listagentsresponseresponsebody.md +0 -11
  420. package/docs/models/errors/listcallsresponse500responsebody.md +0 -11
  421. package/docs/models/errors/listcallsresponsebody.md +0 -11
  422. package/docs/models/errors/listcallsresponseresponsebody.md +0 -11
  423. package/docs/models/errors/listphonenumbersresponse500responsebody.md +0 -11
  424. package/docs/models/errors/listphonenumbersresponsebody.md +0 -11
  425. package/docs/models/errors/listphonenumbersresponseresponsebody.md +0 -11
  426. package/docs/models/errors/updateagentresponse422responsebody.md +0 -11
  427. package/docs/models/errors/updateagentresponse500responsebody.md +0 -11
  428. package/docs/models/errors/updateagentresponsebody.md +0 -11
  429. package/docs/models/errors/updateagentresponseresponsebody.md +0 -11
  430. package/docs/models/errors/updatephoneagentresponse422responsebody.md +0 -11
  431. package/docs/models/errors/updatephoneagentresponse500responsebody.md +0 -11
  432. package/docs/models/errors/updatephoneagentresponsebody.md +0 -11
  433. package/docs/models/errors/updatephoneagentresponseresponsebody.md +0 -11
  434. package/docs/models/operations/callstatus.md +0 -12
  435. package/docs/models/operations/calltype.md +0 -10
  436. package/docs/models/operations/createagentrequestbody.md +0 -15
  437. package/docs/models/operations/createagentresponse.md +0 -11
  438. package/docs/models/operations/createphonecallcalltype.md +0 -12
  439. package/docs/models/operations/createphonecallrequestbody.md +0 -9
  440. package/docs/models/operations/createphonecallresponse.md +0 -11
  441. package/docs/models/operations/createphonecallresponsebody.md +0 -16
  442. package/docs/models/operations/createphonenumberrequestbody.md +0 -9
  443. package/docs/models/operations/createphonenumberresponse.md +0 -11
  444. package/docs/models/operations/deleteagentrequest.md +0 -8
  445. package/docs/models/operations/deleteagentresponse.md +0 -10
  446. package/docs/models/operations/deletephonenumberrequest.md +0 -8
  447. package/docs/models/operations/deletephonenumberresponse.md +0 -10
  448. package/docs/models/operations/filtercriteria.md +0 -13
  449. package/docs/models/operations/getagentrequest.md +0 -8
  450. package/docs/models/operations/getagentresponse.md +0 -11
  451. package/docs/models/operations/getcallrequest.md +0 -8
  452. package/docs/models/operations/getcallresponse.md +0 -11
  453. package/docs/models/operations/getphonenumberrequest.md +0 -8
  454. package/docs/models/operations/getphonenumberresponse.md +0 -11
  455. package/docs/models/operations/listagentsresponse.md +0 -11
  456. package/docs/models/operations/listcallsrequest.md +0 -10
  457. package/docs/models/operations/listcallsresponse.md +0 -11
  458. package/docs/models/operations/listphonenumbersresponse.md +0 -11
  459. package/docs/models/operations/phonenumber.md +0 -11
  460. package/docs/models/operations/sortorder.md +0 -11
  461. package/docs/models/operations/updateagentrequest.md +0 -9
  462. package/docs/models/operations/updateagentresponse.md +0 -11
  463. package/docs/models/operations/updatephoneagentrequest.md +0 -9
  464. package/docs/models/operations/updatephoneagentrequestbody.md +0 -8
  465. package/docs/models/operations/updatephoneagentresponse.md +0 -11
  466. package/docs/sdks/retellclient/README.md +0 -673
@@ -1,673 +0,0 @@
1
- # RetellClient SDK
2
-
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createAgent](#createagent) - Create a new agent
9
- * [createPhoneCall](#createphonecall) - Initiate an outbound phone call.
10
- * [createPhoneNumber](#createphonenumber) - Create a new phone number
11
- * [deleteAgent](#deleteagent) - Delete an existing agent
12
- * [deletePhoneNumber](#deletephonenumber) - Delete a specific phone number
13
- * [getAgent](#getagent) - Retrieve details of a specific agent
14
- * [getCall](#getcall) - Retrieve details of a specific call
15
- * [getPhoneNumber](#getphonenumber) - Retrieve info about a specific number
16
- * [listAgents](#listagents) - List all agents
17
- * [listCalls](#listcalls) - Retrieve call details
18
- * [listPhoneNumbers](#listphonenumbers) - List all purchased and active phone numbers
19
- * [updateAgent](#updateagent) - Update an existing agent
20
- * [updatePhoneAgent](#updatephoneagent) - Update an existing phone number
21
-
22
- ## createAgent
23
-
24
- Create a new agent
25
-
26
- ### Example Usage
27
-
28
- ```typescript
29
- import { RetellClient } from "retell-sdk";
30
-
31
- async function run() {
32
- const sdk = new RetellClient({
33
- apiKey: "",
34
- });
35
-
36
- const res = await sdk.createAgent({
37
- agentName: "Jarvis",
38
- beginMessage: "Hello there, how can I help you?",
39
- enableBeginMessage: true,
40
- enableEndCall: true,
41
- enableEndMessage: false,
42
- endMessage: "Hope you have a good day, goodbye.",
43
- prompt: "You are a marketing assistant. You help come up with creative content ideas and content like marketing emails, blog posts, tweets, ad copy and product descriptions. You respond concisely, with filler words in it.",
44
- voiceId: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
45
- });
46
-
47
- if (res.statusCode == 200) {
48
- // handle response
49
- }
50
- }
51
-
52
- run();
53
- ```
54
-
55
- ### Parameters
56
-
57
- | Parameter | Type | Required | Description |
58
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
59
- | `request` | [operations.CreateAgentRequestBody](../../models/operations/createagentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
60
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
61
-
62
-
63
- ### Response
64
-
65
- **Promise<[operations.CreateAgentResponse](../../models/operations/createagentresponse.md)>**
66
- ### Errors
67
-
68
- | Error Object | Status Code | Content Type |
69
- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
70
- | errors.CreateAgentResponseBody | 400 | application/json |
71
- | errors.CreateAgentResponseResponseBody | 401 | application/json |
72
- | errors.CreateAgentResponse422ResponseBody | 422 | application/json |
73
- | errors.CreateAgentResponse500ResponseBody | 500 | application/json |
74
- | errors.SDKError | 400-600 | */* |
75
-
76
- ## createPhoneCall
77
-
78
- Initiate an outbound phone call.
79
-
80
- ### Example Usage
81
-
82
- ```typescript
83
- import { RetellClient } from "retell-sdk";
84
-
85
- async function run() {
86
- const sdk = new RetellClient({
87
- apiKey: "",
88
- });
89
-
90
- const res = await sdk.createPhoneCall({
91
- agentPromptParams: [
92
- {
93
- name: "username",
94
- value: "Adam",
95
- },
96
- ],
97
- phoneNumber: {
98
- from: "+14159095857",
99
- to: "+14159095858",
100
- },
101
- });
102
-
103
- if (res.statusCode == 200) {
104
- // handle response
105
- }
106
- }
107
-
108
- run();
109
- ```
110
-
111
- ### Parameters
112
-
113
- | Parameter | Type | Required | Description |
114
- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
115
- | `request` | [operations.CreatePhoneCallRequestBody](../../models/operations/createphonecallrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
116
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
117
-
118
-
119
- ### Response
120
-
121
- **Promise<[operations.CreatePhoneCallResponse](../../models/operations/createphonecallresponse.md)>**
122
- ### Errors
123
-
124
- | Error Object | Status Code | Content Type |
125
- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
126
- | errors.CreatePhoneCallResponseBody | 400 | application/json |
127
- | errors.CreatePhoneCallResponseResponseBody | 401 | application/json |
128
- | errors.CreatePhoneCallResponse402ResponseBody | 402 | application/json |
129
- | errors.CreatePhoneCallResponse422ResponseBody | 422 | application/json |
130
- | errors.CreatePhoneCallResponse429ResponseBody | 429 | application/json |
131
- | errors.CreatePhoneCallResponse500ResponseBody | 500 | application/json |
132
- | errors.SDKError | 400-600 | */* |
133
-
134
- ## createPhoneNumber
135
-
136
- Create a new phone number
137
-
138
- ### Example Usage
139
-
140
- ```typescript
141
- import { RetellClient } from "retell-sdk";
142
-
143
- async function run() {
144
- const sdk = new RetellClient({
145
- apiKey: "",
146
- });
147
-
148
- const res = await sdk.createPhoneNumber({
149
- agentId: "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
150
- areaCode: 415,
151
- });
152
-
153
- if (res.statusCode == 200) {
154
- // handle response
155
- }
156
- }
157
-
158
- run();
159
- ```
160
-
161
- ### Parameters
162
-
163
- | Parameter | Type | Required | Description |
164
- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
165
- | `request` | [operations.CreatePhoneNumberRequestBody](../../models/operations/createphonenumberrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
166
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
167
-
168
-
169
- ### Response
170
-
171
- **Promise<[operations.CreatePhoneNumberResponse](../../models/operations/createphonenumberresponse.md)>**
172
- ### Errors
173
-
174
- | Error Object | Status Code | Content Type |
175
- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
176
- | errors.CreatePhoneNumberResponseBody | 400 | application/json |
177
- | errors.CreatePhoneNumberResponseResponseBody | 401 | application/json |
178
- | errors.CreatePhoneNumberResponse402ResponseBody | 402 | application/json |
179
- | errors.CreatePhoneNumberResponse422ResponseBody | 422 | application/json |
180
- | errors.CreatePhoneNumberResponse500ResponseBody | 500 | application/json |
181
- | errors.SDKError | 400-600 | */* |
182
-
183
- ## deleteAgent
184
-
185
- Delete an existing agent
186
-
187
- ### Example Usage
188
-
189
- ```typescript
190
- import { RetellClient } from "retell-sdk";
191
- import { DeleteAgentRequest } from "retell-sdk/dist/models/operations";
192
-
193
- async function run() {
194
- const sdk = new RetellClient({
195
- apiKey: "",
196
- });
197
- const agentId: string = "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD";
198
-
199
- const res = await sdk.deleteAgent(agentId);
200
-
201
- if (res.statusCode == 200) {
202
- // handle response
203
- }
204
- }
205
-
206
- run();
207
- ```
208
-
209
- ### Parameters
210
-
211
- | Parameter | Type | Required | Description | Example |
212
- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
213
- | `agentId` | *string* | :heavy_check_mark: | Unique id of the agent to be deleted. | oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD |
214
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | |
215
-
216
-
217
- ### Response
218
-
219
- **Promise<[operations.DeleteAgentResponse](../../models/operations/deleteagentresponse.md)>**
220
- ### Errors
221
-
222
- | Error Object | Status Code | Content Type |
223
- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
224
- | errors.DeleteAgentResponseBody | 400 | application/json |
225
- | errors.DeleteAgentResponseResponseBody | 401 | application/json |
226
- | errors.DeleteAgentResponse422ResponseBody | 422 | application/json |
227
- | errors.DeleteAgentResponse500ResponseBody | 500 | application/json |
228
- | errors.SDKError | 400-600 | */* |
229
-
230
- ## deletePhoneNumber
231
-
232
- Delete a specific phone number
233
-
234
- ### Example Usage
235
-
236
- ```typescript
237
- import { RetellClient } from "retell-sdk";
238
- import { DeletePhoneNumberRequest } from "retell-sdk/dist/models/operations";
239
-
240
- async function run() {
241
- const sdk = new RetellClient({
242
- apiKey: "",
243
- });
244
- const phoneNumber: string = "string";
245
-
246
- const res = await sdk.deletePhoneNumber(phoneNumber);
247
-
248
- if (res.statusCode == 200) {
249
- // handle response
250
- }
251
- }
252
-
253
- run();
254
- ```
255
-
256
- ### Parameters
257
-
258
- | Parameter | Type | Required | Description |
259
- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
260
- | `phoneNumber` | *string* | :heavy_check_mark: | Phone number to delete in E.164 format. |
261
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
262
-
263
-
264
- ### Response
265
-
266
- **Promise<[operations.DeletePhoneNumberResponse](../../models/operations/deletephonenumberresponse.md)>**
267
- ### Errors
268
-
269
- | Error Object | Status Code | Content Type |
270
- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
271
- | errors.DeletePhoneNumberResponseBody | 400 | application/json |
272
- | errors.DeletePhoneNumberResponseResponseBody | 401 | application/json |
273
- | errors.DeletePhoneNumberResponse422ResponseBody | 422 | application/json |
274
- | errors.DeletePhoneNumberResponse500ResponseBody | 500 | application/json |
275
- | errors.SDKError | 400-600 | */* |
276
-
277
- ## getAgent
278
-
279
- Retrieve details of a specific agent
280
-
281
- ### Example Usage
282
-
283
- ```typescript
284
- import { RetellClient } from "retell-sdk";
285
- import { GetAgentRequest } from "retell-sdk/dist/models/operations";
286
-
287
- async function run() {
288
- const sdk = new RetellClient({
289
- apiKey: "",
290
- });
291
- const agentId: string = "16b980523634a6dc504898cda492e939";
292
-
293
- const res = await sdk.getAgent(agentId);
294
-
295
- if (res.statusCode == 200) {
296
- // handle response
297
- }
298
- }
299
-
300
- run();
301
- ```
302
-
303
- ### Parameters
304
-
305
- | Parameter | Type | Required | Description | Example |
306
- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
307
- | `agentId` | *string* | :heavy_check_mark: | Unique id of the agent to be retrieved. | 16b980523634a6dc504898cda492e939 |
308
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | |
309
-
310
-
311
- ### Response
312
-
313
- **Promise<[operations.GetAgentResponse](../../models/operations/getagentresponse.md)>**
314
- ### Errors
315
-
316
- | Error Object | Status Code | Content Type |
317
- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
318
- | errors.GetAgentResponseBody | 400 | application/json |
319
- | errors.GetAgentResponseResponseBody | 401 | application/json |
320
- | errors.GetAgentResponse422ResponseBody | 422 | application/json |
321
- | errors.GetAgentResponse500ResponseBody | 500 | application/json |
322
- | errors.SDKError | 400-600 | */* |
323
-
324
- ## getCall
325
-
326
- Retrieve details of a specific call
327
-
328
- ### Example Usage
329
-
330
- ```typescript
331
- import { RetellClient } from "retell-sdk";
332
- import { GetCallRequest } from "retell-sdk/dist/models/operations";
333
-
334
- async function run() {
335
- const sdk = new RetellClient({
336
- apiKey: "",
337
- });
338
- const callId: string = "119c3f8e47135a29e65947eeb34cf12d";
339
-
340
- const res = await sdk.getCall(callId);
341
-
342
- if (res.statusCode == 200) {
343
- // handle response
344
- }
345
- }
346
-
347
- run();
348
- ```
349
-
350
- ### Parameters
351
-
352
- | Parameter | Type | Required | Description | Example |
353
- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
354
- | `callId` | *string* | :heavy_check_mark: | The call id to retrieve call history for. | 119c3f8e47135a29e65947eeb34cf12d |
355
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | |
356
-
357
-
358
- ### Response
359
-
360
- **Promise<[operations.GetCallResponse](../../models/operations/getcallresponse.md)>**
361
- ### Errors
362
-
363
- | Error Object | Status Code | Content Type |
364
- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
365
- | errors.GetCallResponseBody | 400 | application/json |
366
- | errors.GetCallResponseResponseBody | 401 | application/json |
367
- | errors.GetCallResponse422ResponseBody | 422 | application/json |
368
- | errors.GetCallResponse500ResponseBody | 500 | application/json |
369
- | errors.SDKError | 400-600 | */* |
370
-
371
- ## getPhoneNumber
372
-
373
- Retrieve info about a specific number
374
-
375
- ### Example Usage
376
-
377
- ```typescript
378
- import { RetellClient } from "retell-sdk";
379
- import { GetPhoneNumberRequest } from "retell-sdk/dist/models/operations";
380
-
381
- async function run() {
382
- const sdk = new RetellClient({
383
- apiKey: "",
384
- });
385
- const phoneNumber: string = "+14159095857";
386
-
387
- const res = await sdk.getPhoneNumber(phoneNumber);
388
-
389
- if (res.statusCode == 200) {
390
- // handle response
391
- }
392
- }
393
-
394
- run();
395
- ```
396
-
397
- ### Parameters
398
-
399
- | Parameter | Type | Required | Description | Example |
400
- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
401
- | `phoneNumber` | *string* | :heavy_check_mark: | Phone number in E.164 format to retreive more information. | +14159095857 |
402
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | |
403
-
404
-
405
- ### Response
406
-
407
- **Promise<[operations.GetPhoneNumberResponse](../../models/operations/getphonenumberresponse.md)>**
408
- ### Errors
409
-
410
- | Error Object | Status Code | Content Type |
411
- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
412
- | errors.GetPhoneNumberResponseBody | 400 | application/json |
413
- | errors.GetPhoneNumberResponseResponseBody | 401 | application/json |
414
- | errors.GetPhoneNumberResponse422ResponseBody | 422 | application/json |
415
- | errors.GetPhoneNumberResponse500ResponseBody | 500 | application/json |
416
- | errors.SDKError | 400-600 | */* |
417
-
418
- ## listAgents
419
-
420
- List all agents
421
-
422
- ### Example Usage
423
-
424
- ```typescript
425
- import { RetellClient } from "retell-sdk";
426
-
427
- async function run() {
428
- const sdk = new RetellClient({
429
- apiKey: "",
430
- });
431
-
432
- const res = await sdk.listAgents();
433
-
434
- if (res.statusCode == 200) {
435
- // handle response
436
- }
437
- }
438
-
439
- run();
440
- ```
441
-
442
- ### Parameters
443
-
444
- | Parameter | Type | Required | Description |
445
- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
446
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
447
-
448
-
449
- ### Response
450
-
451
- **Promise<[operations.ListAgentsResponse](../../models/operations/listagentsresponse.md)>**
452
- ### Errors
453
-
454
- | Error Object | Status Code | Content Type |
455
- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
456
- | errors.ListAgentsResponseBody | 401 | application/json |
457
- | errors.ListAgentsResponseResponseBody | 500 | application/json |
458
- | errors.SDKError | 400-600 | */* |
459
-
460
- ## listCalls
461
-
462
- Retrieve call details
463
-
464
- ### Example Usage
465
-
466
- ```typescript
467
- import { RetellClient } from "retell-sdk";
468
- import { CallType, FilterCriteria, ListCallsRequest, SortOrder } from "retell-sdk/dist/models/operations";
469
-
470
- async function run() {
471
- const sdk = new RetellClient({
472
- apiKey: "",
473
- });
474
- const filterCriteria: FilterCriteria = {
475
- afterEndTimestamp: 1703302428800,
476
- afterStartTimestamp: 1703302407300,
477
- agentId: [
478
- "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
479
- ],
480
- beforeEndTimestamp: 1703302428899,
481
- beforeStartTimestamp: 1703302407399,
482
- callType: [
483
- CallType.InboundPhoneCall,
484
- CallType.OutboundPhoneCall,
485
- ],
486
- };
487
- const limit: number = 666195;
488
- const sortOrder: SortOrder = SortOrder.Descending;
489
-
490
- const res = await sdk.listCalls(filterCriteria, limit, sortOrder);
491
-
492
- if (res.statusCode == 200) {
493
- // handle response
494
- }
495
- }
496
-
497
- run();
498
- ```
499
-
500
- ### Parameters
501
-
502
- | Parameter | Type | Required | Description |
503
- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
504
- | `filterCriteria` | [operations.FilterCriteria](../../models/operations/filtercriteria.md) | :heavy_minus_sign: | N/A |
505
- | `limit` | *number* | :heavy_minus_sign: | Limit the number of calls returned. |
506
- | `sortOrder` | [operations.SortOrder](../../models/operations/sortorder.md) | :heavy_minus_sign: | The calls will be sorted by `start_timestamp`, whether to return the calls in ascending or descending order. |
507
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
508
-
509
-
510
- ### Response
511
-
512
- **Promise<[operations.ListCallsResponse](../../models/operations/listcallsresponse.md)>**
513
- ### Errors
514
-
515
- | Error Object | Status Code | Content Type |
516
- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
517
- | errors.ListCallsResponseBody | 400 | application/json |
518
- | errors.ListCallsResponseResponseBody | 401 | application/json |
519
- | errors.ListCallsResponse500ResponseBody | 500 | application/json |
520
- | errors.SDKError | 400-600 | */* |
521
-
522
- ## listPhoneNumbers
523
-
524
- List all purchased and active phone numbers
525
-
526
- ### Example Usage
527
-
528
- ```typescript
529
- import { RetellClient } from "retell-sdk";
530
-
531
- async function run() {
532
- const sdk = new RetellClient({
533
- apiKey: "",
534
- });
535
-
536
- const res = await sdk.listPhoneNumbers();
537
-
538
- if (res.statusCode == 200) {
539
- // handle response
540
- }
541
- }
542
-
543
- run();
544
- ```
545
-
546
- ### Parameters
547
-
548
- | Parameter | Type | Required | Description |
549
- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
550
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
551
-
552
-
553
- ### Response
554
-
555
- **Promise<[operations.ListPhoneNumbersResponse](../../models/operations/listphonenumbersresponse.md)>**
556
- ### Errors
557
-
558
- | Error Object | Status Code | Content Type |
559
- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
560
- | errors.ListPhoneNumbersResponseBody | 400 | application/json |
561
- | errors.ListPhoneNumbersResponseResponseBody | 401 | application/json |
562
- | errors.ListPhoneNumbersResponse500ResponseBody | 500 | application/json |
563
- | errors.SDKError | 400-600 | */* |
564
-
565
- ## updateAgent
566
-
567
- Update an existing agent
568
-
569
- ### Example Usage
570
-
571
- ```typescript
572
- import { RetellClient } from "retell-sdk";
573
- import { AgentNoDefaultNoRequired } from "retell-sdk/dist/models/components";
574
- import { UpdateAgentRequest } from "retell-sdk/dist/models/operations";
575
-
576
- async function run() {
577
- const sdk = new RetellClient({
578
- apiKey: "",
579
- });
580
- const agentNoDefaultNoRequired: AgentNoDefaultNoRequired = {
581
- agentName: "Jarvis",
582
- beginMessage: "Hello there, how can I help you.",
583
- enableBeginMessage: true,
584
- enableEndCall: true,
585
- enableEndMessage: false,
586
- endMessage: "Hope you have a good day, goodbye.",
587
- prompt: "You are a marketing assistant. You help come up with creative content ideas and content like marketing emails, blog posts, tweets, ad copy and product descriptions. You respond concisely, with filler words in it.",
588
- voiceId: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
589
- };
590
- const agentId: string = "16b980523634a6dc504898cda492e939";
591
-
592
- const res = await sdk.updateAgent(agentNoDefaultNoRequired, agentId);
593
-
594
- if (res.statusCode == 200) {
595
- // handle response
596
- }
597
- }
598
-
599
- run();
600
- ```
601
-
602
- ### Parameters
603
-
604
- | Parameter | Type | Required | Description | Example |
605
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
606
- | `agentNoDefaultNoRequired` | [components.AgentNoDefaultNoRequired](../../models/components/agentnodefaultnorequired.md) | :heavy_check_mark: | N/A | |
607
- | `agentId` | *string* | :heavy_check_mark: | Unique id of the agent to be updated. | 16b980523634a6dc504898cda492e939 |
608
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | |
609
-
610
-
611
- ### Response
612
-
613
- **Promise<[operations.UpdateAgentResponse](../../models/operations/updateagentresponse.md)>**
614
- ### Errors
615
-
616
- | Error Object | Status Code | Content Type |
617
- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
618
- | errors.UpdateAgentResponseBody | 400 | application/json |
619
- | errors.UpdateAgentResponseResponseBody | 401 | application/json |
620
- | errors.UpdateAgentResponse422ResponseBody | 422 | application/json |
621
- | errors.UpdateAgentResponse500ResponseBody | 500 | application/json |
622
- | errors.SDKError | 400-600 | */* |
623
-
624
- ## updatePhoneAgent
625
-
626
- Update an existing phone number
627
-
628
- ### Example Usage
629
-
630
- ```typescript
631
- import { RetellClient } from "retell-sdk";
632
- import { UpdatePhoneAgentRequest, UpdatePhoneAgentRequestBody } from "retell-sdk/dist/models/operations";
633
-
634
- async function run() {
635
- const sdk = new RetellClient({
636
- apiKey: "",
637
- });
638
- const requestBody: UpdatePhoneAgentRequestBody = {
639
- agentId: "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
640
- };
641
- const phoneNumber: string = "+14159095857";
642
-
643
- const res = await sdk.updatePhoneAgent(requestBody, phoneNumber);
644
-
645
- if (res.statusCode == 200) {
646
- // handle response
647
- }
648
- }
649
-
650
- run();
651
- ```
652
-
653
- ### Parameters
654
-
655
- | Parameter | Type | Required | Description | Example |
656
- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
657
- | `requestBody` | [operations.UpdatePhoneAgentRequestBody](../../models/operations/updatephoneagentrequestbody.md) | :heavy_check_mark: | N/A | |
658
- | `phoneNumber` | *string* | :heavy_check_mark: | Phone number in E.164 format that require agent update. | +14159095857 |
659
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. | |
660
-
661
-
662
- ### Response
663
-
664
- **Promise<[operations.UpdatePhoneAgentResponse](../../models/operations/updatephoneagentresponse.md)>**
665
- ### Errors
666
-
667
- | Error Object | Status Code | Content Type |
668
- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
669
- | errors.UpdatePhoneAgentResponseBody | 400 | application/json |
670
- | errors.UpdatePhoneAgentResponseResponseBody | 401 | application/json |
671
- | errors.UpdatePhoneAgentResponse422ResponseBody | 422 | application/json |
672
- | errors.UpdatePhoneAgentResponse500ResponseBody | 500 | application/json |
673
- | errors.SDKError | 400-600 | */* |