@signalwire/sdk 2.0.5 → 3.6.0

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 (659) hide show
  1. package/CHANGELOG.md +821 -0
  2. package/LICENSE +21 -0
  3. package/README.md +163 -68
  4. package/dist/AGENTS.md +13 -0
  5. package/dist/AgentBase.d.ts +510 -126
  6. package/dist/AgentBase.js +1581 -455
  7. package/dist/AgentBase.js.map +1 -1
  8. package/dist/AgentServer.d.ts +21 -0
  9. package/dist/AgentServer.js +154 -47
  10. package/dist/AgentServer.js.map +1 -1
  11. package/dist/AuthHandler.d.ts +14 -2
  12. package/dist/AuthHandler.js +7 -2
  13. package/dist/AuthHandler.js.map +1 -1
  14. package/dist/ConfigLoader.d.ts +5 -13
  15. package/dist/ConfigLoader.js +15 -29
  16. package/dist/ConfigLoader.js.map +1 -1
  17. package/dist/ContextBuilder.d.ts +202 -9
  18. package/dist/ContextBuilder.js +219 -36
  19. package/dist/ContextBuilder.js.map +1 -1
  20. package/dist/DataMap.d.ts +186 -45
  21. package/dist/DataMap.js +210 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +309 -83
  24. package/dist/FunctionResult.js +483 -116
  25. package/dist/FunctionResult.js.map +1 -1
  26. package/dist/Logger.d.ts +30 -5
  27. package/dist/Logger.js +77 -19
  28. package/dist/Logger.js.map +1 -1
  29. package/dist/POM/PromptObjectModel.d.ts +12 -1
  30. package/dist/POM/PromptObjectModel.js +25 -9
  31. package/dist/POM/PromptObjectModel.js.map +1 -1
  32. package/dist/ParameterSchema.d.ts +306 -0
  33. package/dist/ParameterSchema.js +251 -0
  34. package/dist/ParameterSchema.js.map +1 -0
  35. package/dist/PlatformContracts.d.ts +21 -0
  36. package/dist/PlatformContracts.generated.d.ts +109 -0
  37. package/dist/PlatformContracts.generated.js +8 -0
  38. package/dist/PlatformContracts.generated.js.map +1 -0
  39. package/dist/PlatformContracts.js +2 -0
  40. package/dist/PlatformContracts.js.map +1 -0
  41. package/dist/PomBuilder.d.ts +18 -0
  42. package/dist/PomBuilder.js +53 -3
  43. package/dist/PomBuilder.js.map +1 -1
  44. package/dist/PostPrompt.d.ts +110 -0
  45. package/dist/PostPrompt.js +204 -0
  46. package/dist/PostPrompt.js.map +1 -0
  47. package/dist/PromptManager.d.ts +22 -1
  48. package/dist/PromptManager.js +28 -1
  49. package/dist/PromptManager.js.map +1 -1
  50. package/dist/PublicFetch.d.ts +132 -0
  51. package/dist/PublicFetch.js +311 -0
  52. package/dist/PublicFetch.js.map +1 -0
  53. package/dist/RobotsTxt.d.ts +41 -0
  54. package/dist/RobotsTxt.js +152 -0
  55. package/dist/RobotsTxt.js.map +1 -0
  56. package/dist/SWMLHandler.js.map +1 -1
  57. package/dist/SWMLService.d.ts +169 -59
  58. package/dist/SWMLService.js +456 -129
  59. package/dist/SWMLService.js.map +1 -1
  60. package/dist/SchemaUtils.d.ts +115 -2
  61. package/dist/SchemaUtils.js +444 -12
  62. package/dist/SchemaUtils.js.map +1 -1
  63. package/dist/SecurityUtils.d.ts +49 -9
  64. package/dist/SecurityUtils.js +153 -51
  65. package/dist/SecurityUtils.js.map +1 -1
  66. package/dist/SemanticGate.d.ts +183 -0
  67. package/dist/SemanticGate.js +533 -0
  68. package/dist/SemanticGate.js.map +1 -0
  69. package/dist/ServerlessAdapter.d.ts +156 -7
  70. package/dist/ServerlessAdapter.js +399 -42
  71. package/dist/ServerlessAdapter.js.map +1 -1
  72. package/dist/SessionManager.d.ts +11 -2
  73. package/dist/SessionManager.js +50 -18
  74. package/dist/SessionManager.js.map +1 -1
  75. package/dist/SslConfig.d.ts +2 -1
  76. package/dist/SslConfig.js +4 -1
  77. package/dist/SslConfig.js.map +1 -1
  78. package/dist/SwaigActions.generated.d.ts +23 -0
  79. package/dist/SwaigActions.generated.js +8 -0
  80. package/dist/SwaigActions.generated.js.map +1 -0
  81. package/dist/SwaigContracts.d.ts +15 -0
  82. package/dist/SwaigContracts.generated.d.ts +264 -0
  83. package/dist/SwaigContracts.generated.js +12 -0
  84. package/dist/SwaigContracts.generated.js.map +1 -0
  85. package/dist/SwaigContracts.js +2 -0
  86. package/dist/SwaigContracts.js.map +1 -0
  87. package/dist/SwaigFunction.d.ts +139 -7
  88. package/dist/SwaigFunction.js +170 -22
  89. package/dist/SwaigFunction.js.map +1 -1
  90. package/dist/SwmlBuilder.d.ts +68 -19
  91. package/dist/SwmlBuilder.js +74 -38
  92. package/dist/SwmlBuilder.js.map +1 -1
  93. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  94. package/dist/SwmlVerbMethods.generated.js +1 -1
  95. package/dist/TypeInference.d.ts +39 -3
  96. package/dist/TypeInference.js +256 -16
  97. package/dist/TypeInference.js.map +1 -1
  98. package/dist/WebService.d.ts +79 -11
  99. package/dist/WebService.js +320 -109
  100. package/dist/WebService.js.map +1 -1
  101. package/dist/WebhookMiddleware.d.ts +119 -0
  102. package/dist/WebhookMiddleware.js +271 -0
  103. package/dist/WebhookMiddleware.js.map +1 -0
  104. package/dist/WebhookValidator.d.ts +92 -0
  105. package/dist/WebhookValidator.js +409 -0
  106. package/dist/WebhookValidator.js.map +1 -0
  107. package/dist/agents/BedrockAgent.d.ts +162 -0
  108. package/dist/agents/BedrockAgent.js +323 -0
  109. package/dist/agents/BedrockAgent.js.map +1 -0
  110. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  111. package/dist/ai-chat/AIChatClient.js +535 -0
  112. package/dist/ai-chat/AIChatClient.js.map +1 -0
  113. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  114. package/dist/ai-chat/ChatGateway.js +747 -0
  115. package/dist/ai-chat/ChatGateway.js.map +1 -0
  116. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  117. package/dist/ai-chat/HandoffRouter.js +518 -0
  118. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  119. package/dist/ai-chat/index.d.ts +12 -0
  120. package/dist/ai-chat/index.js +10 -0
  121. package/dist/ai-chat/index.js.map +1 -0
  122. package/dist/capabilities.d.ts +64 -0
  123. package/dist/capabilities.js +95 -0
  124. package/dist/capabilities.js.map +1 -0
  125. package/dist/cli/agent-loader.d.ts +32 -6
  126. package/dist/cli/agent-loader.js +92 -33
  127. package/dist/cli/agent-loader.js.map +1 -1
  128. package/dist/cli/datamap-exec.d.ts +175 -0
  129. package/dist/cli/datamap-exec.js +1284 -0
  130. package/dist/cli/datamap-exec.js.map +1 -0
  131. package/dist/cli/function-args.d.ts +40 -0
  132. package/dist/cli/function-args.js +146 -0
  133. package/dist/cli/function-args.js.map +1 -0
  134. package/dist/cli/simulation.d.ts +99 -0
  135. package/dist/cli/simulation.js +490 -0
  136. package/dist/cli/simulation.js.map +1 -0
  137. package/dist/cli/swaig-test.d.ts +12 -25
  138. package/dist/cli/swaig-test.js +935 -371
  139. package/dist/cli/swaig-test.js.map +1 -1
  140. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  141. package/dist/cli/tsdocs/agentsNote.js +92 -0
  142. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  143. package/dist/cli/tsdocs/api-index.json +1 -0
  144. package/dist/cli/tsdocs/api.d.ts +91 -0
  145. package/dist/cli/tsdocs/api.js +372 -0
  146. package/dist/cli/tsdocs/api.js.map +1 -0
  147. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  148. package/dist/cli/tsdocs/apiTypes.js +7 -0
  149. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  150. package/dist/cli/tsdocs/bin.d.ts +6 -0
  151. package/dist/cli/tsdocs/bin.js +23 -0
  152. package/dist/cli/tsdocs/bin.js.map +1 -0
  153. package/dist/cli/tsdocs/files.d.ts +108 -0
  154. package/dist/cli/tsdocs/files.js +287 -0
  155. package/dist/cli/tsdocs/files.js.map +1 -0
  156. package/dist/cli/tsdocs/index.d.ts +28 -0
  157. package/dist/cli/tsdocs/index.js +307 -0
  158. package/dist/cli/tsdocs/index.js.map +1 -0
  159. package/dist/cli/tsdocs/live.d.ts +41 -0
  160. package/dist/cli/tsdocs/live.js +202 -0
  161. package/dist/cli/tsdocs/live.js.map +1 -0
  162. package/dist/cli/tsdocs/locate.d.ts +51 -0
  163. package/dist/cli/tsdocs/locate.js +75 -0
  164. package/dist/cli/tsdocs/locate.js.map +1 -0
  165. package/dist/cli/tsdocs/render.d.ts +75 -0
  166. package/dist/cli/tsdocs/render.js +323 -0
  167. package/dist/cli/tsdocs/render.js.map +1 -0
  168. package/dist/cli/tsdocs/topics.d.ts +43 -0
  169. package/dist/cli/tsdocs/topics.js +920 -0
  170. package/dist/cli/tsdocs/topics.js.map +1 -0
  171. package/dist/index.d.ts +49 -68
  172. package/dist/index.js +45 -73
  173. package/dist/index.js.map +1 -1
  174. package/dist/livewire/index.d.ts +229 -155
  175. package/dist/livewire/index.js +298 -195
  176. package/dist/livewire/index.js.map +1 -1
  177. package/dist/llms.txt +65 -0
  178. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  179. package/dist/prefabs/CallSessionStore.js +72 -0
  180. package/dist/prefabs/CallSessionStore.js.map +1 -0
  181. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  182. package/dist/prefabs/ConciergeAgent.js +36 -31
  183. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  184. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  185. package/dist/prefabs/FAQBotAgent.js +113 -47
  186. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  187. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  188. package/dist/prefabs/InfoGathererAgent.js +67 -58
  189. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  190. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  191. package/dist/prefabs/ReceptionistAgent.js +39 -31
  192. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  193. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  194. package/dist/prefabs/SurveyAgent.js +84 -68
  195. package/dist/prefabs/SurveyAgent.js.map +1 -1
  196. package/dist/relay/Action.d.ts +44 -21
  197. package/dist/relay/Action.js +75 -17
  198. package/dist/relay/Action.js.map +1 -1
  199. package/dist/relay/Call.d.ts +312 -47
  200. package/dist/relay/Call.js +369 -18
  201. package/dist/relay/Call.js.map +1 -1
  202. package/dist/relay/Deferred.js.map +1 -1
  203. package/dist/relay/Message.d.ts +26 -5
  204. package/dist/relay/Message.js +36 -6
  205. package/dist/relay/Message.js.map +1 -1
  206. package/dist/relay/RelayClient.d.ts +44 -17
  207. package/dist/relay/RelayClient.js +175 -65
  208. package/dist/relay/RelayClient.js.map +1 -1
  209. package/dist/relay/RelayError.d.ts +14 -0
  210. package/dist/relay/RelayError.js +15 -0
  211. package/dist/relay/RelayError.js.map +1 -1
  212. package/dist/relay/RelayEvent.d.ts +96 -65
  213. package/dist/relay/RelayEvent.js +85 -56
  214. package/dist/relay/RelayEvent.js.map +1 -1
  215. package/dist/relay/closedSets.d.ts +111 -0
  216. package/dist/relay/closedSets.js +83 -0
  217. package/dist/relay/closedSets.js.map +1 -0
  218. package/dist/relay/index.d.ts +3 -1
  219. package/dist/relay/index.js +1 -0
  220. package/dist/relay/index.js.map +1 -1
  221. package/dist/relay/normalize.js.map +1 -1
  222. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  223. package/dist/relay/protocol.types.generated.js +8 -0
  224. package/dist/relay/protocol.types.generated.js.map +1 -0
  225. package/dist/relay/types.d.ts +73 -42
  226. package/dist/rest/HttpClient.d.ts +36 -8
  227. package/dist/rest/HttpClient.js +233 -40
  228. package/dist/rest/HttpClient.js.map +1 -1
  229. package/dist/rest/RequestOptions.d.ts +110 -0
  230. package/dist/rest/RequestOptions.js +113 -0
  231. package/dist/rest/RequestOptions.js.map +1 -0
  232. package/dist/rest/RestError.d.ts +52 -6
  233. package/dist/rest/RestError.js +89 -5
  234. package/dist/rest/RestError.js.map +1 -1
  235. package/dist/rest/base/CrudResource.d.ts +16 -26
  236. package/dist/rest/base/CrudResource.js +19 -33
  237. package/dist/rest/base/CrudResource.js.map +1 -1
  238. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  239. package/dist/rest/base/CrudWithAddresses.js +2 -2
  240. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  241. package/dist/rest/base/FabricResource.d.ts +15 -0
  242. package/dist/rest/base/FabricResource.js +16 -0
  243. package/dist/rest/base/FabricResource.js.map +1 -0
  244. package/dist/rest/base/ReadResource.d.ts +62 -0
  245. package/dist/rest/base/ReadResource.js +69 -0
  246. package/dist/rest/base/ReadResource.js.map +1 -0
  247. package/dist/rest/callHandler.d.ts +5 -2
  248. package/dist/rest/callHandler.js +4 -1
  249. package/dist/rest/callHandler.js.map +1 -1
  250. package/dist/rest/index.d.ts +18 -77
  251. package/dist/rest/index.js +47 -120
  252. package/dist/rest/index.js.map +1 -1
  253. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  254. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  255. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  256. package/dist/rest/namespaces/addresses.d.ts +3 -42
  257. package/dist/rest/namespaces/addresses.js +3 -50
  258. package/dist/rest/namespaces/addresses.js.map +1 -1
  259. package/dist/rest/namespaces/calling.d.ts +6 -378
  260. package/dist/rest/namespaces/calling.js +6 -473
  261. package/dist/rest/namespaces/calling.js.map +1 -1
  262. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  263. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  264. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  265. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  266. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  267. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  268. package/dist/rest/namespaces/chat.d.ts +4 -18
  269. package/dist/rest/namespaces/chat.js +4 -21
  270. package/dist/rest/namespaces/chat.js.map +1 -1
  271. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  272. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  273. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  274. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  275. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  276. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  277. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  278. package/dist/rest/namespaces/datasphere.js +6 -72
  279. package/dist/rest/namespaces/datasphere.js.map +1 -1
  280. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  281. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  282. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  283. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  284. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  285. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  286. package/dist/rest/namespaces/fabric.d.ts +11 -327
  287. package/dist/rest/namespaces/fabric.js +14 -439
  288. package/dist/rest/namespaces/fabric.js.map +1 -1
  289. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  290. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  291. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  293. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  294. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  296. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  297. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  298. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  299. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  300. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  301. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  302. package/dist/rest/namespaces/imported-numbers.js +3 -21
  303. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  304. package/dist/rest/namespaces/logs.d.ts +10 -101
  305. package/dist/rest/namespaces/logs.js +10 -128
  306. package/dist/rest/namespaces/logs.js.map +1 -1
  307. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  308. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  309. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  310. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  311. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  312. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  313. package/dist/rest/namespaces/lookup.d.ts +3 -25
  314. package/dist/rest/namespaces/lookup.js +3 -27
  315. package/dist/rest/namespaces/lookup.js.map +1 -1
  316. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  317. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  318. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  319. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  320. package/dist/rest/namespaces/message.types.generated.js +8 -0
  321. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  323. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  324. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  325. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  326. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  327. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  328. package/dist/rest/namespaces/mfa.d.ts +3 -42
  329. package/dist/rest/namespaces/mfa.js +3 -49
  330. package/dist/rest/namespaces/mfa.js.map +1 -1
  331. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  332. package/dist/rest/namespaces/number-groups.js +3 -53
  333. package/dist/rest/namespaces/number-groups.js.map +1 -1
  334. package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
  335. package/dist/rest/namespaces/phone-numbers.js +8 -230
  336. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  337. package/dist/rest/namespaces/project.d.ts +6 -42
  338. package/dist/rest/namespaces/project.js +6 -51
  339. package/dist/rest/namespaces/project.js.map +1 -1
  340. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  341. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  342. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  343. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  344. package/dist/rest/namespaces/project.types.generated.js +8 -0
  345. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  347. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  348. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  349. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  350. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  351. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  352. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  353. package/dist/rest/namespaces/pubsub.js +4 -21
  354. package/dist/rest/namespaces/pubsub.js.map +1 -1
  355. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  356. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  357. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  358. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  359. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  360. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  361. package/dist/rest/namespaces/queues.d.ts +3 -38
  362. package/dist/rest/namespaces/queues.js +3 -44
  363. package/dist/rest/namespaces/queues.js.map +1 -1
  364. package/dist/rest/namespaces/recordings.d.ts +3 -34
  365. package/dist/rest/namespaces/recordings.js +3 -40
  366. package/dist/rest/namespaces/recordings.js.map +1 -1
  367. package/dist/rest/namespaces/registry.d.ts +6 -137
  368. package/dist/rest/namespaces/registry.js +6 -173
  369. package/dist/rest/namespaces/registry.js.map +1 -1
  370. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  371. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  372. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  373. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  374. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  375. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  376. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  377. package/dist/rest/namespaces/short-codes.js +3 -41
  378. package/dist/rest/namespaces/short-codes.js.map +1 -1
  379. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  380. package/dist/rest/namespaces/sip-profile.js +3 -29
  381. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  382. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  383. package/dist/rest/namespaces/verified-callers.js +3 -34
  384. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  385. package/dist/rest/namespaces/video.d.ts +10 -227
  386. package/dist/rest/namespaces/video.js +10 -288
  387. package/dist/rest/namespaces/video.js.map +1 -1
  388. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  389. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  390. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  391. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  392. package/dist/rest/namespaces/video.types.generated.js +8 -0
  393. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  395. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  396. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  397. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  398. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  399. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  400. package/dist/rest/pagination.d.ts +5 -1
  401. package/dist/rest/pagination.js +40 -20
  402. package/dist/rest/pagination.js.map +1 -1
  403. package/dist/rest/types.d.ts +21 -3
  404. package/dist/schema.json +299 -98
  405. package/dist/skills/SkillBase.d.ts +111 -21
  406. package/dist/skills/SkillBase.js +100 -17
  407. package/dist/skills/SkillBase.js.map +1 -1
  408. package/dist/skills/SkillManager.d.ts +66 -13
  409. package/dist/skills/SkillManager.js +101 -20
  410. package/dist/skills/SkillManager.js.map +1 -1
  411. package/dist/skills/SkillName.d.ts +44 -0
  412. package/dist/skills/SkillName.js +2 -0
  413. package/dist/skills/SkillName.js.map +1 -0
  414. package/dist/skills/SkillRegistry.d.ts +22 -11
  415. package/dist/skills/SkillRegistry.js +47 -17
  416. package/dist/skills/SkillRegistry.js.map +1 -1
  417. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  418. package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
  419. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  420. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  421. package/dist/skills/builtin/ask_claude.js +36 -14
  422. package/dist/skills/builtin/ask_claude.js.map +1 -1
  423. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  424. package/dist/skills/builtin/claude_skills.js +19 -15
  425. package/dist/skills/builtin/claude_skills.js.map +1 -1
  426. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  427. package/dist/skills/builtin/custom_skills.js +26 -9
  428. package/dist/skills/builtin/custom_skills.js.map +1 -1
  429. package/dist/skills/builtin/datasphere.d.ts +5 -3
  430. package/dist/skills/builtin/datasphere.js +21 -22
  431. package/dist/skills/builtin/datasphere.js.map +1 -1
  432. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  433. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  434. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  435. package/dist/skills/builtin/datetime.d.ts +3 -1
  436. package/dist/skills/builtin/datetime.js +11 -7
  437. package/dist/skills/builtin/datetime.js.map +1 -1
  438. package/dist/skills/builtin/google_maps.d.ts +29 -14
  439. package/dist/skills/builtin/google_maps.js +89 -269
  440. package/dist/skills/builtin/google_maps.js.map +1 -1
  441. package/dist/skills/builtin/index.d.ts +8 -6
  442. package/dist/skills/builtin/index.js +8 -6
  443. package/dist/skills/builtin/index.js.map +1 -1
  444. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  445. package/dist/skills/builtin/info_gatherer.js +20 -12
  446. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  447. package/dist/skills/builtin/joke.d.ts +16 -6
  448. package/dist/skills/builtin/joke.js +54 -37
  449. package/dist/skills/builtin/joke.js.map +1 -1
  450. package/dist/skills/builtin/math.d.ts +3 -1
  451. package/dist/skills/builtin/math.js +14 -9
  452. package/dist/skills/builtin/math.js.map +1 -1
  453. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  454. package/dist/skills/builtin/mcp_gateway.js +77 -46
  455. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  456. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  457. package/dist/skills/builtin/native_vector_search.js +179 -61
  458. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  459. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  460. package/dist/skills/builtin/play_background_file.js +43 -122
  461. package/dist/skills/builtin/play_background_file.js.map +1 -1
  462. package/dist/skills/builtin/spider.d.ts +42 -4
  463. package/dist/skills/builtin/spider.js +277 -104
  464. package/dist/skills/builtin/spider.js.map +1 -1
  465. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  466. package/dist/skills/builtin/swml_transfer.js +45 -24
  467. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  468. package/dist/skills/builtin/weather_api.d.ts +24 -13
  469. package/dist/skills/builtin/weather_api.js +38 -30
  470. package/dist/skills/builtin/weather_api.js.map +1 -1
  471. package/dist/skills/builtin/web_search.d.ts +48 -10
  472. package/dist/skills/builtin/web_search.js +294 -100
  473. package/dist/skills/builtin/web_search.js.map +1 -1
  474. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  475. package/dist/skills/builtin/wikipedia_search.js +14 -13
  476. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  477. package/dist/skills/index.d.ts +3 -2
  478. package/dist/skills/index.js +1 -1
  479. package/dist/skills/index.js.map +1 -1
  480. package/dist/swml_verbs_generated.d.ts +2824 -0
  481. package/dist/swml_verbs_generated.js +12 -0
  482. package/dist/swml_verbs_generated.js.map +1 -0
  483. package/dist/types.d.ts +59 -6
  484. package/dist/web.d.ts +27 -0
  485. package/dist/web.js +20 -0
  486. package/dist/web.js.map +1 -0
  487. package/docs/agent-guide.md +1034 -0
  488. package/docs/ai_chat.md +560 -0
  489. package/docs/api-reference.md +3641 -0
  490. package/docs/architecture.md +846 -0
  491. package/docs/bedrock_agent.md +411 -0
  492. package/docs/cli-guide.md +403 -0
  493. package/docs/cloud_functions_guide.md +399 -0
  494. package/docs/configuration.md +548 -0
  495. package/docs/contexts-guide.md +884 -0
  496. package/docs/datamap-guide.md +1207 -0
  497. package/docs/developer_pain_points.md +548 -0
  498. package/docs/llm_parameters.md +298 -0
  499. package/docs/mcp_gateway_reference.md +354 -0
  500. package/docs/mcp_integration.md +162 -0
  501. package/docs/pgi_agent_guide.md +1820 -0
  502. package/docs/prefabs-guide.md +815 -0
  503. package/docs/programmatically_governed_inference.md +301 -0
  504. package/docs/sdk_features.md +501 -0
  505. package/docs/security.md +559 -0
  506. package/docs/serverless-guide.md +520 -0
  507. package/docs/skills-guide.md +1223 -0
  508. package/docs/skills-system.md +405 -0
  509. package/docs/skills_parameter_schema.md +417 -0
  510. package/docs/swaig-reference.md +1986 -0
  511. package/docs/swml_service_guide.md +573 -0
  512. package/docs/third_party_skills.md +410 -0
  513. package/docs/web_service.md +666 -0
  514. package/examples/README.md +202 -0
  515. package/examples/advanced-datamap.ts +108 -0
  516. package/examples/advanced-dynamic-config.ts +70 -0
  517. package/examples/auto-vivified.ts +95 -0
  518. package/examples/call-flow.ts +65 -0
  519. package/examples/comprehensive-dynamic.ts +125 -0
  520. package/examples/contexts-steps.ts +65 -0
  521. package/examples/custom-path.ts +45 -0
  522. package/examples/datamap-tools.ts +51 -0
  523. package/examples/datasphere-multi-instance.ts +66 -0
  524. package/examples/datasphere-serverless-env.ts +87 -0
  525. package/examples/datasphere-webhook-env.ts +65 -0
  526. package/examples/datasphere.ts +56 -0
  527. package/examples/declarative.ts +100 -0
  528. package/examples/dynamic-config.ts +54 -0
  529. package/examples/dynamic-info-gatherer.ts +69 -0
  530. package/examples/dynamic-swml-service.ts +67 -0
  531. package/examples/gather-info.ts +95 -0
  532. package/examples/gather-per-question-functions-demo.ts +139 -0
  533. package/examples/joke-agent.ts +34 -0
  534. package/examples/kubernetes-agent.ts +45 -0
  535. package/examples/llm-params.ts +75 -0
  536. package/examples/mcp-agent.ts +89 -0
  537. package/examples/mcp-gateway.ts +81 -0
  538. package/examples/multi-agent.ts +80 -0
  539. package/examples/multi-endpoint.ts +79 -0
  540. package/examples/pgi/case-domain.ts +114 -0
  541. package/examples/pgi/serve.ts +16 -0
  542. package/examples/pgi/support-agent.ts +265 -0
  543. package/examples/pom-prompt.ts +70 -0
  544. package/examples/prefab-concierge.ts +42 -0
  545. package/examples/prefab-faq.ts +58 -0
  546. package/examples/prefab-info-gatherer.ts +33 -0
  547. package/examples/prefab-receptionist.ts +36 -0
  548. package/examples/prefab-survey.ts +69 -0
  549. package/examples/quickstart-agent.ts +29 -0
  550. package/examples/quickstart-relay.ts +25 -0
  551. package/examples/quickstart-rest.ts +25 -0
  552. package/examples/record-call.ts +65 -0
  553. package/examples/relay-demo.ts +33 -0
  554. package/examples/room-and-sip.ts +93 -0
  555. package/examples/serverless-lambda.ts +43 -0
  556. package/examples/session-state.ts +83 -0
  557. package/examples/simple-agent.ts +36 -0
  558. package/examples/simple-static.ts +29 -0
  559. package/examples/skills-demo.ts +41 -0
  560. package/examples/step-function-inheritance-demo.ts +124 -0
  561. package/examples/swaig-features.ts +193 -0
  562. package/examples/swml-service-routing.ts +66 -0
  563. package/examples/swml-service.ts +38 -0
  564. package/examples/swmlservice_ai_sidecar.ts +104 -0
  565. package/examples/swmlservice_swaig_standalone.ts +79 -0
  566. package/examples/tap.ts +67 -0
  567. package/examples/typed-tools.ts +68 -0
  568. package/examples/verb-methods.ts +45 -0
  569. package/examples/web-search-multi-instance.ts +75 -0
  570. package/examples/web-search.ts +38 -0
  571. package/examples/wikipedia.ts +36 -0
  572. package/livewire/README.md +164 -0
  573. package/livewire/docs/migration-guide.md +251 -0
  574. package/livewire/examples/livewire-basic-agent.ts +74 -0
  575. package/livewire/examples/livewire-handoff.ts +196 -0
  576. package/livewire/examples/livewire-multi-tool.ts +121 -0
  577. package/package.json +85 -13
  578. package/relay/README.md +101 -0
  579. package/relay/docs/call-methods.md +622 -0
  580. package/relay/docs/client-reference.md +281 -0
  581. package/relay/docs/events.md +193 -0
  582. package/relay/docs/getting-started.md +221 -0
  583. package/relay/docs/guide.md +386 -0
  584. package/relay/docs/messaging.md +246 -0
  585. package/relay/examples/relay-inbound.ts +66 -0
  586. package/relay/examples/relay-messaging.ts +74 -0
  587. package/relay/examples/relay-outbound.ts +76 -0
  588. package/rest/README.md +141 -0
  589. package/rest/docs/calling.md +313 -0
  590. package/rest/docs/client-reference.md +149 -0
  591. package/rest/docs/fabric.md +192 -0
  592. package/rest/docs/getting-started.md +138 -0
  593. package/rest/docs/guide.md +421 -0
  594. package/rest/docs/namespaces.md +367 -0
  595. package/rest/docs/phone-binding.md +116 -0
  596. package/rest/examples/rest-10dlc-registration.ts +177 -0
  597. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  598. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  599. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  600. package/rest/examples/rest-client.ts +59 -0
  601. package/rest/examples/rest-datasphere-search.ts +81 -0
  602. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  603. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  604. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  605. package/rest/examples/rest-manage-resources.ts +64 -0
  606. package/rest/examples/rest-phone-number-management.ts +200 -0
  607. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  608. package/rest/examples/rest-video-rooms.ts +186 -0
  609. package/tutorial/fred/fred.ts +218 -0
  610. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  611. package/tutorial/fred/tutorial/02-setup.md +304 -0
  612. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  613. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  614. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  615. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  616. package/tutorial/fred/tutorial/README.md +56 -0
  617. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  618. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  619. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  620. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  621. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  622. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  623. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  624. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  625. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  626. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  627. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  628. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  629. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  630. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  631. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  632. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  633. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  634. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  635. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  636. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  637. package/tutorial/multi_agents/README.md +175 -0
  638. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  639. package/tutorial/multi_agents/extending_agents.ts +641 -0
  640. package/tutorial/multi_agents/knowledge.ts +59 -0
  641. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  642. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  643. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  644. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  645. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  646. package/tutorial/multi_agents/pc_builder.ts +529 -0
  647. package/tutorial/multi_agents/sales_agent.ts +88 -0
  648. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  649. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  650. package/tutorial/multi_agents/support_knowledge.md +256 -0
  651. package/dist/cli/mock-data.d.ts +0 -37
  652. package/dist/cli/mock-data.js +0 -80
  653. package/dist/cli/mock-data.js.map +0 -1
  654. package/dist/generateVerbTypes.d.ts +0 -11
  655. package/dist/generateVerbTypes.js +0 -265
  656. package/dist/generateVerbTypes.js.map +0 -1
  657. package/dist/rest/namespaces/compat.d.ts +0 -585
  658. package/dist/rest/namespaces/compat.js +0 -735
  659. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -1,12 +1,43 @@
1
1
  /**
2
- * FunctionResult - Builder for SWAIG function responses.
2
+ * FunctionResult: builder for SWAIG function responses.
3
3
  *
4
- * Carries response text and a list of structured actions (connect, hangup, SMS, etc.).
5
- * Every mutating method returns `this` for fluent chaining.
4
+ * Carries a response for the model and a list of structured actions (connect,
5
+ * hangup, SMS and others). Every mutating method returns `this` for fluent chaining.
6
6
  */
7
+ /**
8
+ * A single SWAIG action object. Each action is keyed by its action name (for
9
+ * example `hangup`, `say` or `SWML`) mapped to that action's payload. `connect()`,
10
+ * `swmlTransfer()` and `executeSwml(..., true)` also put a `transfer` key beside
11
+ * `SWML` in the same object.
12
+ * The name set is open-ended (the platform adds new actions), so this is an open
13
+ * key-to-value map rather than a closed union. {@link FunctionResult}'s
14
+ * `addAction`, `connect`, `swmlTransfer` and the other helpers build these, and
15
+ * they are emitted as given under the `action` key of the SWAIG response.
16
+ */
17
+ export type SwaigAction = Record<string, unknown>;
18
+ /**
19
+ * The object {@link FunctionResult.toDict} serializes to: the SWAIG response
20
+ * body. `toDict` only ever sets these three keys (plus the `response` fallback),
21
+ * so the shape is closed (no index signature).
22
+ */
23
+ export interface SwaigResultDict {
24
+ /**
25
+ * Context for the model: a string, or `{ tool_result, tool_prompt }`
26
+ * separating what the tool found from what the model should do next. Omitted
27
+ * when empty (unless it is the sole fallback).
28
+ */
29
+ response?: string | {
30
+ tool_result?: string;
31
+ tool_prompt?: string;
32
+ };
33
+ /** Ordered list of actions to execute. Omitted when there are none. */
34
+ action?: SwaigAction[];
35
+ /** Present (and `true`) only when post-processing is on and actions exist. */
36
+ post_process?: boolean;
37
+ }
7
38
  /** Prompt configuration for a payment collection flow. */
8
39
  export interface PaymentPrompt {
9
- /** The situation this prompt applies to (e.g., "payment-card-number"). */
40
+ /** The payment step this prompt applies to (for example "payment-card-number"). */
10
41
  for: string;
11
42
  /** Actions to perform for this prompt. */
12
43
  actions: PaymentAction[];
@@ -15,11 +46,11 @@ export interface PaymentPrompt {
15
46
  /** Optional error type this prompt handles. */
16
47
  error_type?: string;
17
48
  }
18
- /** A single action within a payment prompt (e.g., say or play). */
49
+ /** A single action within a payment prompt: a phrase to say or a file to play. */
19
50
  export interface PaymentAction {
20
- /** The action type (e.g., "say", "play"). */
51
+ /** The action type: "Say" or "Play" (the SWML `pay` schema's values). */
21
52
  type: string;
22
- /** The phrase or URL to use for this action. */
53
+ /** The text to say, or for "Play" the URL of the audio file. */
23
54
  phrase: string;
24
55
  }
25
56
  /** A custom key-value parameter passed to the payment connector. */
@@ -32,11 +63,23 @@ export interface PaymentParameter {
32
63
  /**
33
64
  * Builder for SWAIG function responses.
34
65
  *
35
- * Carries response text (what the AI says to the caller) and a list of structured
36
- * actions (connect, hangup, SMS, record, transfer, etc.) that the SignalWire platform
37
- * executes after the AI speaks. Every mutating method returns `this` for fluent chaining.
66
+ * Carries a response and a list of structured actions (connect, hangup, SMS,
67
+ * record, transfer and others) that the SignalWire platform executes. Every
68
+ * mutating method returns `this` for fluent chaining.
38
69
  *
39
- * Return an instance (or a promise that resolves to one) from any SWAIG tool handler.
70
+ * The response is context for the model, not speech played to the caller. The
71
+ * model reads it and decides what to say. It can carry facts, an instruction, or
72
+ * both. The clearest form keeps them apart with {@link setToolResponse}, or the
73
+ * constructor's `toolResult` and `toolPrompt`: `tool_result` holds the facts and
74
+ * `tool_prompt` the instruction. A plain string of facts ("Order 1234 shipped
75
+ * Tuesday.") or an instruction ("Tell the caller their order shipped Tuesday.")
76
+ * also works. Avoid a line written for the caller ("Your order shipped
77
+ * Tuesday."): the model interprets it rather than speaking it, so it can drift
78
+ * or be rephrased. Set `postProcess` when the caller must hear something before
79
+ * an action takes effect (hold, connect, transfer, hangup).
80
+ *
81
+ * Return an instance (or a promise that resolves to one) from any SWAIG tool
82
+ * handler. Handlers receive `(args, rawData, agent)`.
40
83
  *
41
84
  * @example Simple text response
42
85
  * ```ts
@@ -44,7 +87,7 @@ export interface PaymentParameter {
44
87
  * name: 'say_hi',
45
88
  * description: 'Say hello.',
46
89
  * parameters: { type: 'object', properties: {} },
47
- * handler: () => new FunctionResult('Hello there!'),
90
+ * handler: () => new FunctionResult('Greet the caller warmly.'),
48
91
  * });
49
92
  * ```
50
93
  *
@@ -55,40 +98,77 @@ export interface PaymentParameter {
55
98
  * description: 'Forward the caller to sales.',
56
99
  * parameters: { type: 'object', properties: {} },
57
100
  * handler: () =>
58
- * new FunctionResult('Connecting you to sales now.').connect('+15551112222'),
101
+ * new FunctionResult('Tell the caller you are connecting them to sales.', true).connect(
102
+ * '+15551112222',
103
+ * ),
59
104
  * });
60
105
  * ```
61
106
  *
62
107
  * @example Chained actions
63
108
  * ```ts
64
- * new FunctionResult("Thanks, you're all set.")
109
+ * new FunctionResult('Tell the caller they are all set and say goodbye.', true)
65
110
  * .sendSms({ toNumber: '+15551234567', fromNumber: '+15559998888', body: 'Confirmation!' })
66
111
  * .hangup();
67
112
  * ```
68
113
  *
69
- * @see {@link AgentBase.defineTool} — where handlers return a `FunctionResult`
70
- * @see {@link DataMap} — alternative for purely data-driven (no handler) tools
114
+ * @see {@link AgentBase.defineTool}, where handlers return a `FunctionResult`
115
+ * @see {@link DataMap}, an alternative for data-driven tools with no handler
71
116
  */
72
117
  export declare class FunctionResult {
73
- /** The text response returned to the AI agent. */
118
+ /**
119
+ * The response string returned to the model as context. When the structured
120
+ * form is set ({@link setToolResponse}), that is sent instead.
121
+ */
74
122
  response: string;
123
+ /** The structured response set by {@link setToolResponse}, sent instead of `response`. */
124
+ private _toolResponse;
75
125
  /** Ordered list of actions to execute after the response. */
76
- action: Record<string, unknown>[];
126
+ action: SwaigAction[];
77
127
  /** Whether actions should be post-processed after the AI responds. */
78
128
  postProcess: boolean;
79
129
  /**
80
- * @param response - Initial response text; defaults to empty string.
81
- * @param postProcess - Whether to enable post-processing of actions.
130
+ * @param response - Initial response: a string of context for the model
131
+ * (facts or an instruction), or the structured `{ tool_result, tool_prompt }`
132
+ * form. Defaults to an empty string.
133
+ * @param postProcess - Whether the model takes one more turn before the
134
+ * actions execute (set it when the caller must hear something first).
135
+ * @param toolResult - Sets the structured response's `tool_result` (see
136
+ * {@link setToolResponse}).
137
+ * @param toolPrompt - Sets the structured response's `tool_prompt`.
82
138
  */
83
- constructor(response?: string, postProcess?: boolean);
139
+ constructor(response?: string | {
140
+ tool_result?: string;
141
+ tool_prompt?: string;
142
+ }, postProcess?: boolean, toolResult?: string, toolPrompt?: string);
84
143
  /**
85
- * Set the response text returned to the AI agent.
86
- * @param response - The response text.
144
+ * Set the response string returned to the model as context. Clears any
145
+ * structured response set by {@link setToolResponse}.
146
+ * @param response - The response text: facts or an instruction.
87
147
  * @returns This instance for chaining.
88
148
  */
89
149
  setResponse(response: string): this;
90
150
  /**
91
- * Enable or disable post-processing of actions.
151
+ * Set the structured response, separating facts from instruction:
152
+ * `{ tool_result, tool_prompt }`. Replaces any string response.
153
+ *
154
+ * - `toolResult`: what the tool did or found. Facts for the model to reason
155
+ * from ("hold initiated", "payment declined", "3 seats left").
156
+ * - `toolPrompt`: what the model should do next. An instruction, such as
157
+ * "Tell the caller how many seats are left."
158
+ *
159
+ * Splitting them keeps the model from reading a status line aloud, and keeps
160
+ * the instruction from being mistaken for data.
161
+ *
162
+ * @param toolResult - Facts from the call; omit if there is nothing to
163
+ * report beyond the instruction.
164
+ * @param toolPrompt - Instruction for what to do next; omit for a
165
+ * facts-only result.
166
+ * @returns This instance for chaining.
167
+ */
168
+ setToolResponse(toolResult?: string, toolPrompt?: string): this;
169
+ /**
170
+ * Enable or disable post-processing. When enabled, the model takes one more
171
+ * turn before the actions execute, so it can tell the caller something first.
92
172
  * @param postProcess - Whether to post-process actions.
93
173
  * @returns This instance for chaining.
94
174
  */
@@ -105,37 +185,70 @@ export declare class FunctionResult {
105
185
  * @param actions - Array of action objects to append.
106
186
  * @returns This instance for chaining.
107
187
  */
108
- addActions(actions: Record<string, unknown>[]): this;
188
+ addActions(actions: SwaigAction[]): this;
109
189
  /**
110
- * Connect the call to another destination via SWML transfer.
190
+ * Connect the call to another destination with an inline SWML `connect`
191
+ * document, emitted with `transfer: "true"` or `"false"` beside it.
111
192
  * @param destination - The destination address (phone number or SIP URI).
112
- * @param final - Whether this is a final transfer that ends the AI session.
193
+ * @param final - `true` (default) for a permanent transfer that leaves the
194
+ * agent; `false` returns the call to the agent when the far end hangs up.
113
195
  * @param fromAddr - Optional caller ID to use for the outbound leg.
114
196
  * @returns This instance for chaining.
115
197
  */
116
198
  connect(destination: string, final?: boolean, fromAddr?: string): this;
117
199
  /**
118
- * Transfer the call to a SWML destination with a custom AI response.
119
- * @param dest - The transfer destination.
120
- * @param aiResponse - The AI response text to set before transferring.
121
- * @param final - Whether this is a final transfer.
200
+ * Transfer the call with an inline SWML document that sets `ai_response` and
201
+ * then runs the `transfer` verb, emitted with `transfer` beside it.
202
+ * @param dest - The transfer destination (a SWML URL, SIP address or similar).
203
+ * @param aiResponse - Stored as `ai_response`, for the agent to use when a
204
+ * non-final transfer returns the call.
205
+ * @param final - `true` (default) for a permanent transfer; `false` to return.
122
206
  * @returns This instance for chaining.
123
207
  */
124
208
  swmlTransfer(dest: string, aiResponse: string, final?: boolean): this;
125
209
  /**
126
- * Hang up the call.
210
+ * Hang up the call. Emits `{ hangup: true }`.
127
211
  * @returns This instance for chaining.
128
212
  */
129
213
  hangup(): this;
130
214
  /**
131
- * Place the call on hold for a specified duration.
132
- * @param timeout - Hold duration in seconds, clamped to 0-900.
215
+ * Put the call on hold, optionally announcing it and routing what happens next.
216
+ *
217
+ * The hold action carries no prompt of its own, and during a hold speech
218
+ * detection is paused and the agent doesn't respond, so anything the caller
219
+ * needs to hear has to be said before the hold takes effect. Passing `prompt`
220
+ * does that: it becomes the structured response's `tool_prompt` (with
221
+ * `tool_result: "status: on hold"`) and turns on `postProcess`, so the model
222
+ * takes one more turn, and can tell the caller, before the hold runs.
223
+ *
224
+ * `step` and `timeoutStep` move the call to a step when the hold ends:
225
+ * `step` when it's taken off hold, `timeoutStep` when the hold times out.
226
+ * They fire when the hold ends, unlike {@link swmlChangeStep}, which applies
227
+ * at once and would move the caller before the hold begins. Omit one, and a
228
+ * hold that ends that way resumes in the current step. Omitting both emits
229
+ * the bare timeout (`{ hold: 300 }`); either one emits
230
+ * `{ hold: { timeout, step?, timeout_step? } }`.
231
+ *
232
+ * @example
233
+ * ```ts
234
+ * new FunctionResult().hold('Tell the caller you are checking if they are available.', 300,
235
+ * 'back_with_agent', 'take_a_message');
236
+ * ```
237
+ *
238
+ * @param prompt - Instruction for the model to act on before the hold. A
239
+ * number here is taken as `timeout`, so `hold(120)` keeps working.
240
+ * @param timeout - Hold duration in seconds, clamped to 0-900 (default 300).
241
+ * @param step - Step to move to when the call is taken off hold.
242
+ * @param timeoutStep - Step to move to when the hold times out.
133
243
  * @returns This instance for chaining.
134
244
  */
135
- hold(timeout?: number): this;
245
+ hold(prompt?: string | number, timeout?: number, step?: string, timeoutStep?: string): this;
136
246
  /**
137
- * Wait for user input before continuing.
138
- * @param opts - Options controlling wait behavior: enable/disable, timeout, or answer-first mode.
247
+ * Emit a `wait_for_user` action. The first option set wins, in this order:
248
+ * `answerFirst` (emits `"answer_first"`), `timeout`, `enabled`; with none,
249
+ * it emits `true`.
250
+ * @param opts - Options controlling wait behavior: enable/disable, timeout in
251
+ * seconds, or answer-first mode.
139
252
  * @returns This instance for chaining.
140
253
  */
141
254
  waitForUser(opts?: {
@@ -144,12 +257,13 @@ export declare class FunctionResult {
144
257
  answerFirst?: boolean;
145
258
  }): this;
146
259
  /**
147
- * Stop the AI session.
260
+ * Stop the AI conversation. Emits `{ stop: true }`.
148
261
  * @returns This instance for chaining.
149
262
  */
150
263
  stop(): this;
151
264
  /**
152
- * Speak text to the caller via TTS.
265
+ * Speak text to the caller via TTS. Unlike the response, this text is
266
+ * spoken to the caller.
153
267
  * @param text - The text to speak.
154
268
  * @returns This instance for chaining.
155
269
  */
@@ -157,7 +271,8 @@ export declare class FunctionResult {
157
271
  /**
158
272
  * Play an audio file in the background during the call.
159
273
  * @param filename - URL or path of the audio file.
160
- * @param wait - Whether to wait for playback to complete before continuing.
274
+ * @param wait - Whether to wait for playback to finish before continuing.
275
+ * `true` emits `{ file, wait: true }`; `false` emits the file name alone.
161
276
  * @returns This instance for chaining.
162
277
  */
163
278
  playBackgroundFile(filename: string, wait?: boolean): this;
@@ -166,6 +281,23 @@ export declare class FunctionResult {
166
281
  * @returns This instance for chaining.
167
282
  */
168
283
  stopBackgroundFile(): this;
284
+ /**
285
+ * Change the agent's voice for the rest of the call.
286
+ *
287
+ * The voice is an `engine.voice:model` spec — the same form a language's voice
288
+ * takes in the SWML `languages` list (e.g. `"elevenlabs.rachel"`); the
289
+ * `engine.` prefix and the `:model` suffix are optional. It replaces the voice
290
+ * of the language currently in use, and switching to a voice on a different
291
+ * TTS engine is allowed. The platform applies it at the next speech batch
292
+ * boundary (never mid-utterance), and it then persists for that language for
293
+ * the rest of the call. If the new voice cannot be opened, the platform falls
294
+ * back to its fallback voice. The platform ignores an empty spec, so the SDK
295
+ * refuses one.
296
+ * @param voice - Voice spec in `engine.voice:model` form.
297
+ * @returns This instance for chaining.
298
+ * @throws {Error} When `voice` is empty or only whitespace.
299
+ */
300
+ changeVoice(voice: string): this;
169
301
  /**
170
302
  * Add dynamic speech recognition hints to improve transcription accuracy.
171
303
  * @param hints - Array of hint strings or pattern-replacement objects.
@@ -182,23 +314,40 @@ export declare class FunctionResult {
182
314
  */
183
315
  clearDynamicHints(): this;
184
316
  /**
185
- * Set the silence duration that marks the end of a user's speech.
317
+ * Set the silence after detected speech that finalizes speech recognition.
186
318
  * @param milliseconds - Timeout in milliseconds.
187
319
  * @returns This instance for chaining.
188
320
  */
189
321
  setEndOfSpeechTimeout(milliseconds: number): this;
190
322
  /**
191
- * Set the timeout for speech event detection.
323
+ * Set the time since the last speech detection event after which speech
324
+ * recognition is finalized. Suits noisy environments.
192
325
  * @param milliseconds - Timeout in milliseconds.
193
326
  * @returns This instance for chaining.
194
327
  */
195
328
  setSpeechEventTimeout(milliseconds: number): this;
196
329
  /**
197
- * Merge key-value pairs into the global data store shared across functions.
330
+ * Merge key-value pairs into the call's global data (`set_global_data`),
331
+ * which persists for the AI session and is readable by every function.
198
332
  * @param data - Key-value pairs to set or update.
199
333
  * @returns This instance for chaining.
200
334
  */
201
335
  updateGlobalData(data: Record<string, unknown>): this;
336
+ /**
337
+ * Set the semantic state the call's semantic gates judge, besides the
338
+ * dialogue.
339
+ *
340
+ * The state is `global_data.semantic_state`, and this replaces it as a whole:
341
+ * to change one field, send the whole state with that field changed, and
342
+ * send `{}` to reset it. Keep it to what the application has established,
343
+ * such as an order the caller confirmed, rather than what the caller claims.
344
+ * It's the only global data copied into the decision model's state; a gate
345
+ * question can still bring in other global data with a `${global_data.x}`
346
+ * template.
347
+ * @param state - The semantic state.
348
+ * @returns This instance for chaining.
349
+ */
350
+ setSemanticState(state: Record<string, unknown>): this;
202
351
  /**
203
352
  * Remove keys from the global data store.
204
353
  * @param keys - A single key or array of keys to remove.
@@ -206,47 +355,66 @@ export declare class FunctionResult {
206
355
  */
207
356
  removeGlobalData(keys: string | string[]): this;
208
357
  /**
209
- * Set metadata key-value pairs on the current call.
358
+ * Set metadata (`set_meta_data`) scoped to the current function's
359
+ * `meta_data_token`. Functions sharing a token share the metadata.
210
360
  * @param data - Metadata key-value pairs to set.
211
361
  * @returns This instance for chaining.
212
362
  */
213
363
  setMetadata(data: Record<string, unknown>): this;
214
364
  /**
215
- * Remove metadata keys from the current call.
365
+ * Remove metadata keys (`unset_meta_data`) from the current function's
366
+ * `meta_data_token` scope.
216
367
  * @param keys - A single key or array of keys to remove.
217
368
  * @returns This instance for chaining.
218
369
  */
219
370
  removeMetadata(keys: string | string[]): this;
220
371
  /**
221
372
  * Execute arbitrary SWML content as an action.
222
- * @param swmlContent - SWML as a JSON string or object.
223
- * @param transfer - Whether this SWML execution should transfer the call.
373
+ *
374
+ * A JSON string is parsed; a string that isn't JSON is sent as
375
+ * `{ raw_swml: <string> }`. An object with a `toDict()` method is converted
376
+ * through it, and a plain object is copied. Any other value throws.
377
+ *
378
+ * @param swmlContent - SWML as a JSON string, a plain object, or an object
379
+ * with `toDict()`.
380
+ * @param transfer - When `true`, emits `transfer: "true"` beside the `SWML`
381
+ * key, so the call leaves the agent for the SWML.
224
382
  * @returns This instance for chaining.
383
+ * @throws {Error} When `swmlContent` is not a string, a plain object, or an
384
+ * object with `toDict()` (for example a number, an array or `null`).
225
385
  */
226
386
  executeSwml(swmlContent: string | Record<string, unknown> | {
227
387
  toDict(): Record<string, unknown>;
228
388
  }, transfer?: boolean): this;
229
389
  /**
230
- * Change the current SWML step.
390
+ * Move the conversation to a step in the current context (`change_step`).
391
+ * The change applies at once, and the step must exist in the current
392
+ * context of the agent's contexts (see `defineContexts()`).
231
393
  * @param stepName - The name of the step to switch to.
232
394
  * @returns This instance for chaining.
233
395
  */
234
396
  swmlChangeStep(stepName: string): this;
235
397
  /**
236
- * Change the current SWML context.
398
+ * Move the conversation to another context (`change_context`). The context
399
+ * must exist in the agent's contexts (see `defineContexts()`).
237
400
  * @param contextName - The name of the context to switch to.
238
401
  * @returns This instance for chaining.
239
402
  */
240
403
  swmlChangeContext(contextName: string): this;
241
404
  /**
242
- * Emit a custom user event via SWML.
405
+ * Send an event to the client connected to the call, through an inline SWML
406
+ * `user_event` verb. The client receives it as a `user_event` event.
243
407
  * @param eventData - The event payload.
244
408
  * @returns This instance for chaining.
245
409
  */
246
410
  swmlUserEvent(eventData: Record<string, unknown>): this;
247
411
  /**
248
- * Switch the AI context with optional new prompts and reset options.
249
- * @param opts - Context switch options including system/user prompts and reset flags.
412
+ * Replace the agent's prompt mid-call (`context_switch`). With only
413
+ * `systemPrompt`, emits the prompt string; otherwise emits an object with the
414
+ * fields that are set.
415
+ * @param opts - The new system prompt, a user prompt to add, whether to
416
+ * summarize the conversation so far (`consolidate`), and whether to reset the
417
+ * context completely (`fullReset`).
250
418
  * @returns This instance for chaining.
251
419
  */
252
420
  switchContext(opts?: {
@@ -265,40 +433,45 @@ export declare class FunctionResult {
265
433
  active: boolean;
266
434
  }[]): this;
267
435
  /**
268
- * Control whether functions fire on speaker timeout.
436
+ * Control whether functions can be called on speaker timeout
437
+ * (`functions_on_speaker_timeout`).
269
438
  * @param enabled - Whether to enable function execution on timeout.
270
439
  * @returns This instance for chaining.
271
440
  */
272
441
  enableFunctionsOnTimeout(enabled?: boolean): this;
273
442
  /**
274
- * Update AI engine settings at runtime.
443
+ * Update AI settings at runtime (`settings`). The platform validates the
444
+ * keys, such as `temperature`, `top-p` and `barge-confidence`.
275
445
  * @param settings - Key-value pairs of settings to update.
276
446
  * @returns This instance for chaining.
277
447
  */
278
448
  updateSettings(settings: Record<string, unknown>): this;
279
449
  /**
280
- * Inject text as if the user had spoken it.
450
+ * Queue text as if the user had said it (`user_input`).
281
451
  * @param text - The simulated user input text.
282
452
  * @returns This instance for chaining.
283
453
  */
284
454
  simulateUserInput(text: string): this;
285
455
  /**
286
- * Enable or disable extensive data reporting in function calls.
287
- * @param enabled - Whether to enable extensive data.
456
+ * Send the full data to the model for this turn only, then a smaller
457
+ * replacement in later turns (`extensive_data`).
458
+ * @param enabled - Whether to send extensive data this turn.
288
459
  * @returns This instance for chaining.
289
460
  */
290
461
  enableExtensiveData(enabled?: boolean): this;
291
462
  /**
292
- * Replace the function call output in conversation history.
293
- * @param text - Replacement text, or true to replace with the response.
463
+ * After the first send, replace this tool call and its result in the
464
+ * conversation history (`replace_in_history`).
465
+ * @param text - A string replaces the pair with an assistant message holding
466
+ * that text; `true` (default) removes the pair from the history.
294
467
  * @returns This instance for chaining.
295
468
  */
296
469
  replaceInHistory(text?: string | boolean): this;
297
470
  /**
298
471
  * Send an SMS or MMS message from within the call flow.
299
472
  *
300
- * @param opts - SMS parameters. Must include either `body` (text SMS) or
301
- * `media` (MMS) — supplying neither throws.
473
+ * @param opts - SMS parameters. Must include `body` (text SMS), `media`
474
+ * (MMS), or both; supplying neither throws.
302
475
  * @returns This instance for chaining.
303
476
  * @throws {Error} When neither `body` nor `media` is provided.
304
477
  */
@@ -311,14 +484,14 @@ export declare class FunctionResult {
311
484
  region?: string;
312
485
  }): this;
313
486
  /**
314
- * Start recording the call.
487
+ * Start a background recording of the call (SWML `record_call`).
315
488
  * @param opts - Recording options including format, direction, and timeouts.
316
489
  * @returns This instance for chaining.
317
490
  */
318
491
  recordCall(opts?: {
319
492
  controlId?: string;
320
493
  stereo?: boolean;
321
- format?: 'wav' | 'mp3';
494
+ format?: 'wav' | 'mp3' | 'mp4';
322
495
  direction?: 'speak' | 'listen' | 'both';
323
496
  terminators?: string;
324
497
  beep?: boolean;
@@ -335,14 +508,19 @@ export declare class FunctionResult {
335
508
  */
336
509
  stopRecordCall(controlId?: string): this;
337
510
  /**
338
- * Start a media tap to stream audio to an external URI.
511
+ * Start a media tap to stream audio to an external URI (`ws://`, `wss://` or
512
+ * `rtp://IP:port`). `direction` is always sent; `codec` and `rtpPtime` are
513
+ * sent only when they differ from `PCMU` and 20.
339
514
  * @param opts - Tap parameters including URI, direction, and codec.
515
+ * @throws {Error} On a `direction` or `codec` outside the allowed values, or
516
+ * an `rtpPtime` that isn't positive.
340
517
  * @returns This instance for chaining.
341
518
  */
342
519
  tap(opts: {
343
520
  uri: string;
344
521
  controlId?: string;
345
- direction?: 'speak' | 'hear' | 'both';
522
+ /** `speak` (what the party says), `listen` (what it hears) or `both` (default). */
523
+ direction?: 'speak' | 'listen' | 'both';
346
524
  codec?: 'PCMU' | 'PCMA';
347
525
  rtpPtime?: number;
348
526
  statusUrl?: string;
@@ -354,7 +532,7 @@ export declare class FunctionResult {
354
532
  */
355
533
  stopTap(controlId?: string): this;
356
534
  /**
357
- * Join a SignalWire room.
535
+ * Join a RELAY room by name (SWML `join_room`).
358
536
  * @param name - The room name to join.
359
537
  * @returns This instance for chaining.
360
538
  */
@@ -366,9 +544,19 @@ export declare class FunctionResult {
366
544
  */
367
545
  sipRefer(toUri: string): this;
368
546
  /**
369
- * Join a conference by name with optional configuration.
547
+ * Join a conference by name with optional configuration. Options at their
548
+ * default value are left out; with none left, `join_conference` is the name
549
+ * string alone.
550
+ *
551
+ * `maxParticipants` is sent whenever it is given, as an integer of 2 or
552
+ * more: the platform refuses a conference of fewer than 2 and sets no upper
553
+ * limit (the SWML schema's cap of 100000 isn't enforced). A numeric string
554
+ * is converted, and a SWML variable reference such as `'${room_size}'` is
555
+ * passed through.
370
556
  * @param name - The conference name to join.
371
557
  * @param opts - Optional conference settings such as mute, recording, and callbacks.
558
+ * @throws {Error} When `name` is blank, or `maxParticipants` isn't an
559
+ * integer of at least 2 or a SWML variable reference.
372
560
  * @returns This instance for chaining.
373
561
  */
374
562
  joinConference(name: string, opts?: {
@@ -377,7 +565,7 @@ export declare class FunctionResult {
377
565
  startOnEnter?: boolean;
378
566
  endOnExit?: boolean;
379
567
  waitUrl?: string;
380
- maxParticipants?: number;
568
+ maxParticipants?: number | string;
381
569
  record?: 'do-not-record' | 'record-from-start';
382
570
  region?: string;
383
571
  trim?: 'trim-silence' | 'do-not-trim';
@@ -402,31 +590,63 @@ export declare class FunctionResult {
402
590
  nodeId?: string;
403
591
  }): this;
404
592
  /**
405
- * Dial a number via RPC, optionally specifying device type.
593
+ * Dial out with the `dial` RPC method, optionally specifying device type.
406
594
  * @param toNumber - The destination phone number.
407
595
  * @param fromNumber - The caller ID number.
408
- * @param destSwml - The SWML destination for the dialed call.
596
+ * @param destSwml - URL of the SWML that handles the dialed call.
409
597
  * @param deviceType - The device type (defaults to "phone").
410
598
  * @returns This instance for chaining.
411
599
  */
412
600
  rpcDial(toNumber: string, fromNumber: string, destSwml: string, deviceType?: string): this;
413
601
  /**
414
- * Send an AI message to another call via RPC.
602
+ * Send a message and/or global data to an AI agent on another call.
603
+ *
604
+ * Two payloads, either or both: `messageText` lands as a turn in the other
605
+ * agent's conversation, where it competes with everything else arriving at
606
+ * that moment; `globalData` is merged into the other call's global data,
607
+ * where it stays silent until a prompt expands it with
608
+ * `${global_data.your_key}`. That makes data the better channel for content a
609
+ * later step needs to say.
610
+ *
611
+ * @param callId - The target call ID.
612
+ * @param messageText - Message to inject into the other conversation.
613
+ * @param role - The message role (defaults to "system"); sent with the message.
614
+ * @param globalData - Object merged into the target call's global data.
615
+ * @returns This instance for chaining.
616
+ * @throws Error when neither `messageText` nor `globalData` is given.
617
+ */
618
+ rpcAiMessage(callId: string, messageText?: string | null, role?: string, globalData?: Record<string, unknown>): this;
619
+ /**
620
+ * Merge data into another call's global data, with no conversation turn.
621
+ * The other call's prompt reads it back with `${global_data.key}`.
415
622
  * @param callId - The target call ID.
416
- * @param messageText - The message text to inject.
417
- * @param role - The message role (defaults to "system").
623
+ * @param data - Object merged into that call's global data.
418
624
  * @returns This instance for chaining.
419
625
  */
420
- rpcAiMessage(callId: string, messageText: string, role?: string): this;
626
+ rpcAiGlobalData(callId: string, data: Record<string, unknown>): this;
421
627
  /**
422
- * Unhold a call that was previously placed on hold via RPC.
628
+ * Take another call off hold with the `ai_unhold` RPC method.
423
629
  * @param callId - The target call ID to unhold.
424
630
  * @returns This instance for chaining.
425
631
  */
426
632
  rpcAiUnhold(callId: string): this;
427
633
  /**
428
- * Initiate a payment collection flow on the call.
634
+ * Start a payment collection flow on the call. Emits an inline SWML document
635
+ * that sets `ai_response` and then runs the `pay` verb.
636
+ *
637
+ * `timeout`, `max_attempts`, `min_postal_code_length`, `security_code` and
638
+ * `postal_code` are sent as strings, as the platform reads them: its SWML
639
+ * validator requires strings for `security_code` and `postal_code`, and the
640
+ * pay request reads all five as strings. Each input is checked first:
641
+ * `timeout`, `maxAttempts` and `minPostalCodeLength` must be integers (or
642
+ * numeric strings), and `securityCode` a boolean (or `"true"`/`"false"`).
643
+ * A SWML variable reference such as `'${timeout}'` is passed through.
644
+ * `postalCode` is a boolean (whether to ask for it) or the postal code
645
+ * itself, as a string.
429
646
  * @param opts - Payment configuration including connector URL, method, and prompt options.
647
+ * @throws {Error} When `timeout`, `maxAttempts` or `minPostalCodeLength`
648
+ * isn't an integer, or `securityCode` isn't a boolean, or a SWML variable
649
+ * reference.
430
650
  * @returns This instance for chaining.
431
651
  */
432
652
  pay(opts: {
@@ -434,11 +654,11 @@ export declare class FunctionResult {
434
654
  inputMethod?: string;
435
655
  statusUrl?: string;
436
656
  paymentMethod?: string;
437
- timeout?: number;
438
- maxAttempts?: number;
439
- securityCode?: boolean;
657
+ timeout?: number | string;
658
+ maxAttempts?: number | string;
659
+ securityCode?: boolean | string;
440
660
  postalCode?: boolean | string;
441
- minPostalCodeLength?: number;
661
+ minPostalCodeLength?: number | string;
442
662
  tokenType?: string;
443
663
  chargeAmount?: string;
444
664
  currency?: string;
@@ -461,8 +681,8 @@ export declare class FunctionResult {
461
681
  static createPaymentPrompt(forSituation: string, actions: PaymentAction[], cardType?: string, errorType?: string): PaymentPrompt;
462
682
  /**
463
683
  * Create a payment action for use within a payment prompt.
464
- * @param actionType - The action type (e.g., "say", "play").
465
- * @param phrase - The phrase or URL for this action.
684
+ * @param actionType - The action type: "Say" or "Play".
685
+ * @param phrase - The text to say, or for "Play" the audio file URL.
466
686
  * @returns A new PaymentAction object.
467
687
  */
468
688
  static createPaymentAction(actionType: string, phrase: string): PaymentAction;
@@ -477,5 +697,11 @@ export declare class FunctionResult {
477
697
  * Serialize this result to a plain object for the SWAIG response.
478
698
  * @returns A dictionary with response, action, and post_process fields; falls back to "Action completed." if empty.
479
699
  */
480
- toDict(): Record<string, unknown>;
700
+ toDict(): SwaigResultDict;
701
+ /**
702
+ * TS-native serialization hook. `JSON.stringify(result)` emits the wire
703
+ * shape (delegates to {@link FunctionResult.toDict}) instead of the
704
+ * internal field layout. No Python counterpart.
705
+ */
706
+ toJSON(): SwaigResultDict;
481
707
  }