@signalwire/sdk 2.0.4 → 3.5.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 (656) hide show
  1. package/CHANGELOG.md +785 -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 +550 -163
  6. package/dist/AgentBase.js +1640 -514
  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 +158 -45
  21. package/dist/DataMap.js +167 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +277 -83
  24. package/dist/FunctionResult.js +444 -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 +163 -0
  30. package/dist/POM/PromptObjectModel.js +481 -0
  31. package/dist/POM/PromptObjectModel.js.map +1 -0
  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 +28 -0
  42. package/dist/PomBuilder.js +81 -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 +29 -1
  48. package/dist/PromptManager.js +37 -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 +265 -66
  58. package/dist/SWMLService.js +652 -112
  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 +55 -8
  64. package/dist/SecurityUtils.js +162 -49
  65. package/dist/SecurityUtils.js.map +1 -1
  66. package/dist/ServerlessAdapter.d.ts +156 -7
  67. package/dist/ServerlessAdapter.js +399 -42
  68. package/dist/ServerlessAdapter.js.map +1 -1
  69. package/dist/SessionManager.d.ts +11 -2
  70. package/dist/SessionManager.js +50 -18
  71. package/dist/SessionManager.js.map +1 -1
  72. package/dist/SslConfig.d.ts +2 -1
  73. package/dist/SslConfig.js +4 -1
  74. package/dist/SslConfig.js.map +1 -1
  75. package/dist/SwaigActions.generated.d.ts +23 -0
  76. package/dist/SwaigActions.generated.js +8 -0
  77. package/dist/SwaigActions.generated.js.map +1 -0
  78. package/dist/SwaigContracts.d.ts +15 -0
  79. package/dist/SwaigContracts.generated.d.ts +264 -0
  80. package/dist/SwaigContracts.generated.js +12 -0
  81. package/dist/SwaigContracts.generated.js.map +1 -0
  82. package/dist/SwaigContracts.js +2 -0
  83. package/dist/SwaigContracts.js.map +1 -0
  84. package/dist/SwaigFunction.d.ts +110 -4
  85. package/dist/SwaigFunction.js +151 -19
  86. package/dist/SwaigFunction.js.map +1 -1
  87. package/dist/SwmlBuilder.d.ts +68 -19
  88. package/dist/SwmlBuilder.js +74 -38
  89. package/dist/SwmlBuilder.js.map +1 -1
  90. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  91. package/dist/SwmlVerbMethods.generated.js +1 -1
  92. package/dist/TypeInference.d.ts +39 -3
  93. package/dist/TypeInference.js +256 -16
  94. package/dist/TypeInference.js.map +1 -1
  95. package/dist/WebService.d.ts +79 -11
  96. package/dist/WebService.js +320 -109
  97. package/dist/WebService.js.map +1 -1
  98. package/dist/WebhookMiddleware.d.ts +119 -0
  99. package/dist/WebhookMiddleware.js +271 -0
  100. package/dist/WebhookMiddleware.js.map +1 -0
  101. package/dist/WebhookValidator.d.ts +92 -0
  102. package/dist/WebhookValidator.js +409 -0
  103. package/dist/WebhookValidator.js.map +1 -0
  104. package/dist/agents/BedrockAgent.d.ts +162 -0
  105. package/dist/agents/BedrockAgent.js +323 -0
  106. package/dist/agents/BedrockAgent.js.map +1 -0
  107. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  108. package/dist/ai-chat/AIChatClient.js +535 -0
  109. package/dist/ai-chat/AIChatClient.js.map +1 -0
  110. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  111. package/dist/ai-chat/ChatGateway.js +747 -0
  112. package/dist/ai-chat/ChatGateway.js.map +1 -0
  113. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  114. package/dist/ai-chat/HandoffRouter.js +518 -0
  115. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  116. package/dist/ai-chat/index.d.ts +12 -0
  117. package/dist/ai-chat/index.js +10 -0
  118. package/dist/ai-chat/index.js.map +1 -0
  119. package/dist/capabilities.d.ts +64 -0
  120. package/dist/capabilities.js +95 -0
  121. package/dist/capabilities.js.map +1 -0
  122. package/dist/cli/agent-loader.d.ts +32 -6
  123. package/dist/cli/agent-loader.js +95 -34
  124. package/dist/cli/agent-loader.js.map +1 -1
  125. package/dist/cli/datamap-exec.d.ts +175 -0
  126. package/dist/cli/datamap-exec.js +1284 -0
  127. package/dist/cli/datamap-exec.js.map +1 -0
  128. package/dist/cli/function-args.d.ts +40 -0
  129. package/dist/cli/function-args.js +146 -0
  130. package/dist/cli/function-args.js.map +1 -0
  131. package/dist/cli/simulation.d.ts +99 -0
  132. package/dist/cli/simulation.js +490 -0
  133. package/dist/cli/simulation.js.map +1 -0
  134. package/dist/cli/swaig-test.d.ts +12 -25
  135. package/dist/cli/swaig-test.js +935 -367
  136. package/dist/cli/swaig-test.js.map +1 -1
  137. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  138. package/dist/cli/tsdocs/agentsNote.js +92 -0
  139. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  140. package/dist/cli/tsdocs/api-index.json +1 -0
  141. package/dist/cli/tsdocs/api.d.ts +91 -0
  142. package/dist/cli/tsdocs/api.js +372 -0
  143. package/dist/cli/tsdocs/api.js.map +1 -0
  144. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  145. package/dist/cli/tsdocs/apiTypes.js +7 -0
  146. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  147. package/dist/cli/tsdocs/bin.d.ts +6 -0
  148. package/dist/cli/tsdocs/bin.js +23 -0
  149. package/dist/cli/tsdocs/bin.js.map +1 -0
  150. package/dist/cli/tsdocs/files.d.ts +108 -0
  151. package/dist/cli/tsdocs/files.js +287 -0
  152. package/dist/cli/tsdocs/files.js.map +1 -0
  153. package/dist/cli/tsdocs/index.d.ts +28 -0
  154. package/dist/cli/tsdocs/index.js +307 -0
  155. package/dist/cli/tsdocs/index.js.map +1 -0
  156. package/dist/cli/tsdocs/live.d.ts +41 -0
  157. package/dist/cli/tsdocs/live.js +202 -0
  158. package/dist/cli/tsdocs/live.js.map +1 -0
  159. package/dist/cli/tsdocs/locate.d.ts +51 -0
  160. package/dist/cli/tsdocs/locate.js +75 -0
  161. package/dist/cli/tsdocs/locate.js.map +1 -0
  162. package/dist/cli/tsdocs/render.d.ts +75 -0
  163. package/dist/cli/tsdocs/render.js +323 -0
  164. package/dist/cli/tsdocs/render.js.map +1 -0
  165. package/dist/cli/tsdocs/topics.d.ts +43 -0
  166. package/dist/cli/tsdocs/topics.js +916 -0
  167. package/dist/cli/tsdocs/topics.js.map +1 -0
  168. package/dist/index.d.ts +102 -39
  169. package/dist/index.js +107 -30
  170. package/dist/index.js.map +1 -1
  171. package/dist/livewire/index.d.ts +229 -155
  172. package/dist/livewire/index.js +298 -195
  173. package/dist/livewire/index.js.map +1 -1
  174. package/dist/llms.txt +65 -0
  175. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  176. package/dist/prefabs/CallSessionStore.js +72 -0
  177. package/dist/prefabs/CallSessionStore.js.map +1 -0
  178. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  179. package/dist/prefabs/ConciergeAgent.js +36 -31
  180. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  181. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  182. package/dist/prefabs/FAQBotAgent.js +113 -47
  183. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  184. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  185. package/dist/prefabs/InfoGathererAgent.js +67 -58
  186. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  187. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  188. package/dist/prefabs/ReceptionistAgent.js +39 -31
  189. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  190. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  191. package/dist/prefabs/SurveyAgent.js +84 -68
  192. package/dist/prefabs/SurveyAgent.js.map +1 -1
  193. package/dist/relay/Action.d.ts +44 -21
  194. package/dist/relay/Action.js +75 -17
  195. package/dist/relay/Action.js.map +1 -1
  196. package/dist/relay/Call.d.ts +312 -47
  197. package/dist/relay/Call.js +369 -18
  198. package/dist/relay/Call.js.map +1 -1
  199. package/dist/relay/Deferred.js.map +1 -1
  200. package/dist/relay/Message.d.ts +26 -5
  201. package/dist/relay/Message.js +36 -6
  202. package/dist/relay/Message.js.map +1 -1
  203. package/dist/relay/RelayClient.d.ts +79 -14
  204. package/dist/relay/RelayClient.js +268 -61
  205. package/dist/relay/RelayClient.js.map +1 -1
  206. package/dist/relay/RelayError.d.ts +14 -0
  207. package/dist/relay/RelayError.js +15 -0
  208. package/dist/relay/RelayError.js.map +1 -1
  209. package/dist/relay/RelayEvent.d.ts +96 -65
  210. package/dist/relay/RelayEvent.js +85 -56
  211. package/dist/relay/RelayEvent.js.map +1 -1
  212. package/dist/relay/closedSets.d.ts +111 -0
  213. package/dist/relay/closedSets.js +83 -0
  214. package/dist/relay/closedSets.js.map +1 -0
  215. package/dist/relay/index.d.ts +3 -1
  216. package/dist/relay/index.js +1 -0
  217. package/dist/relay/index.js.map +1 -1
  218. package/dist/relay/normalize.js.map +1 -1
  219. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  220. package/dist/relay/protocol.types.generated.js +8 -0
  221. package/dist/relay/protocol.types.generated.js.map +1 -0
  222. package/dist/relay/types.d.ts +81 -39
  223. package/dist/rest/HttpClient.d.ts +36 -8
  224. package/dist/rest/HttpClient.js +233 -40
  225. package/dist/rest/HttpClient.js.map +1 -1
  226. package/dist/rest/RequestOptions.d.ts +110 -0
  227. package/dist/rest/RequestOptions.js +113 -0
  228. package/dist/rest/RequestOptions.js.map +1 -0
  229. package/dist/rest/RestError.d.ts +52 -6
  230. package/dist/rest/RestError.js +89 -5
  231. package/dist/rest/RestError.js.map +1 -1
  232. package/dist/rest/base/CrudResource.d.ts +16 -26
  233. package/dist/rest/base/CrudResource.js +19 -33
  234. package/dist/rest/base/CrudResource.js.map +1 -1
  235. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  236. package/dist/rest/base/CrudWithAddresses.js +2 -2
  237. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  238. package/dist/rest/base/FabricResource.d.ts +15 -0
  239. package/dist/rest/base/FabricResource.js +16 -0
  240. package/dist/rest/base/FabricResource.js.map +1 -0
  241. package/dist/rest/base/ReadResource.d.ts +62 -0
  242. package/dist/rest/base/ReadResource.js +69 -0
  243. package/dist/rest/base/ReadResource.js.map +1 -0
  244. package/dist/rest/callHandler.d.ts +63 -0
  245. package/dist/rest/callHandler.js +62 -0
  246. package/dist/rest/callHandler.js.map +1 -0
  247. package/dist/rest/index.d.ts +19 -76
  248. package/dist/rest/index.js +49 -120
  249. package/dist/rest/index.js.map +1 -1
  250. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  251. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  252. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  253. package/dist/rest/namespaces/addresses.d.ts +3 -42
  254. package/dist/rest/namespaces/addresses.js +3 -50
  255. package/dist/rest/namespaces/addresses.js.map +1 -1
  256. package/dist/rest/namespaces/calling.d.ts +6 -378
  257. package/dist/rest/namespaces/calling.js +6 -473
  258. package/dist/rest/namespaces/calling.js.map +1 -1
  259. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  260. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  261. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  262. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  263. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  264. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  265. package/dist/rest/namespaces/chat.d.ts +4 -18
  266. package/dist/rest/namespaces/chat.js +4 -21
  267. package/dist/rest/namespaces/chat.js.map +1 -1
  268. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  269. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  270. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  271. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  272. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  273. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  274. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  275. package/dist/rest/namespaces/datasphere.js +6 -72
  276. package/dist/rest/namespaces/datasphere.js.map +1 -1
  277. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  278. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  279. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  280. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  281. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  282. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  283. package/dist/rest/namespaces/fabric.d.ts +11 -273
  284. package/dist/rest/namespaces/fabric.js +14 -363
  285. package/dist/rest/namespaces/fabric.js.map +1 -1
  286. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  287. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  288. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  289. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  290. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  291. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  293. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  294. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  296. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  297. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  298. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  299. package/dist/rest/namespaces/imported-numbers.js +3 -21
  300. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  301. package/dist/rest/namespaces/logs.d.ts +10 -101
  302. package/dist/rest/namespaces/logs.js +10 -128
  303. package/dist/rest/namespaces/logs.js.map +1 -1
  304. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  305. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  306. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  307. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  308. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  309. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  310. package/dist/rest/namespaces/lookup.d.ts +3 -25
  311. package/dist/rest/namespaces/lookup.js +3 -27
  312. package/dist/rest/namespaces/lookup.js.map +1 -1
  313. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  314. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  315. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  316. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  317. package/dist/rest/namespaces/message.types.generated.js +8 -0
  318. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  319. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  320. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  321. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  323. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  324. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  325. package/dist/rest/namespaces/mfa.d.ts +3 -42
  326. package/dist/rest/namespaces/mfa.js +3 -49
  327. package/dist/rest/namespaces/mfa.js.map +1 -1
  328. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  329. package/dist/rest/namespaces/number-groups.js +3 -53
  330. package/dist/rest/namespaces/number-groups.js.map +1 -1
  331. package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
  332. package/dist/rest/namespaces/phone-numbers.js +9 -63
  333. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  334. package/dist/rest/namespaces/project.d.ts +6 -42
  335. package/dist/rest/namespaces/project.js +6 -51
  336. package/dist/rest/namespaces/project.js.map +1 -1
  337. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  338. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  339. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  340. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  341. package/dist/rest/namespaces/project.types.generated.js +8 -0
  342. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  343. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  344. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  345. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  347. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  348. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  349. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  350. package/dist/rest/namespaces/pubsub.js +4 -21
  351. package/dist/rest/namespaces/pubsub.js.map +1 -1
  352. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  353. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  354. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  355. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  356. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  357. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  358. package/dist/rest/namespaces/queues.d.ts +3 -38
  359. package/dist/rest/namespaces/queues.js +3 -44
  360. package/dist/rest/namespaces/queues.js.map +1 -1
  361. package/dist/rest/namespaces/recordings.d.ts +3 -34
  362. package/dist/rest/namespaces/recordings.js +3 -40
  363. package/dist/rest/namespaces/recordings.js.map +1 -1
  364. package/dist/rest/namespaces/registry.d.ts +6 -137
  365. package/dist/rest/namespaces/registry.js +6 -173
  366. package/dist/rest/namespaces/registry.js.map +1 -1
  367. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  368. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  369. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  370. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  371. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  372. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  373. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  374. package/dist/rest/namespaces/short-codes.js +3 -41
  375. package/dist/rest/namespaces/short-codes.js.map +1 -1
  376. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  377. package/dist/rest/namespaces/sip-profile.js +3 -29
  378. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  379. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  380. package/dist/rest/namespaces/verified-callers.js +3 -34
  381. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  382. package/dist/rest/namespaces/video.d.ts +10 -227
  383. package/dist/rest/namespaces/video.js +10 -288
  384. package/dist/rest/namespaces/video.js.map +1 -1
  385. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  386. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  387. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  388. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  389. package/dist/rest/namespaces/video.types.generated.js +8 -0
  390. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  391. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  392. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  393. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  395. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  396. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  397. package/dist/rest/pagination.d.ts +5 -1
  398. package/dist/rest/pagination.js +40 -20
  399. package/dist/rest/pagination.js.map +1 -1
  400. package/dist/rest/types.d.ts +21 -3
  401. package/dist/schema.json +299 -98
  402. package/dist/skills/SkillBase.d.ts +97 -20
  403. package/dist/skills/SkillBase.js +100 -17
  404. package/dist/skills/SkillBase.js.map +1 -1
  405. package/dist/skills/SkillManager.d.ts +66 -13
  406. package/dist/skills/SkillManager.js +101 -20
  407. package/dist/skills/SkillManager.js.map +1 -1
  408. package/dist/skills/SkillName.d.ts +44 -0
  409. package/dist/skills/SkillName.js +2 -0
  410. package/dist/skills/SkillName.js.map +1 -0
  411. package/dist/skills/SkillRegistry.d.ts +47 -7
  412. package/dist/skills/SkillRegistry.js +85 -13
  413. package/dist/skills/SkillRegistry.js.map +1 -1
  414. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  415. package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
  416. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  417. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  418. package/dist/skills/builtin/ask_claude.js +36 -14
  419. package/dist/skills/builtin/ask_claude.js.map +1 -1
  420. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  421. package/dist/skills/builtin/claude_skills.js +19 -15
  422. package/dist/skills/builtin/claude_skills.js.map +1 -1
  423. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  424. package/dist/skills/builtin/custom_skills.js +26 -9
  425. package/dist/skills/builtin/custom_skills.js.map +1 -1
  426. package/dist/skills/builtin/datasphere.d.ts +5 -3
  427. package/dist/skills/builtin/datasphere.js +34 -25
  428. package/dist/skills/builtin/datasphere.js.map +1 -1
  429. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  430. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  431. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  432. package/dist/skills/builtin/datetime.d.ts +3 -1
  433. package/dist/skills/builtin/datetime.js +11 -7
  434. package/dist/skills/builtin/datetime.js.map +1 -1
  435. package/dist/skills/builtin/google_maps.d.ts +29 -14
  436. package/dist/skills/builtin/google_maps.js +89 -269
  437. package/dist/skills/builtin/google_maps.js.map +1 -1
  438. package/dist/skills/builtin/index.d.ts +8 -6
  439. package/dist/skills/builtin/index.js +8 -6
  440. package/dist/skills/builtin/index.js.map +1 -1
  441. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  442. package/dist/skills/builtin/info_gatherer.js +20 -12
  443. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  444. package/dist/skills/builtin/joke.d.ts +16 -6
  445. package/dist/skills/builtin/joke.js +54 -37
  446. package/dist/skills/builtin/joke.js.map +1 -1
  447. package/dist/skills/builtin/math.d.ts +3 -1
  448. package/dist/skills/builtin/math.js +14 -9
  449. package/dist/skills/builtin/math.js.map +1 -1
  450. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  451. package/dist/skills/builtin/mcp_gateway.js +77 -46
  452. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  453. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  454. package/dist/skills/builtin/native_vector_search.js +179 -61
  455. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  456. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  457. package/dist/skills/builtin/play_background_file.js +43 -122
  458. package/dist/skills/builtin/play_background_file.js.map +1 -1
  459. package/dist/skills/builtin/spider.d.ts +46 -1
  460. package/dist/skills/builtin/spider.js +317 -101
  461. package/dist/skills/builtin/spider.js.map +1 -1
  462. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  463. package/dist/skills/builtin/swml_transfer.js +45 -24
  464. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  465. package/dist/skills/builtin/weather_api.d.ts +24 -13
  466. package/dist/skills/builtin/weather_api.js +57 -31
  467. package/dist/skills/builtin/weather_api.js.map +1 -1
  468. package/dist/skills/builtin/web_search.d.ts +48 -10
  469. package/dist/skills/builtin/web_search.js +301 -84
  470. package/dist/skills/builtin/web_search.js.map +1 -1
  471. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  472. package/dist/skills/builtin/wikipedia_search.js +32 -14
  473. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  474. package/dist/skills/index.d.ts +3 -2
  475. package/dist/skills/index.js +1 -1
  476. package/dist/skills/index.js.map +1 -1
  477. package/dist/swml_verbs_generated.d.ts +2824 -0
  478. package/dist/swml_verbs_generated.js +12 -0
  479. package/dist/swml_verbs_generated.js.map +1 -0
  480. package/dist/types.d.ts +65 -6
  481. package/dist/web.d.ts +27 -0
  482. package/dist/web.js +20 -0
  483. package/dist/web.js.map +1 -0
  484. package/docs/agent-guide.md +1034 -0
  485. package/docs/ai_chat.md +560 -0
  486. package/docs/api-reference.md +3534 -0
  487. package/docs/architecture.md +846 -0
  488. package/docs/bedrock_agent.md +411 -0
  489. package/docs/cli-guide.md +403 -0
  490. package/docs/cloud_functions_guide.md +399 -0
  491. package/docs/configuration.md +548 -0
  492. package/docs/contexts-guide.md +884 -0
  493. package/docs/datamap-guide.md +1160 -0
  494. package/docs/developer_pain_points.md +548 -0
  495. package/docs/llm_parameters.md +298 -0
  496. package/docs/mcp_gateway_reference.md +354 -0
  497. package/docs/mcp_integration.md +162 -0
  498. package/docs/pgi_agent_guide.md +1820 -0
  499. package/docs/prefabs-guide.md +815 -0
  500. package/docs/programmatically_governed_inference.md +301 -0
  501. package/docs/sdk_features.md +501 -0
  502. package/docs/security.md +559 -0
  503. package/docs/serverless-guide.md +520 -0
  504. package/docs/skills-guide.md +1223 -0
  505. package/docs/skills-system.md +405 -0
  506. package/docs/skills_parameter_schema.md +417 -0
  507. package/docs/swaig-reference.md +1938 -0
  508. package/docs/swml_service_guide.md +573 -0
  509. package/docs/third_party_skills.md +410 -0
  510. package/docs/web_service.md +666 -0
  511. package/examples/README.md +202 -0
  512. package/examples/advanced-datamap.ts +108 -0
  513. package/examples/advanced-dynamic-config.ts +70 -0
  514. package/examples/auto-vivified.ts +95 -0
  515. package/examples/call-flow.ts +65 -0
  516. package/examples/comprehensive-dynamic.ts +125 -0
  517. package/examples/contexts-steps.ts +65 -0
  518. package/examples/custom-path.ts +45 -0
  519. package/examples/datamap-tools.ts +51 -0
  520. package/examples/datasphere-multi-instance.ts +66 -0
  521. package/examples/datasphere-serverless-env.ts +87 -0
  522. package/examples/datasphere-webhook-env.ts +65 -0
  523. package/examples/datasphere.ts +56 -0
  524. package/examples/declarative.ts +100 -0
  525. package/examples/dynamic-config.ts +54 -0
  526. package/examples/dynamic-info-gatherer.ts +69 -0
  527. package/examples/dynamic-swml-service.ts +67 -0
  528. package/examples/gather-info.ts +95 -0
  529. package/examples/gather-per-question-functions-demo.ts +139 -0
  530. package/examples/joke-agent.ts +34 -0
  531. package/examples/kubernetes-agent.ts +45 -0
  532. package/examples/llm-params.ts +75 -0
  533. package/examples/mcp-agent.ts +89 -0
  534. package/examples/mcp-gateway.ts +81 -0
  535. package/examples/multi-agent.ts +80 -0
  536. package/examples/multi-endpoint.ts +79 -0
  537. package/examples/pgi/case-domain.ts +114 -0
  538. package/examples/pgi/serve.ts +16 -0
  539. package/examples/pgi/support-agent.ts +265 -0
  540. package/examples/pom-prompt.ts +70 -0
  541. package/examples/prefab-concierge.ts +42 -0
  542. package/examples/prefab-faq.ts +58 -0
  543. package/examples/prefab-info-gatherer.ts +33 -0
  544. package/examples/prefab-receptionist.ts +36 -0
  545. package/examples/prefab-survey.ts +69 -0
  546. package/examples/quickstart-agent.ts +29 -0
  547. package/examples/quickstart-relay.ts +25 -0
  548. package/examples/quickstart-rest.ts +25 -0
  549. package/examples/record-call.ts +65 -0
  550. package/examples/relay-demo.ts +33 -0
  551. package/examples/room-and-sip.ts +93 -0
  552. package/examples/serverless-lambda.ts +43 -0
  553. package/examples/session-state.ts +83 -0
  554. package/examples/simple-agent.ts +36 -0
  555. package/examples/simple-static.ts +29 -0
  556. package/examples/skills-demo.ts +41 -0
  557. package/examples/step-function-inheritance-demo.ts +124 -0
  558. package/examples/swaig-features.ts +193 -0
  559. package/examples/swml-service-routing.ts +66 -0
  560. package/examples/swml-service.ts +38 -0
  561. package/examples/swmlservice_ai_sidecar.ts +104 -0
  562. package/examples/swmlservice_swaig_standalone.ts +79 -0
  563. package/examples/tap.ts +67 -0
  564. package/examples/typed-tools.ts +68 -0
  565. package/examples/verb-methods.ts +45 -0
  566. package/examples/web-search-multi-instance.ts +75 -0
  567. package/examples/web-search.ts +38 -0
  568. package/examples/wikipedia.ts +36 -0
  569. package/livewire/README.md +164 -0
  570. package/livewire/docs/migration-guide.md +251 -0
  571. package/livewire/examples/livewire-basic-agent.ts +74 -0
  572. package/livewire/examples/livewire-handoff.ts +196 -0
  573. package/livewire/examples/livewire-multi-tool.ts +121 -0
  574. package/package.json +88 -13
  575. package/relay/README.md +101 -0
  576. package/relay/docs/call-methods.md +622 -0
  577. package/relay/docs/client-reference.md +281 -0
  578. package/relay/docs/events.md +193 -0
  579. package/relay/docs/getting-started.md +221 -0
  580. package/relay/docs/guide.md +386 -0
  581. package/relay/docs/messaging.md +246 -0
  582. package/relay/examples/relay-inbound.ts +66 -0
  583. package/relay/examples/relay-messaging.ts +74 -0
  584. package/relay/examples/relay-outbound.ts +76 -0
  585. package/rest/README.md +141 -0
  586. package/rest/docs/calling.md +313 -0
  587. package/rest/docs/client-reference.md +149 -0
  588. package/rest/docs/fabric.md +192 -0
  589. package/rest/docs/getting-started.md +138 -0
  590. package/rest/docs/guide.md +421 -0
  591. package/rest/docs/namespaces.md +367 -0
  592. package/rest/docs/phone-binding.md +116 -0
  593. package/rest/examples/rest-10dlc-registration.ts +177 -0
  594. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  595. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  596. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  597. package/rest/examples/rest-client.ts +59 -0
  598. package/rest/examples/rest-datasphere-search.ts +81 -0
  599. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  600. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  601. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  602. package/rest/examples/rest-manage-resources.ts +64 -0
  603. package/rest/examples/rest-phone-number-management.ts +200 -0
  604. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  605. package/rest/examples/rest-video-rooms.ts +186 -0
  606. package/tutorial/fred/fred.ts +218 -0
  607. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  608. package/tutorial/fred/tutorial/02-setup.md +304 -0
  609. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  610. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  611. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  612. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  613. package/tutorial/fred/tutorial/README.md +56 -0
  614. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  615. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  616. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  617. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  618. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  619. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  620. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  621. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  622. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  623. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  624. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  625. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  626. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  627. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  628. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  629. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  630. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  631. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  632. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  633. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  634. package/tutorial/multi_agents/README.md +175 -0
  635. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  636. package/tutorial/multi_agents/extending_agents.ts +641 -0
  637. package/tutorial/multi_agents/knowledge.ts +59 -0
  638. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  639. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  640. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  641. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  642. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  643. package/tutorial/multi_agents/pc_builder.ts +529 -0
  644. package/tutorial/multi_agents/sales_agent.ts +88 -0
  645. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  646. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  647. package/tutorial/multi_agents/support_knowledge.md +256 -0
  648. package/dist/cli/mock-data.d.ts +0 -37
  649. package/dist/cli/mock-data.js +0 -80
  650. package/dist/cli/mock-data.js.map +0 -1
  651. package/dist/generateVerbTypes.d.ts +0 -11
  652. package/dist/generateVerbTypes.js +0 -265
  653. package/dist/generateVerbTypes.js.map +0 -1
  654. package/dist/rest/namespaces/compat.d.ts +0 -585
  655. package/dist/rest/namespaces/compat.js +0 -735
  656. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -0,0 +1,313 @@
1
+ # Calling Commands
2
+
3
+ The Calling API controls calls over REST. Every command is a `POST` to `/api/calling/calls` with a `command` field, and needs no WebSocket connection. This page lists each method on `client.calling` with an example.
4
+
5
+ <!-- snippet-setup -->
6
+ ```ts
7
+ export {}; // treat each example as a module so top-level `await` is allowed
8
+ // Shared context the fragments on this page assume (constructed on the Getting Started page).
9
+ declare const client: import('@signalwire/sdk').RestClient;
10
+ declare const callId: string; // the UUID of an active call
11
+ ```
12
+
13
+ ## How It Works
14
+
15
+ Each method on `client.calling` sends one POST request. This is the body that `client.calling.play(callId, [...])` sends:
16
+
17
+ ```json
18
+ {
19
+ "command": "calling.play",
20
+ "params": {
21
+ "play": [{ "type": "audio", "params": { "url": "https://example.com/a.mp3" } }]
22
+ },
23
+ "id": "<call-uuid>"
24
+ }
25
+ ```
26
+
27
+ For `dial` and `update`, the call details go inside `params`, with no top-level `id`. Every other method takes the UUID of the call to control as its first argument. Each method is async and returns the parsed JSON response.
28
+
29
+ Every method also accepts an `extras` object in its options, merged into `params` for fields the SDK doesn't type, and a final `requestOptions` argument. [Request Options](guide.md#request-options-timeout-retries-abort) describes the second.
30
+
31
+ ## Call Lifecycle
32
+
33
+ These methods start, change and end calls.
34
+
35
+ ### `dial(from, to, options?)`
36
+
37
+ `dial` starts an outbound call. `from` and `to` are positional, and the other fields are options:
38
+
39
+ ```typescript
40
+ const result = await client.calling.dial('+15559876543', '+15551234567', {
41
+ url: 'https://example.com/call-handler',
42
+ });
43
+ const newCallId = result.id;
44
+ ```
45
+
46
+ ### `update(id, options?)`
47
+
48
+ `update` gives an active call a new dialplan, from a `url` or inline `swml`. The call `id` is positional:
49
+
50
+ ```typescript
51
+ await client.calling.update(callId, { url: 'https://example.com/new-handler' });
52
+ ```
53
+
54
+ ### `end(callId, options?)`
55
+
56
+ `end` hangs up a call. The optional `reason` is one of `hangup`, `cancel`, `busy`, `noAnswer`, `decline` or `error`:
57
+
58
+ ```typescript
59
+ await client.calling.end(callId, { reason: 'hangup' });
60
+ ```
61
+
62
+ ### `transfer(callId, dest, options?)`
63
+
64
+ `transfer` moves a call to a new destination: a SIP URI, a phone number or an inline SWML object. `dest` is positional:
65
+
66
+ ```typescript
67
+ await client.calling.transfer(callId, 'sip:agent@example.com');
68
+ ```
69
+
70
+ ### `disconnect(callId, options?)`
71
+
72
+ `disconnect` separates bridged calls without hanging up either leg:
73
+
74
+ ```typescript
75
+ await client.calling.disconnect(callId);
76
+ ```
77
+
78
+ ## Audio Playback
79
+
80
+ These methods play media into a call and control the playback.
81
+
82
+ ### `play(callId, play, options?)`
83
+
84
+ `play` plays audio, TTS, silence or a ringtone. The `play` array is positional. Each item has a `type` (`audio`, `tts`, `silence` or `ring`) and its `params`:
85
+
86
+ ```typescript
87
+ await client.calling.play(callId, [{ type: 'tts', params: { text: 'Hello!' } }], {
88
+ control_id: 'ctrl-1',
89
+ volume: 5.0,
90
+ });
91
+ ```
92
+
93
+ The `volume` option adjusts the level in dB.
94
+
95
+ ### `playPause(callId, control_id, options?)` / `playResume(callId, control_id, options?)`
96
+
97
+ These pause and resume active playback. `control_id` is positional:
98
+
99
+ ```typescript
100
+ await client.calling.playPause(callId, 'ctrl-1');
101
+ await client.calling.playResume(callId, 'ctrl-1');
102
+ ```
103
+
104
+ ### `playStop(callId, control_id, options?)`
105
+
106
+ `playStop` stops active playback:
107
+
108
+ ```typescript
109
+ await client.calling.playStop(callId, 'ctrl-1');
110
+ ```
111
+
112
+ ### `playVolume(callId, control_id, volume, options?)`
113
+
114
+ `playVolume` adjusts the playback volume. `control_id` and `volume` are positional:
115
+
116
+ ```typescript
117
+ await client.calling.playVolume(callId, 'ctrl-1', -3.0);
118
+ ```
119
+
120
+ ## Recording
121
+
122
+ `record` takes an options object. The pause, resume and stop methods take `control_id` positionally:
123
+
124
+ ```typescript
125
+ await client.calling.record(callId, {
126
+ control_id: 'rec-1',
127
+ audio: { beep: true, format: 'wav', stereo: true },
128
+ });
129
+ await client.calling.recordPause(callId, 'rec-1');
130
+ await client.calling.recordResume(callId, 'rec-1');
131
+ await client.calling.recordStop(callId, 'rec-1');
132
+ ```
133
+
134
+ ## Input Collection
135
+
136
+ `collect` gathers DTMF or speech input and takes an options object. `collectStop` and `collectStartInputTimers` take `control_id` positionally:
137
+
138
+ ```typescript
139
+ await client.calling.collect(callId, {
140
+ control_id: 'coll-1',
141
+ digits: { max: 4, terminators: '#' },
142
+ speech: { end_silence_timeout: 2.0 },
143
+ });
144
+ await client.calling.collectStop(callId, 'coll-1');
145
+ await client.calling.collectStartInputTimers(callId, 'coll-1');
146
+ ```
147
+
148
+ ## Detection
149
+
150
+ `detect` starts an answering-machine, fax or digit detector. The `detect` config object is positional, and `detectStop` takes `control_id` positionally:
151
+
152
+ ```typescript
153
+ await client.calling.detect(callId, { type: 'machine', params: { initial_timeout: 4.5 } }, {
154
+ control_id: 'det-1',
155
+ });
156
+ await client.calling.detectStop(callId, 'det-1');
157
+ ```
158
+
159
+ ## Tap and Stream
160
+
161
+ `tap` sends call audio to an RTP or WebSocket endpoint, and `stream` sends it to a WebSocket URL.
162
+
163
+ ### `tap(callId, tap, device, options?)` / `tapStop(callId, control_id, options?)`
164
+
165
+ The `tap` and `device` config objects are positional, and `tapStop` takes `control_id` positionally:
166
+
167
+ ```typescript
168
+ await client.calling.tap(
169
+ callId,
170
+ { type: 'audio', params: { direction: 'both' } },
171
+ { type: 'rtp', params: { addr: '192.168.1.1', port: 1234 } },
172
+ { control_id: 'tap-1' },
173
+ );
174
+ await client.calling.tapStop(callId, 'tap-1');
175
+ ```
176
+
177
+ ### `stream(callId, url, options?)` / `streamStop(callId, control_id, options?)`
178
+
179
+ The stream `url` is positional, and `streamStop` takes `control_id` positionally:
180
+
181
+ ```typescript
182
+ await client.calling.stream(callId, 'wss://example.com/audio-stream', {
183
+ control_id: 'str-1',
184
+ codec: 'PCMU',
185
+ });
186
+ await client.calling.streamStop(callId, 'str-1');
187
+ ```
188
+
189
+ ## Denoise
190
+
191
+ `denoise` starts noise reduction on a call and `denoiseStop` stops it. Both take only the call ID and an optional `extras` object:
192
+
193
+ ```typescript
194
+ await client.calling.denoise(callId);
195
+ await client.calling.denoiseStop(callId);
196
+ ```
197
+
198
+ ## Transcription
199
+
200
+ `transcribe` starts transcription of the call, and `transcribeStop` takes `control_id` positionally:
201
+
202
+ ```typescript
203
+ await client.calling.transcribe(callId, { control_id: 'tx-1', status_url: 'https://example.com/hook' });
204
+ await client.calling.transcribeStop(callId, 'tx-1');
205
+ ```
206
+
207
+ ## AI
208
+
209
+ These methods act on an AI session running on a call.
210
+
211
+ ### `aiMessage(callId, options?)`
212
+
213
+ `aiMessage` adds a message to the AI conversation. The `role` is `system`, `user` or `assistant`. The options also accept `reset` and `global_data`:
214
+
215
+ ```typescript
216
+ await client.calling.aiMessage(callId, { role: 'user', message_text: 'Transfer me to billing' });
217
+ ```
218
+
219
+ ### `aiHold(callId, options?)` / `aiUnhold(callId, options?)`
220
+
221
+ `aiHold` puts the caller on hold for up to `timeout` seconds. Its `prompt` is a system message added to the conversation before the hold, not text read to the caller:
222
+
223
+ ```typescript
224
+ await client.calling.aiHold(callId, { timeout: 60, prompt: 'Tell the caller you are checking their account.' });
225
+ await client.calling.aiUnhold(callId, { prompt: 'The account check is done. Continue helping the caller.' });
226
+ ```
227
+
228
+ ### `aiStop(callId, control_id, options?)`
229
+
230
+ `aiStop` stops an active AI session on a call:
231
+
232
+ ```typescript
233
+ await client.calling.aiStop(callId, 'ai-1');
234
+ ```
235
+
236
+ ## Live Transcribe and Translate
237
+
238
+ `liveTranscribe` and `liveTranslate` take a positional `action`. Use `{ start: {...} }` to begin, `{ summarize: {...} }` to request a summary, or the string `'stop'` to end. `liveTranslate` also accepts `{ inject: {...} }`:
239
+
240
+ ```typescript
241
+ await client.calling.liveTranscribe(callId, {
242
+ start: { lang: 'en-US', direction: ['remote-caller'] },
243
+ });
244
+ await client.calling.liveTranslate(callId, {
245
+ start: { from_lang: 'en-US', to_lang: 'es-ES', direction: ['remote-caller'] },
246
+ });
247
+ await client.calling.liveTranscribe(callId, 'stop');
248
+ ```
249
+
250
+ ## Fax
251
+
252
+ These methods stop an active fax send or receive:
253
+
254
+ ```typescript
255
+ await client.calling.sendFaxStop(callId, 'fax-1');
256
+ await client.calling.receiveFaxStop(callId, 'fax-1');
257
+ ```
258
+
259
+ ## SIP and Custom Events
260
+
261
+ `refer` transfers a SIP call with SIP REFER, and `userEvent` fires a custom event on the call:
262
+
263
+ ```typescript
264
+ // SIP REFER transfer; the `device` object is positional
265
+ await client.calling.refer(callId, { type: 'sip', params: { to: 'sip:agent@example.com' } });
266
+
267
+ // Custom event; the `event` object is positional, and each value is an object
268
+ await client.calling.userEvent(callId, { custom: { key: 'value' } });
269
+ ```
270
+
271
+ ## Complete Method List
272
+
273
+ The table lists all 37 methods, with the wire `command` value each one sends:
274
+
275
+ | Method | Command | Requires callId |
276
+ |--------|---------|:-:|
277
+ | `dial(from, to, options?)` | `dial` | No |
278
+ | `update(id, options?)` | `update` | No (`id` goes in `params`) |
279
+ | `end(callId, options?)` | `calling.end` | Yes |
280
+ | `transfer(callId, dest, options?)` | `calling.transfer` | Yes |
281
+ | `disconnect(callId, options?)` | `calling.disconnect` | Yes |
282
+ | `play(callId, play, options?)` | `calling.play` | Yes |
283
+ | `playPause(callId, control_id, options?)` | `calling.play.pause` | Yes |
284
+ | `playResume(callId, control_id, options?)` | `calling.play.resume` | Yes |
285
+ | `playStop(callId, control_id, options?)` | `calling.play.stop` | Yes |
286
+ | `playVolume(callId, control_id, volume, options?)` | `calling.play.volume` | Yes |
287
+ | `record(callId, options?)` | `calling.record` | Yes |
288
+ | `recordPause(callId, control_id, options?)` | `calling.record.pause` | Yes |
289
+ | `recordResume(callId, control_id, options?)` | `calling.record.resume` | Yes |
290
+ | `recordStop(callId, control_id, options?)` | `calling.record.stop` | Yes |
291
+ | `collect(callId, options?)` | `calling.collect` | Yes |
292
+ | `collectStop(callId, control_id, options?)` | `calling.collect.stop` | Yes |
293
+ | `collectStartInputTimers(callId, control_id, options?)` | `calling.collect.start_input_timers` | Yes |
294
+ | `detect(callId, detect, options?)` | `calling.detect` | Yes |
295
+ | `detectStop(callId, control_id, options?)` | `calling.detect.stop` | Yes |
296
+ | `tap(callId, tap, device, options?)` | `calling.tap` | Yes |
297
+ | `tapStop(callId, control_id, options?)` | `calling.tap.stop` | Yes |
298
+ | `stream(callId, url, options?)` | `calling.stream` | Yes |
299
+ | `streamStop(callId, control_id, options?)` | `calling.stream.stop` | Yes |
300
+ | `denoise(callId, options?)` | `calling.denoise` | Yes |
301
+ | `denoiseStop(callId, options?)` | `calling.denoise.stop` | Yes |
302
+ | `transcribe(callId, options?)` | `calling.transcribe` | Yes |
303
+ | `transcribeStop(callId, control_id, options?)` | `calling.transcribe.stop` | Yes |
304
+ | `aiMessage(callId, options?)` | `calling.ai_message` | Yes |
305
+ | `aiHold(callId, options?)` | `calling.ai_hold` | Yes |
306
+ | `aiUnhold(callId, options?)` | `calling.ai_unhold` | Yes |
307
+ | `aiStop(callId, control_id, options?)` | `calling.ai.stop` | Yes |
308
+ | `liveTranscribe(callId, action, options?)` | `calling.live_transcribe` | Yes |
309
+ | `liveTranslate(callId, action, options?)` | `calling.live_translate` | Yes |
310
+ | `sendFaxStop(callId, control_id, options?)` | `calling.send_fax.stop` | Yes |
311
+ | `receiveFaxStop(callId, control_id, options?)` | `calling.receive_fax.stop` | Yes |
312
+ | `refer(callId, device, options?)` | `calling.refer` | Yes |
313
+ | `userEvent(callId, event, options?)` | `calling.user_event` | Yes |
@@ -0,0 +1,149 @@
1
+ # RestClient Reference
2
+
3
+ This page lists the `RestClient` constructor options, the namespace properties on the client and the error classes it throws.
4
+
5
+ ## Constructor
6
+
7
+ This example passes every connection option explicitly. The comment on each line names the environment variable it falls back to:
8
+
9
+ ```typescript
10
+ import { RestClient } from '@signalwire/sdk';
11
+
12
+ const client = new RestClient({
13
+ project: 'your-project-id', // SIGNALWIRE_PROJECT_ID
14
+ token: 'your-api-token', // SIGNALWIRE_API_TOKEN
15
+ host: 'example.signalwire.com', // SIGNALWIRE_REST_BASE_URL, then SIGNALWIRE_SPACE
16
+ });
17
+ ```
18
+
19
+ The constructor accepts these options:
20
+
21
+ | Option | Type | Description |
22
+ |--------|------|-------------|
23
+ | `project` | `string` | Project ID. Falls back to `SIGNALWIRE_PROJECT_ID`. |
24
+ | `token` | `string` | API token. Falls back to `SIGNALWIRE_API_TOKEN`. |
25
+ | `host` | `string` | A bare host (`example.signalwire.com`) or a full `http(s)://` URL. Falls back to `SIGNALWIRE_REST_BASE_URL`, then `SIGNALWIRE_SPACE`. |
26
+ | `requestOptions` | `RequestOptionsInit` | Default timeout, retry and abort settings for every request. See [Request Options](guide.md#request-options-timeout-retries-abort). |
27
+ | `fetchImpl` | `typeof fetch` | A replacement `fetch`, for tests. |
28
+
29
+ If `project`, `token` or `host` is missing from both the options and the environment, the constructor throws an `Error`. Authentication uses HTTP Basic Auth with `project:token`.
30
+
31
+ The `restClient(options?)` function, also exported from `@signalwire/sdk`, constructs the same client.
32
+
33
+ ## Namespaces
34
+
35
+ Each API area is a property on the client. Namespaces are properties, not methods: write `client.fabric`, not `client.fabric()`.
36
+
37
+ ### Fabric API
38
+
39
+ `client.fabric` has these sub-resources:
40
+
41
+ | Property | Description |
42
+ |-----------|-------------|
43
+ | `client.fabric.swmlScripts` | SWML script resources (CRUD + addresses) |
44
+ | `client.fabric.swmlWebhooks` | SWML webhook resources |
45
+ | `client.fabric.aiAgents` | AI agent resources |
46
+ | `client.fabric.relayApplications` | RELAY application resources |
47
+ | `client.fabric.callFlows` | Call flow resources (+ versions) |
48
+ | `client.fabric.conferenceRooms` | Conference room resources |
49
+ | `client.fabric.freeswitchConnectors` | FreeSWITCH connector resources |
50
+ | `client.fabric.subscribers` | Subscriber resources (+ SIP endpoints) |
51
+ | `client.fabric.sipEndpoints` | SIP endpoint resources |
52
+ | `client.fabric.sipGateways` | SIP gateway resources |
53
+ | `client.fabric.cxmlScripts` | cXML script resources |
54
+ | `client.fabric.cxmlWebhooks` | cXML webhook resources |
55
+ | `client.fabric.cxmlApplications` | cXML application resources (no create) |
56
+ | `client.fabric.resources` | Generic resource operations |
57
+ | `client.fabric.addresses` | Fabric addresses (list and get only) |
58
+ | `client.fabric.tokens` | Subscriber, guest, invite and embed tokens |
59
+
60
+ ### Calling API
61
+
62
+ The Calling API has one property:
63
+
64
+ | Property | Description |
65
+ |-----------|-------------|
66
+ | `client.calling` | REST call control; every command is a POST to `/api/calling/calls` |
67
+
68
+ ### Relay REST Resources
69
+
70
+ These properties wrap the `/api/relay/rest` endpoints:
71
+
72
+ | Property | Description |
73
+ |-----------|-------------|
74
+ | `client.phoneNumbers` | Phone number management (+ search and call-handler helpers) |
75
+ | `client.addresses` | Address management |
76
+ | `client.queues` | Queue management (+ members) |
77
+ | `client.recordings` | Recording management |
78
+ | `client.numberGroups` | Number group management (+ memberships) |
79
+ | `client.verifiedCallers` | Verified caller ID management (+ verification flow) |
80
+ | `client.sipProfile` | Project SIP profile (get and update) |
81
+ | `client.lookup` | Phone number lookup |
82
+ | `client.shortCodes` | Short code management |
83
+ | `client.importedNumbers` | Import external phone numbers |
84
+ | `client.mfa` | Multi-factor authentication (SMS, call, verify) |
85
+ | `client.registry` | 10DLC brand and campaign registry |
86
+
87
+ ### Other APIs
88
+
89
+ These properties cover the remaining APIs:
90
+
91
+ | Property | Description |
92
+ |-----------|-------------|
93
+ | `client.messages` | Send an SMS or MMS message, and redact a sent message |
94
+ | `client.datasphere` | Datasphere document management and semantic search |
95
+ | `client.video` | Video rooms, sessions, recordings, conferences, tokens and streams |
96
+ | `client.logs` | Message, voice, fax and conference logs |
97
+ | `client.project` | API token management |
98
+ | `client.projects` | Project and subproject management (+ signing-key rotation) |
99
+ | `client.pubsub` | PubSub token creation |
100
+ | `client.chat` | Chat token creation |
101
+
102
+ ## Error Handling
103
+
104
+ This example catches the error thrown by a failed request and reads its properties:
105
+
106
+ ```typescript
107
+ import { RestClient, SignalWireRestError } from '@signalwire/sdk';
108
+
109
+ const client = new RestClient();
110
+
111
+ try {
112
+ await client.fabric.aiAgents.get('bad-id');
113
+ } catch (err) {
114
+ if (err instanceof SignalWireRestError) {
115
+ console.log(err.statusCode); // for example 404
116
+ console.log(err.body); // parsed JSON, or the raw text
117
+ console.log(err.url); // the full request URL
118
+ console.log(err.method); // "GET"
119
+ console.log(err.requestId); // the platform request ID, or null
120
+ }
121
+ }
122
+ ```
123
+
124
+ `SignalWireRestError` is thrown on any non-2xx HTTP response. It's also exported as `RestError`; the two names refer to the same class. Its message has the form `GET <url> returned 404: <body>`, followed by ` (request-id: <id>)` when the response carries a request ID.
125
+
126
+ A request that gets no response throws `RestTransportError` (also exported as `SignalWireRestTransportError`). Examples are a refused connection, a DNS or TLS failure, a timeout, and cancellation through `abortSignal`. It extends `RestError`, so one `instanceof RestError` check catches both.
127
+
128
+ ### Error Properties
129
+
130
+ The error has these properties:
131
+
132
+ | Property | Type | Description |
133
+ |-----------|------|-------------|
134
+ | `statusCode` | `number \| null` | HTTP status code; `null` for a transport failure |
135
+ | `body` | `object` or `string` | Response body (parsed JSON or raw text); the error message for a transport failure |
136
+ | `url` | `string` | Full request URL |
137
+ | `method` | `string` | HTTP method |
138
+ | `headers` | `Record<string, string> \| null` | Response headers; `null` for a transport failure |
139
+ | `requestId` | `string \| null` | The first of `x-request-id`, `x-signalwire-request-id`, `request-id` or `x-amzn-requestid` in the response headers |
140
+
141
+ ## Client Behavior
142
+
143
+ The client works this way:
144
+
145
+ - One `HttpClient`, using the global `fetch`, is shared by all namespaces.
146
+ - Requests send `Accept: application/json`, and a JSON body with `Content-Type: application/json`.
147
+ - A `204 No Content` response, or an empty body, returns `{}`.
148
+ - A bare `host` gets an `https://` base URL, or `http://` for a loopback host such as `127.0.0.1:8933`.
149
+ - The `fetchImpl` option replaces `fetch`, for tests.
@@ -0,0 +1,192 @@
1
+ # Fabric Resources
2
+
3
+ The Fabric API (`/api/fabric`) manages the resources in your SignalWire project: AI agents, SWML scripts, subscribers, call flows and others. Most resource types support CRUD operations and address listing. Every method is async, so `await` it.
4
+
5
+ <!-- snippet-setup -->
6
+ ```ts
7
+ export {}; // treat each example as a module so top-level `await` is allowed
8
+ // Shared context the fragments on this page assume (constructed on the Getting Started page).
9
+ declare const client: import('@signalwire/sdk').RestClient;
10
+ declare const pnId: string; // a phone-number SID
11
+ ```
12
+
13
+ ## Standard CRUD Pattern
14
+
15
+ The CRUD resource types share the same methods. This example runs each of them on AI agents:
16
+
17
+ ```typescript
18
+ // List all resources of this type
19
+ let items = await client.fabric.aiAgents.list();
20
+ items = await client.fabric.aiAgents.list({ page_number: 2, page_size: 10 });
21
+
22
+ // Create a new resource
23
+ const agent = await client.fabric.aiAgents.create({
24
+ name: 'Support Bot',
25
+ prompt: { text: 'You are a helpful support agent.' },
26
+ });
27
+
28
+ // Get a resource by ID
29
+ const found = await client.fabric.aiAgents.get('agent-uuid');
30
+
31
+ // Update a resource
32
+ await client.fabric.aiAgents.update('agent-uuid', { name: 'Updated Name' });
33
+
34
+ // Delete a resource
35
+ await client.fabric.aiAgents.delete('agent-uuid');
36
+
37
+ // List addresses assigned to this resource
38
+ const addresses = await client.fabric.aiAgents.listAddresses('agent-uuid');
39
+ ```
40
+
41
+ `list()` returns one page. To walk every page, iterate `paginate()`, for example `for await (const agent of client.fabric.aiAgents.paginate())`. `cxmlApplications` and `resources` have no `paginate()`.
42
+
43
+ `client.fabric` has 16 sub-resources. Thirteen are CRUD resource types, which use one of two update methods. The other three are `resources` (generic), `addresses` and `tokens`, covered later on this page.
44
+
45
+ ### PUT-Update Resources
46
+
47
+ These resources send `update()` as a `PUT` (full replacement):
48
+
49
+ | Accessor | API Path |
50
+ |-----------|----------|
51
+ | `fabric.swmlScripts` | `/api/fabric/resources/swml_scripts` |
52
+ | `fabric.relayApplications` | `/api/fabric/resources/relay_applications` |
53
+ | `fabric.callFlows` | `/api/fabric/resources/call_flows` |
54
+ | `fabric.conferenceRooms` | `/api/fabric/resources/conference_rooms` |
55
+ | `fabric.freeswitchConnectors` | `/api/fabric/resources/freeswitch_connectors` |
56
+ | `fabric.subscribers` | `/api/fabric/resources/subscribers` |
57
+ | `fabric.sipEndpoints` | `/api/fabric/resources/sip_endpoints` |
58
+ | `fabric.cxmlScripts` | `/api/fabric/resources/cxml_scripts` |
59
+ | `fabric.cxmlApplications` | `/api/fabric/resources/cxml_applications` |
60
+
61
+ ### PATCH-Update Resources
62
+
63
+ These resources send `update()` as a `PATCH` (partial update):
64
+
65
+ | Accessor | API Path | Notes |
66
+ |-----------|----------|-------|
67
+ | `fabric.swmlWebhooks` | `/api/fabric/resources/swml_webhooks` | Also created by the platform when you call `phoneNumbers.setSwmlWebhook(sid, url)`. See [phone-binding.md](phone-binding.md). |
68
+ | `fabric.aiAgents` | `/api/fabric/resources/ai_agents` | Create one directly, then bind a number to it with `phoneNumbers.setAiAgent(sid, agentId)`. |
69
+ | `fabric.sipGateways` | `/api/fabric/resources/sip_gateways` | |
70
+ | `fabric.cxmlWebhooks` | `/api/fabric/resources/cxml_webhooks` | Also created by the platform when you call `phoneNumbers.setCxmlWebhook(sid, url)`. This is the cXML (Twilio-compatible) handler, although its `call_handler` wire value is `laml_webhooks`. |
71
+
72
+ ## Call Flows: Extra Methods
73
+
74
+ Call flows support version management. `deployVersion` takes either a `document_version` or a `call_flow_version_id`:
75
+
76
+ ```typescript
77
+ // List all versions of a call flow
78
+ const versions = await client.fabric.callFlows.listVersions('call-flow-uuid');
79
+
80
+ // Deploy a version
81
+ await client.fabric.callFlows.deployVersion('call-flow-uuid', { document_version: 3 });
82
+ ```
83
+
84
+ ## Subscribers: SIP Endpoints
85
+
86
+ Subscribers have nested SIP endpoint management. `createSipEndpoint` takes the username and password positionally:
87
+
88
+ ```typescript
89
+ // List a subscriber's SIP endpoints
90
+ const endpoints = await client.fabric.subscribers.listSipEndpoints('subscriber-uuid');
91
+
92
+ // Create a SIP endpoint for a subscriber (username and password are positional)
93
+ const endpoint = await client.fabric.subscribers.createSipEndpoint('subscriber-uuid', 'user1', 'secret', {
94
+ caller_id: '+15551234567',
95
+ });
96
+
97
+ // Get a specific SIP endpoint
98
+ const found = await client.fabric.subscribers.getSipEndpoint('subscriber-uuid', 'endpoint-uuid');
99
+
100
+ // Update a SIP endpoint (uses PATCH)
101
+ await client.fabric.subscribers.updateSipEndpoint('subscriber-uuid', 'endpoint-uuid', {
102
+ caller_id: '+15559876543',
103
+ });
104
+
105
+ // Delete a SIP endpoint
106
+ await client.fabric.subscribers.deleteSipEndpoint('subscriber-uuid', 'endpoint-uuid');
107
+ ```
108
+
109
+ ## cXML Applications
110
+
111
+ cXML applications support list, get, update and delete. The class has no `create()` method, so a call to it fails to compile:
112
+
113
+ ```typescript
114
+ const apps = await client.fabric.cxmlApplications.list();
115
+ const app = await client.fabric.cxmlApplications.get('app-uuid');
116
+ await client.fabric.cxmlApplications.update('app-uuid', { voice_url: 'https://example.com/voice' });
117
+ await client.fabric.cxmlApplications.delete('app-uuid');
118
+ ```
119
+
120
+ ## Generic Resources
121
+
122
+ `client.fabric.resources` operates on a resource of any type by its ID:
123
+
124
+ ```typescript
125
+ // List all resources across all types
126
+ const allResources = await client.fabric.resources.list();
127
+
128
+ // Get any resource by ID
129
+ const resource = await client.fabric.resources.get('resource-uuid');
130
+
131
+ // Delete any resource
132
+ await client.fabric.resources.delete('resource-uuid');
133
+
134
+ // List addresses for any resource
135
+ const addresses = await client.fabric.resources.listAddresses('resource-uuid');
136
+
137
+ // Assign a resource as a domain application handler
138
+ await client.fabric.resources.assignDomainApplication('resource-uuid', 'da-uuid');
139
+ ```
140
+
141
+ ### `assignPhoneRoute` is not how you bind a phone number
142
+
143
+ `client.fabric.resources.assignPhoneRoute(id, phone_route_id, handler)` posts to `/api/fabric/resources/{id}/phone_routes`. The `handler` is `'calling'` or `'messaging'`. This method doesn't bind a phone number to an SWML webhook, a cXML webhook or an AI agent. You configure those bindings on the phone number, as [phone-binding.md](phone-binding.md) describes.
144
+
145
+ ## Binding a phone number to a handler
146
+
147
+ [phone-binding.md](phone-binding.md) covers the `PhoneCallHandler` values, the Fabric resource each one produces and the typed `phoneNumbers.set*` helpers. The common case routes a number to an SWML webhook:
148
+
149
+ ```typescript
150
+ // SWML webhook (your backend returns SWML per call)
151
+ await client.phoneNumbers.setSwmlWebhook(pnId, 'https://example.com/swml');
152
+ ```
153
+
154
+ ## Fabric Addresses
155
+
156
+ `client.fabric.addresses` gives read-only access to all Fabric addresses. `list()` accepts filters such as `type`, `display_name` and `name`:
157
+
158
+ ```typescript
159
+ // List all addresses, filtered by type
160
+ const addresses = await client.fabric.addresses.list({ type: 'room' });
161
+
162
+ // Get a specific address
163
+ const address = await client.fabric.addresses.get('address-uuid');
164
+ ```
165
+
166
+ ## Tokens
167
+
168
+ `client.fabric.tokens` creates tokens for subscribers, guests, invites and embeds. The `expire_at` and `expires_at` options are Unix times in seconds:
169
+
170
+ ```typescript
171
+ // Subscriber token; `reference` is positional, and the rest are options
172
+ const subscriberToken = await client.fabric.tokens.createSubscriberToken('user@example.com', {
173
+ password: 'a-long-random-password',
174
+ });
175
+
176
+ // Refresh a subscriber token; the refresh token is positional
177
+ const refreshed = await client.fabric.tokens.refreshSubscriberToken('existing-refresh-token');
178
+
179
+ // Guest token; `allowed_addresses` is positional
180
+ const guestToken = await client.fabric.tokens.createGuestToken(
181
+ ['address-uuid-1', 'address-uuid-2'],
182
+ { expire_at: 1767225599 },
183
+ );
184
+
185
+ // Subscriber invite token; `address_id` is positional
186
+ const inviteToken = await client.fabric.tokens.createInviteToken('address-uuid', {
187
+ expires_at: 1767225599,
188
+ });
189
+
190
+ // Click-to-call embed token; the source token is positional
191
+ const embedToken = await client.fabric.tokens.createEmbedToken('embed-source-token');
192
+ ```