@signalwire/sdk 2.0.0 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (612) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/dist/index.d.ts +146 -0
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1019 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
  149. package/dist/rest/index.js +195 -0
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/dist/rest/pagination.d.ts +39 -0
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2489
  416. package/src/AgentServer.ts +0 -415
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1150
  420. package/src/DataMap.ts +0 -449
  421. package/src/FunctionResult.ts +0 -866
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -439
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -717
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -221
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -258
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -181
  435. package/src/WebService.ts +0 -619
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/index.ts +0 -167
  441. package/src/livewire/index.ts +0 -950
  442. package/src/prefabs/ConciergeAgent.ts +0 -287
  443. package/src/prefabs/FAQBotAgent.ts +0 -384
  444. package/src/prefabs/InfoGathererAgent.ts +0 -339
  445. package/src/prefabs/ReceptionistAgent.ts +0 -366
  446. package/src/prefabs/SurveyAgent.ts +0 -646
  447. package/src/relay/Action.ts +0 -314
  448. package/src/relay/Call.ts +0 -854
  449. package/src/relay/Deferred.ts +0 -71
  450. package/src/relay/Message.ts +0 -148
  451. package/src/relay/RelayClient.ts +0 -1036
  452. package/src/relay/RelayError.ts +0 -14
  453. package/src/relay/RelayEvent.ts +0 -892
  454. package/src/relay/index.ts +0 -123
  455. package/src/relay/types.ts +0 -149
  456. package/src/rest/HttpClient.ts +0 -103
  457. package/src/rest/RestError.ts +0 -31
  458. package/src/rest/base/BaseResource.ts +0 -19
  459. package/src/rest/base/CrudResource.ts +0 -51
  460. package/src/rest/base/CrudWithAddresses.ts +0 -26
  461. package/src/rest/namespaces/addresses.ts +0 -32
  462. package/src/rest/namespaces/calling.ts +0 -187
  463. package/src/rest/namespaces/chat.ts +0 -20
  464. package/src/rest/namespaces/compat.ts +0 -352
  465. package/src/rest/namespaces/datasphere.ts +0 -45
  466. package/src/rest/namespaces/fabric.ts +0 -222
  467. package/src/rest/namespaces/imported-numbers.ts +0 -20
  468. package/src/rest/namespaces/logs.ts +0 -84
  469. package/src/rest/namespaces/lookup.ts +0 -21
  470. package/src/rest/namespaces/mfa.ts +0 -30
  471. package/src/rest/namespaces/number-groups.ts +0 -38
  472. package/src/rest/namespaces/phone-numbers.ts +0 -44
  473. package/src/rest/namespaces/project.ts +0 -36
  474. package/src/rest/namespaces/pubsub.ts +0 -20
  475. package/src/rest/namespaces/queues.ts +0 -33
  476. package/src/rest/namespaces/recordings.ts +0 -28
  477. package/src/rest/namespaces/registry.ts +0 -101
  478. package/src/rest/namespaces/short-codes.ts +0 -28
  479. package/src/rest/namespaces/sip-profile.ts +0 -25
  480. package/src/rest/namespaces/verified-callers.ts +0 -27
  481. package/src/rest/namespaces/video.ts +0 -165
  482. package/src/rest/pagination.ts +0 -84
  483. package/src/rest/types.ts +0 -61
  484. package/src/skills/SkillBase.ts +0 -547
  485. package/src/skills/SkillManager.ts +0 -415
  486. package/src/skills/SkillRegistry.ts +0 -367
  487. package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
  488. package/src/skills/builtin/ask_claude.ts +0 -241
  489. package/src/skills/builtin/claude_skills.ts +0 -978
  490. package/src/skills/builtin/custom_skills.ts +0 -312
  491. package/src/skills/builtin/datasphere.ts +0 -438
  492. package/src/skills/builtin/datasphere_serverless.ts +0 -339
  493. package/src/skills/builtin/datetime.ts +0 -130
  494. package/src/skills/builtin/google_maps.ts +0 -651
  495. package/src/skills/builtin/info_gatherer.ts +0 -405
  496. package/src/skills/builtin/joke.ts +0 -191
  497. package/src/skills/builtin/math.ts +0 -142
  498. package/src/skills/builtin/mcp_gateway.ts +0 -677
  499. package/src/skills/builtin/native_vector_search.ts +0 -901
  500. package/src/skills/builtin/play_background_file.ts +0 -358
  501. package/src/skills/builtin/spider.ts +0 -869
  502. package/src/skills/builtin/swml_transfer.ts +0 -635
  503. package/src/skills/builtin/weather_api.ts +0 -248
  504. package/src/skills/builtin/web_search.ts +0 -1074
  505. package/src/skills/builtin/wikipedia_search.ts +0 -299
  506. package/src/types.ts +0 -132
  507. package/tests/AgentBase.test.ts +0 -1093
  508. package/tests/AgentServer.test.ts +0 -126
  509. package/tests/AuthHandler.test.ts +0 -133
  510. package/tests/ConfigLoader.test.ts +0 -151
  511. package/tests/ContextBuilder.test.ts +0 -108
  512. package/tests/DataMap.test.ts +0 -367
  513. package/tests/EphemeralSkillCopy.test.ts +0 -107
  514. package/tests/FunctionResult.test.ts +0 -298
  515. package/tests/GracefulShutdown.test.ts +0 -46
  516. package/tests/Logger.test.ts +0 -420
  517. package/tests/PomBuilder.test.ts +0 -228
  518. package/tests/ProxyDetection.test.ts +0 -228
  519. package/tests/SWMLService.test.ts +0 -320
  520. package/tests/SWMLVerbHandler.test.ts +0 -523
  521. package/tests/SchemaUtils.test.ts +0 -106
  522. package/tests/SchemaUtils.verb.test.ts +0 -206
  523. package/tests/SecurityUtils.test.ts +0 -192
  524. package/tests/ServerlessAdapter.test.ts +0 -222
  525. package/tests/SessionManager.test.ts +0 -257
  526. package/tests/SkillBaseFeatures.test.ts +0 -130
  527. package/tests/SkillMultiInstance.test.ts +0 -102
  528. package/tests/SkillParameterSchemas.test.ts +0 -134
  529. package/tests/SkillRegistrySchema.test.ts +0 -84
  530. package/tests/SslConfig.test.ts +0 -97
  531. package/tests/SwmlBuilder.test.ts +0 -400
  532. package/tests/TypeInference.test.ts +0 -165
  533. package/tests/VerbHandlerRegistry.test.ts +0 -128
  534. package/tests/cli/mock-data.test.ts +0 -113
  535. package/tests/cli/swaig-test.test.ts +0 -108
  536. package/tests/examples.test.ts +0 -194
  537. package/tests/fixtures/scrape-parity/README.md +0 -53
  538. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  548. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  549. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  550. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  551. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  552. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  553. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  554. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  555. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  556. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  557. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  558. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  559. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  560. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  561. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  562. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  563. package/tests/livewire/livewire.test.ts +0 -780
  564. package/tests/mcp.test.ts +0 -221
  565. package/tests/prefabs/prefabs.test.ts +0 -1093
  566. package/tests/relay/Action.test.ts +0 -392
  567. package/tests/relay/Call.test.ts +0 -535
  568. package/tests/relay/Deferred.test.ts +0 -71
  569. package/tests/relay/Message.test.ts +0 -164
  570. package/tests/relay/RelayClient.test.ts +0 -779
  571. package/tests/relay/RelayEvent.test.ts +0 -463
  572. package/tests/relay/helpers.ts +0 -79
  573. package/tests/rest/HttpClient.test.ts +0 -274
  574. package/tests/rest/RestError.test.ts +0 -53
  575. package/tests/rest/calling.test.ts +0 -156
  576. package/tests/rest/client.test.ts +0 -197
  577. package/tests/rest/compat.test.ts +0 -335
  578. package/tests/rest/datasphere.test.ts +0 -71
  579. package/tests/rest/fabric.test.ts +0 -186
  580. package/tests/rest/helpers.ts +0 -95
  581. package/tests/rest/logs.test.ts +0 -68
  582. package/tests/rest/pagination.test.ts +0 -133
  583. package/tests/rest/registry.test.ts +0 -94
  584. package/tests/rest/relay-rest.test.ts +0 -290
  585. package/tests/rest/video.test.ts +0 -173
  586. package/tests/setup.ts +0 -6
  587. package/tests/skills/SkillBase.test.ts +0 -108
  588. package/tests/skills/SkillManager.test.ts +0 -268
  589. package/tests/skills/SkillRegistry.test.ts +0 -176
  590. package/tests/skills/builtin.test.ts +0 -1472
  591. package/tests/skills/claude-skills.test.ts +0 -54
  592. package/tests/skills/custom-skills.test.ts +0 -53
  593. package/tests/skills/datasphere-serverless.test.ts +0 -70
  594. package/tests/skills/datasphere.test.ts +0 -107
  595. package/tests/skills/datetime.test.ts +0 -101
  596. package/tests/skills/google-maps.test.ts +0 -78
  597. package/tests/skills/info-gatherer.test.ts +0 -411
  598. package/tests/skills/joke.test.ts +0 -81
  599. package/tests/skills/math.test.ts +0 -68
  600. package/tests/skills/mcp-gateway.test.ts +0 -101
  601. package/tests/skills/play-background.test.ts +0 -54
  602. package/tests/skills/spider.test.ts +0 -108
  603. package/tests/skills/swml-transfer.test.ts +0 -178
  604. package/tests/skills/trivia.test.ts +0 -54
  605. package/tests/skills/vector-search.test.ts +0 -135
  606. package/tests/skills/weather-api.test.ts +0 -77
  607. package/tests/skills/web-search-parity.test.ts +0 -59
  608. package/tests/skills/web-search.test.ts +0 -103
  609. package/tests/skills/wikipedia.test.ts +0 -63
  610. package/tsconfig.json +0 -18
  611. package/vitest.config.ts +0 -9
  612. /package/{src → dist}/schema.json +0 -0
@@ -1,134 +0,0 @@
1
- # Events
2
-
3
- RELAY events are server-pushed notifications about call state changes and operation results. Events arrive over the WebSocket as `signalwire.event` JSON-RPC messages and are automatically routed to the correct `Call` object.
4
-
5
- ## Listening for Events
6
-
7
- ### On a Call
8
-
9
- ```python
10
- @client.on_call
11
- async def handle(call):
12
- # Register a listener
13
- call.on("calling.call.play", lambda event: print(f"Play: {event.params}"))
14
-
15
- # Or wait for a specific event
16
- event = await call.wait_for("calling.call.state",
17
- predicate=lambda e: e.params.get("call_state") == "ended",
18
- timeout=60.0,
19
- )
20
- ```
21
-
22
- ### Via Actions
23
-
24
- Actions returned by `play()`, `record()`, etc. have a `wait()` method that resolves when the operation completes:
25
-
26
- ```python
27
- action = await call.play([{"type": "tts", "params": {"text": "Hello"}}])
28
- event = await action.wait(timeout=30.0)
29
- # event is a RelayEvent with the terminal state
30
- ```
31
-
32
- ## Event Types
33
-
34
- All event type constants are importable from `signalwire_agents.relay`:
35
-
36
- | Constant | Value | Description |
37
- |----------|-------|-------------|
38
- | `EVENT_CALL_STATE` | `calling.call.state` | Call state changes (created, ringing, answered, ending, ended) |
39
- | `EVENT_CALL_RECEIVE` | `calling.call.receive` | Inbound call notification |
40
- | `EVENT_CALL_PLAY` | `calling.call.play` | Play operation state changes |
41
- | `EVENT_CALL_RECORD` | `calling.call.record` | Record operation state changes |
42
- | `EVENT_CALL_COLLECT` | `calling.call.collect` | Input collection results |
43
- | `EVENT_CALL_CONNECT` | `calling.call.connect` | Bridge/connect state changes |
44
- | `EVENT_CALL_DETECT` | `calling.call.detect` | Detection results |
45
- | `EVENT_CALL_FAX` | `calling.call.fax` | Fax operation state changes |
46
- | `EVENT_CALL_TAP` | `calling.call.tap` | Tap operation state changes |
47
- | `EVENT_CALL_STREAM` | `calling.call.stream` | Stream operation state changes |
48
- | `EVENT_CALL_SEND_DIGITS` | `calling.call.send_digits` | DTMF send completion |
49
- | `EVENT_CALL_DIAL` | `calling.call.dial` | Outbound dial progress |
50
- | `EVENT_CALL_REFER` | `calling.call.refer` | SIP REFER results |
51
- | `EVENT_CALL_DENOISE` | `calling.call.denoise` | Denoise state changes |
52
- | `EVENT_CALL_PAY` | `calling.call.pay` | Payment state changes |
53
- | `EVENT_CALL_QUEUE` | `calling.call.queue` | Queue state changes |
54
- | `EVENT_CALL_ECHO` | `calling.call.echo` | Echo state changes |
55
- | `EVENT_CALL_TRANSCRIBE` | `calling.call.transcribe` | Transcription state changes |
56
- | `EVENT_CONFERENCE` | `calling.conference` | Conference state changes |
57
- | `EVENT_CALLING_ERROR` | `calling.error` | Error events |
58
- | `EVENT_MESSAGING_RECEIVE` | `messaging.receive` | Inbound message received |
59
- | `EVENT_MESSAGING_STATE` | `messaging.state` | Outbound message state change |
60
-
61
- ## Typed Event Classes
62
-
63
- Raw events are always `RelayEvent` with a `params` dict. For convenience, typed event classes provide named properties:
64
-
65
- ```python
66
- from signalwire_agents.relay import CallStateEvent, PlayEvent, RecordEvent, parse_event
67
-
68
- # Automatic parsing
69
- event = parse_event(raw_payload)
70
-
71
- # Or construct directly
72
- if event.event_type == "calling.call.state":
73
- state_event = CallStateEvent.from_payload(raw_payload)
74
- print(state_event.call_state) # "answered"
75
- print(state_event.end_reason) # "hangup" (only on ended)
76
- ```
77
-
78
- ### Available Typed Events
79
-
80
- | Class | Key Properties |
81
- |-------|---------------|
82
- | `CallStateEvent` | `call_state`, `end_reason`, `direction`, `device` |
83
- | `CallReceiveEvent` | `call_state`, `direction`, `device`, `node_id`, `context`, `tag` |
84
- | `PlayEvent` | `control_id`, `state` |
85
- | `RecordEvent` | `control_id`, `state`, `url`, `duration`, `size` |
86
- | `CollectEvent` | `control_id`, `state`, `result`, `final` |
87
- | `ConnectEvent` | `connect_state`, `peer` |
88
- | `DetectEvent` | `control_id`, `detect` |
89
- | `FaxEvent` | `control_id`, `fax` |
90
- | `TapEvent` | `control_id`, `state`, `tap`, `device` |
91
- | `StreamEvent` | `control_id`, `state`, `url`, `name` |
92
- | `SendDigitsEvent` | `control_id`, `state` |
93
- | `DialEvent` | `tag`, `dial_state`, `call` |
94
- | `ReferEvent` | `state`, `sip_refer_to`, `sip_refer_response_code` |
95
- | `DenoiseEvent` | `denoised` |
96
- | `PayEvent` | `control_id`, `state` |
97
- | `QueueEvent` | `control_id`, `status`, `queue_id`, `queue_name`, `position`, `size` |
98
- | `EchoEvent` | `state` |
99
- | `TranscribeEvent` | `control_id`, `state`, `url`, `duration`, `size` |
100
- | `HoldEvent` | `state` |
101
- | `ConferenceEvent` | `conference_id`, `name`, `status` |
102
- | `CallingErrorEvent` | `code`, `message` |
103
- | `MessageReceiveEvent` | `message_id`, `context`, `direction`, `from_number`, `to_number`, `body`, `media`, `segments`, `message_state`, `tags` |
104
- | `MessageStateEvent` | `message_id`, `context`, `direction`, `from_number`, `to_number`, `body`, `media`, `segments`, `message_state`, `reason`, `tags` |
105
-
106
- ## Call States
107
-
108
- ```
109
- created -> ringing -> answered -> ending -> ended
110
- ```
111
-
112
- Constants: `CALL_STATE_CREATED`, `CALL_STATE_RINGING`, `CALL_STATE_ANSWERED`, `CALL_STATE_ENDING`, `CALL_STATE_ENDED`
113
-
114
- ## End Reasons
115
-
116
- When a call reaches the `ended` state, the `end_reason` field indicates why:
117
-
118
- | Reason | Description |
119
- |--------|-------------|
120
- | `hangup` | Normal hangup |
121
- | `cancel` | Caller cancelled |
122
- | `busy` | Destination busy |
123
- | `noAnswer` | No answer |
124
- | `decline` | Call declined |
125
- | `error` | Error occurred |
126
- | `abandoned` | Call abandoned |
127
- | `max_duration` | Max duration reached |
128
- | `not_found` | Destination not found |
129
-
130
- ## Message States
131
-
132
- Outbound messages progress through: `queued` → `initiated` → `sent` → `delivered` (or `undelivered`/`failed`).
133
-
134
- Constants: `MESSAGE_STATE_QUEUED`, `MESSAGE_STATE_INITIATED`, `MESSAGE_STATE_SENT`, `MESSAGE_STATE_DELIVERED`, `MESSAGE_STATE_UNDELIVERED`, `MESSAGE_STATE_FAILED`, `MESSAGE_STATE_RECEIVED`
@@ -1,134 +0,0 @@
1
- # Getting Started with RELAY
2
-
3
- The RELAY client connects to SignalWire via WebSocket and gives you real-time, imperative control over phone calls using Python's asyncio.
4
-
5
- ## Installation
6
-
7
- The RELAY client is included in the `@signalwire/sdk` package:
8
-
9
- ```bash
10
- pip install @signalwire/sdk
11
- ```
12
-
13
- The only additional dependency is `websockets>=12.0`, which is installed automatically.
14
-
15
- ## Configuration
16
-
17
- You need three things to connect:
18
-
19
- | Parameter | Env Var | Description |
20
- |-----------|---------|-------------|
21
- | `project` | `SIGNALWIRE_PROJECT_ID` | Your SignalWire project ID |
22
- | `token` | `SIGNALWIRE_API_TOKEN` | Your SignalWire API token |
23
- | `host` | `SIGNALWIRE_SPACE` | Your space hostname (e.g. `example.signalwire.com`) |
24
-
25
- Alternatively, you can authenticate with a JWT token:
26
-
27
- | Parameter | Env Var | Description |
28
- |-----------|---------|-------------|
29
- | `jwt_token` | `SIGNALWIRE_JWT_TOKEN` | A SignalWire JWT auth token |
30
-
31
- ## Minimal Example
32
-
33
- ```python
34
- from signalwire_agents.relay import RelayClient
35
-
36
- client = RelayClient(
37
- project="your-project-id",
38
- token="your-api-token",
39
- host="example.signalwire.com",
40
- contexts=["default"],
41
- )
42
-
43
- @client.on_call
44
- async def handle(call):
45
- await call.answer()
46
- action = await call.play([{"type": "tts", "params": {"text": "Hello!"}}])
47
- await action.wait()
48
- await call.hangup()
49
-
50
- client.run()
51
- ```
52
-
53
- Or use environment variables and skip the constructor args:
54
-
55
- ```bash
56
- export SIGNALWIRE_PROJECT_ID=your-project-id
57
- export SIGNALWIRE_API_TOKEN=your-api-token
58
- export SIGNALWIRE_SPACE=example.signalwire.com
59
- ```
60
-
61
- ```python
62
- from signalwire_agents.relay import RelayClient
63
-
64
- client = RelayClient(contexts=["default"])
65
-
66
- @client.on_call
67
- async def handle(call):
68
- await call.answer()
69
- await call.hangup()
70
-
71
- client.run()
72
- ```
73
-
74
- ## Contexts
75
-
76
- Contexts are topics your client subscribes to for receiving inbound calls. When a call arrives on a context you're subscribed to, your `@client.on_call` handler is invoked.
77
-
78
- ```python
79
- # Subscribe at connect time
80
- client = RelayClient(contexts=["sales", "support"])
81
-
82
- # Or dynamically after connecting
83
- await client.receive(["billing"])
84
- await client.unreceive(["sales"])
85
- ```
86
-
87
- ## Making Outbound Calls
88
-
89
- Use `client.dial()` to place an outbound call:
90
-
91
- ```python
92
- call = await client.dial([
93
- [{"type": "phone", "params": {"to_number": "+15551234567", "from_number": "+15559876543"}}]
94
- ])
95
- # call is now a live Call object
96
- action = await call.play([{"type": "tts", "params": {"text": "This is an outbound call."}}])
97
- await action.wait()
98
- await call.hangup()
99
- ```
100
-
101
- The outer list represents serial attempts; the inner list represents parallel attempts. For example, to try two numbers simultaneously:
102
-
103
- ```python
104
- call = await client.dial([
105
- [
106
- {"type": "phone", "params": {"to_number": "+15551111111", "from_number": "+15559876543"}},
107
- {"type": "phone", "params": {"to_number": "+15552222222", "from_number": "+15559876543"}},
108
- ]
109
- ])
110
- ```
111
-
112
- ## Debug Logging
113
-
114
- Set the log level to see WebSocket traffic:
115
-
116
- ```bash
117
- export SIGNALWIRE_LOG_LEVEL=debug
118
- ```
119
-
120
- ## Async Context Manager
121
-
122
- For use within an existing async application:
123
-
124
- ```python
125
- async with RelayClient(contexts=["default"]) as client:
126
- call = await client.dial([...])
127
- await call.answer()
128
- ```
129
-
130
- ## Next Steps
131
-
132
- - [Call Methods Reference](call-methods.md) -- all methods available on a Call object
133
- - [Events](events.md) -- handling real-time call events
134
- - [Client Reference](client-reference.md) -- RelayClient configuration and methods
@@ -1,306 +0,0 @@
1
- # RELAY Client Guide
2
-
3
- The RELAY client provides real-time call and message control over a persistent WebSocket connection to SignalWire. Unlike the HTTP-based agent model (AgentBase), RELAY gives your application event-driven, bidirectional control of live calls and messages.
4
-
5
- ## Authentication
6
-
7
- ```typescript
8
- import { RelayClient } from '@signalwire/sdk';
9
-
10
- const client = new RelayClient({
11
- project: 'your-project-id', // or env: SIGNALWIRE_PROJECT_ID
12
- token: 'your-api-token', // or env: SIGNALWIRE_TOKEN
13
- host: 'your-space.signalwire.com', // or env: SIGNALWIRE_SPACE
14
- contexts: ['office', 'support'],
15
- });
16
- ```
17
-
18
- All parameters can be provided via environment variables:
19
- - `SIGNALWIRE_PROJECT_ID` - Your SignalWire project ID
20
- - `SIGNALWIRE_TOKEN` - Your SignalWire API token (or `SIGNALWIRE_JWT_TOKEN` for JWT auth)
21
- - `SIGNALWIRE_SPACE` - Your SignalWire space hostname
22
-
23
- ## Handling Inbound Calls
24
-
25
- ```typescript
26
- client.onCall(async (call) => {
27
- console.log(`Inbound call: ${call.callId}`);
28
-
29
- await call.answer();
30
-
31
- const action = await call.play([
32
- { type: 'tts', text: 'Hello! Thanks for calling.' },
33
- ]);
34
- await action.wait();
35
-
36
- await call.hangup();
37
- });
38
-
39
- // Start the client (auto-reconnects)
40
- client.run();
41
- ```
42
-
43
- ## Making Outbound Calls
44
-
45
- ```typescript
46
- await client.connect();
47
-
48
- const call = await client.dial(
49
- [[{ type: 'phone', to: '+15551234567', from: '+15559876543' }]],
50
- { dialTimeout: 30_000 },
51
- );
52
-
53
- console.log(`Call answered: ${call.callId}`);
54
- await call.play([{ type: 'tts', text: 'Hello from RELAY!' }]);
55
- await call.hangup();
56
- ```
57
-
58
- ### Dial Gotcha
59
-
60
- The `calling.dial` RPC response does **not** contain a `call_id` — it only returns `{"code":"200","message":"Dialing"}`. The real `call_id` arrives via a `calling.call.dial` event matched by `tag`. The `dial()` method handles this automatically and returns a fully-initialized `Call` object.
61
-
62
- ## Call Methods
63
-
64
- ### Lifecycle
65
- - `call.answer()` - Answer an inbound call
66
- - `call.hangup(reason?)` - End the call
67
- - `call.pass()` - Decline control, return to routing
68
-
69
- ### Audio Playback
70
- ```typescript
71
- const action = await call.play([
72
- { type: 'tts', text: 'Hello world', language: 'en-US' },
73
- { type: 'audio', url: 'https://example.com/greeting.mp3' },
74
- { type: 'silence', duration: 2 },
75
- ]);
76
-
77
- // Control playback
78
- await action.pause();
79
- await action.resume();
80
- await action.volume(-3);
81
- await action.stop();
82
-
83
- // Or wait for completion
84
- const event = await action.wait();
85
- ```
86
-
87
- ### Recording
88
- ```typescript
89
- const action = await call.record({ format: 'mp3' });
90
- // ... later
91
- await action.stop();
92
- const event = await action.wait();
93
- console.log(`Recording URL: ${event.url}`);
94
- ```
95
-
96
- ### Input Collection
97
- ```typescript
98
- // Play and collect (combined)
99
- const action = await call.playAndCollect(
100
- [{ type: 'tts', text: 'Enter your PIN:' }],
101
- { digits: { max: 4, terminators: '#' } },
102
- );
103
- const event = await action.wait();
104
-
105
- // Standalone collect (no media)
106
- const collectAction = await call.collect({
107
- speech: { endSilenceTimeout: 2 },
108
- });
109
- ```
110
-
111
- ### Detection
112
- ```typescript
113
- const action = await call.detect(
114
- { type: 'machine', params: { initial_timeout: 5 } },
115
- { timeout: 10 },
116
- );
117
- const event = await action.wait();
118
- // DetectAction resolves on first meaningful result (HUMAN, MACHINE, etc.)
119
- ```
120
-
121
- ### Connectivity
122
- - `call.connect(devices, options?)` - Bridge to another endpoint
123
- - `call.disconnect()` - Unbridge a connected call
124
- - `call.transfer(dest)` - Transfer to another app/script
125
- - `call.refer(device, options?)` - SIP REFER transfer
126
-
127
- ### Other Methods
128
- - `call.sendDigits(digits)` - Send DTMF
129
- - `call.hold()` / `call.unhold()`
130
- - `call.denoise()` / `call.denoiseStop()`
131
- - `call.joinConference(name, options?)` / `call.leaveConference(id)`
132
- - `call.stream(url, options?)` - Stream audio to WebSocket
133
- - `call.tap(tap, device, options?)` - Media interception
134
- - `call.transcribe(options?)` - Start transcription
135
- - `call.pay(connectorUrl, options?)` - Payment collection
136
- - `call.sendFax(document, options?)` / `call.receiveFax(options?)`
137
- - `call.ai(options?)` - Start AI agent session
138
- - `call.queueEnter(name)` / `call.queueLeave(name)`
139
- - `call.echo()` - Echo audio back (testing)
140
-
141
- ## Actions
142
-
143
- Action methods return Action objects that track the operation's lifecycle:
144
-
145
- ```typescript
146
- const action = await call.play([{ type: 'tts', text: 'Hello' }]);
147
-
148
- // Check status
149
- console.log(action.isDone); // false
150
- console.log(action.completed); // false
151
-
152
- // Wait for completion
153
- const event = await action.wait(10_000); // with timeout
154
-
155
- // Or fire-and-forget with callback
156
- await call.play(
157
- [{ type: 'tts', text: 'Background music' }],
158
- {
159
- onCompleted: (event) => console.log('Playback finished'),
160
- },
161
- );
162
- ```
163
-
164
- ### Action Types
165
- | Action | Methods | Terminal States |
166
- |--------|---------|----------------|
167
- | `PlayAction` | stop, pause, resume, volume | finished, error |
168
- | `RecordAction` | stop, pause, resume | finished, no_input |
169
- | `DetectAction` | stop | finished, error (+ first result) |
170
- | `CollectAction` | stop, volume, startInputTimers | finished, error, no_input, no_match |
171
- | `FaxAction` | stop | finished, error |
172
- | `TapAction` | stop | finished |
173
- | `StreamAction` | stop | finished |
174
- | `PayAction` | stop | finished, error |
175
- | `TranscribeAction` | stop | finished |
176
- | `AIAction` | stop | finished, error |
177
-
178
- ## Event Listening
179
-
180
- ```typescript
181
- // Listen for specific events on a call
182
- call.on('calling.call.play', (event) => {
183
- console.log(`Play state: ${event.params.state}`);
184
- });
185
-
186
- // Wait for a specific event
187
- const event = await call.waitFor('calling.call.state',
188
- (e) => e.params.call_state === 'answered',
189
- 10_000, // timeout
190
- );
191
-
192
- // Wait for call to end
193
- const endEvent = await call.waitForEnded(60_000);
194
- ```
195
-
196
- ## Messaging
197
-
198
- ```typescript
199
- // Send SMS
200
- const message = await client.sendMessage({
201
- to: '+15551234567',
202
- from: '+15559876543',
203
- body: 'Hello from RELAY!',
204
- });
205
-
206
- // Track delivery
207
- const event = await message.wait(30_000);
208
- console.log(`State: ${message.state}`); // delivered, undelivered, failed
209
-
210
- // Receive inbound messages
211
- client.onMessage(async (message) => {
212
- console.log(`From ${message.fromNumber}: ${message.body}`);
213
- });
214
- ```
215
-
216
- ## Reconnection
217
-
218
- The `run()` method handles auto-reconnection with exponential backoff:
219
-
220
- ```typescript
221
- client.run(); // Blocks, auto-reconnects on disconnect
222
- ```
223
-
224
- Reconnection behavior:
225
- - Initial delay: 1 second
226
- - Max delay: 30 seconds
227
- - Backoff factor: 2x
228
- - Protocol/authorization state preserved across reconnects
229
- - Queued requests flushed after re-authentication
230
- - SIGINT/SIGTERM triggers clean shutdown
231
-
232
- For manual control:
233
- ```typescript
234
- await client.connect();
235
- // ... use client
236
- await client.disconnect();
237
- ```
238
-
239
- ## Dynamic Context Subscription
240
-
241
- ```typescript
242
- await client.connect();
243
-
244
- // Subscribe to new contexts at runtime
245
- await client.receive(['sales', 'support']);
246
-
247
- // Unsubscribe
248
- await client.unreceive(['sales']);
249
- ```
250
-
251
- ## Error Handling
252
-
253
- ```typescript
254
- import { RelayError } from '@signalwire/sdk';
255
-
256
- try {
257
- await call.answer();
258
- } catch (err) {
259
- if (err instanceof RelayError) {
260
- console.error(`RELAY error ${err.code}: ${err.message}`);
261
- }
262
- }
263
- ```
264
-
265
- ### Call-Gone Handling
266
-
267
- When a call ends (404/410 from server), methods return `{}` instead of throwing. Actions are resolved immediately so `await action.wait()` doesn't hang:
268
-
269
- ```typescript
270
- const action = await call.play([{ type: 'tts', text: 'hello' }]);
271
- // If call ended between play request and response, action.isDone === true
272
- ```
273
-
274
- ## Typed Events
275
-
276
- All events are parsed into typed classes:
277
-
278
- ```typescript
279
- import { CallStateEvent, PlayEvent, parseEvent } from '@signalwire/sdk';
280
-
281
- call.on('calling.call.state', (event) => {
282
- const stateEvent = event as CallStateEvent;
283
- console.log(stateEvent.callState); // 'answered', 'ended', etc.
284
- console.log(stateEvent.endReason); // 'hangup', 'busy', etc.
285
- });
286
- ```
287
-
288
- 22 typed event classes are available for all RELAY event types.
289
-
290
- ## Environment Variables
291
-
292
- | Variable | Purpose |
293
- |----------|---------|
294
- | `SIGNALWIRE_PROJECT_ID` | Project ID for authentication |
295
- | `SIGNALWIRE_TOKEN` | API token for authentication |
296
- | `SIGNALWIRE_JWT_TOKEN` | JWT token (alternative to project/token) |
297
- | `SIGNALWIRE_SPACE` | Space hostname (default: relay.signalwire.com) |
298
- | `SIGNALWIRE_LOG_LEVEL` | Log level: debug, info, warn, error |
299
- | `SIGNALWIRE_LOG_MODE` | Set to "off" to suppress logging |
300
-
301
- ## Examples
302
-
303
- See the `examples/` directory:
304
- - `relay-inbound.ts` - Answer calls, play TTS, collect digits
305
- - `relay-outbound.ts` - Dial outbound, detect machine, play message
306
- - `relay-messaging.ts` - Send/receive SMS