@signalwire/sdk 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (325) hide show
  1. package/.github/workflows/publish.yml +27 -0
  2. package/.github/workflows/test.yml +17 -0
  3. package/CLAUDE.md +112 -0
  4. package/README.md +254 -0
  5. package/docs/MIGRATION-2.0.md +81 -0
  6. package/docs/agent-guide.md +869 -0
  7. package/docs/agent_guide.md +1026 -0
  8. package/docs/api-reference.md +2420 -0
  9. package/docs/api_reference.md +1301 -0
  10. package/docs/architecture.md +843 -0
  11. package/docs/cli-guide.md +579 -0
  12. package/docs/cli_guide.md +448 -0
  13. package/docs/cloud_functions_guide.md +474 -0
  14. package/docs/configuration.md +422 -0
  15. package/docs/contexts-guide.md +787 -0
  16. package/docs/contexts_guide.md +511 -0
  17. package/docs/datamap-guide.md +1141 -0
  18. package/docs/datamap_guide.md +595 -0
  19. package/docs/llm_parameters.md +239 -0
  20. package/docs/mcp_gateway_reference.md +648 -0
  21. package/docs/mcp_integration.md +108 -0
  22. package/docs/prefabs-guide.md +800 -0
  23. package/docs/sdk_features.md +477 -0
  24. package/docs/security.md +436 -0
  25. package/docs/serverless-guide.md +513 -0
  26. package/docs/skills-guide.md +857 -0
  27. package/docs/skills-system.md +301 -0
  28. package/docs/skills_parameter_schema.md +392 -0
  29. package/docs/skills_system.md +467 -0
  30. package/docs/swaig-reference.md +1627 -0
  31. package/docs/swaig_reference.md +910 -0
  32. package/docs/swml_service_guide.md +600 -0
  33. package/docs/third_party_skills.md +533 -0
  34. package/docs/web_service.md +677 -0
  35. package/examples/README.md +131 -0
  36. package/examples/advanced-datamap.ts +100 -0
  37. package/examples/advanced-dynamic-config.ts +70 -0
  38. package/examples/auto-vivified.ts +94 -0
  39. package/examples/call-flow.ts +63 -0
  40. package/examples/comprehensive-dynamic.ts +125 -0
  41. package/examples/contexts-steps.ts +65 -0
  42. package/examples/custom-path.ts +45 -0
  43. package/examples/datamap-tools.ts +55 -0
  44. package/examples/datasphere-multi-instance.ts +63 -0
  45. package/examples/datasphere-serverless-env.ts +68 -0
  46. package/examples/datasphere-webhook-env.ts +66 -0
  47. package/examples/datasphere.ts +37 -0
  48. package/examples/declarative.ts +100 -0
  49. package/examples/dynamic-config.ts +54 -0
  50. package/examples/dynamic-info-gatherer.ts +69 -0
  51. package/examples/dynamic-swml-service.ts +67 -0
  52. package/examples/gather-info.ts +71 -0
  53. package/examples/gather-per-question-functions-demo.ts +140 -0
  54. package/examples/joke-agent.ts +34 -0
  55. package/examples/kubernetes-agent.ts +45 -0
  56. package/examples/llm-params.ts +69 -0
  57. package/examples/mcp-agent.ts +84 -0
  58. package/examples/mcp-gateway.ts +35 -0
  59. package/examples/multi-agent.ts +73 -0
  60. package/examples/multi-endpoint.ts +79 -0
  61. package/examples/pom-prompt.ts +71 -0
  62. package/examples/prefab-concierge.ts +47 -0
  63. package/examples/prefab-faq.ts +54 -0
  64. package/examples/prefab-info-gatherer.ts +33 -0
  65. package/examples/prefab-receptionist.ts +36 -0
  66. package/examples/prefab-survey.ts +68 -0
  67. package/examples/record-call.ts +67 -0
  68. package/examples/relay-demo.ts +33 -0
  69. package/examples/room-and-sip.ts +94 -0
  70. package/examples/serverless-lambda.ts +35 -0
  71. package/examples/session-state.ts +83 -0
  72. package/examples/simple-agent.ts +36 -0
  73. package/examples/simple-static.ts +29 -0
  74. package/examples/skills-demo.ts +38 -0
  75. package/examples/step-function-inheritance-demo.ts +124 -0
  76. package/examples/swaig-features.ts +187 -0
  77. package/examples/swml-service-routing.ts +66 -0
  78. package/examples/swml-service.ts +38 -0
  79. package/examples/tap.ts +68 -0
  80. package/examples/verb-methods.ts +45 -0
  81. package/examples/web-search-multi-instance.ts +72 -0
  82. package/examples/web-search.ts +38 -0
  83. package/examples/wikipedia.ts +36 -0
  84. package/livewire/README.md +140 -0
  85. package/livewire/docs/migration-guide.md +228 -0
  86. package/livewire/examples/livewire-basic-agent.ts +74 -0
  87. package/livewire/examples/livewire-handoff.ts +197 -0
  88. package/livewire/examples/livewire-multi-tool.ts +117 -0
  89. package/package.json +38 -0
  90. package/relay/README.md +70 -0
  91. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
  92. package/relay/docs/call-methods.md +474 -0
  93. package/relay/docs/client-reference.md +142 -0
  94. package/relay/docs/events.md +134 -0
  95. package/relay/docs/getting-started.md +134 -0
  96. package/relay/docs/guide.md +306 -0
  97. package/relay/docs/messaging.md +182 -0
  98. package/relay/examples/relay-inbound.ts +66 -0
  99. package/relay/examples/relay-messaging.ts +71 -0
  100. package/relay/examples/relay-outbound.ts +76 -0
  101. package/rest/README.md +95 -0
  102. package/rest/docs/calling.md +273 -0
  103. package/rest/docs/client-reference.md +107 -0
  104. package/rest/docs/compat.md +204 -0
  105. package/rest/docs/fabric.md +183 -0
  106. package/rest/docs/getting-started.md +110 -0
  107. package/rest/docs/guide.md +351 -0
  108. package/rest/docs/namespaces.md +285 -0
  109. package/rest/examples/rest-10dlc-registration.ts +161 -0
  110. package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
  111. package/rest/examples/rest-calling-play-and-record.ts +91 -0
  112. package/rest/examples/rest-client.ts +65 -0
  113. package/rest/examples/rest-compat-laml.ts +210 -0
  114. package/rest/examples/rest-datasphere-search.ts +82 -0
  115. package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
  116. package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
  117. package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
  118. package/rest/examples/rest-manage-resources.ts +65 -0
  119. package/rest/examples/rest-phone-number-management.ts +197 -0
  120. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  121. package/rest/examples/rest-video-rooms.ts +186 -0
  122. package/src/AgentBase.ts +2489 -0
  123. package/src/AgentServer.ts +415 -0
  124. package/src/AuthHandler.ts +256 -0
  125. package/src/ConfigLoader.ts +447 -0
  126. package/src/ContextBuilder.ts +1150 -0
  127. package/src/DataMap.ts +449 -0
  128. package/src/FunctionResult.ts +866 -0
  129. package/src/Logger.ts +337 -0
  130. package/src/PomBuilder.ts +439 -0
  131. package/src/PromptManager.ts +133 -0
  132. package/src/SWMLHandler.ts +298 -0
  133. package/src/SWMLService.ts +717 -0
  134. package/src/SchemaUtils.ts +361 -0
  135. package/src/SecurityUtils.ts +153 -0
  136. package/src/ServerlessAdapter.ts +221 -0
  137. package/src/SessionManager.ts +311 -0
  138. package/src/SslConfig.ts +118 -0
  139. package/src/SwaigFunction.ts +276 -0
  140. package/src/SwmlBuilder.ts +258 -0
  141. package/src/SwmlVerbMethods.generated.ts +234 -0
  142. package/src/TypeInference.ts +181 -0
  143. package/src/WebService.ts +619 -0
  144. package/src/cli/agent-loader.ts +166 -0
  145. package/src/cli/mock-data.ts +111 -0
  146. package/src/cli/swaig-test.ts +452 -0
  147. package/src/generateVerbTypes.ts +322 -0
  148. package/src/index.ts +167 -0
  149. package/src/livewire/index.ts +950 -0
  150. package/src/prefabs/ConciergeAgent.ts +287 -0
  151. package/src/prefabs/FAQBotAgent.ts +384 -0
  152. package/src/prefabs/InfoGathererAgent.ts +339 -0
  153. package/src/prefabs/ReceptionistAgent.ts +366 -0
  154. package/src/prefabs/SurveyAgent.ts +646 -0
  155. package/src/prefabs/index.ts +27 -0
  156. package/src/relay/Action.ts +314 -0
  157. package/src/relay/Call.ts +854 -0
  158. package/src/relay/Deferred.ts +71 -0
  159. package/src/relay/Message.ts +148 -0
  160. package/src/relay/RelayClient.ts +1036 -0
  161. package/src/relay/RelayError.ts +14 -0
  162. package/src/relay/RelayEvent.ts +892 -0
  163. package/src/relay/constants.ts +132 -0
  164. package/src/relay/index.ts +123 -0
  165. package/src/relay/types.ts +149 -0
  166. package/src/rest/HttpClient.ts +103 -0
  167. package/src/rest/RestError.ts +31 -0
  168. package/src/rest/base/BaseResource.ts +19 -0
  169. package/src/rest/base/CrudResource.ts +51 -0
  170. package/src/rest/base/CrudWithAddresses.ts +26 -0
  171. package/src/rest/index.ts +200 -0
  172. package/src/rest/namespaces/addresses.ts +32 -0
  173. package/src/rest/namespaces/calling.ts +187 -0
  174. package/src/rest/namespaces/chat.ts +20 -0
  175. package/src/rest/namespaces/compat.ts +352 -0
  176. package/src/rest/namespaces/datasphere.ts +45 -0
  177. package/src/rest/namespaces/fabric.ts +222 -0
  178. package/src/rest/namespaces/imported-numbers.ts +20 -0
  179. package/src/rest/namespaces/logs.ts +84 -0
  180. package/src/rest/namespaces/lookup.ts +21 -0
  181. package/src/rest/namespaces/mfa.ts +30 -0
  182. package/src/rest/namespaces/number-groups.ts +38 -0
  183. package/src/rest/namespaces/phone-numbers.ts +44 -0
  184. package/src/rest/namespaces/project.ts +36 -0
  185. package/src/rest/namespaces/pubsub.ts +20 -0
  186. package/src/rest/namespaces/queues.ts +33 -0
  187. package/src/rest/namespaces/recordings.ts +28 -0
  188. package/src/rest/namespaces/registry.ts +101 -0
  189. package/src/rest/namespaces/short-codes.ts +28 -0
  190. package/src/rest/namespaces/sip-profile.ts +25 -0
  191. package/src/rest/namespaces/verified-callers.ts +27 -0
  192. package/src/rest/namespaces/video.ts +165 -0
  193. package/src/rest/pagination.ts +84 -0
  194. package/src/rest/types.ts +61 -0
  195. package/src/schema.json +12250 -0
  196. package/src/skills/SkillBase.ts +547 -0
  197. package/src/skills/SkillManager.ts +415 -0
  198. package/src/skills/SkillRegistry.ts +367 -0
  199. package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
  200. package/src/skills/builtin/ask_claude.ts +241 -0
  201. package/src/skills/builtin/claude_skills.ts +978 -0
  202. package/src/skills/builtin/custom_skills.ts +312 -0
  203. package/src/skills/builtin/datasphere.ts +438 -0
  204. package/src/skills/builtin/datasphere_serverless.ts +339 -0
  205. package/src/skills/builtin/datetime.ts +130 -0
  206. package/src/skills/builtin/google_maps.ts +651 -0
  207. package/src/skills/builtin/index.ts +88 -0
  208. package/src/skills/builtin/info_gatherer.ts +405 -0
  209. package/src/skills/builtin/joke.ts +191 -0
  210. package/src/skills/builtin/math.ts +142 -0
  211. package/src/skills/builtin/mcp_gateway.ts +677 -0
  212. package/src/skills/builtin/native_vector_search.ts +901 -0
  213. package/src/skills/builtin/play_background_file.ts +358 -0
  214. package/src/skills/builtin/spider.ts +869 -0
  215. package/src/skills/builtin/swml_transfer.ts +635 -0
  216. package/src/skills/builtin/weather_api.ts +248 -0
  217. package/src/skills/builtin/web_search.ts +1074 -0
  218. package/src/skills/builtin/wikipedia_search.ts +299 -0
  219. package/src/skills/index.ts +12 -0
  220. package/src/types.ts +132 -0
  221. package/tests/AgentBase.test.ts +1093 -0
  222. package/tests/AgentServer.test.ts +126 -0
  223. package/tests/AuthHandler.test.ts +133 -0
  224. package/tests/ConfigLoader.test.ts +151 -0
  225. package/tests/ContextBuilder.test.ts +108 -0
  226. package/tests/DataMap.test.ts +367 -0
  227. package/tests/EphemeralSkillCopy.test.ts +107 -0
  228. package/tests/FunctionResult.test.ts +298 -0
  229. package/tests/GracefulShutdown.test.ts +46 -0
  230. package/tests/Logger.test.ts +420 -0
  231. package/tests/PomBuilder.test.ts +228 -0
  232. package/tests/ProxyDetection.test.ts +228 -0
  233. package/tests/SWMLService.test.ts +320 -0
  234. package/tests/SWMLVerbHandler.test.ts +523 -0
  235. package/tests/SchemaUtils.test.ts +106 -0
  236. package/tests/SchemaUtils.verb.test.ts +206 -0
  237. package/tests/SecurityUtils.test.ts +192 -0
  238. package/tests/ServerlessAdapter.test.ts +222 -0
  239. package/tests/SessionManager.test.ts +257 -0
  240. package/tests/SkillBaseFeatures.test.ts +130 -0
  241. package/tests/SkillMultiInstance.test.ts +102 -0
  242. package/tests/SkillParameterSchemas.test.ts +134 -0
  243. package/tests/SkillRegistrySchema.test.ts +84 -0
  244. package/tests/SslConfig.test.ts +97 -0
  245. package/tests/SwmlBuilder.test.ts +400 -0
  246. package/tests/TypeInference.test.ts +165 -0
  247. package/tests/VerbHandlerRegistry.test.ts +128 -0
  248. package/tests/cli/mock-data.test.ts +113 -0
  249. package/tests/cli/swaig-test.test.ts +108 -0
  250. package/tests/examples.test.ts +194 -0
  251. package/tests/fixtures/scrape-parity/README.md +53 -0
  252. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
  253. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
  254. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
  255. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
  256. package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
  257. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
  258. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
  259. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
  260. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
  261. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
  262. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
  263. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
  264. package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
  265. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
  266. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
  267. package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
  268. package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
  269. package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
  270. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
  271. package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
  272. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
  273. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
  274. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
  275. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
  276. package/tests/fixtures/scrape-parity/python_extract.py +109 -0
  277. package/tests/livewire/livewire.test.ts +780 -0
  278. package/tests/mcp.test.ts +221 -0
  279. package/tests/prefabs/prefabs.test.ts +1093 -0
  280. package/tests/relay/Action.test.ts +392 -0
  281. package/tests/relay/Call.test.ts +535 -0
  282. package/tests/relay/Deferred.test.ts +71 -0
  283. package/tests/relay/Message.test.ts +164 -0
  284. package/tests/relay/RelayClient.test.ts +779 -0
  285. package/tests/relay/RelayEvent.test.ts +463 -0
  286. package/tests/relay/helpers.ts +79 -0
  287. package/tests/rest/HttpClient.test.ts +274 -0
  288. package/tests/rest/RestError.test.ts +53 -0
  289. package/tests/rest/calling.test.ts +156 -0
  290. package/tests/rest/client.test.ts +197 -0
  291. package/tests/rest/compat.test.ts +335 -0
  292. package/tests/rest/datasphere.test.ts +71 -0
  293. package/tests/rest/fabric.test.ts +186 -0
  294. package/tests/rest/helpers.ts +95 -0
  295. package/tests/rest/logs.test.ts +68 -0
  296. package/tests/rest/pagination.test.ts +133 -0
  297. package/tests/rest/registry.test.ts +94 -0
  298. package/tests/rest/relay-rest.test.ts +290 -0
  299. package/tests/rest/video.test.ts +173 -0
  300. package/tests/setup.ts +6 -0
  301. package/tests/skills/SkillBase.test.ts +108 -0
  302. package/tests/skills/SkillManager.test.ts +268 -0
  303. package/tests/skills/SkillRegistry.test.ts +176 -0
  304. package/tests/skills/builtin.test.ts +1472 -0
  305. package/tests/skills/claude-skills.test.ts +54 -0
  306. package/tests/skills/custom-skills.test.ts +53 -0
  307. package/tests/skills/datasphere-serverless.test.ts +70 -0
  308. package/tests/skills/datasphere.test.ts +107 -0
  309. package/tests/skills/datetime.test.ts +101 -0
  310. package/tests/skills/google-maps.test.ts +78 -0
  311. package/tests/skills/info-gatherer.test.ts +411 -0
  312. package/tests/skills/joke.test.ts +81 -0
  313. package/tests/skills/math.test.ts +68 -0
  314. package/tests/skills/mcp-gateway.test.ts +101 -0
  315. package/tests/skills/play-background.test.ts +54 -0
  316. package/tests/skills/spider.test.ts +108 -0
  317. package/tests/skills/swml-transfer.test.ts +178 -0
  318. package/tests/skills/trivia.test.ts +54 -0
  319. package/tests/skills/vector-search.test.ts +135 -0
  320. package/tests/skills/weather-api.test.ts +77 -0
  321. package/tests/skills/web-search-parity.test.ts +59 -0
  322. package/tests/skills/web-search.test.ts +103 -0
  323. package/tests/skills/wikipedia.test.ts +63 -0
  324. package/tsconfig.json +18 -0
  325. package/vitest.config.ts +9 -0
@@ -0,0 +1,273 @@
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 |
@@ -0,0 +1,107 @@
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.
@@ -0,0 +1,204 @@
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
+ ```