@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
@@ -7,6 +7,20 @@
7
7
  export class RelayError extends Error {
8
8
  /** Numeric RELAY result code returned by the server. */
9
9
  code;
10
+ /**
11
+ * The RAW server message, undecorated — the reference's public `self.message`
12
+ * (`relay/client.py:1332`).
13
+ *
14
+ * Kept as its own property because JS `Error` owns `message` and `super(...)`
15
+ * fills it with the DECORATED text (`"RELAY error {code}: {message}"`, the
16
+ * reference's `super().__init__` on line 1333). A caller who wants the server's
17
+ * own wording — to match on it, surface it in a UI, or forward it — reads this;
18
+ * `message` gives the decorated form, matching Python's `str(exc)`.
19
+ *
20
+ * Same spelling and rationale as {@link AIChatError.serverMessage}. The surface
21
+ * enumerator folds it onto the reference's `message` attribute.
22
+ */
23
+ serverMessage;
10
24
  /**
11
25
  * @param code - Numeric RELAY result code (e.g. `404`, `503`).
12
26
  * @param message - Human-readable error message from the server.
@@ -15,6 +29,7 @@ export class RelayError extends Error {
15
29
  super(`RELAY error ${code}: ${message}`);
16
30
  this.name = 'RelayError';
17
31
  this.code = code;
32
+ this.serverMessage = message;
18
33
  }
19
34
  }
20
35
  //# sourceMappingURL=RelayError.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"RelayError.js","sourceRoot":"","sources":["../../src/relay/RelayError.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,wDAAwD;IAC/C,IAAI,CAAS;IAEtB;;;OAGG;IACH,YAAY,IAAY,EAAE,OAAe;QACvC,KAAK,CAAC,eAAe,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}
1
+ {"version":3,"file":"RelayError.js","sourceRoot":"","sources":["../../src/relay/RelayError.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,wDAAwD;IAC/C,IAAI,CAAS;IACtB;;;;;;;;;;;;OAYG;IACM,aAAa,CAAS;IAE/B;;;OAGG;IACH,YAAY,IAAY,EAAE,OAAe;QACvC,KAAK,CAAC,eAAe,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;IAC/B,CAAC;CACF"}
@@ -4,6 +4,15 @@
4
4
  * These are convenience classes over raw event dicts. All Call event handlers
5
5
  * also accept the raw dict, so these are optional.
6
6
  */
7
+ import type { CallState, DialState, MessageState } from './closedSets.js';
8
+ import type { Device } from './types.js';
9
+ /**
10
+ * Raw RELAY wire payload — a `signalwire.event` notification dict. Field
11
+ * names/types are server-defined; access goes through {@link pick}, which
12
+ * applies a boundary cast to the expected field type while preserving the
13
+ * exact `value ?? default` runtime semantics.
14
+ */
15
+ type EventPayload = Record<string, unknown>;
7
16
  /**
8
17
  * Base class for all typed RELAY events.
9
18
  *
@@ -16,7 +25,7 @@ export declare class RelayEvent {
16
25
  /** Fully-qualified event type (e.g. `"calling.call.state"`). */
17
26
  readonly eventType: string;
18
27
  /** Raw params dict from the RELAY notification. */
19
- readonly params: Record<string, any>;
28
+ readonly params: EventPayload;
20
29
  /** Call ID associated with the event, or `""` for non-call events. */
21
30
  readonly callId: string;
22
31
  /** Server timestamp (epoch seconds) at which the event was emitted. */
@@ -27,43 +36,50 @@ export declare class RelayEvent {
27
36
  * @param callId - Call ID (if applicable).
28
37
  * @param timestamp - Server-side event timestamp.
29
38
  */
30
- constructor(eventType: string, params: Record<string, any>, callId?: string, timestamp?: number);
39
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number);
31
40
  /**
32
41
  * Factory that builds a typed event from a raw `signalwire.event` payload.
33
42
  * Subclasses override this to populate their specialised fields; the base
34
43
  * implementation returns a minimal `RelayEvent` used as the fallback for
35
44
  * unrecognised event types.
36
45
  */
37
- static fromPayload(payload: Record<string, any>): RelayEvent;
46
+ static fromPayload(payload: EventPayload): RelayEvent;
38
47
  }
39
48
  /** `calling.call.state` — fires on every lifecycle transition (created, ringing, answered, ending, ended). */
40
49
  export declare class CallStateEvent extends RelayEvent {
41
- readonly callState: string;
50
+ /**
51
+ * The new call state — a {@link CallState} (`created` | `ringing` |
52
+ * `answered` | `ending` | `ended`; closed literal union, autocompleted +
53
+ * typo-checked). Pass to {@link ../relay/closedSets.isCallStateTerminal} to
54
+ * test for the terminal state.
55
+ */
56
+ readonly callState: CallState;
42
57
  readonly endReason: string;
43
58
  readonly direction: string;
44
- readonly device: Record<string, any>;
45
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, callState: string, endReason: string, direction: string, device: Record<string, any>);
46
- static fromPayload(payload: Record<string, any>): CallStateEvent;
59
+ readonly device: Device;
60
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, callState?: CallState, endReason?: string, direction?: string, device?: Device);
61
+ static fromPayload(payload: EventPayload): CallStateEvent;
47
62
  }
48
63
  /** `calling.call.receive` — fires when an inbound call arrives on a subscribed context. */
49
64
  export declare class CallReceiveEvent extends RelayEvent {
50
- readonly callState: string;
65
+ /** Initial call state ({@link CallState}; typically `created`). */
66
+ readonly callState: CallState;
51
67
  readonly direction: string;
52
- readonly device: Record<string, any>;
68
+ readonly device: Device;
53
69
  readonly nodeId: string;
54
70
  readonly projectId: string;
55
71
  readonly context: string;
56
72
  readonly segmentId: string;
57
73
  readonly tag: string;
58
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, callState: string, direction: string, device: Record<string, any>, nodeId: string, projectId: string, context: string, segmentId: string, tag: string);
59
- static fromPayload(payload: Record<string, any>): CallReceiveEvent;
74
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, callState?: CallState, direction?: string, device?: Device, nodeId?: string, projectId?: string, context?: string, segmentId?: string, tag?: string);
75
+ static fromPayload(payload: EventPayload): CallReceiveEvent;
60
76
  }
61
77
  /** `calling.call.play` — play-media action state change (`playing`, `paused`, `finished`, `error`). */
62
78
  export declare class PlayEvent extends RelayEvent {
63
79
  readonly controlId: string;
64
80
  readonly state: string;
65
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, state: string);
66
- static fromPayload(payload: Record<string, any>): PlayEvent;
81
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string);
82
+ static fromPayload(payload: EventPayload): PlayEvent;
67
83
  }
68
84
  /** `calling.call.record` — recording state change with final URL, duration, and size when finished. */
69
85
  export declare class RecordEvent extends RelayEvent {
@@ -72,48 +88,48 @@ export declare class RecordEvent extends RelayEvent {
72
88
  readonly url: string;
73
89
  readonly duration: number;
74
90
  readonly size: number;
75
- readonly record: Record<string, any>;
76
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, state: string, url: string, duration: number, size: number, record: Record<string, any>);
77
- static fromPayload(payload: Record<string, any>): RecordEvent;
91
+ readonly record: EventPayload;
92
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, url?: string, duration?: number, size?: number, record?: EventPayload);
93
+ static fromPayload(payload: EventPayload): RecordEvent;
78
94
  }
79
95
  /** `calling.call.collect` — caller input (DTMF or speech) collected by a collect action. */
80
96
  export declare class CollectEvent extends RelayEvent {
81
97
  readonly controlId: string;
82
98
  readonly state: string;
83
- readonly result: Record<string, any>;
99
+ readonly result: EventPayload;
84
100
  readonly final: boolean | undefined;
85
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId?: string, state?: string, result?: Record<string, any>, final_?: boolean | undefined);
86
- static fromPayload(payload: Record<string, any>): CollectEvent;
101
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, result?: EventPayload, final_?: boolean | undefined);
102
+ static fromPayload(payload: EventPayload): CollectEvent;
87
103
  }
88
104
  /** `calling.call.connect` — state transition when one call connects to another (dialplan/bridge). */
89
105
  export declare class ConnectEvent extends RelayEvent {
90
106
  readonly connectState: string;
91
- readonly peer: Record<string, any>;
92
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, connectState: string, peer: Record<string, any>);
93
- static fromPayload(payload: Record<string, any>): ConnectEvent;
107
+ readonly peer: EventPayload;
108
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, connectState?: string, peer?: EventPayload);
109
+ static fromPayload(payload: EventPayload): ConnectEvent;
94
110
  }
95
111
  /** `calling.call.detect` — answering-machine / fax / DTMF detection result. */
96
112
  export declare class DetectEvent extends RelayEvent {
97
113
  readonly controlId: string;
98
- readonly detect: Record<string, any>;
99
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, detect: Record<string, any>);
100
- static fromPayload(payload: Record<string, any>): DetectEvent;
114
+ readonly detect: EventPayload;
115
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, detect?: EventPayload);
116
+ static fromPayload(payload: EventPayload): DetectEvent;
101
117
  }
102
118
  /** `calling.call.fax` — fax send/receive progress update. */
103
119
  export declare class FaxEvent extends RelayEvent {
104
120
  readonly controlId: string;
105
- readonly fax: Record<string, any>;
106
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, fax: Record<string, any>);
107
- static fromPayload(payload: Record<string, any>): FaxEvent;
121
+ readonly fax: EventPayload;
122
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, fax?: EventPayload);
123
+ static fromPayload(payload: EventPayload): FaxEvent;
108
124
  }
109
125
  /** `calling.call.tap` — media tap state change (audio mirror to an external endpoint). */
110
126
  export declare class TapEvent extends RelayEvent {
111
127
  readonly controlId: string;
112
128
  readonly state: string;
113
- readonly tap: Record<string, any>;
114
- readonly device: Record<string, any>;
115
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, state: string, tap: Record<string, any>, device: Record<string, any>);
116
- static fromPayload(payload: Record<string, any>): TapEvent;
129
+ readonly tap: EventPayload;
130
+ readonly device: Device;
131
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, tap?: EventPayload, device?: Device);
132
+ static fromPayload(payload: EventPayload): TapEvent;
117
133
  }
118
134
  /** `calling.call.stream` — outbound media stream state change (e.g. RTMP/WebSocket streaming). */
119
135
  export declare class StreamEvent extends RelayEvent {
@@ -121,23 +137,29 @@ export declare class StreamEvent extends RelayEvent {
121
137
  readonly state: string;
122
138
  readonly url: string;
123
139
  readonly name: string;
124
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, state: string, url: string, name: string);
125
- static fromPayload(payload: Record<string, any>): StreamEvent;
140
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, url?: string, name?: string);
141
+ static fromPayload(payload: EventPayload): StreamEvent;
126
142
  }
127
143
  /** `calling.call.send_digits` — progress update for DTMF digits sent out on a call. */
128
144
  export declare class SendDigitsEvent extends RelayEvent {
129
145
  readonly controlId: string;
130
146
  readonly state: string;
131
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, state: string);
132
- static fromPayload(payload: Record<string, any>): SendDigitsEvent;
147
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string);
148
+ static fromPayload(payload: EventPayload): SendDigitsEvent;
133
149
  }
134
150
  /** `calling.call.dial` — outbound dial progress (answered, failed, no-answer, etc.). */
135
151
  export declare class DialEvent extends RelayEvent {
136
152
  readonly tag: string;
137
- readonly dialState: string;
138
- readonly call: Record<string, any>;
139
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, tag: string, dialState: string, call: Record<string, any>);
140
- static fromPayload(payload: Record<string, any>): DialEvent;
153
+ /**
154
+ * Outbound-dial state — a {@link DialState} (`dialing` | `answered` |
155
+ * `failed`; closed literal union, autocompleted + typo-checked). Pass to
156
+ * {@link ../relay/closedSets.isDialStateTerminal} to test for resolution.
157
+ * Distinct from a {@link CallState}.
158
+ */
159
+ readonly dialState: DialState;
160
+ readonly call: EventPayload;
161
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, tag?: string, dialState?: DialState, call?: EventPayload);
162
+ static fromPayload(payload: EventPayload): DialEvent;
141
163
  }
142
164
  /** `calling.call.refer` — SIP REFER result (off-platform transfer response codes). */
143
165
  export declare class ReferEvent extends RelayEvent {
@@ -145,21 +167,21 @@ export declare class ReferEvent extends RelayEvent {
145
167
  readonly sipReferTo: string;
146
168
  readonly sipReferResponseCode: string;
147
169
  readonly sipNotifyResponseCode: string;
148
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, state: string, sipReferTo: string, sipReferResponseCode: string, sipNotifyResponseCode: string);
149
- static fromPayload(payload: Record<string, any>): ReferEvent;
170
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, state?: string, sipReferTo?: string, sipReferResponseCode?: string, sipNotifyResponseCode?: string);
171
+ static fromPayload(payload: EventPayload): ReferEvent;
150
172
  }
151
173
  /** `calling.call.denoise` — noise-reduction on/off confirmation. */
152
174
  export declare class DenoiseEvent extends RelayEvent {
153
175
  readonly denoised: boolean;
154
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, denoised: boolean);
155
- static fromPayload(payload: Record<string, any>): DenoiseEvent;
176
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, denoised?: boolean);
177
+ static fromPayload(payload: EventPayload): DenoiseEvent;
156
178
  }
157
179
  /** `calling.call.pay` — PCI-compliant payment collection progress update. */
158
180
  export declare class PayEvent extends RelayEvent {
159
181
  readonly controlId: string;
160
182
  readonly state: string;
161
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, state: string);
162
- static fromPayload(payload: Record<string, any>): PayEvent;
183
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string);
184
+ static fromPayload(payload: EventPayload): PayEvent;
163
185
  }
164
186
  /** `calling.call.queue` — call-queue position update (queued, waiting, member answered, timed out). */
165
187
  export declare class QueueEvent extends RelayEvent {
@@ -169,14 +191,14 @@ export declare class QueueEvent extends RelayEvent {
169
191
  readonly queueName: string;
170
192
  readonly position: number;
171
193
  readonly size: number;
172
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, status: string, queueId: string, queueName: string, position: number, size: number);
173
- static fromPayload(payload: Record<string, any>): QueueEvent;
194
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, status?: string, queueId?: string, queueName?: string, position?: number, size?: number);
195
+ static fromPayload(payload: EventPayload): QueueEvent;
174
196
  }
175
197
  /** `calling.call.echo` — test/diagnostic echo reflection from the server. */
176
198
  export declare class EchoEvent extends RelayEvent {
177
199
  readonly state: string;
178
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, state: string);
179
- static fromPayload(payload: Record<string, any>): EchoEvent;
200
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, state?: string);
201
+ static fromPayload(payload: EventPayload): EchoEvent;
180
202
  }
181
203
  /** `calling.call.transcribe` — transcription state change and final URL/duration when finished. */
182
204
  export declare class TranscribeEvent extends RelayEvent {
@@ -186,29 +208,29 @@ export declare class TranscribeEvent extends RelayEvent {
186
208
  readonly recordingId: string;
187
209
  readonly duration: number;
188
210
  readonly size: number;
189
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, controlId: string, state: string, url: string, recordingId: string, duration: number, size: number);
190
- static fromPayload(payload: Record<string, any>): TranscribeEvent;
211
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, url?: string, recordingId?: string, duration?: number, size?: number);
212
+ static fromPayload(payload: EventPayload): TranscribeEvent;
191
213
  }
192
214
  /** `calling.call.hold` — hold/unhold state change on the call. */
193
215
  export declare class HoldEvent extends RelayEvent {
194
216
  readonly state: string;
195
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, state: string);
196
- static fromPayload(payload: Record<string, any>): HoldEvent;
217
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, state?: string);
218
+ static fromPayload(payload: EventPayload): HoldEvent;
197
219
  }
198
220
  /** `calling.conference` — conference lifecycle change (created, active, ended). */
199
221
  export declare class ConferenceEvent extends RelayEvent {
200
222
  readonly conferenceId: string;
201
223
  readonly name: string;
202
224
  readonly status: string;
203
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, conferenceId: string, name: string, status: string);
204
- static fromPayload(payload: Record<string, any>): ConferenceEvent;
225
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, conferenceId?: string, name?: string, status?: string);
226
+ static fromPayload(payload: EventPayload): ConferenceEvent;
205
227
  }
206
228
  /** `calling.error` — platform-emitted error against the calling namespace. */
207
229
  export declare class CallingErrorEvent extends RelayEvent {
208
230
  readonly code: string;
209
231
  readonly message: string;
210
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, code: string, message: string);
211
- static fromPayload(payload: Record<string, any>): CallingErrorEvent;
232
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, code?: string, message?: string);
233
+ static fromPayload(payload: EventPayload): CallingErrorEvent;
212
234
  }
213
235
  /** `messaging.receive` — inbound SMS/MMS received on a subscribed context. */
214
236
  export declare class MessageReceiveEvent extends RelayEvent {
@@ -222,8 +244,8 @@ export declare class MessageReceiveEvent extends RelayEvent {
222
244
  readonly segments: number;
223
245
  readonly messageState: string;
224
246
  readonly tags: string[];
225
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, messageId: string, context: string, direction: string, fromNumber: string, toNumber: string, body: string, media: string[], segments: number, messageState: string, tags: string[]);
226
- static fromPayload(payload: Record<string, any>): MessageReceiveEvent;
247
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, messageId?: string, context?: string, direction?: string, fromNumber?: string, toNumber?: string, body?: string, media?: string[], segments?: number, messageState?: string, tags?: string[]);
248
+ static fromPayload(payload: EventPayload): MessageReceiveEvent;
227
249
  }
228
250
  /** `messaging.state` — state change for an outbound message (queued → sent → delivered/failed). */
229
251
  export declare class MessageStateEvent extends RelayEvent {
@@ -235,15 +257,23 @@ export declare class MessageStateEvent extends RelayEvent {
235
257
  readonly body: string;
236
258
  readonly media: string[];
237
259
  readonly segments: number;
238
- readonly messageState: string;
260
+ /**
261
+ * Message lifecycle state — a {@link MessageState} (`queued` |
262
+ * `initiated` | `sent` | `delivered` | `undelivered` | `failed` | `received`;
263
+ * closed literal union, autocompleted + typo-checked). Pass to
264
+ * {@link ../relay/closedSets.isMessageStateTerminal} to test for a final
265
+ * delivery outcome. Distinct from a {@link CallState} /
266
+ * {@link DialState}.
267
+ */
268
+ readonly messageState: MessageState;
239
269
  readonly reason: string;
240
270
  readonly tags: string[];
241
- constructor(eventType: string, params: Record<string, any>, callId: string, timestamp: number, messageId: string, context: string, direction: string, fromNumber: string, toNumber: string, body: string, media: string[], segments: number, messageState: string, reason: string, tags: string[]);
242
- static fromPayload(payload: Record<string, any>): MessageStateEvent;
271
+ constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, messageId?: string, context?: string, direction?: string, fromNumber?: string, toNumber?: string, body?: string, media?: string[], segments?: number, messageState?: MessageState, reason?: string, tags?: string[]);
272
+ static fromPayload(payload: EventPayload): MessageStateEvent;
243
273
  }
244
274
  /** Structural type for an event class that exposes a `fromPayload` factory. */
245
275
  export type EventClass = {
246
- fromPayload(payload: Record<string, any>): RelayEvent;
276
+ fromPayload(payload: EventPayload): RelayEvent;
247
277
  };
248
278
  /**
249
279
  * Maps RELAY `event_type` strings to the typed event subclass that builds
@@ -251,4 +281,5 @@ export type EventClass = {
251
281
  */
252
282
  export declare const EVENT_CLASS_MAP: Record<string, EventClass>;
253
283
  /** Parse a raw signalwire.event params dict into a typed event object. */
254
- export declare function parseEvent(payload: Record<string, any>): RelayEvent;
284
+ export declare function parseEvent(payload: EventPayload): RelayEvent;
285
+ export {};