@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,182 @@
1
+ # Messaging
2
+
3
+ Send and receive SMS/MMS messages through the RELAY client.
4
+
5
+ ## Sending Messages
6
+
7
+ Use `client.send_message()` to send an outbound SMS or MMS.
8
+
9
+ ```python
10
+ message = await client.send_message(
11
+ to_number="+15552222222",
12
+ from_number="+15551111111",
13
+ body="Hello from SignalWire!",
14
+ )
15
+ ```
16
+
17
+ ### Wait for delivery
18
+
19
+ ```python
20
+ message = await client.send_message(
21
+ to_number="+15552222222",
22
+ from_number="+15551111111",
23
+ body="Hello!",
24
+ )
25
+ event = await message.wait() # blocks until delivered/failed
26
+ print(f"Final state: {message.state}")
27
+ if message.reason:
28
+ print(f"Reason: {message.reason}")
29
+ ```
30
+
31
+ ### Fire and forget
32
+
33
+ ```python
34
+ message = await client.send_message(
35
+ to_number="+15552222222",
36
+ from_number="+15551111111",
37
+ body="Hello!",
38
+ )
39
+ # don't call message.wait() — continue immediately
40
+ ```
41
+
42
+ ### Callback on completion
43
+
44
+ ```python
45
+ message = await client.send_message(
46
+ to_number="+15552222222",
47
+ from_number="+15551111111",
48
+ body="Hello!",
49
+ on_completed=lambda event: print(f"Delivery: {event.params.get('message_state')}"),
50
+ )
51
+ ```
52
+
53
+ ### MMS (media messages)
54
+
55
+ ```python
56
+ message = await client.send_message(
57
+ to_number="+15552222222",
58
+ from_number="+15551111111",
59
+ body="Check this out!",
60
+ media=["https://example.com/image.jpg"],
61
+ )
62
+ ```
63
+
64
+ ### All parameters
65
+
66
+ ```python
67
+ message = await client.send_message(
68
+ to_number="+15552222222", # required — E.164 format
69
+ from_number="+15551111111", # required — E.164 format
70
+ body="Message text", # required if no media
71
+ media=["https://..."], # required if no body
72
+ context="my_context", # context for state events (default: relay protocol)
73
+ tags=["vip", "support"], # optional tags for searching in UI
74
+ region="us", # optional origination region
75
+ on_completed=callback_fn, # optional completion callback
76
+ )
77
+ ```
78
+
79
+ ## Receiving Messages
80
+
81
+ Register a handler with `@client.on_message` to receive inbound SMS/MMS.
82
+
83
+ ```python
84
+ from signalwire_agents.relay import RelayClient
85
+
86
+ client = RelayClient(
87
+ project="your-project-id",
88
+ token="your-api-token",
89
+ host="example.signalwire.com",
90
+ contexts=["default"],
91
+ )
92
+
93
+ @client.on_message
94
+ async def handle_message(message):
95
+ print(f"From: {message.from_number}")
96
+ print(f"To: {message.to_number}")
97
+ print(f"Body: {message.body}")
98
+ if message.media:
99
+ print(f"Media: {message.media}")
100
+
101
+ # Reply back
102
+ await client.send_message(
103
+ to_number=message.from_number,
104
+ from_number=message.to_number,
105
+ body=f"You said: {message.body}",
106
+ )
107
+
108
+ client.run()
109
+ ```
110
+
111
+ ## Message Object
112
+
113
+ ### Properties
114
+
115
+ | Property | Type | Description |
116
+ |----------|------|-------------|
117
+ | `message_id` | `str` | Unique message identifier |
118
+ | `context` | `str` | Context the message belongs to |
119
+ | `direction` | `str` | `inbound` or `outbound` |
120
+ | `from_number` | `str` | Sender phone number (E.164) |
121
+ | `to_number` | `str` | Recipient phone number (E.164) |
122
+ | `body` | `str` | Text body of the message |
123
+ | `media` | `list[str]` | Media URLs (MMS) |
124
+ | `segments` | `int` | Number of message segments |
125
+ | `state` | `str` | Current message state |
126
+ | `reason` | `str` | Failure reason (on `undelivered` or `failed`) |
127
+ | `tags` | `list[str]` | Tags attached to the message |
128
+ | `is_done` | `bool` | `True` if message reached a terminal state |
129
+ | `result` | `RelayEvent` | Terminal event (or `None` if not done) |
130
+
131
+ ### Methods
132
+
133
+ | Method | Description |
134
+ |--------|-------------|
135
+ | `await message.wait(timeout=None)` | Block until terminal state. Returns the terminal `RelayEvent`. |
136
+ | `message.on(handler)` | Register a listener for state change events. |
137
+
138
+ ### Message States
139
+
140
+ Outbound messages progress through these states:
141
+
142
+ | State | Description |
143
+ |-------|-------------|
144
+ | `queued` | Message accepted and queued for sending |
145
+ | `initiated` | Sending has started |
146
+ | `sent` | Message sent to carrier |
147
+ | `delivered` | Message delivered to recipient (terminal) |
148
+ | `undelivered` | Delivery failed (terminal) — check `reason` |
149
+ | `failed` | Message failed to send (terminal) — check `reason` |
150
+
151
+ Inbound messages always arrive with state `received`.
152
+
153
+ ## Event Types
154
+
155
+ | Event | Description |
156
+ |-------|-------------|
157
+ | `MessageReceiveEvent` | Inbound message received |
158
+ | `MessageStateEvent` | Outbound message state change |
159
+
160
+ ```python
161
+ from signalwire_agents.relay import MessageReceiveEvent, MessageStateEvent
162
+ ```
163
+
164
+ ## Combining Calls and Messages
165
+
166
+ The same `RelayClient` handles both calls and messages:
167
+
168
+ ```python
169
+ client = RelayClient(project="...", token="...", contexts=["default"])
170
+
171
+ @client.on_call
172
+ async def handle_call(call):
173
+ await call.answer()
174
+ await call.play([{"type": "tts", "params": {"text": "Hello!"}}])
175
+ await call.hangup()
176
+
177
+ @client.on_message
178
+ async def handle_message(message):
179
+ print(f"SMS from {message.from_number}: {message.body}")
180
+
181
+ client.run()
182
+ ```
@@ -0,0 +1,66 @@
1
+ /**
2
+ * RELAY Inbound Call Example
3
+ *
4
+ * Answers inbound calls, plays a TTS greeting, collects digits, and hangs up.
5
+ *
6
+ * Required env vars:
7
+ * SIGNALWIRE_PROJECT_ID - Your SignalWire project ID
8
+ * SIGNALWIRE_API_TOKEN - Your SignalWire API token
9
+ * SIGNALWIRE_SPACE - Your SignalWire space (e.g. example.signalwire.com)
10
+ *
11
+ * Usage:
12
+ * npx tsx relay/examples/relay-inbound.ts
13
+ */
14
+
15
+ import { RelayClient, Call, CALL_STATE_ENDED } from '../../src/relay/index.js';
16
+
17
+ const client = new RelayClient({
18
+ contexts: ['office'],
19
+ });
20
+
21
+ client.onCall(async (call: Call) => {
22
+ console.log(`Inbound call from ${JSON.stringify(call.device)}`);
23
+
24
+ // Answer the call
25
+ await call.answer();
26
+ console.log('Call answered');
27
+
28
+ // Play a greeting
29
+ const playAction = await call.play([
30
+ { type: 'tts', text: 'Hello! Welcome to the SignalWire RELAY demo.' },
31
+ ]);
32
+ await playAction.wait();
33
+ console.log('Greeting played');
34
+
35
+ // Collect digits
36
+ const collectAction = await call.playAndCollect(
37
+ [{ type: 'tts', text: 'Please enter your 4-digit PIN followed by the pound sign.' }],
38
+ {
39
+ digits: { max: 4, terminators: '#', digit_timeout: 5 },
40
+ initial_timeout: 10,
41
+ },
42
+ );
43
+
44
+ const collectEvent = await collectAction.wait();
45
+ const result = collectEvent.params.result as Record<string, unknown> | undefined;
46
+ if (result) {
47
+ const digitParams = result.params as Record<string, unknown> | undefined;
48
+ console.log(`Collected digits: ${digitParams?.digits ?? 'none'}`);
49
+
50
+ await (await call.play([
51
+ { type: 'tts', text: `You entered ${digitParams?.digits ?? 'nothing'}. Thank you!` },
52
+ ])).wait();
53
+ } else {
54
+ await (await call.play([
55
+ { type: 'tts', text: 'No input received. Goodbye!' },
56
+ ])).wait();
57
+ }
58
+
59
+ // Hang up
60
+ await call.hangup();
61
+ console.log('Call ended');
62
+ });
63
+
64
+ console.log('Starting RELAY inbound call handler...');
65
+ console.log('Listening on context: office');
66
+ client.run();
@@ -0,0 +1,71 @@
1
+ /**
2
+ * RELAY Messaging Example
3
+ *
4
+ * Sends an outbound SMS and listens for inbound messages.
5
+ *
6
+ * Required env vars:
7
+ * SIGNALWIRE_PROJECT_ID - Your SignalWire project ID
8
+ * SIGNALWIRE_API_TOKEN - Your SignalWire API token
9
+ * SIGNALWIRE_SPACE - Your SignalWire space (e.g. example.signalwire.com)
10
+ * MSG_TO - Destination number in E.164 format
11
+ * MSG_FROM - Sender number in E.164 format (must be owned by your project)
12
+ *
13
+ * Usage:
14
+ * MSG_TO=+15551234567 MSG_FROM=+15559876543 npx tsx relay/examples/relay-messaging.ts
15
+ */
16
+
17
+ import { RelayClient, Message } from '../../src/relay/index.js';
18
+
19
+ const to = process.env.MSG_TO;
20
+ const from = process.env.MSG_FROM;
21
+
22
+ if (!to || !from) {
23
+ console.error('Set MSG_TO and MSG_FROM env vars');
24
+ process.exit(1);
25
+ }
26
+
27
+ const client = new RelayClient({
28
+ contexts: ['messaging'],
29
+ });
30
+
31
+ // Handle inbound messages
32
+ client.onMessage(async (message: Message) => {
33
+ console.log(`Inbound message from ${message.fromNumber}: ${message.body}`);
34
+ console.log(` media: ${message.media.length > 0 ? message.media.join(', ') : 'none'}`);
35
+ });
36
+
37
+ async function sendAndWait() {
38
+ await client.connect();
39
+ console.log('Connected to RELAY');
40
+
41
+ // Send outbound SMS
42
+ console.log(`Sending SMS to ${to}...`);
43
+ const message = await client.sendMessage({
44
+ toNumber: to,
45
+ fromNumber: from,
46
+ body: 'Hello from SignalWire RELAY TypeScript SDK!',
47
+ });
48
+ console.log(`Message queued: id=${message.messageId}`);
49
+
50
+ // Track delivery
51
+ message.on(async (event) => {
52
+ console.log(`Message state: ${event.params.message_state}`);
53
+ });
54
+
55
+ try {
56
+ const terminalEvent = await message.wait(30_000);
57
+ console.log(`Final state: ${message.state}`);
58
+ if (message.reason) {
59
+ console.log(`Reason: ${message.reason}`);
60
+ }
61
+ } catch (err) {
62
+ console.error(`Message tracking error: ${err}`);
63
+ }
64
+
65
+ console.log('Now listening for inbound messages... (Ctrl+C to stop)');
66
+ }
67
+
68
+ sendAndWait().catch(console.error);
69
+
70
+ // Keep running to receive inbound messages
71
+ client.run();
@@ -0,0 +1,76 @@
1
+ /**
2
+ * RELAY Outbound Call Example
3
+ *
4
+ * Dials an outbound call, detects answering machine, and plays a message.
5
+ *
6
+ * Required env vars:
7
+ * SIGNALWIRE_PROJECT_ID - Your SignalWire project ID
8
+ * SIGNALWIRE_API_TOKEN - Your SignalWire API token
9
+ * SIGNALWIRE_SPACE - Your SignalWire space (e.g. example.signalwire.com)
10
+ * DIAL_TO - Destination number in E.164 format
11
+ * DIAL_FROM - Caller ID number in E.164 format
12
+ *
13
+ * Usage:
14
+ * DIAL_TO=+15551234567 DIAL_FROM=+15559876543 npx tsx relay/examples/relay-outbound.ts
15
+ */
16
+
17
+ import { RelayClient, RelayError } from '../../src/relay/index.js';
18
+
19
+ const to = process.env.DIAL_TO;
20
+ const from = process.env.DIAL_FROM;
21
+
22
+ if (!to || !from) {
23
+ console.error('Set DIAL_TO and DIAL_FROM env vars');
24
+ process.exit(1);
25
+ }
26
+
27
+ async function main() {
28
+ const client = new RelayClient({ contexts: ['default'] });
29
+
30
+ try {
31
+ await client.connect();
32
+ console.log('Connected to RELAY');
33
+
34
+ // Dial outbound
35
+ console.log(`Dialing ${to} from ${from}...`);
36
+ const call = await client.dial(
37
+ [[{ type: 'phone', to, from }]],
38
+ { dialTimeout: 30_000 },
39
+ );
40
+ console.log(`Call answered! call_id=${call.callId}`);
41
+
42
+ // Detect answering machine
43
+ const detectAction = await call.detect(
44
+ { type: 'machine', params: { initial_timeout: 5 } },
45
+ { timeout: 10 },
46
+ );
47
+
48
+ const detectEvent = await detectAction.wait(15_000);
49
+ const detect = detectEvent.params.detect as Record<string, unknown> | undefined;
50
+ const machineEvent = (detect?.params as Record<string, unknown>)?.event ?? 'unknown';
51
+ console.log(`Detection result: ${machineEvent}`);
52
+
53
+ // Play message
54
+ const playAction = await call.play([
55
+ { type: 'tts', text: 'This is an automated message from SignalWire. Have a great day!' },
56
+ ]);
57
+ await playAction.wait();
58
+ console.log('Message played');
59
+
60
+ // Hang up
61
+ await call.hangup();
62
+ console.log('Call ended');
63
+
64
+ await client.disconnect();
65
+ } catch (err) {
66
+ if (err instanceof RelayError) {
67
+ console.error(`RELAY error: ${err.message} (code=${err.code})`);
68
+ } else {
69
+ console.error(`Error: ${err}`);
70
+ }
71
+ await client.disconnect();
72
+ process.exit(1);
73
+ }
74
+ }
75
+
76
+ main();
package/rest/README.md ADDED
@@ -0,0 +1,95 @@
1
+ # SignalWire REST Client
2
+
3
+ Typed HTTP client for managing SignalWire resources, controlling live calls, and interacting with every SignalWire API surface from TypeScript. No WebSocket required — just standard HTTP requests with `fetch`.
4
+
5
+ ## Quick Start
6
+
7
+ ```typescript
8
+ import { RestClient } from '@signalwire/sdk';
9
+
10
+ const client = new RestClient({
11
+ project: 'your-project-id',
12
+ token: 'your-api-token',
13
+ host: 'example.signalwire.com',
14
+ });
15
+
16
+ // Create an AI agent
17
+ const agent = await client.fabric.aiAgents.create({
18
+ name: 'Support Bot',
19
+ prompt: { text: 'You are a helpful support agent.' },
20
+ });
21
+
22
+ // Search for a phone number
23
+ const results = await client.phoneNumbers.search({ area_code: '512' });
24
+
25
+ // Place a call via REST
26
+ await client.calling.dial({
27
+ from: '+15559876543',
28
+ to: '+15551234567',
29
+ url: 'https://example.com/call-handler',
30
+ });
31
+ ```
32
+
33
+ ## Features
34
+
35
+ - Single `RestClient` with namespaced sub-objects for every API
36
+ - All 37 calling commands: dial, play, record, collect, detect, tap, stream, AI, transcribe, and more
37
+ - Full Fabric API: 17 resource types with CRUD + addresses, tokens, and generic resources
38
+ - Datasphere: document management and semantic search
39
+ - Video: rooms, sessions, recordings, conferences, tokens, streams
40
+ - Compatibility API: full Twilio-compatible LAML surface
41
+ - Phone number management, 10DLC registry, MFA, logs, and more
42
+ - Zero dependencies — uses built-in `fetch` (Node 18+)
43
+ - Injectable `fetchImpl` for testing
44
+
45
+ ## Documentation
46
+
47
+ - [Getting Started](docs/guide.md) — installation, configuration, namespaces, pagination, error handling
48
+
49
+ ## Examples
50
+
51
+ - [rest-client.ts](examples/rest-client.ts) — overview: list numbers, agents, rooms, documents, logs
52
+ - [rest-manage-resources.ts](examples/rest-manage-resources.ts) — create an AI agent, assign a number, place a call
53
+ - [rest-datasphere-search.ts](examples/rest-datasphere-search.ts) — upload a document, semantic search
54
+ - [rest-calling-play-and-record.ts](examples/rest-calling-play-and-record.ts) — play, record, transcribe, denoise
55
+ - [rest-calling-ivr-and-ai.ts](examples/rest-calling-ivr-and-ai.ts) — IVR, detect, AI, tap, stream, SIP refer
56
+ - [rest-compat-laml.ts](examples/rest-compat-laml.ts) — Twilio-compatible LAML migration
57
+ - [rest-fabric-swml-and-callflows.ts](examples/rest-fabric-swml-and-callflows.ts) — SWML scripts, call flows, webhooks
58
+ - [rest-fabric-subscribers-and-sip.ts](examples/rest-fabric-subscribers-and-sip.ts) — subscribers, SIP endpoints, gateways
59
+ - [rest-fabric-conferences-and-routing.ts](examples/rest-fabric-conferences-and-routing.ts) — conferences, cXML, routing, tokens
60
+ - [rest-phone-number-management.ts](examples/rest-phone-number-management.ts) — search, purchase, groups, lookup, verified callers
61
+ - [rest-queues-mfa-and-recordings.ts](examples/rest-queues-mfa-and-recordings.ts) — queues, recordings, MFA
62
+ - [rest-video-rooms.ts](examples/rest-video-rooms.ts) — video rooms, sessions, conferences, streams
63
+ - [rest-10dlc-registration.ts](examples/rest-10dlc-registration.ts) — 10DLC brand and campaign registration
64
+
65
+ ## Environment Variables
66
+
67
+ | Variable | Description |
68
+ |----------|-------------|
69
+ | `SIGNALWIRE_PROJECT_ID` | Project ID for authentication |
70
+ | `SIGNALWIRE_API_TOKEN` | API token for authentication |
71
+ | `SIGNALWIRE_SPACE` | Space hostname (e.g. `example.signalwire.com`) |
72
+ | `SIGNALWIRE_LOG_LEVEL` | Log level (`debug` for HTTP request details) |
73
+
74
+ ## Module Structure
75
+
76
+ ```
77
+ src/rest/
78
+ index.ts # RestClient + public exports
79
+ HttpClient.ts # fetch-based HTTP with Basic Auth
80
+ RestError.ts # Error class: statusCode, body, url, method
81
+ pagination.ts # paginate<T>() async generator + paginateAll()
82
+ types.ts # ClientOptions, PaginatedResponse, QueryParams
83
+ base/
84
+ BaseResource.ts # Abstract base with _http + _path()
85
+ CrudResource.ts # list/create/get/update/delete with generics
86
+ CrudWithAddresses.ts # CrudResource + listAddresses()
87
+ namespaces/
88
+ fabric.ts # 17 resource types + generic resources + addresses + tokens
89
+ calling.ts # 37 command dispatch methods via single POST
90
+ phone-numbers.ts # Search, purchase, update, release
91
+ compat.ts # Twilio-compatible LAML API (12 sub-resources)
92
+ video.ts # Rooms, sessions, recordings, conferences, streams
93
+ datasphere.ts # Documents, search, chunks
94
+ ... and 15 more
95
+ ```