@signalwire/sdk 2.0.1 → 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 (610) 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/{src/index.ts → dist/index.d.ts} +13 -100
  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/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  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/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  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 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  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 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  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/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -1,1627 +0,0 @@
1
- # FunctionResult Reference
2
-
3
- Complete API reference for the `FunctionResult` class in the SignalWire AI Agents TypeScript SDK.
4
-
5
- ---
6
-
7
- ## Table of Contents
8
-
9
- - [Overview](#overview)
10
- - [Core Methods](#core-methods)
11
- - [constructor](#constructor)
12
- - [setResponse](#setresponse)
13
- - [setPostProcess](#setpostprocess)
14
- - [addAction](#addaction)
15
- - [addActions](#addactions)
16
- - [toDict](#todict)
17
- - [Call Control](#call-control)
18
- - [connect](#connect)
19
- - [swmlTransfer](#swmltransfer)
20
- - [hangup](#hangup)
21
- - [hold](#hold)
22
- - [waitForUser](#waitforuser)
23
- - [stop](#stop)
24
- - [Audio](#audio)
25
- - [say](#say)
26
- - [playBackgroundFile](#playbackgroundfile)
27
- - [stopBackgroundFile](#stopbackgroundfile)
28
- - [Speech](#speech)
29
- - [addDynamicHints](#adddynamichints)
30
- - [clearDynamicHints](#cleardynamichints)
31
- - [setEndOfSpeechTimeout](#setendofspeechtimeout)
32
- - [setSpeechEventTimeout](#setspeecheventtimeout)
33
- - [Data Management](#data-management)
34
- - [updateGlobalData](#updateglobaldata)
35
- - [removeGlobalData](#removeglobaldata)
36
- - [setMetadata](#setmetadata)
37
- - [removeMetadata](#removemetadata)
38
- - [SWML Actions](#swml-actions)
39
- - [executeSwml](#executeswml)
40
- - [switchContext](#switchcontext)
41
- - [swmlChangeStep](#swmlchangestep)
42
- - [swmlChangeContext](#swmlchangecontext)
43
- - [swmlUserEvent](#swmluserevent)
44
- - [Function Control](#function-control)
45
- - [toggleFunctions](#togglefunctions)
46
- - [enableFunctionsOnTimeout](#enablefunctionsontimeout)
47
- - [updateSettings](#updatesettings)
48
- - [User Input and History](#user-input-and-history)
49
- - [simulateUserInput](#simulateuserinput)
50
- - [enableExtensiveData](#enableextensivedata)
51
- - [replaceInHistory](#replaceinhistory)
52
- - [Communication](#communication)
53
- - [sendSms](#sendsms)
54
- - [recordCall](#recordcall)
55
- - [stopRecordCall](#stoprecordcall)
56
- - [tap](#tap)
57
- - [stopTap](#stoptap)
58
- - [Rooms and Conferencing](#rooms-and-conferencing)
59
- - [joinRoom](#joinroom)
60
- - [sipRefer](#siprefer)
61
- - [joinConference](#joinconference)
62
- - [RPC](#rpc)
63
- - [executeRpc](#executerpc)
64
- - [rpcDial](#rpcdial)
65
- - [rpcAiMessage](#rpcaimessage)
66
- - [rpcAiUnhold](#rpcaiunhold)
67
- - [Payments](#payments)
68
- - [pay](#pay)
69
- - [createPaymentPrompt (static)](#createpaymentprompt-static)
70
- - [createPaymentAction (static)](#createpaymentaction-static)
71
- - [createPaymentParameter (static)](#createpaymentparameter-static)
72
- - [Fluent Chaining](#fluent-chaining)
73
-
74
- ---
75
-
76
- ## Overview
77
-
78
- `FunctionResult` is the return type for SWAIG tool handlers. It carries two pieces of information back to the SignalWire AI engine:
79
-
80
- 1. **Response text** -- A string the AI uses as the tool's output. The AI reads this text and incorporates it into its conversation with the caller.
81
- 2. **Actions** -- An ordered list of structured commands (hangup, connect, play audio, send SMS, etc.) that the platform executes as side effects.
82
-
83
- When a tool handler runs, it constructs a `FunctionResult`, optionally adds actions, and returns it. The SDK serializes it via `toDict()` and sends it back to SignalWire.
84
-
85
- ### Basic usage
86
-
87
- ```typescript
88
- import { AgentBase, FunctionResult } from '@anthropic/@signalwire/sdk';
89
-
90
- const agent = new AgentBase({ name: 'my-agent', basicAuth: ['user', 'pass'] });
91
-
92
- agent.defineTool({
93
- name: 'transfer_call',
94
- description: 'Transfer the caller to a human agent',
95
- parameters: {},
96
- handler: () => {
97
- return new FunctionResult('Transferring you now.')
98
- .connect('+15551234567');
99
- },
100
- });
101
- ```
102
-
103
- ### How serialization works
104
-
105
- When the handler returns, the SDK calls `toDict()` to produce a plain object:
106
-
107
- ```typescript
108
- const result = new FunctionResult('Done').hangup();
109
- console.log(result.toDict());
110
- // { response: "Done", action: [{ hangup: true }] }
111
- ```
112
-
113
- If both `response` and `action` are empty, `toDict()` returns `{ response: "Action completed." }` as a fallback so the AI always receives a valid response.
114
-
115
- ### Properties
116
-
117
- | Property | Type | Description |
118
- |---------------|-----------------------------|--------------------------------------------------------------|
119
- | `response` | `string` | Text returned to the AI engine. |
120
- | `action` | `Record<string, unknown>[]` | Ordered list of action objects to execute. |
121
- | `postProcess` | `boolean` | When `true`, actions execute after the AI formulates its reply. |
122
-
123
- ---
124
-
125
- ## Core Methods
126
-
127
- ### constructor
128
-
129
- Create a new `FunctionResult`.
130
-
131
- ```typescript
132
- constructor(response?: string, postProcess?: boolean)
133
- ```
134
-
135
- | Parameter | Type | Default | Description |
136
- |---------------|-----------|---------|------------------------------------------------|
137
- | `response` | `string` | `''` | Initial response text for the AI. |
138
- | `postProcess` | `boolean` | `false` | Whether actions should be post-processed. |
139
-
140
- **Returns:** A new `FunctionResult` instance.
141
-
142
- ```typescript
143
- // Empty result (will serialize as "Action completed.")
144
- const r1 = new FunctionResult();
145
-
146
- // With response text
147
- const r2 = new FunctionResult('Order placed successfully.');
148
-
149
- // With post-processing enabled
150
- const r3 = new FunctionResult('Processing payment...', true);
151
- ```
152
-
153
- ---
154
-
155
- ### setResponse
156
-
157
- Set or replace the response text.
158
-
159
- ```typescript
160
- setResponse(response: string): this
161
- ```
162
-
163
- | Parameter | Type | Description |
164
- |------------|----------|---------------------------|
165
- | `response` | `string` | The new response text. |
166
-
167
- **Returns:** `this` for chaining.
168
-
169
- ```typescript
170
- const result = new FunctionResult()
171
- .setResponse('Your balance is $42.50');
172
- ```
173
-
174
- ---
175
-
176
- ### setPostProcess
177
-
178
- Enable or disable post-processing of actions.
179
-
180
- When post-processing is enabled, the actions are executed **after** the AI has formulated its spoken response to the caller, rather than before. This is useful when you want the AI to speak first and then perform side effects (like hanging up).
181
-
182
- ```typescript
183
- setPostProcess(postProcess: boolean): this
184
- ```
185
-
186
- | Parameter | Type | Description |
187
- |---------------|-----------|------------------------------------------|
188
- | `postProcess` | `boolean` | Whether to enable post-processing. |
189
-
190
- **Returns:** `this` for chaining.
191
-
192
- ```typescript
193
- const result = new FunctionResult('Goodbye!')
194
- .setPostProcess(true)
195
- .hangup();
196
- // The AI says "Goodbye!" first, then the hangup executes.
197
- ```
198
-
199
- ---
200
-
201
- ### addAction
202
-
203
- Append a single named action to the action list. This is the low-level method used internally by most other methods. You can use it directly for custom or undocumented actions.
204
-
205
- ```typescript
206
- addAction(name: string, data: unknown): this
207
- ```
208
-
209
- | Parameter | Type | Description |
210
- |-----------|-----------|-----------------------------------------|
211
- | `name` | `string` | The action name (e.g., `"hangup"`). |
212
- | `data` | `unknown` | The action payload. |
213
-
214
- **Returns:** `this` for chaining.
215
-
216
- ```typescript
217
- const result = new FunctionResult('Done')
218
- .addAction('custom_action', { key: 'value' });
219
- // action: [{ custom_action: { key: "value" } }]
220
- ```
221
-
222
- ---
223
-
224
- ### addActions
225
-
226
- Append multiple action objects at once. Each object in the array should be a single-key record mapping an action name to its payload.
227
-
228
- ```typescript
229
- addActions(actions: Record<string, unknown>[]): this
230
- ```
231
-
232
- | Parameter | Type | Description |
233
- |-----------|-----------------------------|------------------------------------|
234
- | `actions` | `Record<string, unknown>[]` | Array of action objects to append. |
235
-
236
- **Returns:** `this` for chaining.
237
-
238
- ```typescript
239
- const result = new FunctionResult('Multi-step')
240
- .addActions([
241
- { say: 'Step one complete.' },
242
- { say: 'Step two complete.' },
243
- { hangup: true },
244
- ]);
245
- ```
246
-
247
- ---
248
-
249
- ### toDict
250
-
251
- Serialize the result to a plain object for the SWAIG response wire format.
252
-
253
- ```typescript
254
- toDict(): Record<string, unknown>
255
- ```
256
-
257
- **Returns:** A dictionary with `response`, `action`, and optionally `post_process` fields.
258
-
259
- **Behavior:**
260
- - If `response` is non-empty, it is included as `response`.
261
- - If `action` has entries, they are included as `action`.
262
- - If `postProcess` is `true` and there are actions, `post_process: true` is included.
263
- - If both `response` and `action` are empty, the result falls back to `{ response: "Action completed." }`.
264
-
265
- ```typescript
266
- const result = new FunctionResult('Hello').say('Welcome!');
267
- console.log(result.toDict());
268
- // {
269
- // response: "Hello",
270
- // action: [{ say: "Welcome!" }]
271
- // }
272
-
273
- const empty = new FunctionResult();
274
- console.log(empty.toDict());
275
- // { response: "Action completed." }
276
- ```
277
-
278
- ---
279
-
280
- ## Call Control
281
-
282
- ### connect
283
-
284
- Connect (transfer) the call to another destination using SWML. This generates an inline SWML document with a `connect` verb.
285
-
286
- ```typescript
287
- connect(destination: string, final?: boolean, fromAddr?: string): this
288
- ```
289
-
290
- | Parameter | Type | Default | Description |
291
- |---------------|-----------|---------|----------------------------------------------------------|
292
- | `destination` | `string` | -- | Phone number or SIP URI to connect to. |
293
- | `final` | `boolean` | `true` | If `true`, the AI session ends after the transfer. |
294
- | `fromAddr` | `string` | -- | Optional caller ID for the outbound leg. |
295
-
296
- **Returns:** `this` for chaining.
297
-
298
- ```typescript
299
- // Simple transfer
300
- const result = new FunctionResult('Connecting you to support.')
301
- .connect('+15551234567');
302
-
303
- // Non-final transfer (AI continues after the connected call ends)
304
- const result2 = new FunctionResult('Let me conference in my manager.')
305
- .connect('+15559876543', false);
306
-
307
- // Transfer with custom caller ID
308
- const result3 = new FunctionResult('Transferring...')
309
- .connect('+15551234567', true, '+15550001111');
310
- ```
311
-
312
- ---
313
-
314
- ### swmlTransfer
315
-
316
- Transfer the call to a SWML destination with a custom AI response set before transferring. Unlike `connect`, this uses the SWML `transfer` verb with a `set` verb to inject an AI response.
317
-
318
- ```typescript
319
- swmlTransfer(dest: string, aiResponse: string, final?: boolean): this
320
- ```
321
-
322
- | Parameter | Type | Default | Description |
323
- |--------------|-----------|---------|----------------------------------------------------|
324
- | `dest` | `string` | -- | The transfer destination. |
325
- | `aiResponse` | `string` | -- | AI response text to set before transferring. |
326
- | `final` | `boolean` | `true` | Whether this is a final transfer. |
327
-
328
- **Returns:** `this` for chaining.
329
-
330
- ```typescript
331
- const result = new FunctionResult('Transfer initiated.')
332
- .swmlTransfer('sip:support@example.com', 'Call is being transferred to support.');
333
- ```
334
-
335
- ---
336
-
337
- ### hangup
338
-
339
- Hang up the call. Adds a `{ hangup: true }` action.
340
-
341
- ```typescript
342
- hangup(): this
343
- ```
344
-
345
- **Returns:** `this` for chaining.
346
-
347
- ```typescript
348
- const result = new FunctionResult('Thank you for calling. Goodbye!')
349
- .setPostProcess(true)
350
- .hangup();
351
- ```
352
-
353
- ---
354
-
355
- ### hold
356
-
357
- Place the call on hold for a specified duration. The timeout is clamped between 0 and 900 seconds (15 minutes).
358
-
359
- ```typescript
360
- hold(timeout?: number): this
361
- ```
362
-
363
- | Parameter | Type | Default | Description |
364
- |-----------|----------|---------|--------------------------------------|
365
- | `timeout` | `number` | `300` | Hold duration in seconds (0--900). |
366
-
367
- **Returns:** `this` for chaining.
368
-
369
- ```typescript
370
- // Hold for default 5 minutes
371
- const result = new FunctionResult('Please hold.').hold();
372
-
373
- // Hold for 60 seconds
374
- const result2 = new FunctionResult('Brief hold.').hold(60);
375
- ```
376
-
377
- ---
378
-
379
- ### waitForUser
380
-
381
- Wait for user input before continuing. Supports multiple modes: simple enable/disable, a timeout, or an "answer first" mode.
382
-
383
- ```typescript
384
- waitForUser(opts?: {
385
- enabled?: boolean;
386
- timeout?: number;
387
- answerFirst?: boolean;
388
- }): this
389
- ```
390
-
391
- | Parameter | Type | Default | Description |
392
- |--------------------|-----------|---------|--------------------------------------------------|
393
- | `opts.enabled` | `boolean` | -- | Enable or disable waiting for user input. |
394
- | `opts.timeout` | `number` | -- | Timeout in seconds to wait for user input. |
395
- | `opts.answerFirst` | `boolean` | -- | If `true`, wait for the call to be answered first. |
396
-
397
- **Priority:** `answerFirst` > `timeout` > `enabled`. If no options are provided, `wait_for_user` is set to `true`.
398
-
399
- **Returns:** `this` for chaining.
400
-
401
- ```typescript
402
- // Simple wait
403
- const r1 = new FunctionResult('Go ahead.').waitForUser();
404
-
405
- // Wait with timeout
406
- const r2 = new FunctionResult('I will wait 10 seconds.')
407
- .waitForUser({ timeout: 10 });
408
-
409
- // Answer-first mode
410
- const r3 = new FunctionResult('Waiting for answer.')
411
- .waitForUser({ answerFirst: true });
412
-
413
- // Disable waiting
414
- const r4 = new FunctionResult('Continuing.')
415
- .waitForUser({ enabled: false });
416
- ```
417
-
418
- ---
419
-
420
- ### stop
421
-
422
- Stop the AI session entirely. Adds a `{ stop: true }` action.
423
-
424
- ```typescript
425
- stop(): this
426
- ```
427
-
428
- **Returns:** `this` for chaining.
429
-
430
- ```typescript
431
- const result = new FunctionResult('Session ended.').stop();
432
- ```
433
-
434
- ---
435
-
436
- ## Audio
437
-
438
- ### say
439
-
440
- Speak text to the caller via text-to-speech (TTS).
441
-
442
- ```typescript
443
- say(text: string): this
444
- ```
445
-
446
- | Parameter | Type | Description |
447
- |-----------|----------|--------------------------|
448
- | `text` | `string` | The text to speak. |
449
-
450
- **Returns:** `this` for chaining.
451
-
452
- ```typescript
453
- const result = new FunctionResult('Info retrieved.')
454
- .say('Your order number is 12345.');
455
- ```
456
-
457
- ---
458
-
459
- ### playBackgroundFile
460
-
461
- Play an audio file in the background during the call. The AI conversation continues while the file plays.
462
-
463
- ```typescript
464
- playBackgroundFile(filename: string, wait?: boolean): this
465
- ```
466
-
467
- | Parameter | Type | Default | Description |
468
- |------------|-----------|---------|----------------------------------------------------|
469
- | `filename` | `string` | -- | URL or path of the audio file. |
470
- | `wait` | `boolean` | `false` | If `true`, block until playback completes. |
471
-
472
- **Returns:** `this` for chaining.
473
-
474
- ```typescript
475
- // Play background music (non-blocking)
476
- const result = new FunctionResult('Playing hold music.')
477
- .playBackgroundFile('https://example.com/hold-music.mp3');
478
-
479
- // Play and wait for completion
480
- const result2 = new FunctionResult('Listen to this announcement.')
481
- .playBackgroundFile('https://example.com/announcement.wav', true);
482
- ```
483
-
484
- ---
485
-
486
- ### stopBackgroundFile
487
-
488
- Stop any currently playing background audio file.
489
-
490
- ```typescript
491
- stopBackgroundFile(): this
492
- ```
493
-
494
- **Returns:** `this` for chaining.
495
-
496
- ```typescript
497
- const result = new FunctionResult('Stopping music.')
498
- .stopBackgroundFile();
499
- ```
500
-
501
- ---
502
-
503
- ## Speech
504
-
505
- ### addDynamicHints
506
-
507
- Add dynamic speech recognition hints to improve transcription accuracy for specific words or phrases. Hints can be plain strings or pattern-replacement objects.
508
-
509
- ```typescript
510
- addDynamicHints(
511
- hints: (string | { pattern: string; replace: string; ignore_case?: boolean })[]
512
- ): this
513
- ```
514
-
515
- | Parameter | Type | Description |
516
- |-----------|-----------------------------------------------------------------------------------|------------------------------------------------|
517
- | `hints` | `(string \| { pattern: string; replace: string; ignore_case?: boolean })[]` | Array of hint strings or pattern objects. |
518
-
519
- **Returns:** `this` for chaining.
520
-
521
- ```typescript
522
- // Simple word hints
523
- const result = new FunctionResult('Ready.')
524
- .addDynamicHints(['SignalWire', 'SWML', 'SWAIG']);
525
-
526
- // Pattern-replacement hints
527
- const result2 = new FunctionResult('Ready.')
528
- .addDynamicHints([
529
- { pattern: 'signal wire', replace: 'SignalWire', ignore_case: true },
530
- { pattern: 'swiggy', replace: 'SWAIG' },
531
- ]);
532
- ```
533
-
534
- ---
535
-
536
- ### clearDynamicHints
537
-
538
- Remove all previously added dynamic speech recognition hints.
539
-
540
- ```typescript
541
- clearDynamicHints(): this
542
- ```
543
-
544
- **Returns:** `this` for chaining.
545
-
546
- ```typescript
547
- const result = new FunctionResult('Hints cleared.')
548
- .clearDynamicHints();
549
- ```
550
-
551
- ---
552
-
553
- ### setEndOfSpeechTimeout
554
-
555
- Set the silence duration that marks the end of a user's speech. A shorter timeout makes the AI respond more quickly after the user stops talking; a longer timeout allows for natural pauses.
556
-
557
- ```typescript
558
- setEndOfSpeechTimeout(milliseconds: number): this
559
- ```
560
-
561
- | Parameter | Type | Description |
562
- |----------------|----------|-----------------------------------|
563
- | `milliseconds` | `number` | Timeout in milliseconds. |
564
-
565
- **Returns:** `this` for chaining.
566
-
567
- ```typescript
568
- const result = new FunctionResult('Adjusted speech timeout.')
569
- .setEndOfSpeechTimeout(500); // 500ms of silence = end of speech
570
- ```
571
-
572
- ---
573
-
574
- ### setSpeechEventTimeout
575
-
576
- Set the timeout for speech event detection.
577
-
578
- ```typescript
579
- setSpeechEventTimeout(milliseconds: number): this
580
- ```
581
-
582
- | Parameter | Type | Description |
583
- |----------------|----------|-----------------------------------|
584
- | `milliseconds` | `number` | Timeout in milliseconds. |
585
-
586
- **Returns:** `this` for chaining.
587
-
588
- ```typescript
589
- const result = new FunctionResult('Event timeout set.')
590
- .setSpeechEventTimeout(3000);
591
- ```
592
-
593
- ---
594
-
595
- ## Data Management
596
-
597
- ### updateGlobalData
598
-
599
- Merge key-value pairs into the global data store. The global data store is shared across all SWAIG functions during a call and persists for the call's lifetime.
600
-
601
- ```typescript
602
- updateGlobalData(data: Record<string, unknown>): this
603
- ```
604
-
605
- | Parameter | Type | Description |
606
- |-----------|----------------------------|------------------------------------|
607
- | `data` | `Record<string, unknown>` | Key-value pairs to set or update. |
608
-
609
- **Returns:** `this` for chaining.
610
-
611
- ```typescript
612
- const result = new FunctionResult('Data saved.')
613
- .updateGlobalData({ customer_id: 'C-123', tier: 'premium' });
614
- ```
615
-
616
- ---
617
-
618
- ### removeGlobalData
619
-
620
- Remove one or more keys from the global data store.
621
-
622
- ```typescript
623
- removeGlobalData(keys: string | string[]): this
624
- ```
625
-
626
- | Parameter | Type | Description |
627
- |-----------|----------------------|------------------------------------------|
628
- | `keys` | `string \| string[]` | A single key or array of keys to remove. |
629
-
630
- **Returns:** `this` for chaining.
631
-
632
- ```typescript
633
- // Remove a single key
634
- const r1 = new FunctionResult('Removed.')
635
- .removeGlobalData('temp_token');
636
-
637
- // Remove multiple keys
638
- const r2 = new FunctionResult('Cleaned up.')
639
- .removeGlobalData(['temp_token', 'session_cache']);
640
- ```
641
-
642
- ---
643
-
644
- ### setMetadata
645
-
646
- Set metadata key-value pairs on the current call. Metadata is attached to the call record and can be used for reporting, billing tags, or downstream processing.
647
-
648
- ```typescript
649
- setMetadata(data: Record<string, unknown>): this
650
- ```
651
-
652
- | Parameter | Type | Description |
653
- |-----------|----------------------------|-------------------------------|
654
- | `data` | `Record<string, unknown>` | Metadata key-value pairs. |
655
-
656
- **Returns:** `this` for chaining.
657
-
658
- ```typescript
659
- const result = new FunctionResult('Metadata set.')
660
- .setMetadata({ department: 'sales', priority: 'high' });
661
- ```
662
-
663
- ---
664
-
665
- ### removeMetadata
666
-
667
- Remove metadata keys from the current call.
668
-
669
- ```typescript
670
- removeMetadata(keys: string | string[]): this
671
- ```
672
-
673
- | Parameter | Type | Description |
674
- |-----------|----------------------|------------------------------------------|
675
- | `keys` | `string \| string[]` | A single key or array of keys to remove. |
676
-
677
- **Returns:** `this` for chaining.
678
-
679
- ```typescript
680
- const result = new FunctionResult('Metadata removed.')
681
- .removeMetadata(['temp_flag', 'debug_info']);
682
- ```
683
-
684
- ---
685
-
686
- ## SWML Actions
687
-
688
- ### executeSwml
689
-
690
- Execute arbitrary SWML content as an action. Accepts either a JSON string or an object. If the string is not valid JSON, it is wrapped in a `{ raw_swml: ... }` object.
691
-
692
- ```typescript
693
- executeSwml(
694
- swmlContent: string | Record<string, unknown>,
695
- transfer?: boolean
696
- ): this
697
- ```
698
-
699
- | Parameter | Type | Default | Description |
700
- |---------------|-----------------------------------------|---------|---------------------------------------------------|
701
- | `swmlContent` | `string \| Record<string, unknown>` | -- | SWML as a JSON string or object. |
702
- | `transfer` | `boolean` | `false` | If `true`, the SWML execution transfers the call. |
703
-
704
- **Returns:** `this` for chaining.
705
-
706
- ```typescript
707
- // Execute SWML from an object
708
- const result = new FunctionResult('Executing custom flow.')
709
- .executeSwml({
710
- version: '1.0.0',
711
- sections: {
712
- main: [{ play: { url: 'https://example.com/audio.mp3' } }],
713
- },
714
- });
715
-
716
- // Execute with transfer
717
- const result2 = new FunctionResult('Transferring via SWML.')
718
- .executeSwml({
719
- version: '1.0.0',
720
- sections: {
721
- main: [{ connect: { to: '+15551234567' } }],
722
- },
723
- }, true);
724
- ```
725
-
726
- ---
727
-
728
- ### switchContext
729
-
730
- Switch the AI context at runtime. This can change the system prompt, inject a user prompt, consolidate conversation history, or perform a full reset of the AI context.
731
-
732
- ```typescript
733
- switchContext(opts?: {
734
- systemPrompt?: string;
735
- userPrompt?: string;
736
- consolidate?: boolean;
737
- fullReset?: boolean;
738
- }): this
739
- ```
740
-
741
- | Parameter | Type | Description |
742
- |---------------------|-----------|-------------------------------------------------------------------|
743
- | `opts.systemPrompt` | `string` | New system prompt to switch to. |
744
- | `opts.userPrompt` | `string` | User prompt to inject into the new context. |
745
- | `opts.consolidate` | `boolean` | If `true`, summarize and carry over conversation history. |
746
- | `opts.fullReset` | `boolean` | If `true`, completely reset the AI context (clear all history). |
747
-
748
- **Behavior:** If only `systemPrompt` is provided (no other options), the action uses a simple string value. Otherwise, it builds an object with the specified fields.
749
-
750
- **Returns:** `this` for chaining.
751
-
752
- ```typescript
753
- // Simple context switch -- just change the system prompt
754
- const r1 = new FunctionResult('Switching to billing mode.')
755
- .switchContext({ systemPrompt: 'You are a billing specialist.' });
756
-
757
- // Switch with consolidation (carry over conversation summary)
758
- const r2 = new FunctionResult('Escalating to supervisor.')
759
- .switchContext({
760
- systemPrompt: 'You are a supervisor handling an escalated call.',
761
- consolidate: true,
762
- });
763
-
764
- // Full reset
765
- const r3 = new FunctionResult('Starting fresh.')
766
- .switchContext({
767
- systemPrompt: 'You are a general assistant.',
768
- fullReset: true,
769
- });
770
- ```
771
-
772
- ---
773
-
774
- ### swmlChangeStep
775
-
776
- Change the current SWML step. Steps are named blocks within a SWML document that control call flow.
777
-
778
- ```typescript
779
- swmlChangeStep(stepName: string): this
780
- ```
781
-
782
- | Parameter | Type | Description |
783
- |------------|----------|------------------------------------|
784
- | `stepName` | `string` | The name of the step to switch to. |
785
-
786
- **Returns:** `this` for chaining.
787
-
788
- ```typescript
789
- const result = new FunctionResult('Moving to verification.')
790
- .swmlChangeStep('verify_identity');
791
- ```
792
-
793
- ---
794
-
795
- ### swmlChangeContext
796
-
797
- Change the current SWML context. Contexts are separate AI configurations that can be switched during a call.
798
-
799
- ```typescript
800
- swmlChangeContext(contextName: string): this
801
- ```
802
-
803
- | Parameter | Type | Description |
804
- |---------------|----------|---------------------------------------|
805
- | `contextName` | `string` | The name of the context to switch to. |
806
-
807
- **Returns:** `this` for chaining.
808
-
809
- ```typescript
810
- const result = new FunctionResult('Switching to Spanish.')
811
- .swmlChangeContext('spanish_support');
812
- ```
813
-
814
- ---
815
-
816
- ### swmlUserEvent
817
-
818
- Emit a custom user event via SWML. User events can be consumed by external systems listening to the call's event stream.
819
-
820
- ```typescript
821
- swmlUserEvent(eventData: Record<string, unknown>): this
822
- ```
823
-
824
- | Parameter | Type | Description |
825
- |-------------|----------------------------|----------------------|
826
- | `eventData` | `Record<string, unknown>` | The event payload. |
827
-
828
- **Returns:** `this` for chaining.
829
-
830
- ```typescript
831
- const result = new FunctionResult('Event emitted.')
832
- .swmlUserEvent({
833
- type: 'order_placed',
834
- order_id: 'ORD-456',
835
- total: 29.99,
836
- });
837
- ```
838
-
839
- ---
840
-
841
- ## Function Control
842
-
843
- ### toggleFunctions
844
-
845
- Enable or disable SWAIG functions by name at runtime. This allows dynamic control over which tools the AI can call based on the conversation state.
846
-
847
- ```typescript
848
- toggleFunctions(toggles: { function: string; active: boolean }[]): this
849
- ```
850
-
851
- | Parameter | Type | Description |
852
- |--------------------|-----------|------------------------------------------|
853
- | `toggles[].function` | `string` | The name of the SWAIG function. |
854
- | `toggles[].active` | `boolean` | `true` to enable, `false` to disable. |
855
-
856
- **Returns:** `this` for chaining.
857
-
858
- ```typescript
859
- // After authentication, enable account-specific tools
860
- const result = new FunctionResult('Identity verified.')
861
- .toggleFunctions([
862
- { function: 'check_balance', active: true },
863
- { function: 'make_payment', active: true },
864
- { function: 'verify_identity', active: false },
865
- ]);
866
- ```
867
-
868
- ---
869
-
870
- ### enableFunctionsOnTimeout
871
-
872
- Control whether SWAIG functions can fire automatically when the speaker timeout triggers (i.e., when the caller is silent).
873
-
874
- ```typescript
875
- enableFunctionsOnTimeout(enabled?: boolean): this
876
- ```
877
-
878
- | Parameter | Type | Default | Description |
879
- |-----------|-----------|---------|------------------------------------------------------|
880
- | `enabled` | `boolean` | `true` | Whether to enable function execution on timeout. |
881
-
882
- **Returns:** `this` for chaining.
883
-
884
- ```typescript
885
- // Enable functions on speaker timeout
886
- const r1 = new FunctionResult('Monitoring silence.')
887
- .enableFunctionsOnTimeout();
888
-
889
- // Disable functions on speaker timeout
890
- const r2 = new FunctionResult('Waiting patiently.')
891
- .enableFunctionsOnTimeout(false);
892
- ```
893
-
894
- ---
895
-
896
- ### updateSettings
897
-
898
- Update AI engine settings at runtime. This allows dynamic modification of parameters like temperature, top_p, or any other engine setting.
899
-
900
- ```typescript
901
- updateSettings(settings: Record<string, unknown>): this
902
- ```
903
-
904
- | Parameter | Type | Description |
905
- |------------|----------------------------|--------------------------------------|
906
- | `settings` | `Record<string, unknown>` | Key-value pairs of settings. |
907
-
908
- **Returns:** `this` for chaining.
909
-
910
- ```typescript
911
- const result = new FunctionResult('Settings updated.')
912
- .updateSettings({ temperature: 0.3, top_p: 0.9 });
913
- ```
914
-
915
- ---
916
-
917
- ## User Input and History
918
-
919
- ### simulateUserInput
920
-
921
- Inject text as if the user had spoken it. This is useful for programmatically driving the conversation flow.
922
-
923
- ```typescript
924
- simulateUserInput(text: string): this
925
- ```
926
-
927
- | Parameter | Type | Description |
928
- |-----------|----------|------------------------------------|
929
- | `text` | `string` | The simulated user input text. |
930
-
931
- **Returns:** `this` for chaining.
932
-
933
- ```typescript
934
- const result = new FunctionResult('Proceeding with default.')
935
- .simulateUserInput('Yes, please go ahead.');
936
- ```
937
-
938
- ---
939
-
940
- ### enableExtensiveData
941
-
942
- Enable or disable extensive data reporting in function calls. When enabled, SWAIG function invocations include additional metadata about the call state.
943
-
944
- ```typescript
945
- enableExtensiveData(enabled?: boolean): this
946
- ```
947
-
948
- | Parameter | Type | Default | Description |
949
- |-----------|-----------|---------|------------------------------------------|
950
- | `enabled` | `boolean` | `true` | Whether to enable extensive data. |
951
-
952
- **Returns:** `this` for chaining.
953
-
954
- ```typescript
955
- const result = new FunctionResult('Extensive data enabled.')
956
- .enableExtensiveData();
957
- ```
958
-
959
- ---
960
-
961
- ### replaceInHistory
962
-
963
- Replace the function call output in the conversation history. This controls what the AI "remembers" about this function invocation.
964
-
965
- ```typescript
966
- replaceInHistory(text?: string | boolean): this
967
- ```
968
-
969
- | Parameter | Type | Default | Description |
970
- |-----------|-----------------------|---------|-----------------------------------------------------------|
971
- | `text` | `string \| boolean` | `true` | Replacement text, or `true` to replace with the response. |
972
-
973
- **Returns:** `this` for chaining.
974
-
975
- ```typescript
976
- // Replace with the response text
977
- const r1 = new FunctionResult('Sensitive data redacted.')
978
- .replaceInHistory();
979
-
980
- // Replace with custom text
981
- const r2 = new FunctionResult('SSN verified.')
982
- .replaceInHistory('Identity verification completed.');
983
- ```
984
-
985
- ---
986
-
987
- ## Communication
988
-
989
- ### sendSms
990
-
991
- Send an SMS or MMS message from within the call flow. At least one of `body` or `media` must be provided.
992
-
993
- ```typescript
994
- sendSms(opts: {
995
- toNumber: string;
996
- fromNumber: string;
997
- body?: string;
998
- media?: string[];
999
- tags?: string[];
1000
- region?: string;
1001
- }): this
1002
- ```
1003
-
1004
- | Parameter | Type | Description |
1005
- |------------------|------------|------------------------------------------------|
1006
- | `opts.toNumber` | `string` | Recipient phone number. |
1007
- | `opts.fromNumber` | `string` | Sender phone number (must be a number you own).|
1008
- | `opts.body` | `string` | SMS text body. |
1009
- | `opts.media` | `string[]` | Array of media URLs for MMS. |
1010
- | `opts.tags` | `string[]` | Optional tags for the message. |
1011
- | `opts.region` | `string` | Optional region for message routing. |
1012
-
1013
- **Throws:** `Error` if neither `body` nor `media` is provided.
1014
-
1015
- **Returns:** `this` for chaining.
1016
-
1017
- ```typescript
1018
- // Send a text SMS
1019
- const result = new FunctionResult('Confirmation sent.')
1020
- .sendSms({
1021
- toNumber: '+15551234567',
1022
- fromNumber: '+15559876543',
1023
- body: 'Your appointment is confirmed for tomorrow at 2pm.',
1024
- });
1025
-
1026
- // Send an MMS with an image
1027
- const result2 = new FunctionResult('Receipt sent.')
1028
- .sendSms({
1029
- toNumber: '+15551234567',
1030
- fromNumber: '+15559876543',
1031
- body: 'Here is your receipt:',
1032
- media: ['https://example.com/receipt.png'],
1033
- });
1034
- ```
1035
-
1036
- ---
1037
-
1038
- ### recordCall
1039
-
1040
- Start recording the call with configurable options.
1041
-
1042
- ```typescript
1043
- recordCall(opts?: {
1044
- controlId?: string;
1045
- stereo?: boolean;
1046
- format?: 'wav' | 'mp3';
1047
- direction?: 'speak' | 'listen' | 'both';
1048
- terminators?: string;
1049
- beep?: boolean;
1050
- inputSensitivity?: number;
1051
- initialTimeout?: number;
1052
- endSilenceTimeout?: number;
1053
- maxLength?: number;
1054
- statusUrl?: string;
1055
- }): this
1056
- ```
1057
-
1058
- | Parameter | Type | Default | Description |
1059
- |-------------------------|---------------------------------|----------|-------------------------------------------------|
1060
- | `opts.controlId` | `string` | -- | Identifier for this recording (for stop/status).|
1061
- | `opts.stereo` | `boolean` | `false` | Record in stereo (separate channels). |
1062
- | `opts.format` | `'wav' \| 'mp3'` | `'wav'` | Recording file format. |
1063
- | `opts.direction` | `'speak' \| 'listen' \| 'both'` | `'both'` | Which audio direction to record. |
1064
- | `opts.terminators` | `string` | -- | DTMF keys that stop the recording. |
1065
- | `opts.beep` | `boolean` | `false` | Play a beep when recording starts. |
1066
- | `opts.inputSensitivity` | `number` | `44.0` | Sensitivity for voice activity detection. |
1067
- | `opts.initialTimeout` | `number` | -- | Seconds to wait for initial speech. |
1068
- | `opts.endSilenceTimeout`| `number` | -- | Seconds of silence before stopping. |
1069
- | `opts.maxLength` | `number` | -- | Maximum recording length in seconds. |
1070
- | `opts.statusUrl` | `string` | -- | Webhook URL for recording status callbacks. |
1071
-
1072
- **Returns:** `this` for chaining.
1073
-
1074
- ```typescript
1075
- // Simple recording
1076
- const result = new FunctionResult('Recording started.')
1077
- .recordCall();
1078
-
1079
- // Stereo MP3 recording with a control ID
1080
- const result2 = new FunctionResult('Recording...')
1081
- .recordCall({
1082
- controlId: 'main-recording',
1083
- stereo: true,
1084
- format: 'mp3',
1085
- maxLength: 3600,
1086
- statusUrl: 'https://example.com/recording-status',
1087
- });
1088
- ```
1089
-
1090
- ---
1091
-
1092
- ### stopRecordCall
1093
-
1094
- Stop an active call recording.
1095
-
1096
- ```typescript
1097
- stopRecordCall(controlId?: string): this
1098
- ```
1099
-
1100
- | Parameter | Type | Description |
1101
- |-------------|----------|--------------------------------------------------|
1102
- | `controlId` | `string` | Optional control ID of the recording to stop. |
1103
-
1104
- **Returns:** `this` for chaining.
1105
-
1106
- ```typescript
1107
- const result = new FunctionResult('Recording stopped.')
1108
- .stopRecordCall('main-recording');
1109
- ```
1110
-
1111
- ---
1112
-
1113
- ### tap
1114
-
1115
- Start a media tap to stream audio to an external URI (e.g., for real-time transcription or monitoring).
1116
-
1117
- ```typescript
1118
- tap(opts: {
1119
- uri: string;
1120
- controlId?: string;
1121
- direction?: 'speak' | 'hear' | 'both';
1122
- codec?: 'PCMU' | 'PCMA';
1123
- rtpPtime?: number;
1124
- statusUrl?: string;
1125
- }): this
1126
- ```
1127
-
1128
- | Parameter | Type | Default | Description |
1129
- |------------------|----------------------------------|----------|----------------------------------------------|
1130
- | `opts.uri` | `string` | -- | Destination URI for the media stream. |
1131
- | `opts.controlId` | `string` | -- | Identifier for this tap (for stop/status). |
1132
- | `opts.direction` | `'speak' \| 'hear' \| 'both'` | `'both'` | Which audio direction to tap. |
1133
- | `opts.codec` | `'PCMU' \| 'PCMA'` | `'PCMU'` | Audio codec for the stream. |
1134
- | `opts.rtpPtime` | `number` | `20` | RTP packetization time in milliseconds. |
1135
- | `opts.statusUrl` | `string` | -- | Webhook URL for tap status callbacks. |
1136
-
1137
- **Returns:** `this` for chaining.
1138
-
1139
- ```typescript
1140
- const result = new FunctionResult('Tap started.')
1141
- .tap({
1142
- uri: 'wss://transcription.example.com/stream',
1143
- controlId: 'realtime-tap',
1144
- direction: 'both',
1145
- });
1146
- ```
1147
-
1148
- ---
1149
-
1150
- ### stopTap
1151
-
1152
- Stop an active media tap.
1153
-
1154
- ```typescript
1155
- stopTap(controlId?: string): this
1156
- ```
1157
-
1158
- | Parameter | Type | Description |
1159
- |-------------|----------|---------------------------------------------|
1160
- | `controlId` | `string` | Optional control ID of the tap to stop. |
1161
-
1162
- **Returns:** `this` for chaining.
1163
-
1164
- ```typescript
1165
- const result = new FunctionResult('Tap stopped.')
1166
- .stopTap('realtime-tap');
1167
- ```
1168
-
1169
- ---
1170
-
1171
- ## Rooms and Conferencing
1172
-
1173
- ### joinRoom
1174
-
1175
- Join a SignalWire room by name.
1176
-
1177
- ```typescript
1178
- joinRoom(name: string): this
1179
- ```
1180
-
1181
- | Parameter | Type | Description |
1182
- |-----------|----------|-----------------------|
1183
- | `name` | `string` | The room name. |
1184
-
1185
- **Returns:** `this` for chaining.
1186
-
1187
- ```typescript
1188
- const result = new FunctionResult('Joining the meeting room.')
1189
- .joinRoom('team-standup');
1190
- ```
1191
-
1192
- ---
1193
-
1194
- ### sipRefer
1195
-
1196
- Send a SIP REFER to transfer the call to another SIP endpoint.
1197
-
1198
- ```typescript
1199
- sipRefer(toUri: string): this
1200
- ```
1201
-
1202
- | Parameter | Type | Description |
1203
- |-----------|----------|---------------------------------------|
1204
- | `toUri` | `string` | The SIP URI to refer the call to. |
1205
-
1206
- **Returns:** `this` for chaining.
1207
-
1208
- ```typescript
1209
- const result = new FunctionResult('Transferring via SIP.')
1210
- .sipRefer('sip:agent@pbx.example.com');
1211
- ```
1212
-
1213
- ---
1214
-
1215
- ### joinConference
1216
-
1217
- Join a conference by name with optional configuration parameters.
1218
-
1219
- ```typescript
1220
- joinConference(name: string, opts?: {
1221
- muted?: boolean;
1222
- beep?: 'true' | 'false' | 'onEnter' | 'onExit';
1223
- startOnEnter?: boolean;
1224
- endOnExit?: boolean;
1225
- waitUrl?: string;
1226
- maxParticipants?: number;
1227
- record?: 'do-not-record' | 'record-from-start';
1228
- region?: string;
1229
- trim?: 'trim-silence' | 'do-not-trim';
1230
- coach?: string;
1231
- statusCallbackEvent?: string;
1232
- statusCallback?: string;
1233
- statusCallbackMethod?: 'GET' | 'POST';
1234
- recordingStatusCallback?: string;
1235
- recordingStatusCallbackMethod?: 'GET' | 'POST';
1236
- recordingStatusCallbackEvent?: string;
1237
- result?: unknown;
1238
- }): this
1239
- ```
1240
-
1241
- | Parameter | Type | Default | Description |
1242
- |----------------------------------------|---------------------------------------------|---------------------|------------------------------------------------------|
1243
- | `name` | `string` | -- | Conference name. |
1244
- | `opts.muted` | `boolean` | -- | Join muted. |
1245
- | `opts.beep` | `'true' \| 'false' \| 'onEnter' \| 'onExit'` | `'true'` | When to play the beep sound. |
1246
- | `opts.startOnEnter` | `boolean` | `true` | Start the conference when this participant joins. |
1247
- | `opts.endOnExit` | `boolean` | -- | End the conference when this participant leaves. |
1248
- | `opts.waitUrl` | `string` | -- | URL to play while waiting for the conference to start.|
1249
- | `opts.maxParticipants` | `number` | `250` | Maximum number of participants. |
1250
- | `opts.record` | `'do-not-record' \| 'record-from-start'` | `'do-not-record'` | Recording mode. |
1251
- | `opts.region` | `string` | -- | Region for the conference. |
1252
- | `opts.trim` | `'trim-silence' \| 'do-not-trim'` | `'trim-silence'` | Silence trimming mode for recordings. |
1253
- | `opts.coach` | `string` | -- | Call SID of participant to coach (whisper to). |
1254
- | `opts.statusCallbackEvent` | `string` | -- | Events to trigger status callback. |
1255
- | `opts.statusCallback` | `string` | -- | URL for status callback. |
1256
- | `opts.statusCallbackMethod` | `'GET' \| 'POST'` | `'POST'` | HTTP method for status callback. |
1257
- | `opts.recordingStatusCallback` | `string` | -- | URL for recording status callback. |
1258
- | `opts.recordingStatusCallbackMethod` | `'GET' \| 'POST'` | `'POST'` | HTTP method for recording status callback. |
1259
- | `opts.recordingStatusCallbackEvent` | `string` | `'completed'` | Events to trigger recording status callback. |
1260
- | `opts.result` | `unknown` | -- | Custom result data. |
1261
-
1262
- **Behavior:** When only the `name` is provided (or all options are at their defaults), the `join_conference` action uses the name as a simple string value. When non-default options are specified, it uses an object with all the configured parameters.
1263
-
1264
- **Returns:** `this` for chaining.
1265
-
1266
- ```typescript
1267
- // Simple conference join
1268
- const result = new FunctionResult('Joining conference.')
1269
- .joinConference('support-queue');
1270
-
1271
- // Conference with options
1272
- const result2 = new FunctionResult('Joining as listener.')
1273
- .joinConference('all-hands', {
1274
- muted: true,
1275
- record: 'record-from-start',
1276
- maxParticipants: 50,
1277
- beep: 'onEnter',
1278
- });
1279
- ```
1280
-
1281
- ---
1282
-
1283
- ## RPC
1284
-
1285
- ### executeRpc
1286
-
1287
- Execute a SignalWire RPC method via SWML. This is the low-level RPC method; convenience wrappers like `rpcDial`, `rpcAiMessage`, and `rpcAiUnhold` are built on top of it.
1288
-
1289
- ```typescript
1290
- executeRpc(opts: {
1291
- method: string;
1292
- params?: Record<string, unknown>;
1293
- callId?: string;
1294
- nodeId?: string;
1295
- }): this
1296
- ```
1297
-
1298
- | Parameter | Type | Description |
1299
- |---------------|----------------------------|-------------------------------------|
1300
- | `opts.method` | `string` | The RPC method name. |
1301
- | `opts.params` | `Record<string, unknown>` | Optional parameters for the method. |
1302
- | `opts.callId` | `string` | Optional target call ID. |
1303
- | `opts.nodeId` | `string` | Optional target node ID. |
1304
-
1305
- **Returns:** `this` for chaining.
1306
-
1307
- ```typescript
1308
- const result = new FunctionResult('RPC executed.')
1309
- .executeRpc({
1310
- method: 'calling.play',
1311
- callId: 'call-abc-123',
1312
- params: {
1313
- url: 'https://example.com/notification.mp3',
1314
- },
1315
- });
1316
- ```
1317
-
1318
- ---
1319
-
1320
- ### rpcDial
1321
-
1322
- Dial a number via RPC. This creates an outbound call using the SignalWire RPC mechanism.
1323
-
1324
- ```typescript
1325
- rpcDial(
1326
- toNumber: string,
1327
- fromNumber: string,
1328
- destSwml: string,
1329
- deviceType?: string
1330
- ): this
1331
- ```
1332
-
1333
- | Parameter | Type | Default | Description |
1334
- |--------------|----------|-----------|------------------------------------------|
1335
- | `toNumber` | `string` | -- | Destination phone number. |
1336
- | `fromNumber` | `string` | -- | Caller ID number. |
1337
- | `destSwml` | `string` | -- | SWML destination for the dialed call. |
1338
- | `deviceType` | `string` | `'phone'` | Device type for the outbound leg. |
1339
-
1340
- **Returns:** `this` for chaining.
1341
-
1342
- ```typescript
1343
- const result = new FunctionResult('Dialing out.')
1344
- .rpcDial('+15551234567', '+15559876543', 'https://example.com/swml');
1345
- ```
1346
-
1347
- ---
1348
-
1349
- ### rpcAiMessage
1350
-
1351
- Send an AI message to another call via RPC. This injects a message into the target call's AI conversation.
1352
-
1353
- ```typescript
1354
- rpcAiMessage(callId: string, messageText: string, role?: string): this
1355
- ```
1356
-
1357
- | Parameter | Type | Default | Description |
1358
- |---------------|----------|------------|--------------------------------------|
1359
- | `callId` | `string` | -- | The target call ID. |
1360
- | `messageText` | `string` | -- | The message text to inject. |
1361
- | `role` | `string` | `'system'` | The message role. |
1362
-
1363
- **Returns:** `this` for chaining.
1364
-
1365
- ```typescript
1366
- const result = new FunctionResult('Message sent to other call.')
1367
- .rpcAiMessage('call-abc-123', 'The customer has been verified.');
1368
- ```
1369
-
1370
- ---
1371
-
1372
- ### rpcAiUnhold
1373
-
1374
- Unhold a call that was previously placed on hold, via RPC.
1375
-
1376
- ```typescript
1377
- rpcAiUnhold(callId: string): this
1378
- ```
1379
-
1380
- | Parameter | Type | Description |
1381
- |-----------|----------|--------------------------------|
1382
- | `callId` | `string` | The target call ID to unhold. |
1383
-
1384
- **Returns:** `this` for chaining.
1385
-
1386
- ```typescript
1387
- const result = new FunctionResult('Resuming the held call.')
1388
- .rpcAiUnhold('call-abc-123');
1389
- ```
1390
-
1391
- ---
1392
-
1393
- ## Payments
1394
-
1395
- ### pay
1396
-
1397
- Initiate a payment collection flow on the call. The payment is collected via DTMF or speech and processed by the specified payment connector.
1398
-
1399
- ```typescript
1400
- pay(opts: {
1401
- paymentConnectorUrl: string;
1402
- inputMethod?: string;
1403
- statusUrl?: string;
1404
- paymentMethod?: string;
1405
- timeout?: number;
1406
- maxAttempts?: number;
1407
- securityCode?: boolean;
1408
- postalCode?: boolean | string;
1409
- minPostalCodeLength?: number;
1410
- tokenType?: string;
1411
- chargeAmount?: string;
1412
- currency?: string;
1413
- language?: string;
1414
- voice?: string;
1415
- description?: string;
1416
- validCardTypes?: string;
1417
- parameters?: PaymentParameter[];
1418
- prompts?: PaymentPrompt[];
1419
- aiResponse?: string;
1420
- }): this
1421
- ```
1422
-
1423
- | Parameter | Type | Default | Description |
1424
- |----------------------------|----------------------|---------------------------------------|-----------------------------------------------------------------|
1425
- | `opts.paymentConnectorUrl` | `string` | -- | URL of the payment connector endpoint. |
1426
- | `opts.inputMethod` | `string` | `'dtmf'` | Input method (`'dtmf'` or `'speech'`). |
1427
- | `opts.statusUrl` | `string` | -- | Webhook URL for payment status callbacks. |
1428
- | `opts.paymentMethod` | `string` | `'credit-card'` | Payment method type. |
1429
- | `opts.timeout` | `number` | `5` | Timeout in seconds for each input step. |
1430
- | `opts.maxAttempts` | `number` | `1` | Maximum number of retry attempts. |
1431
- | `opts.securityCode` | `boolean` | `true` | Whether to collect the security code (CVV). |
1432
- | `opts.postalCode` | `boolean \| string` | `true` | Whether to collect postal code, or a fixed postal code string. |
1433
- | `opts.minPostalCodeLength` | `number` | `0` | Minimum length for postal code input. |
1434
- | `opts.tokenType` | `string` | `'reusable'` | Token type for tokenized payments. |
1435
- | `opts.chargeAmount` | `string` | -- | Amount to charge (e.g., `'29.99'`). |
1436
- | `opts.currency` | `string` | `'usd'` | Currency code. |
1437
- | `opts.language` | `string` | `'en-US'` | Language for payment prompts. |
1438
- | `opts.voice` | `string` | `'woman'` | Voice for payment prompts. |
1439
- | `opts.description` | `string` | -- | Description of the payment. |
1440
- | `opts.validCardTypes` | `string` | `'visa mastercard amex'` | Space-separated list of accepted card types. |
1441
- | `opts.parameters` | `PaymentParameter[]` | -- | Custom parameters for the payment connector. |
1442
- | `opts.prompts` | `PaymentPrompt[]` | -- | Custom prompts for payment steps. |
1443
- | `opts.aiResponse` | `string` | Template referencing `${pay_result}` | AI response set after payment completes. |
1444
-
1445
- **Returns:** `this` for chaining.
1446
-
1447
- ```typescript
1448
- const result = new FunctionResult('Collecting payment.')
1449
- .pay({
1450
- paymentConnectorUrl: 'https://payments.example.com/connector',
1451
- chargeAmount: '49.99',
1452
- currency: 'usd',
1453
- maxAttempts: 3,
1454
- timeout: 10,
1455
- });
1456
- ```
1457
-
1458
- ---
1459
-
1460
- ### createPaymentPrompt (static)
1461
-
1462
- Create a `PaymentPrompt` configuration object for use with the `pay()` method.
1463
-
1464
- ```typescript
1465
- static createPaymentPrompt(
1466
- forSituation: string,
1467
- actions: PaymentAction[],
1468
- cardType?: string,
1469
- errorType?: string
1470
- ): PaymentPrompt
1471
- ```
1472
-
1473
- | Parameter | Type | Description |
1474
- |----------------|-------------------|---------------------------------------------------|
1475
- | `forSituation` | `string` | The situation this prompt applies to. |
1476
- | `actions` | `PaymentAction[]` | Actions to perform for this prompt. |
1477
- | `cardType` | `string` | Optional card type filter (e.g., `'visa'`). |
1478
- | `errorType` | `string` | Optional error type this prompt handles. |
1479
-
1480
- **Returns:** A `PaymentPrompt` object.
1481
-
1482
- ```typescript
1483
- const prompt = FunctionResult.createPaymentPrompt(
1484
- 'payment-card-number',
1485
- [FunctionResult.createPaymentAction('say', 'Please enter your card number.')],
1486
- );
1487
- ```
1488
-
1489
- ---
1490
-
1491
- ### createPaymentAction (static)
1492
-
1493
- Create a `PaymentAction` for use within a `PaymentPrompt`.
1494
-
1495
- ```typescript
1496
- static createPaymentAction(actionType: string, phrase: string): PaymentAction
1497
- ```
1498
-
1499
- | Parameter | Type | Description |
1500
- |--------------|----------|------------------------------------------|
1501
- | `actionType` | `string` | The action type (e.g., `'say'`, `'play'`). |
1502
- | `phrase` | `string` | The phrase or URL for this action. |
1503
-
1504
- **Returns:** A `PaymentAction` object.
1505
-
1506
- ```typescript
1507
- const action = FunctionResult.createPaymentAction(
1508
- 'say',
1509
- 'Please enter your credit card number followed by the pound sign.',
1510
- );
1511
- ```
1512
-
1513
- ---
1514
-
1515
- ### createPaymentParameter (static)
1516
-
1517
- Create a custom `PaymentParameter` for the payment connector.
1518
-
1519
- ```typescript
1520
- static createPaymentParameter(name: string, value: string): PaymentParameter
1521
- ```
1522
-
1523
- | Parameter | Type | Description |
1524
- |-----------|----------|------------------------|
1525
- | `name` | `string` | The parameter name. |
1526
- | `value` | `string` | The parameter value. |
1527
-
1528
- **Returns:** A `PaymentParameter` object.
1529
-
1530
- ```typescript
1531
- const param = FunctionResult.createPaymentParameter('merchant_id', 'MERCH-001');
1532
- ```
1533
-
1534
- ---
1535
-
1536
- ### Full payment example
1537
-
1538
- ```typescript
1539
- const prompts = [
1540
- FunctionResult.createPaymentPrompt(
1541
- 'payment-card-number',
1542
- [FunctionResult.createPaymentAction('say', 'Please enter your card number.')],
1543
- ),
1544
- FunctionResult.createPaymentPrompt(
1545
- 'payment-expiration-date',
1546
- [FunctionResult.createPaymentAction('say', 'Enter the expiration date.')],
1547
- ),
1548
- FunctionResult.createPaymentPrompt(
1549
- 'payment-security-code',
1550
- [FunctionResult.createPaymentAction('say', 'Enter the CVV on the back of your card.')],
1551
- ),
1552
- ];
1553
-
1554
- const params = [
1555
- FunctionResult.createPaymentParameter('merchant_id', 'MERCH-001'),
1556
- ];
1557
-
1558
- const result = new FunctionResult('Starting payment collection.')
1559
- .pay({
1560
- paymentConnectorUrl: 'https://payments.example.com/connector',
1561
- chargeAmount: '99.95',
1562
- currency: 'usd',
1563
- maxAttempts: 3,
1564
- timeout: 15,
1565
- prompts,
1566
- parameters: params,
1567
- description: 'Annual subscription',
1568
- });
1569
- ```
1570
-
1571
- ---
1572
-
1573
- ## Fluent Chaining
1574
-
1575
- Every mutating method on `FunctionResult` returns `this`, enabling fluent method chaining. You can compose complex multi-action responses in a single expression.
1576
-
1577
- ```typescript
1578
- agent.defineTool({
1579
- name: 'complete_order',
1580
- description: 'Complete an order and send confirmation',
1581
- parameters: {
1582
- order_id: { type: 'string', description: 'The order ID' },
1583
- },
1584
- handler: (args) => {
1585
- const orderId = args.order_id as string;
1586
-
1587
- return new FunctionResult(`Order ${orderId} completed.`)
1588
- .setPostProcess(true)
1589
- // Store data for other tools
1590
- .updateGlobalData({ last_order: orderId, order_status: 'complete' })
1591
- // Tag the call
1592
- .setMetadata({ order_id: orderId })
1593
- // Send SMS confirmation
1594
- .sendSms({
1595
- toNumber: '+15551234567',
1596
- fromNumber: '+15559876543',
1597
- body: `Your order ${orderId} has been confirmed!`,
1598
- })
1599
- // Speak a confirmation
1600
- .say(`Your order ${orderId} is confirmed.`)
1601
- // Emit a tracking event
1602
- .swmlUserEvent({ type: 'order_complete', order_id: orderId })
1603
- // Disable the order tool, enable the feedback tool
1604
- .toggleFunctions([
1605
- { function: 'complete_order', active: false },
1606
- { function: 'submit_feedback', active: true },
1607
- ]);
1608
- },
1609
- });
1610
- ```
1611
-
1612
- The chained calls produce an `action` array in the order they were called. SignalWire executes them sequentially:
1613
-
1614
- ```json
1615
- {
1616
- "response": "Order ORD-789 completed.",
1617
- "action": [
1618
- { "set_global_data": { "last_order": "ORD-789", "order_status": "complete" } },
1619
- { "set_meta_data": { "order_id": "ORD-789" } },
1620
- { "SWML": { "version": "1.0.0", "sections": { "main": [{ "send_sms": { "to_number": "+15551234567", "from_number": "+15559876543", "body": "Your order ORD-789 has been confirmed!" } }] } } },
1621
- { "say": "Your order ORD-789 is confirmed." },
1622
- { "SWML": { "version": "1.0.0", "sections": { "main": [{ "user_event": { "event": { "type": "order_complete", "order_id": "ORD-789" } } }] } } },
1623
- { "toggle_functions": [{ "function": "complete_order", "active": false }, { "function": "submit_feedback", "active": true }] }
1624
- ],
1625
- "post_process": true
1626
- }
1627
- ```