@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,285 @@
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
+ ```
@@ -0,0 +1,161 @@
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
+ });
@@ -0,0 +1,102 @@
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
+ });
@@ -0,0 +1,91 @@
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
+ });
@@ -0,0 +1,65 @@
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
+ });