@signalwire/sdk 2.0.1 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1019 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -1,285 +0,0 @@
1
- # All Namespaces
2
-
3
- Reference for every namespace beyond Fabric, Calling, and Compat (which have their own pages).
4
-
5
- ## Phone Numbers
6
-
7
- ```python
8
- # List your phone numbers
9
- numbers = client.phone_numbers.list()
10
- numbers = client.phone_numbers.list(name="Main")
11
-
12
- # Search available numbers to purchase
13
- available = client.phone_numbers.search(area_code="512", number_type="local")
14
-
15
- # Purchase a number
16
- number = client.phone_numbers.create(number="+15551234567")
17
-
18
- # Get / update / release
19
- number = client.phone_numbers.get("pn-uuid")
20
- client.phone_numbers.update("pn-uuid", name="Support Line")
21
- client.phone_numbers.delete("pn-uuid")
22
- ```
23
-
24
- ## Addresses
25
-
26
- ```python
27
- addresses = client.addresses.list()
28
- address = client.addresses.create(label="Office", street="123 Main St", city="Austin", state="TX")
29
- address = client.addresses.get("addr-uuid")
30
- client.addresses.delete("addr-uuid")
31
- ```
32
-
33
- ## Queues
34
-
35
- ```python
36
- queues = client.queues.list()
37
- queue = client.queues.create(name="Support")
38
- queue = client.queues.get("q-uuid")
39
- client.queues.update("q-uuid", name="VIP Support")
40
- client.queues.delete("q-uuid")
41
-
42
- # Members
43
- members = client.queues.list_members("q-uuid")
44
- next_member = client.queues.get_next_member("q-uuid")
45
- member = client.queues.get_member("q-uuid", "member-uuid")
46
- ```
47
-
48
- ## Recordings
49
-
50
- ```python
51
- recordings = client.recordings.list()
52
- recording = client.recordings.get("rec-uuid")
53
- client.recordings.delete("rec-uuid")
54
- ```
55
-
56
- ## Number Groups
57
-
58
- ```python
59
- groups = client.number_groups.list()
60
- group = client.number_groups.create(name="Marketing")
61
- group = client.number_groups.get("ng-uuid")
62
- client.number_groups.update("ng-uuid", name="Sales")
63
- client.number_groups.delete("ng-uuid")
64
-
65
- # Memberships
66
- memberships = client.number_groups.list_memberships("ng-uuid")
67
- client.number_groups.add_membership("ng-uuid", phone_number_id="pn-uuid")
68
- membership = client.number_groups.get_membership("mem-uuid")
69
- client.number_groups.delete_membership("mem-uuid")
70
- ```
71
-
72
- ## Verified Caller IDs
73
-
74
- ```python
75
- callers = client.verified_callers.list()
76
- caller = client.verified_callers.create(phone_number="+15551234567", name="Office")
77
- caller = client.verified_callers.get("vc-uuid")
78
- client.verified_callers.update("vc-uuid", name="Main Office")
79
- client.verified_callers.delete("vc-uuid")
80
-
81
- # Verification flow
82
- client.verified_callers.redial_verification("vc-uuid")
83
- client.verified_callers.submit_verification("vc-uuid", code="123456")
84
- ```
85
-
86
- ## SIP Profile
87
-
88
- Singleton resource -- no ID needed:
89
-
90
- ```python
91
- profile = client.sip_profile.get()
92
- client.sip_profile.update(username="myproject", password="newsecret")
93
- ```
94
-
95
- ## Phone Number Lookup
96
-
97
- ```python
98
- info = client.lookup.phone_number("+15551234567")
99
- info = client.lookup.phone_number("+15551234567", include="carrier,cnam")
100
- ```
101
-
102
- Note: carrier and CNAM lookups are billable.
103
-
104
- ## Short Codes
105
-
106
- ```python
107
- codes = client.short_codes.list()
108
- code = client.short_codes.get("sc-uuid")
109
- client.short_codes.update("sc-uuid", name="Alerts")
110
- ```
111
-
112
- ## Imported Phone Numbers
113
-
114
- ```python
115
- client.imported_numbers.create(number="+15559999999", carrier="external")
116
- ```
117
-
118
- ## MFA (Multi-Factor Authentication)
119
-
120
- ```python
121
- # Request a verification code via SMS
122
- result = client.mfa.sms(
123
- to="+15551234567",
124
- from_="+15559876543",
125
- message="Your code is {code}",
126
- )
127
- request_id = result["id"]
128
-
129
- # Or via phone call
130
- result = client.mfa.call(
131
- to="+15551234567",
132
- from_="+15559876543",
133
- )
134
-
135
- # Verify the code
136
- result = client.mfa.verify(request_id, token="123456")
137
- ```
138
-
139
- ## 10DLC Campaign Registry
140
-
141
- ```python
142
- # Brands
143
- brands = client.registry.brands.list()
144
- brand = client.registry.brands.create(name="My Brand", ein="12-3456789")
145
- brand = client.registry.brands.get("brand-uuid")
146
-
147
- # Campaigns under a brand
148
- campaigns = client.registry.brands.list_campaigns("brand-uuid")
149
- campaign = client.registry.brands.create_campaign("brand-uuid", description="Alerts")
150
-
151
- # Campaign management
152
- campaign = client.registry.campaigns.get("camp-uuid")
153
- client.registry.campaigns.update("camp-uuid", description="Updated alerts")
154
-
155
- # Number assignments
156
- numbers = client.registry.campaigns.list_numbers("camp-uuid")
157
- orders = client.registry.campaigns.list_orders("camp-uuid")
158
- order = client.registry.campaigns.create_order("camp-uuid", phone_number_ids=["pn-1"])
159
- order = client.registry.orders.get("order-uuid")
160
- client.registry.numbers.delete("number-assignment-uuid")
161
- ```
162
-
163
- ## Datasphere
164
-
165
- ```python
166
- # Documents
167
- docs = client.datasphere.documents.list()
168
- doc = client.datasphere.documents.create(url="https://example.com/doc.pdf", tags=["support"])
169
- doc = client.datasphere.documents.get("doc-uuid")
170
- client.datasphere.documents.update("doc-uuid", tags=["support", "billing"])
171
- client.datasphere.documents.delete("doc-uuid")
172
-
173
- # Semantic search
174
- results = client.datasphere.documents.search(
175
- query_string="How do I reset my password?",
176
- tags=["support"],
177
- count=5,
178
- )
179
-
180
- # Chunks
181
- chunks = client.datasphere.documents.list_chunks("doc-uuid")
182
- chunk = client.datasphere.documents.get_chunk("doc-uuid", "chunk-uuid")
183
- client.datasphere.documents.delete_chunk("doc-uuid", "chunk-uuid")
184
- ```
185
-
186
- ## Video
187
-
188
- ```python
189
- # Rooms
190
- rooms = client.video.rooms.list()
191
- room = client.video.rooms.create(name="standup", max_members=10)
192
- room = client.video.rooms.get("room-uuid")
193
- client.video.rooms.update("room-uuid", max_members=20)
194
- client.video.rooms.delete("room-uuid")
195
- client.video.rooms.list_streams("room-uuid")
196
- client.video.rooms.create_stream("room-uuid", url="rtmp://example.com/live")
197
-
198
- # Room tokens
199
- token = client.video.room_tokens.create(room_name="standup", user_name="alice")
200
-
201
- # Room sessions
202
- sessions = client.video.room_sessions.list(room_name="standup")
203
- session = client.video.room_sessions.get("session-uuid")
204
- events = client.video.room_sessions.list_events("session-uuid")
205
- members = client.video.room_sessions.list_members("session-uuid")
206
- recordings = client.video.room_sessions.list_recordings("session-uuid")
207
-
208
- # Room recordings
209
- recs = client.video.room_recordings.list()
210
- rec = client.video.room_recordings.get("rec-uuid")
211
- client.video.room_recordings.delete("rec-uuid")
212
- events = client.video.room_recordings.list_events("rec-uuid")
213
-
214
- # Conferences
215
- confs = client.video.conferences.list()
216
- conf = client.video.conferences.create(name="all-hands", quality="720p")
217
- conf = client.video.conferences.get("conf-uuid")
218
- client.video.conferences.update("conf-uuid", quality="1080p")
219
- client.video.conferences.delete("conf-uuid")
220
- tokens = client.video.conferences.list_conference_tokens("conf-uuid")
221
- client.video.conferences.list_streams("conf-uuid")
222
- client.video.conferences.create_stream("conf-uuid", url="rtmp://example.com/live")
223
-
224
- # Conference tokens
225
- token = client.video.conference_tokens.get("token-uuid")
226
- client.video.conference_tokens.reset("token-uuid")
227
-
228
- # Streams
229
- stream = client.video.streams.get("stream-uuid")
230
- client.video.streams.update("stream-uuid", url="rtmp://example.com/new")
231
- client.video.streams.delete("stream-uuid")
232
- ```
233
-
234
- ## Logs
235
-
236
- All log endpoints are read-only.
237
-
238
- ```python
239
- # Message logs
240
- logs = client.logs.messages.list(include_deleted=True)
241
- log = client.logs.messages.get("log-uuid")
242
-
243
- # Voice logs (with events)
244
- logs = client.logs.voice.list()
245
- log = client.logs.voice.get("log-uuid")
246
- events = client.logs.voice.list_events("log-uuid")
247
-
248
- # Fax logs
249
- logs = client.logs.fax.list()
250
- log = client.logs.fax.get("log-uuid")
251
-
252
- # Conference logs
253
- logs = client.logs.conferences.list()
254
- ```
255
-
256
- ## Project Tokens
257
-
258
- ```python
259
- token = client.project.tokens.create(
260
- name="ci-token",
261
- permissions=["calling", "messaging", "numbers"],
262
- )
263
- client.project.tokens.update("token-uuid", name="renamed-token")
264
- client.project.tokens.delete("token-uuid")
265
- ```
266
-
267
- ## PubSub Tokens
268
-
269
- ```python
270
- token = client.pubsub.create_token(
271
- ttl=60,
272
- channels=[{"name": "updates", "read": True, "write": False}],
273
- member_id="user-123",
274
- )
275
- ```
276
-
277
- ## Chat Tokens
278
-
279
- ```python
280
- token = client.chat.create_token(
281
- ttl=60,
282
- channels=[{"name": "support", "read": True, "write": True}],
283
- member_id="user-123",
284
- )
285
- ```
@@ -1,161 +0,0 @@
1
- /**
2
- * REST Example: 10DLC brand and campaign compliance registration.
3
- *
4
- * WARNING: This example interacts with the real 10DLC registration system.
5
- * Brand and campaign registrations may have side effects and costs.
6
- * Use with caution in production environments.
7
- *
8
- * Prerequisites:
9
- * export SIGNALWIRE_PROJECT_ID=your-project-id
10
- * export SIGNALWIRE_API_TOKEN=your-api-token
11
- * export SIGNALWIRE_SPACE=your-space.signalwire.com
12
- *
13
- * Run:
14
- * npx tsx rest/examples/rest-10dlc-registration.ts
15
- */
16
-
17
- import { RestClient, RestError } from '../../src/index.js';
18
-
19
- const client = new RestClient();
20
-
21
- async function main() {
22
- // 1. Register a brand
23
- console.log('Registering 10DLC brand...');
24
- let brandId: string | null = null;
25
- try {
26
- const brand = await client.registry.brands.create({
27
- company_name: 'Acme Corp',
28
- ein: '12-3456789',
29
- entity_type: 'PRIVATE_PROFIT',
30
- vertical: 'TECHNOLOGY',
31
- website: 'https://acme.example.com',
32
- country: 'US',
33
- });
34
- brandId = brand.id;
35
- console.log(` Registered brand: ${brandId}`);
36
- } catch (err) {
37
- if (err instanceof RestError) {
38
- console.log(` Brand registration failed (expected in demo): ${err.statusCode}`);
39
- } else throw err;
40
- }
41
-
42
- // 2. List brands
43
- console.log('\nListing brands...');
44
- const brands = await client.registry.brands.list();
45
- for (const b of brands.data ?? []) {
46
- console.log(` - ${b.id}: ${b.name ?? 'unnamed'}`);
47
- }
48
- if (!brandId && brands.data?.length) {
49
- brandId = brands.data[0].id;
50
- }
51
-
52
- // 3. Get brand details
53
- if (brandId) {
54
- const detail = await client.registry.brands.get(brandId);
55
- console.log(`\nBrand detail: ${detail.name ?? 'N/A'} (${detail.state ?? 'N/A'})`);
56
- }
57
-
58
- // 4. Create a campaign under the brand
59
- let campaignId: string | null = null;
60
- if (brandId) {
61
- console.log('\nCreating campaign...');
62
- try {
63
- const campaign = await client.registry.brands.createCampaign(brandId, {
64
- use_case: 'MIXED',
65
- description: 'Customer notifications and support messages',
66
- sample_message: 'Your order #12345 has shipped.',
67
- });
68
- campaignId = campaign.id;
69
- console.log(` Created campaign: ${campaignId}`);
70
- } catch (err) {
71
- if (err instanceof RestError) {
72
- console.log(` Campaign creation failed (expected in demo): ${err.statusCode}`);
73
- } else throw err;
74
- }
75
- }
76
-
77
- // 5. List campaigns for the brand
78
- if (brandId) {
79
- console.log('\nListing brand campaigns...');
80
- const campaigns = await client.registry.brands.listCampaigns(brandId);
81
- for (const c of campaigns.data ?? []) {
82
- console.log(` - ${c.id}: ${c.name ?? 'unknown'}`);
83
- if (!campaignId) campaignId = c.id;
84
- }
85
- }
86
-
87
- // 6. Get and update campaign
88
- if (campaignId) {
89
- const campDetail = await client.registry.campaigns.get(campaignId);
90
- console.log(`\nCampaign: ${campDetail.name ?? 'N/A'} (${campDetail.state ?? 'N/A'})`);
91
-
92
- try {
93
- await client.registry.campaigns.update(campaignId, {
94
- description: 'Updated: customer notifications',
95
- });
96
- console.log(' Campaign description updated');
97
- } catch (err) {
98
- if (err instanceof RestError) {
99
- console.log(` Campaign update failed: ${err.statusCode}`);
100
- } else throw err;
101
- }
102
- }
103
-
104
- // 7. Create an order to assign numbers
105
- let orderId: string | null = null;
106
- if (campaignId) {
107
- console.log('\nCreating number assignment order...');
108
- try {
109
- const order = await client.registry.campaigns.createOrder(campaignId, {
110
- phone_numbers: ['+15125551234'],
111
- });
112
- orderId = order.id;
113
- console.log(` Created order: ${orderId}`);
114
- } catch (err) {
115
- if (err instanceof RestError) {
116
- console.log(` Order creation failed (expected in demo): ${err.statusCode}`);
117
- } else throw err;
118
- }
119
- }
120
-
121
- // 8. Get order status
122
- if (orderId) {
123
- const orderDetail = await client.registry.orders.get(orderId);
124
- console.log(` Order status: ${orderDetail.status ?? 'N/A'}`);
125
- }
126
-
127
- // 9. List campaign numbers and orders
128
- if (campaignId) {
129
- console.log('\nListing campaign numbers...');
130
- const numbers = await client.registry.campaigns.listNumbers(campaignId);
131
- for (const n of numbers.data ?? []) {
132
- console.log(` - ${n.phone_number ?? n.id ?? 'unknown'}`);
133
- }
134
-
135
- const orders = await client.registry.campaigns.listOrders(campaignId);
136
- for (const o of orders.data ?? []) {
137
- console.log(` - Order ${o.id}: ${o.status ?? 'unknown'}`);
138
- }
139
- }
140
-
141
- // 10. Unassign a number (clean up)
142
- if (campaignId) {
143
- console.log('\nUnassigning numbers...');
144
- const nums = await client.registry.campaigns.listNumbers(campaignId);
145
- for (const n of nums.data ?? []) {
146
- try {
147
- await client.registry.numbers.delete(n.id);
148
- console.log(` Unassigned number ${n.id}`);
149
- } catch (err) {
150
- if (err instanceof RestError) {
151
- console.log(` Unassign failed: ${err.statusCode}`);
152
- } else throw err;
153
- }
154
- }
155
- }
156
- }
157
-
158
- main().catch(err => {
159
- console.error('Error:', err.message);
160
- process.exit(1);
161
- });
@@ -1,102 +0,0 @@
1
- /**
2
- * REST Example: IVR input collection, AI operations, and advanced call control.
3
- *
4
- * NOTE: These commands require an active call. The CALL_ID used here is
5
- * illustrative -- in production you would obtain it from a dial response or
6
- * inbound call event.
7
- *
8
- * Prerequisites:
9
- * export SIGNALWIRE_PROJECT_ID=your-project-id
10
- * export SIGNALWIRE_API_TOKEN=your-api-token
11
- * export SIGNALWIRE_SPACE=your-space.signalwire.com
12
- *
13
- * Run:
14
- * npx tsx rest/examples/rest-calling-ivr-and-ai.ts
15
- */
16
-
17
- import { RestClient, RestError } from '../../src/index.js';
18
-
19
- const client = new RestClient();
20
- const CALL_ID = 'demo-call-id';
21
-
22
- async function safe(label: string, fn: () => Promise<unknown>): Promise<unknown> {
23
- try {
24
- const result = await fn();
25
- console.log(` ${label}: OK`);
26
- return result;
27
- } catch (err) {
28
- if (err instanceof RestError) {
29
- console.log(` ${label}: failed (${err.statusCode})`);
30
- } else throw err;
31
- return null;
32
- }
33
- }
34
-
35
- async function main() {
36
- // 1. Collect DTMF input
37
- console.log('Collecting DTMF input...');
38
- await safe('Collect', () => client.calling.collect(CALL_ID, {
39
- digits: { max: 4, terminators: '#' },
40
- play: [{ type: 'tts', text: 'Enter your PIN followed by pound.' }],
41
- }));
42
- await safe('Start input timers', () => client.calling.collectStartInputTimers(CALL_ID));
43
- await safe('Stop collect', () => client.calling.collectStop(CALL_ID));
44
-
45
- // 2. Answering machine detection
46
- console.log('\nDetecting answering machine...');
47
- await safe('Detect', () => client.calling.detect(CALL_ID, { type: 'machine' }));
48
- await safe('Stop detect', () => client.calling.detectStop(CALL_ID));
49
-
50
- // 3. AI operations
51
- console.log('\nAI agent operations...');
52
- await safe('AI message', () => client.calling.aiMessage(CALL_ID, {
53
- message: 'The customer wants to check their balance.',
54
- }));
55
- await safe('AI hold', () => client.calling.aiHold(CALL_ID));
56
- await safe('AI unhold', () => client.calling.aiUnhold(CALL_ID));
57
- await safe('AI stop', () => client.calling.aiStop(CALL_ID));
58
-
59
- // 4. Live transcription and translation
60
- console.log('\nLive transcription and translation...');
61
- await safe('Live transcribe', () => client.calling.liveTranscribe(CALL_ID, { language: 'en-US' }));
62
- await safe('Live translate', () => client.calling.liveTranslate(CALL_ID, { language: 'es' }));
63
-
64
- // 5. Tap (media fork)
65
- console.log('\nTap (media fork)...');
66
- await safe('Tap start', () => client.calling.tap(CALL_ID, {
67
- tap: { type: 'audio', direction: 'both' },
68
- device: { type: 'rtp', addr: '192.168.1.100', port: 9000 },
69
- }));
70
- await safe('Tap stop', () => client.calling.tapStop(CALL_ID));
71
-
72
- // 6. Stream (WebSocket)
73
- console.log('\nStream (WebSocket)...');
74
- await safe('Stream start', () => client.calling.stream(CALL_ID, { url: 'wss://example.com/audio-stream' }));
75
- await safe('Stream stop', () => client.calling.streamStop(CALL_ID));
76
-
77
- // 7. User event
78
- console.log('\nSending user event...');
79
- await safe('User event', () => client.calling.userEvent(CALL_ID, {
80
- event_name: 'agent_note', data: { note: 'VIP caller' },
81
- }));
82
-
83
- // 8. SIP refer
84
- console.log('\nSIP refer...');
85
- await safe('SIP refer', () => client.calling.refer(CALL_ID, { sip_uri: 'sip:support@example.com' }));
86
-
87
- // 9. Fax stop commands
88
- console.log('\nFax stop commands...');
89
- await safe('Send fax stop', () => client.calling.sendFaxStop(CALL_ID));
90
- await safe('Receive fax stop', () => client.calling.receiveFaxStop(CALL_ID));
91
-
92
- // 10. Transfer and disconnect
93
- console.log('\nTransfer and disconnect...');
94
- await safe('Transfer', () => client.calling.transfer(CALL_ID, { dest: '+15559999999' }));
95
- await safe('Update call', () => client.calling.update({ call_id: CALL_ID, metadata: { priority: 'high' } }));
96
- await safe('Disconnect', () => client.calling.disconnect(CALL_ID));
97
- }
98
-
99
- main().catch(err => {
100
- console.error('Error:', err.message);
101
- process.exit(1);
102
- });
@@ -1,91 +0,0 @@
1
- /**
2
- * REST Example: Control an active call with media operations (play, record, transcribe, denoise).
3
- *
4
- * NOTE: These commands require an active call. The call_id used here is
5
- * illustrative -- in production you would obtain it from a dial response or
6
- * inbound call event.
7
- *
8
- * Prerequisites:
9
- * export SIGNALWIRE_PROJECT_ID=your-project-id
10
- * export SIGNALWIRE_API_TOKEN=your-api-token
11
- * export SIGNALWIRE_SPACE=your-space.signalwire.com
12
- *
13
- * Run:
14
- * npx tsx rest/examples/rest-calling-play-and-record.ts
15
- */
16
-
17
- import { RestClient, RestError } from '../../src/index.js';
18
-
19
- const client = new RestClient();
20
-
21
- async function safe(label: string, fn: () => Promise<unknown>): Promise<unknown> {
22
- try {
23
- const result = await fn();
24
- console.log(` ${label}: OK`);
25
- return result;
26
- } catch (err) {
27
- if (err instanceof RestError) {
28
- console.log(` ${label}: failed (${err.statusCode})`);
29
- } else throw err;
30
- return null;
31
- }
32
- }
33
-
34
- async function main() {
35
- // 1. Dial an outbound call
36
- console.log('Dialing outbound call...');
37
- let callId = 'demo-call-id';
38
- try {
39
- const call: any = await client.calling.dial({
40
- from: '+15559876543',
41
- to: '+15551234567',
42
- url: 'https://example.com/call-handler',
43
- });
44
- callId = call.id ?? 'demo-call-id';
45
- console.log(` Call initiated: ${callId}`);
46
- } catch (err) {
47
- if (err instanceof RestError) {
48
- console.log(` Dial failed (expected in demo): ${err.statusCode}`);
49
- } else throw err;
50
- }
51
-
52
- // 2. Play TTS audio
53
- console.log('\nPlaying TTS on call...');
54
- await safe('Play', () => client.calling.play(callId, { play: [{ type: 'tts', text: 'Welcome to SignalWire.' }] }));
55
-
56
- // 3. Pause, resume, adjust volume, stop playback
57
- console.log('\nControlling playback...');
58
- await safe('Pause', () => client.calling.playPause(callId));
59
- await safe('Resume', () => client.calling.playResume(callId));
60
- await safe('Volume +2dB', () => client.calling.playVolume(callId, { volume: 2.0 }));
61
- await safe('Stop', () => client.calling.playStop(callId));
62
-
63
- // 4. Record the call
64
- console.log('\nRecording call...');
65
- await safe('Record', () => client.calling.record(callId, { beep: true, format: 'mp3' }));
66
-
67
- // 5. Pause, resume, stop recording
68
- console.log('\nControlling recording...');
69
- await safe('Pause', () => client.calling.recordPause(callId));
70
- await safe('Resume', () => client.calling.recordResume(callId));
71
- await safe('Stop', () => client.calling.recordStop(callId));
72
-
73
- // 6. Transcribe the call
74
- console.log('\nTranscribing call...');
75
- await safe('Transcribe', () => client.calling.transcribe(callId, { language: 'en-US' }));
76
- await safe('Transcribe stop', () => client.calling.transcribeStop(callId));
77
-
78
- // 7. Denoise the call
79
- console.log('\nEnabling denoise...');
80
- await safe('Denoise', () => client.calling.denoise(callId));
81
- await safe('Denoise stop', () => client.calling.denoiseStop(callId));
82
-
83
- // 8. End the call
84
- console.log('\nEnding call...');
85
- await safe('End', () => client.calling.end(callId, { reason: 'hangup' }));
86
- }
87
-
88
- main().catch(err => {
89
- console.error('Error:', err.message);
90
- process.exit(1);
91
- });
@@ -1,65 +0,0 @@
1
- /**
2
- * REST Client Example — demonstrates CRUD operations, search, and pagination.
3
- *
4
- * Prerequisites:
5
- * export SIGNALWIRE_PROJECT_ID=your-project-id
6
- * export SIGNALWIRE_API_TOKEN=your-api-token
7
- * export SIGNALWIRE_SPACE=your-space.signalwire.com
8
- *
9
- * Run:
10
- * npx tsx rest/examples/rest-client.ts
11
- */
12
-
13
- import { RestClient, paginateAll } from '../../src/index.js';
14
-
15
- async function main() {
16
- // Create client — reads from env vars if not provided explicitly
17
- const client = new RestClient();
18
-
19
- console.log('=== Phone Numbers ===');
20
-
21
- // List owned phone numbers
22
- const numbers = await client.phoneNumbers.list();
23
- console.log('Owned numbers:', numbers.data?.length ?? 0);
24
-
25
- // Search available numbers
26
- const available = await client.phoneNumbers.search({ area_code: '512' });
27
- console.log('Available 512 numbers:', available.data?.length ?? 0);
28
-
29
- console.log('\n=== Fabric AI Agents ===');
30
-
31
- // List AI agents
32
- const agents = await client.fabric.aiAgents.list();
33
- console.log('AI agents:', agents.data?.length ?? 0);
34
-
35
- console.log('\n=== Video Rooms ===');
36
-
37
- // List video rooms
38
- const rooms = await client.video.rooms.list();
39
- console.log('Video rooms:', rooms.data?.length ?? 0);
40
-
41
- console.log('\n=== Datasphere ===');
42
-
43
- // List documents
44
- const docs = await client.datasphere.documents.list();
45
- console.log('Documents:', docs.data?.length ?? 0);
46
-
47
- console.log('\n=== Logs ===');
48
-
49
- // List recent voice logs
50
- const voiceLogs = await client.logs.voice.list({ page_size: 5 });
51
- console.log('Recent voice logs:', voiceLogs.data?.length ?? 0);
52
-
53
- console.log('\n=== Compat (Twilio-compatible) ===');
54
-
55
- // List calls via compatibility API
56
- const calls = await client.compat.calls.list();
57
- console.log('Compat calls:', calls.calls?.length ?? 0);
58
-
59
- console.log('\nDone.');
60
- }
61
-
62
- main().catch(err => {
63
- console.error('Error:', err.message);
64
- process.exit(1);
65
- });