@signalwire/sdk 2.0.1 → 2.0.3

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 +1026 -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,273 +0,0 @@
1
- # Calling Commands
2
-
3
- The Calling API provides REST-based call control. All commands are dispatched via a single `POST /api/calling/calls` endpoint with a `command` field. No WebSocket connection is needed.
4
-
5
- ## How It Works
6
-
7
- Every method on `client.calling` sends a POST request with this structure:
8
-
9
- ```json
10
- {
11
- "command": "calling.play",
12
- "id": "<call-uuid>",
13
- "params": { ... }
14
- }
15
- ```
16
-
17
- For `dial` and `update`, the call details are inside `params` (no top-level `id`). For all other commands, `id` is the UUID of the call to control.
18
-
19
- ## Call Lifecycle
20
-
21
- ### `dial(**params) -> dict`
22
-
23
- Initiate an outbound call.
24
-
25
- ```python
26
- result = client.calling.dial(
27
- from_="+15559876543",
28
- to="+15551234567",
29
- url="https://example.com/call-handler",
30
- )
31
- call_id = result.get("id")
32
- ```
33
-
34
- ### `update(**params) -> dict`
35
-
36
- Update an active call's dialplan mid-call.
37
-
38
- ```python
39
- client.calling.update(id=call_id, url="https://example.com/new-handler")
40
- ```
41
-
42
- ### `end(call_id, **params) -> dict`
43
-
44
- Terminate a call.
45
-
46
- ```python
47
- client.calling.end(call_id, reason="hangup")
48
- ```
49
-
50
- ### `transfer(call_id, **params) -> dict`
51
-
52
- Transfer a call to a new destination.
53
-
54
- ```python
55
- client.calling.transfer(call_id, dest="sip:agent@example.com")
56
- ```
57
-
58
- ### `disconnect(call_id) -> dict`
59
-
60
- Disconnect bridged calls without hanging up either leg.
61
-
62
- ```python
63
- client.calling.disconnect(call_id)
64
- ```
65
-
66
- ## Audio Playback
67
-
68
- ### `play(call_id, **params) -> dict`
69
-
70
- Play audio, TTS, silence, or ringtone.
71
-
72
- ```python
73
- client.calling.play(call_id,
74
- play=[{"type": "tts", "text": "Hello!"}],
75
- volume=5.0,
76
- )
77
- ```
78
-
79
- ### `play_pause(call_id, **params)` / `play_resume(call_id, **params)`
80
-
81
- Pause or resume active playback.
82
-
83
- ```python
84
- client.calling.play_pause(call_id, control_id="ctrl-1")
85
- client.calling.play_resume(call_id, control_id="ctrl-1")
86
- ```
87
-
88
- ### `play_stop(call_id, **params)`
89
-
90
- Stop active playback.
91
-
92
- ```python
93
- client.calling.play_stop(call_id, control_id="ctrl-1")
94
- ```
95
-
96
- ### `play_volume(call_id, **params)`
97
-
98
- Adjust playback volume.
99
-
100
- ```python
101
- client.calling.play_volume(call_id, control_id="ctrl-1", volume=-3.0)
102
- ```
103
-
104
- ## Recording
105
-
106
- ### `record(call_id, **params)` / `record_pause` / `record_resume` / `record_stop`
107
-
108
- ```python
109
- client.calling.record(call_id,
110
- control_id="rec-1",
111
- audio={"beep": True, "format": "wav", "stereo": True},
112
- )
113
- client.calling.record_pause(call_id, control_id="rec-1")
114
- client.calling.record_resume(call_id, control_id="rec-1")
115
- client.calling.record_stop(call_id, control_id="rec-1")
116
- ```
117
-
118
- ## Input Collection
119
-
120
- ### `collect(call_id, **params)` / `collect_stop` / `collect_start_input_timers`
121
-
122
- ```python
123
- client.calling.collect(call_id,
124
- control_id="coll-1",
125
- digits={"max": 4, "terminators": "#"},
126
- speech={"end_silence_timeout": 2.0},
127
- )
128
- client.calling.collect_stop(call_id, control_id="coll-1")
129
- client.calling.collect_start_input_timers(call_id, control_id="coll-1")
130
- ```
131
-
132
- ## Detection
133
-
134
- ### `detect(call_id, **params)` / `detect_stop`
135
-
136
- ```python
137
- client.calling.detect(call_id,
138
- control_id="det-1",
139
- detect={"type": "machine", "params": {"initial_timeout": 4.5}},
140
- )
141
- client.calling.detect_stop(call_id, control_id="det-1")
142
- ```
143
-
144
- ## Tap & Stream
145
-
146
- ### `tap(call_id, **params)` / `tap_stop`
147
-
148
- ```python
149
- client.calling.tap(call_id,
150
- control_id="tap-1",
151
- tap={"type": "audio", "params": {"direction": "both"}},
152
- device={"type": "rtp", "params": {"addr": "192.168.1.1", "port": 1234}},
153
- )
154
- client.calling.tap_stop(call_id, control_id="tap-1")
155
- ```
156
-
157
- ### `stream(call_id, **params)` / `stream_stop`
158
-
159
- ```python
160
- client.calling.stream(call_id,
161
- control_id="str-1",
162
- url="wss://example.com/audio-stream",
163
- codec="PCMU",
164
- )
165
- client.calling.stream_stop(call_id, control_id="str-1")
166
- ```
167
-
168
- ## Denoise
169
-
170
- ### `denoise(call_id)` / `denoise_stop(call_id)`
171
-
172
- ```python
173
- client.calling.denoise(call_id)
174
- client.calling.denoise_stop(call_id)
175
- ```
176
-
177
- ## Transcription
178
-
179
- ### `transcribe(call_id, **params)` / `transcribe_stop`
180
-
181
- ```python
182
- client.calling.transcribe(call_id, control_id="tx-1", status_url="https://example.com/hook")
183
- client.calling.transcribe_stop(call_id, control_id="tx-1")
184
- ```
185
-
186
- ## AI
187
-
188
- ### `ai_message(call_id, **params)`
189
-
190
- Inject a message into an active AI session.
191
-
192
- ```python
193
- client.calling.ai_message(call_id, role="user", message_text="Transfer me to billing")
194
- ```
195
-
196
- ### `ai_hold(call_id, **params)` / `ai_unhold(call_id, **params)`
197
-
198
- ```python
199
- client.calling.ai_hold(call_id, timeout=60, prompt="Please wait while I transfer you.")
200
- client.calling.ai_unhold(call_id, prompt="I'm back, how can I help?")
201
- ```
202
-
203
- ### `ai_stop(call_id, **params)`
204
-
205
- ```python
206
- client.calling.ai_stop(call_id, control_id="ai-1")
207
- ```
208
-
209
- ## Live Transcribe & Translate
210
-
211
- ```python
212
- client.calling.live_transcribe(call_id, action="start", lang="en")
213
- client.calling.live_translate(call_id, action="start", from_lang="en", to_lang="es")
214
- ```
215
-
216
- ## Fax
217
-
218
- ```python
219
- client.calling.send_fax_stop(call_id, control_id="fax-1")
220
- client.calling.receive_fax_stop(call_id, control_id="fax-1")
221
- ```
222
-
223
- ## SIP & Custom Events
224
-
225
- ```python
226
- # SIP REFER transfer
227
- client.calling.refer(call_id, device={"to": "sip:agent@example.com"})
228
-
229
- # Custom event
230
- client.calling.user_event(call_id, event={"type": "custom", "data": {"key": "value"}})
231
- ```
232
-
233
- ## Complete Method List
234
-
235
- | Method | Command | Requires call_id |
236
- |--------|---------|:-:|
237
- | `dial(**params)` | `dial` | No |
238
- | `update(**params)` | `update` | No |
239
- | `end(call_id, **params)` | `calling.end` | Yes |
240
- | `transfer(call_id, **params)` | `calling.transfer` | Yes |
241
- | `disconnect(call_id)` | `calling.disconnect` | Yes |
242
- | `play(call_id, **params)` | `calling.play` | Yes |
243
- | `play_pause(call_id, **params)` | `calling.play.pause` | Yes |
244
- | `play_resume(call_id, **params)` | `calling.play.resume` | Yes |
245
- | `play_stop(call_id, **params)` | `calling.play.stop` | Yes |
246
- | `play_volume(call_id, **params)` | `calling.play.volume` | Yes |
247
- | `record(call_id, **params)` | `calling.record` | Yes |
248
- | `record_pause(call_id, **params)` | `calling.record.pause` | Yes |
249
- | `record_resume(call_id, **params)` | `calling.record.resume` | Yes |
250
- | `record_stop(call_id, **params)` | `calling.record.stop` | Yes |
251
- | `collect(call_id, **params)` | `calling.collect` | Yes |
252
- | `collect_stop(call_id, **params)` | `calling.collect.stop` | Yes |
253
- | `collect_start_input_timers(call_id, **params)` | `calling.collect.start_input_timers` | Yes |
254
- | `detect(call_id, **params)` | `calling.detect` | Yes |
255
- | `detect_stop(call_id, **params)` | `calling.detect.stop` | Yes |
256
- | `tap(call_id, **params)` | `calling.tap` | Yes |
257
- | `tap_stop(call_id, **params)` | `calling.tap.stop` | Yes |
258
- | `stream(call_id, **params)` | `calling.stream` | Yes |
259
- | `stream_stop(call_id, **params)` | `calling.stream.stop` | Yes |
260
- | `denoise(call_id)` | `calling.denoise` | Yes |
261
- | `denoise_stop(call_id)` | `calling.denoise.stop` | Yes |
262
- | `transcribe(call_id, **params)` | `calling.transcribe` | Yes |
263
- | `transcribe_stop(call_id, **params)` | `calling.transcribe.stop` | Yes |
264
- | `ai_message(call_id, **params)` | `calling.ai_message` | Yes |
265
- | `ai_hold(call_id, **params)` | `calling.ai_hold` | Yes |
266
- | `ai_unhold(call_id, **params)` | `calling.ai_unhold` | Yes |
267
- | `ai_stop(call_id, **params)` | `calling.ai.stop` | Yes |
268
- | `live_transcribe(call_id, **params)` | `calling.live_transcribe` | Yes |
269
- | `live_translate(call_id, **params)` | `calling.live_translate` | Yes |
270
- | `send_fax_stop(call_id, **params)` | `calling.send_fax.stop` | Yes |
271
- | `receive_fax_stop(call_id, **params)` | `calling.receive_fax.stop` | Yes |
272
- | `refer(call_id, **params)` | `calling.refer` | Yes |
273
- | `user_event(call_id, **params)` | `calling.user_event` | Yes |
@@ -1,107 +0,0 @@
1
- # RestClient Reference
2
-
3
- ## Constructor
4
-
5
- ```python
6
- RestClient(
7
- project: str = None, # SIGNALWIRE_PROJECT_ID
8
- token: str = None, # SIGNALWIRE_API_TOKEN
9
- host: str = None, # SIGNALWIRE_SPACE
10
- )
11
- ```
12
-
13
- All parameters fall back to their corresponding environment variables. A `ValueError` is raised if any are missing.
14
-
15
- Authentication uses HTTP Basic Auth (`project:token`).
16
-
17
- ## Namespaces
18
-
19
- Every API surface is available as a namespace attribute on the client:
20
-
21
- ### Fabric API
22
-
23
- | Attribute | Description |
24
- |-----------|-------------|
25
- | `client.fabric.swml_scripts` | SWML script resources (CRUD + addresses) |
26
- | `client.fabric.swml_webhooks` | SWML webhook resources |
27
- | `client.fabric.ai_agents` | AI agent resources |
28
- | `client.fabric.relay_applications` | Relay application resources |
29
- | `client.fabric.call_flows` | Call flow resources (+ versions) |
30
- | `client.fabric.conference_rooms` | Conference room resources |
31
- | `client.fabric.freeswitch_connectors` | FreeSWITCH connector resources |
32
- | `client.fabric.subscribers` | Subscriber resources (+ SIP endpoints) |
33
- | `client.fabric.sip_endpoints` | SIP endpoint resources |
34
- | `client.fabric.sip_gateways` | SIP gateway resources |
35
- | `client.fabric.cxml_scripts` | cXML script resources |
36
- | `client.fabric.cxml_webhooks` | cXML webhook resources |
37
- | `client.fabric.cxml_applications` | cXML application resources (no create) |
38
- | `client.fabric.resources` | Generic resource operations |
39
- | `client.fabric.addresses` | Fabric addresses (list/get only) |
40
- | `client.fabric.tokens` | Subscriber/guest/invite/embed token creation |
41
-
42
- ### Calling API
43
-
44
- | Attribute | Description |
45
- |-----------|-------------|
46
- | `client.calling` | REST call control -- 37 commands via POST |
47
-
48
- ### Relay REST Resources
49
-
50
- | Attribute | Description |
51
- |-----------|-------------|
52
- | `client.phone_numbers` | Phone number management (+ search) |
53
- | `client.addresses` | Address management |
54
- | `client.queues` | Queue management (+ members) |
55
- | `client.recordings` | Recording management |
56
- | `client.number_groups` | Number group management (+ memberships) |
57
- | `client.verified_callers` | Verified caller ID management (+ verification flow) |
58
- | `client.sip_profile` | Project SIP profile (get/update) |
59
- | `client.lookup` | Phone number lookup |
60
- | `client.short_codes` | Short code management |
61
- | `client.imported_numbers` | Import external phone numbers |
62
- | `client.mfa` | Multi-factor authentication (SMS/call/verify) |
63
- | `client.registry` | 10DLC brand/campaign registry |
64
-
65
- ### Other APIs
66
-
67
- | Attribute | Description |
68
- |-----------|-------------|
69
- | `client.datasphere` | Datasphere document management and semantic search |
70
- | `client.video` | Video rooms, sessions, recordings, conferences |
71
- | `client.logs` | Message, voice, fax, and conference logs |
72
- | `client.project` | API token management |
73
- | `client.pubsub` | PubSub token creation |
74
- | `client.chat` | Chat token creation |
75
- | `client.compat` | Twilio-compatible LAML API |
76
-
77
- ## Error Handling
78
-
79
- ```python
80
- from signalwire_agents.rest import SignalWireRestError
81
-
82
- try:
83
- client.fabric.ai_agents.get("bad-id")
84
- except SignalWireRestError as e:
85
- print(e.status_code) # 404
86
- print(e.body) # {"error": "not found"}
87
- print(e.url) # "/api/fabric/resources/ai_agents/bad-id"
88
- print(e.method) # "GET"
89
- ```
90
-
91
- `SignalWireRestError` is raised on any non-2xx HTTP response.
92
-
93
- ### Error Attributes
94
-
95
- | Attribute | Type | Description |
96
- |-----------|------|-------------|
97
- | `status_code` | `int` | HTTP status code |
98
- | `body` | `dict` or `str` | Response body (parsed JSON or raw text) |
99
- | `url` | `str` | Request path |
100
- | `method` | `str` | HTTP method |
101
-
102
- ## Session Behavior
103
-
104
- - A single `requests.Session` is shared across all namespaces for connection pooling.
105
- - Content-Type is always `application/json`.
106
- - User-Agent is `@signalwire/sdk-python-rest/1.0`.
107
- - DELETE requests returning 204 return an empty dict.
@@ -1,204 +0,0 @@
1
- # Compatibility API
2
-
3
- The Compatibility API provides a Twilio-compatible LAML surface at `/api/laml/2010-04-01`. All paths are scoped under `/Accounts/{AccountSid}`, where AccountSid is your project ID.
4
-
5
- ## Sub-Resources
6
-
7
- | Attribute | Description |
8
- |-----------|-------------|
9
- | `compat.accounts` | Account/subproject management |
10
- | `compat.calls` | Call management + recordings + streams |
11
- | `compat.messages` | SMS/MMS management + media |
12
- | `compat.faxes` | Fax management + media |
13
- | `compat.conferences` | Conference management + participants + recordings + streams |
14
- | `compat.phone_numbers` | Incoming + available phone numbers |
15
- | `compat.applications` | Application management |
16
- | `compat.laml_bins` | cXML/LaML script management |
17
- | `compat.queues` | Queue management + members |
18
- | `compat.recordings` | Recording management |
19
- | `compat.transcriptions` | Transcription management |
20
- | `compat.tokens` | API token management |
21
-
22
- ## Accounts
23
-
24
- ```python
25
- # List accounts/subprojects
26
- accounts = client.compat.accounts.list()
27
-
28
- # Create a subproject
29
- sub = client.compat.accounts.create(FriendlyName="My Subproject")
30
-
31
- # Get/update an account
32
- account = client.compat.accounts.get("AC-sid")
33
- client.compat.accounts.update("AC-sid", FriendlyName="Updated")
34
- ```
35
-
36
- ## Calls
37
-
38
- ```python
39
- # List calls
40
- calls = client.compat.calls.list(From="+15551234567")
41
-
42
- # Create a call
43
- call = client.compat.calls.create(
44
- To="+15552222222",
45
- From="+15551111111",
46
- Url="https://example.com/twiml",
47
- )
48
-
49
- # Get / update / delete
50
- call = client.compat.calls.get("CA-sid")
51
- client.compat.calls.update("CA-sid", Status="completed")
52
- client.compat.calls.delete("CA-sid")
53
-
54
- # Start/update recording on a call
55
- client.compat.calls.start_recording("CA-sid", channels="dual")
56
- client.compat.calls.update_recording("CA-sid", "RE-sid", Status="paused")
57
-
58
- # Start/stop stream on a call
59
- client.compat.calls.start_stream("CA-sid", Url="wss://example.com/stream")
60
- client.compat.calls.stop_stream("CA-sid", "ST-sid")
61
- ```
62
-
63
- ## Messages
64
-
65
- ```python
66
- # Send an SMS
67
- msg = client.compat.messages.create(
68
- To="+15552222222",
69
- From="+15551111111",
70
- Body="Hello from SignalWire!",
71
- )
72
-
73
- # List / get / update / delete
74
- messages = client.compat.messages.list()
75
- msg = client.compat.messages.get("SM-sid")
76
- client.compat.messages.update("SM-sid", Body="") # redact
77
- client.compat.messages.delete("SM-sid")
78
-
79
- # Media sub-resources
80
- media = client.compat.messages.list_media("SM-sid")
81
- item = client.compat.messages.get_media("SM-sid", "ME-sid")
82
- client.compat.messages.delete_media("SM-sid", "ME-sid")
83
- ```
84
-
85
- ## Faxes
86
-
87
- ```python
88
- # Send a fax
89
- fax = client.compat.faxes.create(MediaUrl="https://example.com/doc.pdf", To="+15552222222", From="+15551111111")
90
-
91
- # List / get / cancel / delete
92
- faxes = client.compat.faxes.list()
93
- fax = client.compat.faxes.get("FX-sid")
94
- client.compat.faxes.update("FX-sid", Status="canceled")
95
- client.compat.faxes.delete("FX-sid")
96
-
97
- # Media sub-resources
98
- media = client.compat.faxes.list_media("FX-sid")
99
- item = client.compat.faxes.get_media("FX-sid", "ME-sid")
100
- client.compat.faxes.delete_media("FX-sid", "ME-sid")
101
- ```
102
-
103
- ## Conferences
104
-
105
- ```python
106
- # List / get / update
107
- conferences = client.compat.conferences.list()
108
- conf = client.compat.conferences.get("CF-sid")
109
- client.compat.conferences.update("CF-sid", Status="completed")
110
-
111
- # Participants
112
- participants = client.compat.conferences.list_participants("CF-sid")
113
- p = client.compat.conferences.get_participant("CF-sid", "CA-sid")
114
- client.compat.conferences.update_participant("CF-sid", "CA-sid", Muted=True)
115
- client.compat.conferences.remove_participant("CF-sid", "CA-sid")
116
-
117
- # Conference recordings
118
- recs = client.compat.conferences.list_recordings("CF-sid")
119
- rec = client.compat.conferences.get_recording("CF-sid", "RE-sid")
120
- client.compat.conferences.update_recording("CF-sid", "RE-sid", Status="stopped")
121
- client.compat.conferences.delete_recording("CF-sid", "RE-sid")
122
-
123
- # Conference streams
124
- client.compat.conferences.start_stream("CF-sid", Url="wss://example.com/stream")
125
- client.compat.conferences.stop_stream("CF-sid", "ST-sid")
126
- ```
127
-
128
- ## Phone Numbers
129
-
130
- ```python
131
- # List purchased numbers
132
- numbers = client.compat.phone_numbers.list()
133
-
134
- # Search available numbers
135
- local = client.compat.phone_numbers.search_local("US", AreaCode="512")
136
- toll_free = client.compat.phone_numbers.search_toll_free("US")
137
- countries = client.compat.phone_numbers.list_available_countries()
138
-
139
- # Purchase / get / update / release
140
- num = client.compat.phone_numbers.purchase(PhoneNumber="+15551234567")
141
- num = client.compat.phone_numbers.get("PN-sid")
142
- client.compat.phone_numbers.update("PN-sid", VoiceUrl="https://example.com/voice")
143
- client.compat.phone_numbers.delete("PN-sid")
144
-
145
- # Import external number
146
- client.compat.phone_numbers.import_number(PhoneNumber="+15559999999")
147
- ```
148
-
149
- ## Applications
150
-
151
- ```python
152
- apps = client.compat.applications.list()
153
- app = client.compat.applications.create(FriendlyName="My App", VoiceUrl="https://example.com/voice")
154
- app = client.compat.applications.get("AP-sid")
155
- client.compat.applications.update("AP-sid", VoiceUrl="https://example.com/new-voice")
156
- client.compat.applications.delete("AP-sid")
157
- ```
158
-
159
- ## LaML Bins (cXML Scripts)
160
-
161
- ```python
162
- bins = client.compat.laml_bins.list()
163
- b = client.compat.laml_bins.create(Name="Greeting", Contents="<Response><Say>Hello</Say></Response>")
164
- b = client.compat.laml_bins.get("LB-sid")
165
- client.compat.laml_bins.update("LB-sid", Contents="<Response><Say>Updated</Say></Response>")
166
- client.compat.laml_bins.delete("LB-sid")
167
- ```
168
-
169
- ## Queues
170
-
171
- ```python
172
- queues = client.compat.queues.list()
173
- q = client.compat.queues.create(FriendlyName="Support", MaxSize=100)
174
- q = client.compat.queues.get("QU-sid")
175
- client.compat.queues.update("QU-sid", MaxSize=200)
176
- client.compat.queues.delete("QU-sid")
177
-
178
- # Members
179
- members = client.compat.queues.list_members("QU-sid")
180
- member = client.compat.queues.get_member("QU-sid", "CA-sid")
181
- client.compat.queues.dequeue_member("QU-sid", "CA-sid", Url="https://example.com/dequeue")
182
- ```
183
-
184
- ## Recordings & Transcriptions
185
-
186
- ```python
187
- # Recordings
188
- recs = client.compat.recordings.list()
189
- rec = client.compat.recordings.get("RE-sid")
190
- client.compat.recordings.delete("RE-sid")
191
-
192
- # Transcriptions
193
- txns = client.compat.transcriptions.list()
194
- txn = client.compat.transcriptions.get("TR-sid")
195
- client.compat.transcriptions.delete("TR-sid")
196
- ```
197
-
198
- ## Tokens
199
-
200
- ```python
201
- token = client.compat.tokens.create(name="my-token", permissions=["calling", "messaging"])
202
- client.compat.tokens.update("token-id", name="renamed")
203
- client.compat.tokens.delete("token-id")
204
- ```