@signalwire/sdk 2.0.0 → 2.0.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 (612) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/dist/index.d.ts +146 -0
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1019 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
  149. package/dist/rest/index.js +195 -0
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/dist/rest/pagination.d.ts +39 -0
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2489
  416. package/src/AgentServer.ts +0 -415
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1150
  420. package/src/DataMap.ts +0 -449
  421. package/src/FunctionResult.ts +0 -866
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -439
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -717
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -221
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -258
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -181
  435. package/src/WebService.ts +0 -619
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/index.ts +0 -167
  441. package/src/livewire/index.ts +0 -950
  442. package/src/prefabs/ConciergeAgent.ts +0 -287
  443. package/src/prefabs/FAQBotAgent.ts +0 -384
  444. package/src/prefabs/InfoGathererAgent.ts +0 -339
  445. package/src/prefabs/ReceptionistAgent.ts +0 -366
  446. package/src/prefabs/SurveyAgent.ts +0 -646
  447. package/src/relay/Action.ts +0 -314
  448. package/src/relay/Call.ts +0 -854
  449. package/src/relay/Deferred.ts +0 -71
  450. package/src/relay/Message.ts +0 -148
  451. package/src/relay/RelayClient.ts +0 -1036
  452. package/src/relay/RelayError.ts +0 -14
  453. package/src/relay/RelayEvent.ts +0 -892
  454. package/src/relay/index.ts +0 -123
  455. package/src/relay/types.ts +0 -149
  456. package/src/rest/HttpClient.ts +0 -103
  457. package/src/rest/RestError.ts +0 -31
  458. package/src/rest/base/BaseResource.ts +0 -19
  459. package/src/rest/base/CrudResource.ts +0 -51
  460. package/src/rest/base/CrudWithAddresses.ts +0 -26
  461. package/src/rest/namespaces/addresses.ts +0 -32
  462. package/src/rest/namespaces/calling.ts +0 -187
  463. package/src/rest/namespaces/chat.ts +0 -20
  464. package/src/rest/namespaces/compat.ts +0 -352
  465. package/src/rest/namespaces/datasphere.ts +0 -45
  466. package/src/rest/namespaces/fabric.ts +0 -222
  467. package/src/rest/namespaces/imported-numbers.ts +0 -20
  468. package/src/rest/namespaces/logs.ts +0 -84
  469. package/src/rest/namespaces/lookup.ts +0 -21
  470. package/src/rest/namespaces/mfa.ts +0 -30
  471. package/src/rest/namespaces/number-groups.ts +0 -38
  472. package/src/rest/namespaces/phone-numbers.ts +0 -44
  473. package/src/rest/namespaces/project.ts +0 -36
  474. package/src/rest/namespaces/pubsub.ts +0 -20
  475. package/src/rest/namespaces/queues.ts +0 -33
  476. package/src/rest/namespaces/recordings.ts +0 -28
  477. package/src/rest/namespaces/registry.ts +0 -101
  478. package/src/rest/namespaces/short-codes.ts +0 -28
  479. package/src/rest/namespaces/sip-profile.ts +0 -25
  480. package/src/rest/namespaces/verified-callers.ts +0 -27
  481. package/src/rest/namespaces/video.ts +0 -165
  482. package/src/rest/pagination.ts +0 -84
  483. package/src/rest/types.ts +0 -61
  484. package/src/skills/SkillBase.ts +0 -547
  485. package/src/skills/SkillManager.ts +0 -415
  486. package/src/skills/SkillRegistry.ts +0 -367
  487. package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
  488. package/src/skills/builtin/ask_claude.ts +0 -241
  489. package/src/skills/builtin/claude_skills.ts +0 -978
  490. package/src/skills/builtin/custom_skills.ts +0 -312
  491. package/src/skills/builtin/datasphere.ts +0 -438
  492. package/src/skills/builtin/datasphere_serverless.ts +0 -339
  493. package/src/skills/builtin/datetime.ts +0 -130
  494. package/src/skills/builtin/google_maps.ts +0 -651
  495. package/src/skills/builtin/info_gatherer.ts +0 -405
  496. package/src/skills/builtin/joke.ts +0 -191
  497. package/src/skills/builtin/math.ts +0 -142
  498. package/src/skills/builtin/mcp_gateway.ts +0 -677
  499. package/src/skills/builtin/native_vector_search.ts +0 -901
  500. package/src/skills/builtin/play_background_file.ts +0 -358
  501. package/src/skills/builtin/spider.ts +0 -869
  502. package/src/skills/builtin/swml_transfer.ts +0 -635
  503. package/src/skills/builtin/weather_api.ts +0 -248
  504. package/src/skills/builtin/web_search.ts +0 -1074
  505. package/src/skills/builtin/wikipedia_search.ts +0 -299
  506. package/src/types.ts +0 -132
  507. package/tests/AgentBase.test.ts +0 -1093
  508. package/tests/AgentServer.test.ts +0 -126
  509. package/tests/AuthHandler.test.ts +0 -133
  510. package/tests/ConfigLoader.test.ts +0 -151
  511. package/tests/ContextBuilder.test.ts +0 -108
  512. package/tests/DataMap.test.ts +0 -367
  513. package/tests/EphemeralSkillCopy.test.ts +0 -107
  514. package/tests/FunctionResult.test.ts +0 -298
  515. package/tests/GracefulShutdown.test.ts +0 -46
  516. package/tests/Logger.test.ts +0 -420
  517. package/tests/PomBuilder.test.ts +0 -228
  518. package/tests/ProxyDetection.test.ts +0 -228
  519. package/tests/SWMLService.test.ts +0 -320
  520. package/tests/SWMLVerbHandler.test.ts +0 -523
  521. package/tests/SchemaUtils.test.ts +0 -106
  522. package/tests/SchemaUtils.verb.test.ts +0 -206
  523. package/tests/SecurityUtils.test.ts +0 -192
  524. package/tests/ServerlessAdapter.test.ts +0 -222
  525. package/tests/SessionManager.test.ts +0 -257
  526. package/tests/SkillBaseFeatures.test.ts +0 -130
  527. package/tests/SkillMultiInstance.test.ts +0 -102
  528. package/tests/SkillParameterSchemas.test.ts +0 -134
  529. package/tests/SkillRegistrySchema.test.ts +0 -84
  530. package/tests/SslConfig.test.ts +0 -97
  531. package/tests/SwmlBuilder.test.ts +0 -400
  532. package/tests/TypeInference.test.ts +0 -165
  533. package/tests/VerbHandlerRegistry.test.ts +0 -128
  534. package/tests/cli/mock-data.test.ts +0 -113
  535. package/tests/cli/swaig-test.test.ts +0 -108
  536. package/tests/examples.test.ts +0 -194
  537. package/tests/fixtures/scrape-parity/README.md +0 -53
  538. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  548. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  549. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  550. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  551. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  552. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  553. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  554. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  555. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  556. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  557. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  558. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  559. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  560. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  561. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  562. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  563. package/tests/livewire/livewire.test.ts +0 -780
  564. package/tests/mcp.test.ts +0 -221
  565. package/tests/prefabs/prefabs.test.ts +0 -1093
  566. package/tests/relay/Action.test.ts +0 -392
  567. package/tests/relay/Call.test.ts +0 -535
  568. package/tests/relay/Deferred.test.ts +0 -71
  569. package/tests/relay/Message.test.ts +0 -164
  570. package/tests/relay/RelayClient.test.ts +0 -779
  571. package/tests/relay/RelayEvent.test.ts +0 -463
  572. package/tests/relay/helpers.ts +0 -79
  573. package/tests/rest/HttpClient.test.ts +0 -274
  574. package/tests/rest/RestError.test.ts +0 -53
  575. package/tests/rest/calling.test.ts +0 -156
  576. package/tests/rest/client.test.ts +0 -197
  577. package/tests/rest/compat.test.ts +0 -335
  578. package/tests/rest/datasphere.test.ts +0 -71
  579. package/tests/rest/fabric.test.ts +0 -186
  580. package/tests/rest/helpers.ts +0 -95
  581. package/tests/rest/logs.test.ts +0 -68
  582. package/tests/rest/pagination.test.ts +0 -133
  583. package/tests/rest/registry.test.ts +0 -94
  584. package/tests/rest/relay-rest.test.ts +0 -290
  585. package/tests/rest/video.test.ts +0 -173
  586. package/tests/setup.ts +0 -6
  587. package/tests/skills/SkillBase.test.ts +0 -108
  588. package/tests/skills/SkillManager.test.ts +0 -268
  589. package/tests/skills/SkillRegistry.test.ts +0 -176
  590. package/tests/skills/builtin.test.ts +0 -1472
  591. package/tests/skills/claude-skills.test.ts +0 -54
  592. package/tests/skills/custom-skills.test.ts +0 -53
  593. package/tests/skills/datasphere-serverless.test.ts +0 -70
  594. package/tests/skills/datasphere.test.ts +0 -107
  595. package/tests/skills/datetime.test.ts +0 -101
  596. package/tests/skills/google-maps.test.ts +0 -78
  597. package/tests/skills/info-gatherer.test.ts +0 -411
  598. package/tests/skills/joke.test.ts +0 -81
  599. package/tests/skills/math.test.ts +0 -68
  600. package/tests/skills/mcp-gateway.test.ts +0 -101
  601. package/tests/skills/play-background.test.ts +0 -54
  602. package/tests/skills/spider.test.ts +0 -108
  603. package/tests/skills/swml-transfer.test.ts +0 -178
  604. package/tests/skills/trivia.test.ts +0 -54
  605. package/tests/skills/vector-search.test.ts +0 -135
  606. package/tests/skills/weather-api.test.ts +0 -77
  607. package/tests/skills/web-search-parity.test.ts +0 -59
  608. package/tests/skills/web-search.test.ts +0 -103
  609. package/tests/skills/wikipedia.test.ts +0 -63
  610. package/tsconfig.json +0 -18
  611. package/vitest.config.ts +0 -9
  612. /package/{src → dist}/schema.json +0 -0
package/src/relay/Call.ts DELETED
@@ -1,854 +0,0 @@
1
- /**
2
- * Call object — represents a live RELAY call with command methods.
3
- *
4
- * Created by RelayClient on inbound calling.call.receive events or
5
- * outbound dial responses.
6
- */
7
-
8
- /* eslint-disable @typescript-eslint/no-explicit-any */
9
-
10
- import { randomUUID } from 'node:crypto';
11
- import { getLogger } from '../Logger.js';
12
- import {
13
- Action,
14
- PlayAction,
15
- RecordAction,
16
- DetectAction,
17
- CollectAction,
18
- StandaloneCollectAction,
19
- FaxAction,
20
- TapAction,
21
- StreamAction,
22
- PayAction,
23
- TranscribeAction,
24
- AIAction,
25
- } from './Action.js';
26
- import { createDeferred, type Deferred } from './Deferred.js';
27
- import { CALL_STATE_ENDED, EVENT_CALL_COLLECT, EVENT_CALL_STATE } from './constants.js';
28
- import { RelayEvent, parseEvent } from './RelayEvent.js';
29
- import type { CompletedCallback, EventHandler } from './types.js';
30
-
31
- const logger = getLogger('relay_call');
32
-
33
- /** Interface the Call needs from RelayClient (avoids circular import). */
34
- export interface RelayClientLike {
35
- execute(method: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
36
- }
37
-
38
- export class Call {
39
- /** @internal */ readonly _client: RelayClientLike;
40
- callId: string;
41
- nodeId: string;
42
- projectId: string;
43
- context: string;
44
- tag: string;
45
- direction: string;
46
- device: Record<string, any>;
47
- state: string;
48
- segmentId: string;
49
-
50
- /** @internal */ readonly _listeners: Map<string, EventHandler[]> = new Map();
51
- /** @internal */ readonly _actions: Map<string, Action> = new Map();
52
- /** @internal */ readonly _ended: Deferred<RelayEvent>;
53
-
54
- constructor(
55
- client: RelayClientLike,
56
- callId: string,
57
- nodeId: string,
58
- projectId: string,
59
- context: string,
60
- options: {
61
- tag?: string;
62
- direction?: string;
63
- device?: Record<string, any>;
64
- state?: string;
65
- segmentId?: string;
66
- } = {},
67
- ) {
68
- this._client = client;
69
- this.callId = callId;
70
- this.nodeId = nodeId;
71
- this.projectId = projectId;
72
- this.context = context;
73
- this.tag = options.tag ?? '';
74
- this.direction = options.direction ?? '';
75
- this.device = options.device ?? {};
76
- this.state = options.state ?? '';
77
- this.segmentId = options.segmentId ?? '';
78
- this._ended = createDeferred<RelayEvent>();
79
- }
80
-
81
- // ─── Internal RPC Primitive ──────────────────────────────────────
82
-
83
- /** @internal Send a calling.<method> JSON-RPC request for this call. */
84
- async _execute(method: string, extraParams?: Record<string, unknown>): Promise<Record<string, unknown>> {
85
- const rpcMethod = `calling.${method}`;
86
- const params: Record<string, unknown> = {
87
- node_id: this.nodeId,
88
- call_id: this.callId,
89
- };
90
- if (extraParams) {
91
- Object.assign(params, extraParams);
92
- }
93
- try {
94
- return await this._client.execute(rpcMethod, params);
95
- } catch (err: any) {
96
- if (err?.code !== undefined) {
97
- logger.warn(`Call ${this.callId} error during ${method} (code=${err.code}): ${err}`);
98
- return {};
99
- }
100
- throw err;
101
- }
102
- }
103
-
104
- // ─── Event Plumbing ──────────────────────────────────────────────
105
-
106
- /** Register an event listener for this call. */
107
- on(eventType: string, handler: EventHandler): void {
108
- const handlers = this._listeners.get(eventType) ?? [];
109
- handlers.push(handler);
110
- this._listeners.set(eventType, handlers);
111
- }
112
-
113
- /** @internal Called by RelayClient when an event arrives for this call. */
114
- async _dispatchEvent(payload: Record<string, unknown>): Promise<void> {
115
- const event = parseEvent(payload as Record<string, any>);
116
- const eventType = event.eventType;
117
-
118
- // Update call state
119
- if (eventType === EVENT_CALL_STATE) {
120
- const callState = (event.params.call_state ?? this.state) as string;
121
- this.state = callState;
122
- if (this.state === CALL_STATE_ENDED && !this._ended.settled) {
123
- this._ended.resolve(event);
124
- }
125
- }
126
-
127
- // Route to active actions by control_id
128
- const controlId = (event.params.control_id ?? '') as string;
129
- if (controlId) {
130
- const action = this._actions.get(controlId);
131
- if (action) {
132
- action._checkEvent(event);
133
- if (action.completed) {
134
- this._actions.delete(controlId);
135
- }
136
- }
137
- }
138
-
139
- // Notify registered listeners (snapshot to allow modification during iteration)
140
- const handlers = [...(this._listeners.get(eventType) ?? [])];
141
- for (const handler of handlers) {
142
- try {
143
- await handler(event);
144
- } catch (err) {
145
- logger.error(`Error in event handler for ${eventType}: ${err}`);
146
- }
147
- }
148
- }
149
-
150
- /** Wait for a specific event, optionally filtered by predicate. */
151
- async waitFor(
152
- eventType: string,
153
- predicate?: (event: RelayEvent) => boolean,
154
- timeout?: number,
155
- ): Promise<RelayEvent> {
156
- const deferred = createDeferred<RelayEvent>();
157
-
158
- const handler: EventHandler = (event: RelayEvent) => {
159
- if (deferred.settled) return;
160
- if (predicate == null || predicate(event)) {
161
- deferred.resolve(event);
162
- }
163
- };
164
-
165
- this.on(eventType, handler);
166
- try {
167
- if (timeout != null) {
168
- return await new Promise<RelayEvent>((resolve, reject) => {
169
- const timer = setTimeout(() => {
170
- reject(new Error(`waitFor(${eventType}) timed out after ${timeout}ms`));
171
- }, timeout);
172
- deferred.promise.then(
173
- (v) => { clearTimeout(timer); resolve(v); },
174
- (e) => { clearTimeout(timer); reject(e); },
175
- );
176
- });
177
- }
178
- return await deferred.promise;
179
- } finally {
180
- // Clean up the one-shot handler
181
- const list = this._listeners.get(eventType);
182
- if (list) {
183
- const idx = list.indexOf(handler);
184
- if (idx !== -1) list.splice(idx, 1);
185
- }
186
- }
187
- }
188
-
189
- /** Wait for the call to reach the ended state. */
190
- async waitForEnded(timeout?: number): Promise<RelayEvent> {
191
- if (timeout != null) {
192
- return new Promise<RelayEvent>((resolve, reject) => {
193
- const timer = setTimeout(() => {
194
- reject(new Error(`waitForEnded timed out after ${timeout}ms`));
195
- }, timeout);
196
- this._ended.promise.then(
197
- (v) => { clearTimeout(timer); resolve(v); },
198
- (e) => { clearTimeout(timer); reject(e); },
199
- );
200
- });
201
- }
202
- return this._ended.promise;
203
- }
204
-
205
- // ─── Action Helper ───────────────────────────────────────────────
206
-
207
- /** @internal Register an action, execute the RPC, clean up on failure. */
208
- async _startAction<T extends Action>(
209
- action: T,
210
- method: string,
211
- params: Record<string, unknown>,
212
- onCompleted?: CompletedCallback | null,
213
- ): Promise<T> {
214
- if (this.state === CALL_STATE_ENDED) {
215
- logger.warn(`Call ${this.callId} already ended, skipping ${method}`);
216
- const goneEvent = new RelayEvent('', {});
217
- action._resolve(goneEvent);
218
- return action;
219
- }
220
- if (onCompleted) action._onCompleted = onCompleted;
221
- this._actions.set(action.controlId, action);
222
- try {
223
- const result = await this._execute(method, params);
224
- // _execute returns {} when the call is gone (404/410) — resolve immediately
225
- if (!result || Object.keys(result).length === 0) {
226
- this._actions.delete(action.controlId);
227
- if (!action._done.settled) {
228
- const goneEvent = new RelayEvent('', {});
229
- action._resolve(goneEvent);
230
- }
231
- }
232
- } catch (err) {
233
- this._actions.delete(action.controlId);
234
- if (!action._done.settled) {
235
- action._done.reject(err);
236
- // Suppress unhandled rejection — the caller gets the error via the rethrown exception
237
- action._done.promise.catch(() => {});
238
- }
239
- throw err;
240
- }
241
- return action;
242
- }
243
-
244
- // ─── Call Lifecycle Methods ──────────────────────────────────────
245
-
246
- /** Answer an inbound call. */
247
- async answer(extra?: Record<string, unknown>): Promise<Record<string, unknown>> {
248
- return this._execute('answer', extra);
249
- }
250
-
251
- /** End/hang up the call. */
252
- async hangup(reason = 'hangup'): Promise<Record<string, unknown>> {
253
- return this._execute('end', { reason });
254
- }
255
-
256
- /** Decline control of an inbound call, returning it to routing. */
257
- async pass(): Promise<Record<string, unknown>> {
258
- return this._execute('pass');
259
- }
260
-
261
- // ─── Audio Playback ──────────────────────────────────────────────
262
-
263
- /** Play audio content. Returns a PlayAction for stop/pause/resume/wait. */
264
- async play(
265
- media: Record<string, unknown>[],
266
- options: {
267
- volume?: number;
268
- direction?: string;
269
- loop?: number;
270
- controlId?: string;
271
- onCompleted?: CompletedCallback;
272
- } = {},
273
- ): Promise<PlayAction> {
274
- const cid = options.controlId ?? randomUUID();
275
- const params: Record<string, unknown> = { control_id: cid, play: media };
276
- if (options.volume != null) params.volume = options.volume;
277
- if (options.direction != null) params.direction = options.direction;
278
- if (options.loop != null) params.loop = options.loop;
279
- const action = new PlayAction(this, cid);
280
- return this._startAction(action, 'play', params, options.onCompleted);
281
- }
282
-
283
- // ─── Recording ───────────────────────────────────────────────────
284
-
285
- /** Record audio from the call. Returns a RecordAction. */
286
- async record(
287
- audio?: Record<string, unknown>,
288
- options: {
289
- controlId?: string;
290
- onCompleted?: CompletedCallback;
291
- } = {},
292
- ): Promise<RecordAction> {
293
- const cid = options.controlId ?? randomUUID();
294
- const recordObj = { audio: audio ?? {} };
295
- const params: Record<string, unknown> = { control_id: cid, record: recordObj };
296
- const action = new RecordAction(this, cid);
297
- return this._startAction(action, 'record', params, options.onCompleted);
298
- }
299
-
300
- // ─── Input Collection ────────────────────────────────────────────
301
-
302
- /** Play audio and collect digit/speech input. Returns a CollectAction. */
303
- async playAndCollect(
304
- media: Record<string, unknown>[],
305
- collect: Record<string, unknown>,
306
- options: {
307
- volume?: number;
308
- controlId?: string;
309
- onCompleted?: CompletedCallback;
310
- } = {},
311
- ): Promise<CollectAction> {
312
- const cid = options.controlId ?? randomUUID();
313
- const params: Record<string, unknown> = {
314
- control_id: cid,
315
- play: media,
316
- collect,
317
- };
318
- if (options.volume != null) params.volume = options.volume;
319
- const action = new CollectAction(this, cid);
320
- return this._startAction(action, 'play_and_collect', params, options.onCompleted);
321
- }
322
-
323
- /** Collect digit/speech input without playing media. Returns a StandaloneCollectAction. */
324
- async collect(options: {
325
- digits?: Record<string, unknown>;
326
- speech?: Record<string, unknown>;
327
- initialTimeout?: number;
328
- partialResults?: boolean;
329
- continuous?: boolean;
330
- sendStartOfInput?: boolean;
331
- startInputTimers?: boolean;
332
- controlId?: string;
333
- onCompleted?: CompletedCallback;
334
- } = {}): Promise<StandaloneCollectAction> {
335
- const cid = options.controlId ?? randomUUID();
336
- const params: Record<string, unknown> = { control_id: cid };
337
- if (options.digits != null) params.digits = options.digits;
338
- if (options.speech != null) params.speech = options.speech;
339
- if (options.initialTimeout != null) params.initial_timeout = options.initialTimeout;
340
- if (options.partialResults != null) params.partial_results = options.partialResults;
341
- if (options.continuous != null) params.continuous = options.continuous;
342
- if (options.sendStartOfInput != null) params.send_start_of_input = options.sendStartOfInput;
343
- if (options.startInputTimers != null) params.start_input_timers = options.startInputTimers;
344
- const action = new StandaloneCollectAction(this, cid);
345
- return this._startAction(action, 'collect', params, options.onCompleted);
346
- }
347
-
348
- // ─── Bridging & Connectivity ─────────────────────────────────────
349
-
350
- /** Bridge the call to one or more destinations. */
351
- async connect(
352
- devices: Record<string, unknown>[][],
353
- options: {
354
- ringback?: Record<string, unknown>[];
355
- tag?: string;
356
- maxDuration?: number;
357
- maxPricePerMinute?: number;
358
- statusUrl?: string;
359
- } = {},
360
- ): Promise<Record<string, unknown>> {
361
- const params: Record<string, unknown> = { devices };
362
- if (options.ringback != null) params.ringback = options.ringback;
363
- if (options.tag != null) params.tag = options.tag;
364
- if (options.maxDuration != null) params.max_duration = options.maxDuration;
365
- if (options.maxPricePerMinute != null) params.max_price_per_minute = options.maxPricePerMinute;
366
- if (options.statusUrl != null) params.status_url = options.statusUrl;
367
- return this._execute('connect', params);
368
- }
369
-
370
- /** Disconnect (unbridge) a connected call. */
371
- async disconnect(): Promise<Record<string, unknown>> {
372
- return this._execute('disconnect');
373
- }
374
-
375
- // ─── DTMF ────────────────────────────────────────────────────────
376
-
377
- /** Send DTMF digits on the call. */
378
- async sendDigits(digits: string, controlId?: string): Promise<Record<string, unknown>> {
379
- const cid = controlId ?? randomUUID();
380
- return this._execute('send_digits', { control_id: cid, digits });
381
- }
382
-
383
- // ─── Detection ───────────────────────────────────────────────────
384
-
385
- /** Start audio detection (machine, fax, digit). Returns a DetectAction. */
386
- async detect(
387
- detect: Record<string, unknown>,
388
- options: {
389
- timeout?: number;
390
- controlId?: string;
391
- onCompleted?: CompletedCallback;
392
- } = {},
393
- ): Promise<DetectAction> {
394
- const cid = options.controlId ?? randomUUID();
395
- const params: Record<string, unknown> = { control_id: cid, detect };
396
- if (options.timeout != null) params.timeout = options.timeout;
397
- const action = new DetectAction(this, cid);
398
- return this._startAction(action, 'detect', params, options.onCompleted);
399
- }
400
-
401
- // ─── SIP Refer ───────────────────────────────────────────────────
402
-
403
- /** Transfer a SIP call via REFER. */
404
- async refer(
405
- device: Record<string, unknown>,
406
- options: { statusUrl?: string } = {},
407
- ): Promise<Record<string, unknown>> {
408
- const params: Record<string, unknown> = { device };
409
- if (options.statusUrl != null) params.status_url = options.statusUrl;
410
- return this._execute('refer', params);
411
- }
412
-
413
- // ─── Payment ─────────────────────────────────────────────────────
414
-
415
- /** Start a payment collection. Returns a PayAction. */
416
- async pay(
417
- paymentConnectorUrl: string,
418
- options: {
419
- controlId?: string;
420
- inputMethod?: string;
421
- statusUrl?: string;
422
- paymentMethod?: string;
423
- timeout?: string;
424
- maxAttempts?: string;
425
- securityCode?: string;
426
- postalCode?: string;
427
- minPostalCodeLength?: string;
428
- tokenType?: string;
429
- chargeAmount?: string;
430
- currency?: string;
431
- language?: string;
432
- voice?: string;
433
- description?: string;
434
- validCardTypes?: string;
435
- parameters?: Record<string, unknown>[];
436
- prompts?: Record<string, unknown>[];
437
- onCompleted?: CompletedCallback;
438
- } = {},
439
- ): Promise<PayAction> {
440
- const cid = options.controlId ?? randomUUID();
441
- const params: Record<string, unknown> = {
442
- control_id: cid,
443
- payment_connector_url: paymentConnectorUrl,
444
- };
445
- if (options.inputMethod != null) params.input = options.inputMethod;
446
- if (options.statusUrl != null) params.status_url = options.statusUrl;
447
- if (options.paymentMethod != null) params.payment_method = options.paymentMethod;
448
- if (options.timeout != null) params.timeout = options.timeout;
449
- if (options.maxAttempts != null) params.max_attempts = options.maxAttempts;
450
- if (options.securityCode != null) params.security_code = options.securityCode;
451
- if (options.postalCode != null) params.postal_code = options.postalCode;
452
- if (options.minPostalCodeLength != null) params.min_postal_code_length = options.minPostalCodeLength;
453
- if (options.tokenType != null) params.token_type = options.tokenType;
454
- if (options.chargeAmount != null) params.charge_amount = options.chargeAmount;
455
- if (options.currency != null) params.currency = options.currency;
456
- if (options.language != null) params.language = options.language;
457
- if (options.voice != null) params.voice = options.voice;
458
- if (options.description != null) params.description = options.description;
459
- if (options.validCardTypes != null) params.valid_card_types = options.validCardTypes;
460
- if (options.parameters != null) params.parameters = options.parameters;
461
- if (options.prompts != null) params.prompts = options.prompts;
462
- const action = new PayAction(this, cid);
463
- return this._startAction(action, 'pay', params, options.onCompleted);
464
- }
465
-
466
- // ─── Faxing ──────────────────────────────────────────────────────
467
-
468
- /** Send a fax document. Returns a FaxAction. */
469
- async sendFax(
470
- document: string,
471
- options: {
472
- identity?: string;
473
- headerInfo?: string;
474
- controlId?: string;
475
- onCompleted?: CompletedCallback;
476
- } = {},
477
- ): Promise<FaxAction> {
478
- const cid = options.controlId ?? randomUUID();
479
- const params: Record<string, unknown> = { control_id: cid, document };
480
- if (options.identity != null) params.identity = options.identity;
481
- if (options.headerInfo != null) params.header_info = options.headerInfo;
482
- const action = new FaxAction(this, cid, 'send_fax');
483
- return this._startAction(action, 'send_fax', params, options.onCompleted);
484
- }
485
-
486
- /** Receive a fax. Returns a FaxAction. */
487
- async receiveFax(
488
- options: {
489
- controlId?: string;
490
- onCompleted?: CompletedCallback;
491
- } = {},
492
- ): Promise<FaxAction> {
493
- const cid = options.controlId ?? randomUUID();
494
- const params: Record<string, unknown> = { control_id: cid };
495
- const action = new FaxAction(this, cid, 'receive_fax');
496
- return this._startAction(action, 'receive_fax', params, options.onCompleted);
497
- }
498
-
499
- // ─── Tap (Media Interception) ────────────────────────────────────
500
-
501
- /** Intercept call media and stream it. Returns a TapAction. */
502
- async tap(
503
- tap: Record<string, unknown>,
504
- device: Record<string, unknown>,
505
- options: {
506
- controlId?: string;
507
- onCompleted?: CompletedCallback;
508
- } = {},
509
- ): Promise<TapAction> {
510
- const cid = options.controlId ?? randomUUID();
511
- const params: Record<string, unknown> = { control_id: cid, tap, device };
512
- const action = new TapAction(this, cid);
513
- return this._startAction(action, 'tap', params, options.onCompleted);
514
- }
515
-
516
- // ─── Streaming ───────────────────────────────────────────────────
517
-
518
- /** Start streaming call audio to a WebSocket endpoint. Returns a StreamAction. */
519
- async stream(
520
- url: string,
521
- options: {
522
- name?: string;
523
- codec?: string;
524
- track?: string;
525
- statusUrl?: string;
526
- statusUrlMethod?: string;
527
- authorizationBearerToken?: string;
528
- customParameters?: Record<string, unknown>;
529
- controlId?: string;
530
- onCompleted?: CompletedCallback;
531
- } = {},
532
- ): Promise<StreamAction> {
533
- const cid = options.controlId ?? randomUUID();
534
- const params: Record<string, unknown> = { control_id: cid, url };
535
- if (options.name != null) params.name = options.name;
536
- if (options.codec != null) params.codec = options.codec;
537
- if (options.track != null) params.track = options.track;
538
- if (options.statusUrl != null) params.status_url = options.statusUrl;
539
- if (options.statusUrlMethod != null) params.status_url_method = options.statusUrlMethod;
540
- if (options.authorizationBearerToken != null) params.authorization_bearer_token = options.authorizationBearerToken;
541
- if (options.customParameters != null) params.custom_parameters = options.customParameters;
542
- const action = new StreamAction(this, cid);
543
- return this._startAction(action, 'stream', params, options.onCompleted);
544
- }
545
-
546
- // ─── Transfer ────────────────────────────────────────────────────
547
-
548
- /** Transfer call control to another RELAY app or SWML script. */
549
- async transfer(dest: string, extra?: Record<string, unknown>): Promise<Record<string, unknown>> {
550
- const params: Record<string, unknown> = { dest, ...extra };
551
- return this._execute('transfer', params);
552
- }
553
-
554
- // ─── Conference ──────────────────────────────────────────────────
555
-
556
- /** Join an ad-hoc audio conference. */
557
- async joinConference(
558
- name: string,
559
- options: {
560
- muted?: boolean;
561
- beep?: string;
562
- startOnEnter?: boolean;
563
- endOnExit?: boolean;
564
- waitUrl?: string;
565
- maxParticipants?: number;
566
- record?: string;
567
- region?: string;
568
- trim?: string;
569
- coach?: string;
570
- statusCallback?: string;
571
- statusCallbackEvent?: string;
572
- statusCallbackEventType?: string;
573
- statusCallbackMethod?: string;
574
- recordingStatusCallback?: string;
575
- recordingStatusCallbackEvent?: string;
576
- recordingStatusCallbackEventType?: string;
577
- recordingStatusCallbackMethod?: string;
578
- stream?: Record<string, unknown>;
579
- } = {},
580
- ): Promise<Record<string, unknown>> {
581
- const params: Record<string, unknown> = { name };
582
- if (options.muted != null) params.muted = options.muted;
583
- if (options.beep != null) params.beep = options.beep;
584
- if (options.startOnEnter != null) params.start_on_enter = options.startOnEnter;
585
- if (options.endOnExit != null) params.end_on_exit = options.endOnExit;
586
- if (options.waitUrl != null) params.wait_url = options.waitUrl;
587
- if (options.maxParticipants != null) params.max_participants = options.maxParticipants;
588
- if (options.record != null) params.record = options.record;
589
- if (options.region != null) params.region = options.region;
590
- if (options.trim != null) params.trim = options.trim;
591
- if (options.coach != null) params.coach = options.coach;
592
- if (options.statusCallback != null) params.status_callback = options.statusCallback;
593
- if (options.statusCallbackEvent != null) params.status_callback_event = options.statusCallbackEvent;
594
- if (options.statusCallbackEventType != null) params.status_callback_event_type = options.statusCallbackEventType;
595
- if (options.statusCallbackMethod != null) params.status_callback_method = options.statusCallbackMethod;
596
- if (options.recordingStatusCallback != null) params.recording_status_callback = options.recordingStatusCallback;
597
- if (options.recordingStatusCallbackEvent != null) params.recording_status_callback_event = options.recordingStatusCallbackEvent;
598
- if (options.recordingStatusCallbackEventType != null) params.recording_status_callback_event_type = options.recordingStatusCallbackEventType;
599
- if (options.recordingStatusCallbackMethod != null) params.recording_status_callback_method = options.recordingStatusCallbackMethod;
600
- if (options.stream != null) params.stream = options.stream;
601
- return this._execute('join_conference', params);
602
- }
603
-
604
- /** Leave an audio conference. */
605
- async leaveConference(conferenceId: string, extra?: Record<string, unknown>): Promise<Record<string, unknown>> {
606
- return this._execute('leave_conference', { conference_id: conferenceId, ...extra });
607
- }
608
-
609
- // ─── Hold / Unhold ───────────────────────────────────────────────
610
-
611
- /** Put the call on hold. */
612
- async hold(): Promise<Record<string, unknown>> {
613
- return this._execute('hold');
614
- }
615
-
616
- /** Release the call from hold. */
617
- async unhold(): Promise<Record<string, unknown>> {
618
- return this._execute('unhold');
619
- }
620
-
621
- // ─── Denoise ─────────────────────────────────────────────────────
622
-
623
- /** Start noise reduction on the call. */
624
- async denoise(): Promise<Record<string, unknown>> {
625
- return this._execute('denoise');
626
- }
627
-
628
- /** Stop noise reduction on the call. */
629
- async denoiseStop(): Promise<Record<string, unknown>> {
630
- return this._execute('denoise.stop');
631
- }
632
-
633
- // ─── Transcribe ──────────────────────────────────────────────────
634
-
635
- /** Start transcribing the call. Returns a TranscribeAction. */
636
- async transcribe(
637
- options: {
638
- controlId?: string;
639
- statusUrl?: string;
640
- onCompleted?: CompletedCallback;
641
- } = {},
642
- ): Promise<TranscribeAction> {
643
- const cid = options.controlId ?? randomUUID();
644
- const params: Record<string, unknown> = { control_id: cid };
645
- if (options.statusUrl != null) params.status_url = options.statusUrl;
646
- const action = new TranscribeAction(this, cid);
647
- return this._startAction(action, 'transcribe', params, options.onCompleted);
648
- }
649
-
650
- // ─── Echo ────────────────────────────────────────────────────────
651
-
652
- /** Echo audio back to the caller (useful for testing). */
653
- async echo(options: { timeout?: number; statusUrl?: string } = {}): Promise<Record<string, unknown>> {
654
- const params: Record<string, unknown> = {};
655
- if (options.timeout != null) params.timeout = options.timeout;
656
- if (options.statusUrl != null) params.status_url = options.statusUrl;
657
- return this._execute('echo', Object.keys(params).length ? params : undefined);
658
- }
659
-
660
- // ─── Digit Bindings ──────────────────────────────────────────────
661
-
662
- /** Bind a DTMF digit sequence to trigger a RELAY method. */
663
- async bindDigit(
664
- digits: string,
665
- bindMethod: string,
666
- options: {
667
- bindParams?: Record<string, unknown>;
668
- realm?: string;
669
- maxTriggers?: number;
670
- } = {},
671
- ): Promise<Record<string, unknown>> {
672
- const params: Record<string, unknown> = {
673
- digits,
674
- bind_method: bindMethod,
675
- };
676
- if (options.bindParams != null) params.params = options.bindParams;
677
- if (options.realm != null) params.realm = options.realm;
678
- if (options.maxTriggers != null) params.max_triggers = options.maxTriggers;
679
- return this._execute('bind_digit', params);
680
- }
681
-
682
- /** Clear all digit bindings, optionally filtered by realm. */
683
- async clearDigitBindings(realm?: string): Promise<Record<string, unknown>> {
684
- const params: Record<string, unknown> = {};
685
- if (realm != null) params.realm = realm;
686
- return this._execute('clear_digit_bindings', Object.keys(params).length ? params : undefined);
687
- }
688
-
689
- // ─── Live Transcribe / Translate ─────────────────────────────────
690
-
691
- /** Start or stop live transcription on the call. */
692
- async liveTranscribe(action: Record<string, unknown>, extra?: Record<string, unknown>): Promise<Record<string, unknown>> {
693
- return this._execute('live_transcribe', { action, ...extra });
694
- }
695
-
696
- /** Start or stop live translation on the call. */
697
- async liveTranslate(
698
- action: Record<string, unknown>,
699
- options: { statusUrl?: string } = {},
700
- ): Promise<Record<string, unknown>> {
701
- const params: Record<string, unknown> = { action };
702
- if (options.statusUrl != null) params.status_url = options.statusUrl;
703
- return this._execute('live_translate', params);
704
- }
705
-
706
- // ─── Room ────────────────────────────────────────────────────────
707
-
708
- /** Join a video/audio room. */
709
- async joinRoom(
710
- name: string,
711
- options: { statusUrl?: string } = {},
712
- ): Promise<Record<string, unknown>> {
713
- const params: Record<string, unknown> = { name };
714
- if (options.statusUrl != null) params.status_url = options.statusUrl;
715
- return this._execute('join_room', params);
716
- }
717
-
718
- /** Leave the current room. */
719
- async leaveRoom(extra?: Record<string, unknown>): Promise<Record<string, unknown>> {
720
- return this._execute('leave_room', extra);
721
- }
722
-
723
- // ─── AI Agent ────────────────────────────────────────────────────
724
-
725
- /** Start an AI agent session on the call. Returns an AIAction. */
726
- async ai(options: {
727
- controlId?: string;
728
- agent?: string;
729
- prompt?: Record<string, unknown>;
730
- postPrompt?: Record<string, unknown>;
731
- postPromptUrl?: string;
732
- postPromptAuthUser?: string;
733
- postPromptAuthPassword?: string;
734
- globalData?: Record<string, unknown>;
735
- pronounce?: Record<string, unknown>[];
736
- hints?: string[];
737
- languages?: Record<string, unknown>[];
738
- SWAIG?: Record<string, unknown>;
739
- aiParams?: Record<string, unknown>;
740
- onCompleted?: CompletedCallback;
741
- } = {}): Promise<AIAction> {
742
- const cid = options.controlId ?? randomUUID();
743
- const params: Record<string, unknown> = { control_id: cid };
744
- if (options.agent != null) params.agent = options.agent;
745
- if (options.prompt != null) params.prompt = options.prompt;
746
- if (options.postPrompt != null) params.post_prompt = options.postPrompt;
747
- if (options.postPromptUrl != null) params.post_prompt_url = options.postPromptUrl;
748
- if (options.postPromptAuthUser != null) params.post_prompt_auth_user = options.postPromptAuthUser;
749
- if (options.postPromptAuthPassword != null) params.post_prompt_auth_password = options.postPromptAuthPassword;
750
- if (options.globalData != null) params.global_data = options.globalData;
751
- if (options.pronounce != null) params.pronounce = options.pronounce;
752
- if (options.hints != null) params.hints = options.hints;
753
- if (options.languages != null) params.languages = options.languages;
754
- if (options.SWAIG != null) params.SWAIG = options.SWAIG;
755
- if (options.aiParams != null) params.params = options.aiParams;
756
- const action = new AIAction(this, cid);
757
- return this._startAction(action, 'ai', params, options.onCompleted);
758
- }
759
-
760
- /** Connect to an Amazon Bedrock AI agent. */
761
- async amazonBedrock(options: {
762
- prompt?: unknown;
763
- SWAIG?: Record<string, unknown>;
764
- aiParams?: Record<string, unknown>;
765
- globalData?: Record<string, unknown>;
766
- postPrompt?: Record<string, unknown>;
767
- postPromptUrl?: string;
768
- } = {}): Promise<Record<string, unknown>> {
769
- const params: Record<string, unknown> = {};
770
- if (options.prompt != null) params.prompt = options.prompt;
771
- if (options.SWAIG != null) params.SWAIG = options.SWAIG;
772
- if (options.aiParams != null) params.params = options.aiParams;
773
- if (options.globalData != null) params.global_data = options.globalData;
774
- if (options.postPrompt != null) params.post_prompt = options.postPrompt;
775
- if (options.postPromptUrl != null) params.post_prompt_url = options.postPromptUrl;
776
- return this._execute('amazon_bedrock', params);
777
- }
778
-
779
- /** Send a message to an active AI agent session. */
780
- async aiMessage(options: {
781
- messageText?: string;
782
- role?: string;
783
- reset?: Record<string, unknown>;
784
- globalData?: Record<string, unknown>;
785
- } = {}): Promise<Record<string, unknown>> {
786
- const params: Record<string, unknown> = {};
787
- if (options.messageText != null) params.message_text = options.messageText;
788
- if (options.role != null) params.role = options.role;
789
- if (options.reset != null) params.reset = options.reset;
790
- if (options.globalData != null) params.global_data = options.globalData;
791
- return this._execute('ai_message', params);
792
- }
793
-
794
- /** Put an AI agent session on hold. */
795
- async aiHold(options: { timeout?: string; prompt?: string } = {}): Promise<Record<string, unknown>> {
796
- const params: Record<string, unknown> = {};
797
- if (options.timeout != null) params.timeout = options.timeout;
798
- if (options.prompt != null) params.prompt = options.prompt;
799
- return this._execute('ai_hold', Object.keys(params).length ? params : undefined);
800
- }
801
-
802
- /** Resume an AI agent session from hold. */
803
- async aiUnhold(options: { prompt?: string } = {}): Promise<Record<string, unknown>> {
804
- const params: Record<string, unknown> = {};
805
- if (options.prompt != null) params.prompt = options.prompt;
806
- return this._execute('ai_unhold', Object.keys(params).length ? params : undefined);
807
- }
808
-
809
- // ─── User Events ─────────────────────────────────────────────────
810
-
811
- /** Send a custom user-defined event. */
812
- async userEvent(options: { event?: string } & Record<string, unknown> = {}): Promise<Record<string, unknown>> {
813
- const params: Record<string, unknown> = {};
814
- if (options.event != null) params.event = options.event;
815
- return this._execute('user_event', params);
816
- }
817
-
818
- // ─── Queue ───────────────────────────────────────────────────────
819
-
820
- /** Place the call in a queue. */
821
- async queueEnter(
822
- queueName: string,
823
- options: { controlId?: string; statusUrl?: string } = {},
824
- ): Promise<Record<string, unknown>> {
825
- const cid = options.controlId ?? randomUUID();
826
- const params: Record<string, unknown> = {
827
- control_id: cid,
828
- queue_name: queueName,
829
- };
830
- if (options.statusUrl != null) params.status_url = options.statusUrl;
831
- return this._execute('queue.enter', params);
832
- }
833
-
834
- /** Remove the call from a queue. */
835
- async queueLeave(
836
- queueName: string,
837
- options: { controlId?: string; queueId?: string; statusUrl?: string } = {},
838
- ): Promise<Record<string, unknown>> {
839
- const cid = options.controlId ?? randomUUID();
840
- const params: Record<string, unknown> = {
841
- control_id: cid,
842
- queue_name: queueName,
843
- };
844
- if (options.queueId != null) params.queue_id = options.queueId;
845
- if (options.statusUrl != null) params.status_url = options.statusUrl;
846
- return this._execute('queue.leave', params);
847
- }
848
-
849
- // ─── Repr ────────────────────────────────────────────────────────
850
-
851
- toString(): string {
852
- return `<Call id=${this.callId} state=${this.state} direction=${this.direction}>`;
853
- }
854
- }