@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,138 @@
1
+ # Getting Started with the REST Client
2
+
3
+ The REST client gives you access to the SignalWire platform APIs over standard HTTP requests. It needs no WebSocket connection. This page installs the SDK, configures credentials and makes a first API call.
4
+
5
+ ## Installation
6
+
7
+ The REST client is part of the `@signalwire/sdk` package. Install it with npm:
8
+
9
+ ```bash
10
+ npm install @signalwire/sdk
11
+ ```
12
+
13
+ The SDK requires Node.js 22 or later. The client uses the global `fetch` API.
14
+
15
+ ## Configuration
16
+
17
+ The client needs three settings. Each constructor option falls back to an environment variable:
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 (for example `example.signalwire.com`) |
24
+
25
+ `SIGNALWIRE_REST_BASE_URL` also sets the host, as a full URL, and takes precedence over `SIGNALWIRE_SPACE`. If a setting is missing from both the options and the environment, the constructor throws an `Error`.
26
+
27
+ ## Minimal Example
28
+
29
+ This example lists the AI agents in your project:
30
+
31
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
32
+ ```typescript
33
+ import { RestClient } from '@signalwire/sdk';
34
+
35
+ const client = new RestClient({
36
+ project: 'your-project-id',
37
+ token: 'your-api-token',
38
+ host: 'example.signalwire.com',
39
+ });
40
+
41
+ // List your AI agents
42
+ const agents = await client.fabric.aiAgents.list();
43
+ console.log(agents);
44
+ ```
45
+
46
+ To configure the client from the environment instead, export the three variables:
47
+
48
+ ```bash
49
+ export SIGNALWIRE_PROJECT_ID=your-project-id
50
+ export SIGNALWIRE_API_TOKEN=your-api-token
51
+ export SIGNALWIRE_SPACE=example.signalwire.com
52
+ ```
53
+
54
+ Then construct the client without options:
55
+
56
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
57
+ ```typescript
58
+ import { RestClient } from '@signalwire/sdk';
59
+
60
+ const client = new RestClient();
61
+ const agents = await client.fabric.aiAgents.list();
62
+ ```
63
+
64
+ ## CRUD Pattern
65
+
66
+ Most resources share the same CRUD methods. This example runs each of them on AI agents:
67
+
68
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
69
+ ```typescript
70
+ import { RestClient } from '@signalwire/sdk';
71
+
72
+ const client = new RestClient();
73
+
74
+ // List
75
+ const items = await client.fabric.aiAgents.list();
76
+
77
+ // Create
78
+ const agent = await client.fabric.aiAgents.create({
79
+ name: 'Support',
80
+ prompt: { text: 'Be helpful' },
81
+ });
82
+
83
+ // Get by ID
84
+ const found = await client.fabric.aiAgents.get('agent-uuid');
85
+
86
+ // Update
87
+ await client.fabric.aiAgents.update('agent-uuid', { name: 'Updated Name' });
88
+
89
+ // Delete
90
+ await client.fabric.aiAgents.delete('agent-uuid');
91
+ ```
92
+
93
+ Fabric resources also list the addresses assigned to them:
94
+
95
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
96
+ ```typescript
97
+ import { RestClient } from '@signalwire/sdk';
98
+
99
+ const client = new RestClient();
100
+ const addresses = await client.fabric.aiAgents.listAddresses('agent-uuid');
101
+ ```
102
+
103
+ ## Error Handling
104
+
105
+ Every non-2xx HTTP response throws `SignalWireRestError`, which is the same class as `RestError`. A request that gets no response, such as a refused connection or a timeout, throws `RestTransportError`, a subclass with a `null` status code:
106
+
107
+ ```typescript
108
+ import { RestClient, SignalWireRestError } from '@signalwire/sdk';
109
+
110
+ const client = new RestClient();
111
+
112
+ try {
113
+ const agent = await client.fabric.aiAgents.get('nonexistent-id');
114
+ } catch (err) {
115
+ if (err instanceof SignalWireRestError) {
116
+ console.error(`HTTP ${err.statusCode}: ${JSON.stringify(err.body)}`);
117
+ }
118
+ }
119
+ ```
120
+
121
+ The `body` property holds the parsed JSON response, or the raw text when the response isn't JSON. [Client Reference](client-reference.md#error-handling) lists every property of the error.
122
+
123
+ ## Debug Logging
124
+
125
+ Set the log level to `debug` to log the method and URL of each request:
126
+
127
+ ```bash
128
+ export SIGNALWIRE_LOG_LEVEL=debug
129
+ ```
130
+
131
+ ## Next Steps
132
+
133
+ These pages continue from here:
134
+
135
+ - [Client Reference](client-reference.md): all namespaces and constructor options
136
+ - [Fabric Resources](fabric.md): managing AI agents, SWML scripts and more
137
+ - [Calling Commands](calling.md): REST-based call control
138
+ - [All Namespaces](namespaces.md): phone numbers, video, Datasphere and more
@@ -0,0 +1,421 @@
1
+ # REST Client Guide
2
+
3
+ The SignalWire REST client gives you typed HTTP access to the SignalWire platform APIs. It's a standalone module that doesn't depend on `AgentBase`, so you can use it in any server-side integration. This guide shows each namespace, then pagination, request options, error handling and test injection.
4
+
5
+ <!-- snippet-setup -->
6
+ ```ts
7
+ // Shared context the fragments on this page assume. `client` is a RestClient
8
+ // configured from the environment (see Getting Started).
9
+ import { RestClient } from '@signalwire/sdk';
10
+ const client = new RestClient();
11
+ ```
12
+
13
+ ## Quick Start
14
+
15
+ This example lists AI agents, searches phone numbers and plays audio into a call:
16
+
17
+ <!-- snippet: no-run makes live REST calls to a real SignalWire space -->
18
+ ```ts
19
+ // List AI agents
20
+ const agents = await client.fabric.aiAgents.list();
21
+
22
+ // Search phone numbers
23
+ const numbers = await client.phoneNumbers.search({ areacode: '512' });
24
+
25
+ // Play audio into a call (the `play` array is positional)
26
+ await client.calling.play('call-id', [
27
+ { type: 'audio', params: { url: 'https://example.com/audio.mp3' } },
28
+ ]);
29
+ ```
30
+
31
+ ## Authentication
32
+
33
+ The client uses HTTP Basic Auth with your project ID and API token. You pass the credentials as options, or set the environment variables:
34
+
35
+ | Option | Environment Variable |
36
+ |--------|---------------------|
37
+ | `project` | `SIGNALWIRE_PROJECT_ID` |
38
+ | `token` | `SIGNALWIRE_API_TOKEN` |
39
+ | `host` | `SIGNALWIRE_SPACE` (or `SIGNALWIRE_REST_BASE_URL`, a full URL, which takes precedence) |
40
+
41
+ With the environment variables set, `new RestClient()` needs no arguments. [Getting Started](getting-started.md#configuration) has the details.
42
+
43
+ ## Namespaces
44
+
45
+ The client groups the APIs into namespaces, one property each. The sections that follow show the common calls in each one.
46
+
47
+ ### Fabric (`client.fabric.*`)
48
+
49
+ The Fabric namespace manages resources such as AI agents, SWML scripts, call flows and subscribers:
50
+
51
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
52
+ ```ts
53
+ // AI Agents (PATCH updates); create requires both `name` and `prompt`
54
+ await client.fabric.aiAgents.list();
55
+ await client.fabric.aiAgents.create({ name: 'My Agent', prompt: { text: 'Be helpful' } });
56
+ await client.fabric.aiAgents.get('agent-id');
57
+ await client.fabric.aiAgents.update('agent-id', { name: 'Updated' });
58
+ await client.fabric.aiAgents.delete('agent-id');
59
+ await client.fabric.aiAgents.listAddresses('agent-id');
60
+
61
+ // SWML Scripts (PUT updates); the script body key is `contents`
62
+ const swml = JSON.stringify({ version: '1.0.0', sections: { main: [{ answer: {} }] } });
63
+ await client.fabric.swmlScripts.create({ name: 'flow', contents: swml });
64
+ await client.fabric.swmlScripts.update('id', { contents: swml });
65
+
66
+ // Call Flows (with version management)
67
+ await client.fabric.callFlows.list();
68
+ await client.fabric.callFlows.listVersions('cf-id');
69
+ await client.fabric.callFlows.deployVersion('cf-id', { document_version: 2 });
70
+
71
+ // Subscribers (with SIP endpoints); username and password are positional
72
+ await client.fabric.subscribers.listSipEndpoints('sub-id');
73
+ await client.fabric.subscribers.createSipEndpoint('sub-id', 'user', 'a-long-random-password');
74
+
75
+ // Tokens; the primary identifier is positional
76
+ await client.fabric.tokens.createSubscriberToken('user@example.com');
77
+ await client.fabric.tokens.createGuestToken(['address-uuid']);
78
+ ```
79
+
80
+ The Fabric sub-resources are `swmlScripts`, `relayApplications`, `callFlows`, `conferenceRooms`, `freeswitchConnectors`, `subscribers`, `sipEndpoints`, `cxmlScripts`, `cxmlApplications`, `swmlWebhooks`, `aiAgents`, `sipGateways`, `cxmlWebhooks`, `resources`, `addresses` and `tokens`. [Fabric Resources](fabric.md) covers each one.
81
+
82
+ ### Calling (`client.calling.*`)
83
+
84
+ The Calling namespace controls calls over REST. Each command is a POST to `/api/calling/calls`:
85
+
86
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
87
+ ```ts
88
+ // Dial; from and to are positional
89
+ await client.calling.dial('+15559876543', '+15551234567', { url: 'https://example.com/handler' });
90
+
91
+ // Play audio; the play array is positional, and pause/resume/stop take control_id positionally
92
+ await client.calling.play('call-id', [
93
+ { type: 'audio', params: { url: 'https://example.com/audio.mp3' } },
94
+ ], { control_id: 'ctrl-1' });
95
+ await client.calling.playPause('call-id', 'ctrl-1');
96
+ await client.calling.playResume('call-id', 'ctrl-1');
97
+ await client.calling.playStop('call-id', 'ctrl-1');
98
+
99
+ // Record; record takes an options object, and recordStop takes control_id positionally
100
+ await client.calling.record('call-id', { control_id: 'rec-1', audio: { beep: true } });
101
+ await client.calling.recordStop('call-id', 'rec-1');
102
+
103
+ // AI control
104
+ await client.calling.aiMessage('call-id', { role: 'system', message_text: 'The caller is a premium customer.' });
105
+ await client.calling.aiStop('call-id', 'ai-1');
106
+
107
+ // End the call
108
+ await client.calling.end('call-id');
109
+ ```
110
+
111
+ [Calling Commands](calling.md) lists every method and the wire command it sends.
112
+
113
+ ### Phone Numbers (`client.phoneNumbers`)
114
+
115
+ This example lists, searches, purchases, updates and releases phone numbers:
116
+
117
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
118
+ ```typescript
119
+ await client.phoneNumbers.list();
120
+ await client.phoneNumbers.search({ areacode: '512' });
121
+ await client.phoneNumbers.create({ number: '+15551234567' }); // Purchase
122
+ await client.phoneNumbers.update('id', { name: 'Main Line' });
123
+ await client.phoneNumbers.delete('id'); // Release
124
+ ```
125
+
126
+ To route a number's inbound calls, use the `phoneNumbers.set*` helpers that [phone-binding.md](phone-binding.md) describes.
127
+
128
+ ### Datasphere (`client.datasphere.*`)
129
+
130
+ The Datasphere namespace manages documents and runs semantic search over them:
131
+
132
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
133
+ ```ts
134
+ // Documents; create takes a document URL
135
+ await client.datasphere.documents.list();
136
+ await client.datasphere.documents.create({ url: 'https://example.com/faq.pdf', tags: ['faq'] });
137
+ await client.datasphere.documents.get('doc-id');
138
+ await client.datasphere.documents.update('doc-id', { tags: ['faq', 'billing'] });
139
+ await client.datasphere.documents.delete('doc-id');
140
+
141
+ // Search; the query string is positional
142
+ await client.datasphere.documents.search('how do I reset my password', { count: 5 });
143
+
144
+ // Chunks
145
+ await client.datasphere.documents.listChunks('doc-id');
146
+ await client.datasphere.documents.getChunk('doc-id', 'chunk-id');
147
+ await client.datasphere.documents.deleteChunk('doc-id', 'chunk-id');
148
+ ```
149
+
150
+ ### Video (`client.video.*`)
151
+
152
+ The Video namespace manages rooms, room tokens, sessions and conferences:
153
+
154
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
155
+ ```ts
156
+ // Rooms; update uses `max_members`
157
+ await client.video.rooms.list();
158
+ await client.video.rooms.create({ name: 'standup' });
159
+ await client.video.rooms.update('room-id', { max_members: 10 });
160
+ await client.video.rooms.listStreams('room-id');
161
+ await client.video.rooms.createStream('room-id', 'rtmp://example.com/live');
162
+
163
+ // Room tokens; room_name is positional
164
+ await client.video.roomTokens.create('standup', { user_name: 'alice' });
165
+
166
+ // Sessions
167
+ await client.video.roomSessions.list();
168
+ await client.video.roomSessions.listMembers('session-id');
169
+ await client.video.roomSessions.listRecordings('session-id');
170
+
171
+ // Conferences
172
+ await client.video.conferences.list();
173
+ await client.video.conferences.listConferenceTokens('conf-id');
174
+ ```
175
+
176
+ ### Other Namespaces
177
+
178
+ This example shows one or two calls from each of the remaining namespaces:
179
+
180
+ <!-- snippet: no-run makes a live REST call to a real SignalWire space -->
181
+ ```ts
182
+ // Messaging; to and from are positional
183
+ await client.messages.create('+15551234567', '+15559876543', { body: 'Your order has shipped.' });
184
+
185
+ // Addresses; create takes the address fields positionally
186
+ await client.addresses.list();
187
+ await client.addresses.create(
188
+ 'Office', 'US', 'Jane', 'Doe', '123', 'Main St', 'Austin', 'TX', '78701',
189
+ );
190
+
191
+ // Queues (with member management)
192
+ await client.queues.list();
193
+ await client.queues.listMembers('queue-id');
194
+ await client.queues.getNextMember('queue-id');
195
+
196
+ // Recordings
197
+ await client.recordings.list();
198
+ await client.recordings.get('recording-id');
199
+ await client.recordings.delete('recording-id');
200
+
201
+ // Number Groups (with memberships); phone_number_id is positional
202
+ await client.numberGroups.list();
203
+ await client.numberGroups.listMemberships('group-id');
204
+ await client.numberGroups.addMembership('group-id', 'pn-id');
205
+
206
+ // Verified Callers; the create body key is `number`
207
+ await client.verifiedCallers.list();
208
+ await client.verifiedCallers.create({ number: '+15551234567' });
209
+ await client.verifiedCallers.submitVerification('id', '1234');
210
+
211
+ // SIP Profile (one per project); the codecs field is `default_codecs`
212
+ await client.sipProfile.get();
213
+ await client.sipProfile.update({ default_codecs: ['PCMU', 'PCMA'] });
214
+
215
+ // Lookup
216
+ await client.lookup.phoneNumber('+15551234567', { include: 'cnam' });
217
+
218
+ // Short Codes; update takes (id, name, message_handler) positionally
219
+ await client.shortCodes.list();
220
+ await client.shortCodes.update('sc-id', 'Alerts', 'laml_webhooks', {
221
+ message_request_url: 'https://example.com/sms',
222
+ });
223
+
224
+ // Imported Numbers; number and number_type are positional
225
+ await client.importedNumbers.create('+15551234567', 'longcode');
226
+
227
+ // MFA; `to` is positional
228
+ await client.mfa.sms('+15551234567', { from: '+15559876543' });
229
+ await client.mfa.call('+15551234567', { from: '+15559876543' });
230
+ await client.mfa.verify('request-id', '1234');
231
+
232
+ // Registry (10DLC); createCampaign takes a typed campaign body
233
+ await client.registry.brands.list();
234
+ await client.registry.brands.createCampaign('brand-id', {
235
+ name: 'Alerts',
236
+ brand_id: 'brand-id',
237
+ csp_campaign_reference: 'CAMP123',
238
+ });
239
+ await client.registry.campaigns.listNumbers('campaign-id');
240
+
241
+ // Logs
242
+ await client.logs.voice.list({ page_size: 10 });
243
+ await client.logs.voice.listEvents('log-id');
244
+ await client.logs.messages.list();
245
+ await client.logs.fax.list();
246
+ await client.logs.conferences.list();
247
+
248
+ // Project tokens; create takes (name, permissions) positionally
249
+ await client.project.tokens.create('ci-token', ['calling', 'messaging', 'numbers']);
250
+ await client.project.tokens.update('token-id', { name: 'updated' });
251
+ await client.project.tokens.delete('token-id');
252
+
253
+ // Projects and subprojects
254
+ await client.projects.list();
255
+ await client.projects.rotateSigningKey('project-id');
256
+
257
+ // PubSub and Chat tokens; createToken(ttl, channels, options?)
258
+ await client.pubsub.createToken(60, { updates: { read: true, write: false } }, { member_id: 'user-1' });
259
+ await client.chat.createToken(60, { support: { read: true, write: true } }, { member_id: 'user-1' });
260
+ ```
261
+
262
+ [All Namespaces](namespaces.md) covers each of these in more detail.
263
+
264
+ ## Pagination
265
+
266
+ A `list()` call returns one page of results, as the server sent it. The platform APIs use two pagination styles: a `links.next` URL, or a `next_page_uri` field.
267
+
268
+ ### Iterating a resource
269
+
270
+ Resources built on `ReadResource` or `CrudResource` also have `paginate()`. Examples are `phoneNumbers`, `queues`, `video.rooms`, `logs.voice`, `fabric.addresses` and most Fabric resource types. `paginate()` follows the next-page link of either style and yields one item at a time:
271
+
272
+ <!-- snippet: no-run makes live REST calls to a real SignalWire space -->
273
+ ```ts
274
+ for await (const number of client.phoneNumbers.paginate({ page_size: 50 })) {
275
+ console.log(number.id);
276
+ }
277
+ ```
278
+
279
+ The query parameters apply to the first request only. Later pages use the URL the server returns. `paginate()` stops when there's no next link, or when the server repeats a link it already returned.
280
+
281
+ ### The pagination functions
282
+
283
+ The SDK also exports `paginate()` and `paginateAll()` as functions. They take an `HttpClient`, a path and optional query parameters. `dataKey` names the property that holds the items, and defaults to `data`. `paginateAll()` collects every item into one array, so it holds all pages in memory:
284
+
285
+ <!-- snippet: no-run makes live REST calls to a real SignalWire space -->
286
+ ```ts
287
+ import { HttpClient, paginate, paginateAll } from '@signalwire/sdk';
288
+
289
+ const http = new HttpClient({
290
+ host: 'example.signalwire.com',
291
+ project: 'your-project-id',
292
+ token: 'your-api-token',
293
+ });
294
+
295
+ // Yield items one at a time across pages
296
+ for await (const number of paginate<{ id: string; number: string }>(
297
+ http,
298
+ '/api/relay/rest/phone_numbers',
299
+ )) {
300
+ console.log(number.number);
301
+ }
302
+
303
+ // Collect every item into an array
304
+ const allNumbers = await paginateAll(http, '/api/relay/rest/phone_numbers');
305
+ console.log(allNumbers.length);
306
+ ```
307
+
308
+ `paginate()` takes `requestOptions` as its fifth argument and applies them to every page. `paginateAll()` doesn't take `requestOptions`.
309
+
310
+ ## Request Options (timeout, retries, abort)
311
+
312
+ Every request accepts request options that control its timeout, retries and cancellation. Set a client-wide default with the `requestOptions` constructor option. Override it for one call by passing an options object as the method's last argument:
313
+
314
+ <!-- snippet: no-run makes live REST calls to a real SignalWire space -->
315
+ ```typescript
316
+ // `RestClient` is imported in the shared setup. Construct a client with
317
+ // defaults that apply to every request:
318
+ const tunedClient = new RestClient({
319
+ project: 'your-project-id',
320
+ token: 'your-api-token',
321
+ host: 'example.signalwire.com',
322
+ requestOptions: { timeout: 10, retries: 2 },
323
+ });
324
+
325
+ // Per-call override (merged over the client default, field by field):
326
+ await tunedClient.phoneNumbers.list({ page_size: 20 }, { timeout: 5 });
327
+ await tunedClient.fabric.aiAgents.get('agent-id', { retries: 3 });
328
+
329
+ // Cancel an in-flight request with an AbortSignal:
330
+ const controller = new AbortController();
331
+ const pending = tunedClient.phoneNumbers.list(undefined, { abortSignal: controller.signal });
332
+ // Later, call the controller's abort() method: `pending` then rejects with a RestTransportError.
333
+ ```
334
+
335
+ The request options have these fields, all optional:
336
+
337
+ | Field | Default | Meaning |
338
+ |-------|---------|---------|
339
+ | `timeout` | `30` | Maximum seconds for each attempt. When it's exceeded, the request throws `RestTransportError`. |
340
+ | `retries` | `0` | Number of retries after a retryable failure (total attempts = `retries + 1`). By default the client doesn't retry. |
341
+ | `retryOnStatus` | `{429, 500, 502, 503, 504}` | HTTP statuses that trigger a retry for an idempotent method. |
342
+ | `retryBackoff` | `0.5` | Base seconds for exponential backoff (`retryBackoff * 2 ** (attempt - 1)`). A numeric `Retry-After` header takes precedence. |
343
+ | `abortSignal` | None | An `AbortSignal` that cancels the request in flight. It's also checked before each attempt. |
344
+
345
+ A field you leave unset falls back to the client default, then to the built-in default. Retries depend on the method. `GET`, `PUT` and `DELETE` retry on any status in `retryOnStatus`, and on transport errors. `POST` and `PATCH` retry only on transport errors and on a `429` or `503` in `retryOnStatus`. That way a request that changed data isn't sent twice after a `500`. A cancellation through `abortSignal` is never retried.
346
+
347
+ ## Error Handling
348
+
349
+ Every non-2xx response throws `RestError`, with the status code, body, URL and method. A request that gets no response throws `RestTransportError`, a subclass of `RestError` whose `statusCode` is `null`:
350
+
351
+ ```typescript
352
+ import { RestError } from '@signalwire/sdk';
353
+
354
+ try {
355
+ await client.phoneNumbers.get('nonexistent');
356
+ } catch (err) {
357
+ if (err instanceof RestError) {
358
+ console.error(`${err.method} ${err.url} returned ${err.statusCode}`);
359
+ console.error('Body:', err.body);
360
+ }
361
+ }
362
+ ```
363
+
364
+ `RestError` is also exported as `SignalWireRestError`. [Client Reference](client-reference.md#error-properties) lists its properties.
365
+
366
+ ## Test Injection
367
+
368
+ For tests, pass your own `fetch` implementation as `fetchImpl`. This example returns an empty list for every request:
369
+
370
+ ```ts
371
+ const mockFetch = async (input: RequestInfo | URL, init?: RequestInit) =>
372
+ new Response(JSON.stringify({ data: [] }));
373
+
374
+ const testClient = new RestClient({
375
+ project: 'test',
376
+ token: 'test',
377
+ host: 'test.signalwire.com',
378
+ fetchImpl: mockFetch,
379
+ });
380
+ void testClient;
381
+ ```
382
+
383
+ ## Architecture
384
+
385
+ `RestClient` holds one `HttpClient` and a property for each namespace. This tree shows each property and the class behind it:
386
+
387
+ ```text
388
+ RestClient
389
+ HttpClient (fetch + Basic Auth, shared by every namespace)
390
+ fabric: FabricNamespace (16 sub-resources)
391
+ calling: Calling (command dispatch)
392
+ phoneNumbers: PhoneNumbers (CRUD + search + call-handler helpers)
393
+ addresses: Addresses
394
+ messages: Messages
395
+ queues: Queues (CRUD + members)
396
+ recordings: Recordings
397
+ numberGroups: NumberGroups (CRUD + memberships)
398
+ verifiedCallers: VerifiedCallers (CRUD + verification)
399
+ sipProfile: SipProfile (get and update)
400
+ lookup: Lookup
401
+ shortCodes: ShortCodes
402
+ importedNumbers: ImportedNumbers
403
+ mfa: Mfa
404
+ registry: RegistryNamespace (brands, campaigns, orders, numbers)
405
+ datasphere: DatasphereNamespace (documents)
406
+ video: VideoNamespace (rooms, roomTokens, roomSessions, roomRecordings, conferences, conferenceTokens, streams)
407
+ logs: LogsNamespace (messages, voice, fax, conferences)
408
+ project: ProjectNamespace (tokens)
409
+ projects: Projects
410
+ pubsub: PubSub
411
+ chat: Chat
412
+ ```
413
+
414
+ The resource classes build on these base classes:
415
+
416
+ - `BaseResource` holds the `HttpClient` and the base path, and provides the `_path()` helper.
417
+ - `ReadResource` adds `list()`, `get()` and `paginate()`.
418
+ - `CrudResource` adds `create()`, `update()` and `delete()` to `ReadResource`. Its update method is `PATCH` or `PUT`, depending on the resource.
419
+ - `CrudWithAddresses` adds `listAddresses()` to `CrudResource`.
420
+
421
+ Resources whose API doesn't fit these shapes, such as `recordings` and `sipProfile`, extend `BaseResource` and define their own methods. They have no `paginate()`.