@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,210 @@
1
+ /**
2
+ * REST Example: Twilio-compatible LAML migration -- phone numbers, messaging,
3
+ * calls, conferences, queues, recordings, project tokens, PubSub/Chat, and logs.
4
+ *
5
+ * Prerequisites:
6
+ * export SIGNALWIRE_PROJECT_ID=your-project-id
7
+ * export SIGNALWIRE_API_TOKEN=your-api-token
8
+ * export SIGNALWIRE_SPACE=your-space.signalwire.com
9
+ *
10
+ * Run:
11
+ * npx tsx rest/examples/rest-compat-laml.ts
12
+ */
13
+
14
+ import { RestClient, RestError } from '../../src/index.js';
15
+
16
+ const client = new RestClient();
17
+
18
+ async function safe(label: string, fn: () => Promise<unknown>): Promise<unknown> {
19
+ try {
20
+ const result = await fn();
21
+ console.log(` ${label}: OK`);
22
+ return result;
23
+ } catch (err) {
24
+ if (err instanceof RestError) {
25
+ console.log(` ${label}: failed (${err.statusCode})`);
26
+ } else throw err;
27
+ return null;
28
+ }
29
+ }
30
+
31
+ async function main() {
32
+ // --- Compat Phone Numbers ---
33
+
34
+ // 1. Search available numbers
35
+ console.log('Searching compat phone numbers...');
36
+ await safe('Search local', () => client.compat.phoneNumbers.searchLocal('US', { AreaCode: '512' }));
37
+ await safe('Search toll-free', () => client.compat.phoneNumbers.searchTollFree('US'));
38
+ await safe('List countries', () => client.compat.phoneNumbers.listAvailableCountries());
39
+
40
+ // 2. Purchase a number (demo -- will fail without valid number)
41
+ console.log('\nPurchasing compat number...');
42
+ const num: any = await safe('Purchase', () => client.compat.phoneNumbers.purchase({ PhoneNumber: '+15125551234' }));
43
+ const numSid = num?.sid ?? null;
44
+
45
+ // --- LaML Bin & Application ---
46
+
47
+ // 3. Create a LaML bin and application
48
+ console.log('\nCreating LaML resources...');
49
+ const laml: any = await safe('LaML bin', () => client.compat.lamlBins.create({
50
+ Name: 'Hold Music',
51
+ Contents: '<Response><Say>Please hold.</Say></Response>',
52
+ }));
53
+ const lamlSid = laml?.sid ?? null;
54
+
55
+ const app: any = await safe('Application', () => client.compat.applications.create({
56
+ FriendlyName: 'Demo App',
57
+ VoiceUrl: 'https://example.com/voice',
58
+ }));
59
+ const appSid = app?.sid ?? null;
60
+
61
+ // --- Messaging ---
62
+
63
+ // 4. Send an SMS (demo -- requires valid numbers)
64
+ console.log('\nMessaging operations...');
65
+ const msg: any = await safe('Send SMS', () => client.compat.messages.create({
66
+ From: '+15559876543', To: '+15551234567', Body: 'Hello from SignalWire!',
67
+ }));
68
+ const msgSid = msg?.sid ?? null;
69
+
70
+ // 5. List and get messages
71
+ await safe('List messages', () => client.compat.messages.list());
72
+ if (msgSid) {
73
+ await safe('Get message', () => client.compat.messages.get(msgSid));
74
+ await safe('List media', () => client.compat.messages.listMedia(msgSid));
75
+ }
76
+
77
+ // --- Calls ---
78
+
79
+ // 6. Outbound call with recording and streaming
80
+ console.log('\nCall operations...');
81
+ const call: any = await safe('Create call', () => client.compat.calls.create({
82
+ From: '+15559876543', To: '+15551234567',
83
+ Url: 'https://example.com/voice-handler',
84
+ }));
85
+ const callSid = call?.sid ?? null;
86
+
87
+ if (callSid) {
88
+ await safe('Start recording', () => client.compat.calls.startRecording(callSid));
89
+ await safe('Start stream', () => client.compat.calls.startStream(callSid, { Url: 'wss://example.com/stream' }));
90
+ }
91
+
92
+ // --- Conferences ---
93
+
94
+ // 7. Conference operations
95
+ console.log('\nConference operations...');
96
+ const confs: any = await safe('List conferences', () => client.compat.conferences.list());
97
+ const confSid = confs?.data?.[0]?.sid ?? null;
98
+
99
+ if (confSid) {
100
+ await safe('Get conference', () => client.compat.conferences.get(confSid));
101
+ await safe('List participants', () => client.compat.conferences.listParticipants(confSid));
102
+ await safe('List conf recordings', () => client.compat.conferences.listRecordings(confSid));
103
+ }
104
+
105
+ // --- Queues ---
106
+
107
+ // 8. Queue operations
108
+ console.log('\nQueue operations...');
109
+ const queue: any = await safe('Create queue', () => client.compat.queues.create({ FriendlyName: 'compat-support-queue' }));
110
+ const qSid = queue?.sid ?? null;
111
+
112
+ if (qSid) {
113
+ await safe('List queue members', () => client.compat.queues.listMembers(qSid));
114
+ }
115
+
116
+ // --- Recordings & Transcriptions ---
117
+
118
+ // 9. Recordings and transcriptions
119
+ console.log('\nRecordings and transcriptions...');
120
+ const recs: any = await safe('List recordings', () => client.compat.recordings.list());
121
+ const firstRecSid = recs?.data?.[0]?.sid ?? null;
122
+ if (firstRecSid) {
123
+ await safe('Get recording', () => client.compat.recordings.get(firstRecSid));
124
+ }
125
+
126
+ const trans: any = await safe('List transcriptions', () => client.compat.transcriptions.list());
127
+ const firstTransSid = trans?.data?.[0]?.sid ?? null;
128
+ if (firstTransSid) {
129
+ await safe('Get transcription', () => client.compat.transcriptions.get(firstTransSid));
130
+ }
131
+
132
+ // --- Faxes ---
133
+
134
+ // 10. Fax operations
135
+ console.log('\nFax operations...');
136
+ const fax: any = await safe('Create fax', () => client.compat.faxes.create({
137
+ From: '+15559876543', To: '+15551234567',
138
+ MediaUrl: 'https://example.com/document.pdf',
139
+ }));
140
+ const faxSid = fax?.sid ?? null;
141
+ if (faxSid) {
142
+ await safe('Get fax', () => client.compat.faxes.get(faxSid));
143
+ }
144
+
145
+ // --- Compat Accounts & Tokens ---
146
+
147
+ // 11. Accounts and compat tokens
148
+ console.log('\nAccounts and compat tokens...');
149
+ await safe('List accounts', () => client.compat.accounts.list());
150
+ const compatToken: any = await safe('Create compat token', () => client.compat.tokens.create({ name: 'demo-token' }));
151
+ if (compatToken?.id) {
152
+ await safe('Delete compat token', () => client.compat.tokens.delete(compatToken.id));
153
+ }
154
+
155
+ // --- Project Tokens ---
156
+
157
+ // 12. Project token management
158
+ console.log('\nProject tokens...');
159
+ const projToken: any = await safe('Create project token', () => client.project.tokens.create({
160
+ name: 'CI Token',
161
+ permissions: ['calling', 'messaging', 'video'],
162
+ }));
163
+ if (projToken?.id) {
164
+ await safe('Update project token', () => client.project.tokens.update(projToken.id, { name: 'CI Token (updated)' }));
165
+ await safe('Delete project token', () => client.project.tokens.delete(projToken.id));
166
+ }
167
+
168
+ // --- PubSub & Chat Tokens ---
169
+
170
+ // 13. PubSub and Chat tokens
171
+ console.log('\nPubSub and Chat tokens...');
172
+ await safe('PubSub token', () => client.pubsub.createToken({
173
+ channels: { notifications: { read: true, write: true } },
174
+ ttl: 3600,
175
+ }));
176
+ await safe('Chat token', () => client.chat.createToken({
177
+ member_id: 'user-alice',
178
+ channels: { general: { read: true, write: true } },
179
+ ttl: 3600,
180
+ }));
181
+
182
+ // --- Logs ---
183
+
184
+ // 14. Log queries
185
+ console.log('\nQuerying logs...');
186
+ await safe('Message logs', () => client.logs.messages.list());
187
+ await safe('Voice logs', () => client.logs.voice.list());
188
+ await safe('Fax logs', () => client.logs.fax.list());
189
+ await safe('Conference logs', () => client.logs.conferences.list());
190
+
191
+ const voiceLogs: any = await safe('Voice log list', () => client.logs.voice.list()) ?? {};
192
+ const firstVoice = (voiceLogs?.data ?? [{}])[0];
193
+ if (firstVoice?.id) {
194
+ await safe('Voice log detail', () => client.logs.voice.get(firstVoice.id));
195
+ await safe('Voice log events', () => client.logs.voice.listEvents(firstVoice.id));
196
+ }
197
+
198
+ // --- Clean up ---
199
+
200
+ console.log('\nCleaning up...');
201
+ if (qSid) await safe('Delete queue', () => client.compat.queues.delete(qSid));
202
+ if (appSid) await safe('Delete application', () => client.compat.applications.delete(appSid));
203
+ if (lamlSid) await safe('Delete LaML bin', () => client.compat.lamlBins.delete(lamlSid));
204
+ if (numSid) await safe('Delete number', () => client.compat.phoneNumbers.delete(numSid));
205
+ }
206
+
207
+ main().catch(err => {
208
+ console.error('Error:', err.message);
209
+ process.exit(1);
210
+ });
@@ -0,0 +1,82 @@
1
+ /**
2
+ * REST Example: Upload a document to Datasphere and run a semantic search.
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-datasphere-search.ts
11
+ */
12
+
13
+ import { RestClient } from '../../src/index.js';
14
+
15
+ const client = new RestClient();
16
+
17
+ function sleep(ms: number): Promise<void> {
18
+ return new Promise(resolve => setTimeout(resolve, ms));
19
+ }
20
+
21
+ async function main() {
22
+ // 1. Upload a document
23
+ console.log('Uploading document to Datasphere...');
24
+ const doc = await client.datasphere.documents.create({
25
+ url: 'https://filesamples.com/samples/document/txt/sample3.txt',
26
+ tags: ['support', 'demo'],
27
+ });
28
+ const docId = doc.id;
29
+ console.log(` Document created: ${docId} (status: ${doc.status})`);
30
+
31
+ // 2. Wait for vectorization to complete
32
+ console.log('\nWaiting for document to be vectorized...');
33
+ let vectorized = false;
34
+ for (let i = 0; i < 30; i++) {
35
+ await sleep(2000);
36
+ const docStatus = await client.datasphere.documents.get(docId);
37
+ const status = docStatus.status ?? 'unknown';
38
+ console.log(` Poll ${i + 1}: status=${status}`);
39
+ if (status === 'completed') {
40
+ console.log(` Vectorized! Chunks: ${docStatus.number_of_chunks ?? 0}`);
41
+ vectorized = true;
42
+ break;
43
+ }
44
+ if (status === 'error' || status === 'failed') {
45
+ console.log(` Document processing failed: ${status}`);
46
+ await client.datasphere.documents.delete(docId);
47
+ return;
48
+ }
49
+ }
50
+ if (!vectorized) {
51
+ console.log(' Timed out waiting for vectorization.');
52
+ await client.datasphere.documents.delete(docId);
53
+ return;
54
+ }
55
+
56
+ // 3. List chunks
57
+ console.log(`\nListing chunks for document ${docId}...`);
58
+ const chunks = await client.datasphere.documents.listChunks(docId);
59
+ for (const chunk of (chunks.data ?? []).slice(0, 5)) {
60
+ console.log(` - Chunk ${chunk.id}: ${(chunk.content ?? '').slice(0, 80)}...`);
61
+ }
62
+
63
+ // 4. Semantic search across all documents
64
+ console.log('\nSearching Datasphere...');
65
+ const results = await client.datasphere.documents.search({
66
+ query_string: 'lorem ipsum dolor sit amet',
67
+ count: 3,
68
+ });
69
+ for (const chunk of results.chunks ?? []) {
70
+ console.log(` - ${(chunk.text ?? '').slice(0, 100)}...`);
71
+ }
72
+
73
+ // 5. Clean up
74
+ console.log(`\nDeleting document ${docId}...`);
75
+ await client.datasphere.documents.delete(docId);
76
+ console.log(' Deleted.');
77
+ }
78
+
79
+ main().catch(err => {
80
+ console.error('Error:', err.message);
81
+ process.exit(1);
82
+ });
@@ -0,0 +1,144 @@
1
+ /**
2
+ * REST Example: Conference infrastructure, cXML resources, generic routing, and tokens.
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-fabric-conferences-and-routing.ts
11
+ */
12
+
13
+ import { RestClient, RestError } from '../../src/index.js';
14
+
15
+ const client = new RestClient();
16
+
17
+ async function main() {
18
+ // 1. Create a conference room
19
+ console.log('Creating conference room...');
20
+ const room = await client.fabric.conferenceRooms.create({ name: 'team-standup' });
21
+ const roomId = room.id;
22
+ console.log(` Created conference room: ${roomId}`);
23
+
24
+ // 2. List conference room addresses
25
+ console.log('\nListing conference room addresses...');
26
+ try {
27
+ const addrs = await client.fabric.conferenceRooms.listAddresses(roomId);
28
+ for (const a of addrs.data ?? []) {
29
+ console.log(` - ${a.display_name ?? a.id ?? 'unknown'}`);
30
+ }
31
+ } catch (err) {
32
+ if (err instanceof RestError) {
33
+ console.log(` List addresses failed: ${err.statusCode}`);
34
+ } else throw err;
35
+ }
36
+
37
+ // 3. Create a cXML script
38
+ console.log('\nCreating cXML script...');
39
+ const cxml = await client.fabric.cxmlScripts.create({
40
+ name: 'Hold Music Script',
41
+ contents: '<Response><Say>Please hold.</Say><Play>https://example.com/hold.mp3</Play></Response>',
42
+ });
43
+ const cxmlId = cxml.id;
44
+ console.log(` Created cXML script: ${cxmlId}`);
45
+
46
+ // 4. Create a cXML webhook
47
+ console.log('\nCreating cXML webhook...');
48
+ const cxmlWh = await client.fabric.cxmlWebhooks.create({
49
+ name: 'External cXML Handler',
50
+ primary_request_url: 'https://example.com/cxml-handler',
51
+ });
52
+ const cxmlWhId = cxmlWh.id;
53
+ console.log(` Created cXML webhook: ${cxmlWhId}`);
54
+
55
+ // 5. Create a relay application
56
+ console.log('\nCreating relay application...');
57
+ const relayApp = await client.fabric.relayApplications.create({
58
+ name: 'Inbound Handler',
59
+ topic: 'office',
60
+ });
61
+ const relayId = relayApp.id;
62
+ console.log(` Created relay application: ${relayId}`);
63
+
64
+ // 6. Generic resources: list all
65
+ console.log('\nListing all fabric resources...');
66
+ const resources = await client.fabric.resources.list();
67
+ for (const r of (resources.data ?? []).slice(0, 5)) {
68
+ console.log(` - ${r.type ?? 'unknown'}: ${r.display_name ?? r.id ?? 'unknown'}`);
69
+ }
70
+
71
+ // 7. Get a specific generic resource
72
+ const first = (resources.data ?? [{}])[0];
73
+ if (first?.id) {
74
+ const detail = await client.fabric.resources.get(first.id);
75
+ console.log(` Resource detail: ${detail.display_name ?? 'N/A'} (${detail.type ?? 'N/A'})`);
76
+ }
77
+
78
+ // 8. Assign a phone route to a resource (demo)
79
+ console.log('\nAssigning phone route (demo)...');
80
+ try {
81
+ await client.fabric.resources.assignPhoneRoute(relayId, { phone_number: '+15551234567' });
82
+ console.log(' Phone route assigned');
83
+ } catch (err) {
84
+ if (err instanceof RestError) {
85
+ console.log(` Route assignment failed (expected in demo): ${err.statusCode}`);
86
+ } else throw err;
87
+ }
88
+
89
+ // 9. Assign a domain application (demo)
90
+ console.log('\nAssigning domain application (demo)...');
91
+ try {
92
+ await client.fabric.resources.assignDomainApplication(relayId, { domain: 'app.example.com' });
93
+ console.log(' Domain application assigned');
94
+ } catch (err) {
95
+ if (err instanceof RestError) {
96
+ console.log(` Domain assignment failed (expected in demo): ${err.statusCode}`);
97
+ } else throw err;
98
+ }
99
+
100
+ // 10. Generate tokens
101
+ console.log('\nGenerating tokens...');
102
+ try {
103
+ const guest = await client.fabric.tokens.createGuestToken({ resource_id: relayId });
104
+ console.log(` Guest token: ${String(guest.token ?? '').slice(0, 40)}...`);
105
+ } catch (err) {
106
+ if (err instanceof RestError) {
107
+ console.log(` Guest token failed (expected in demo): ${err.statusCode}`);
108
+ } else throw err;
109
+ }
110
+
111
+ try {
112
+ const invite = await client.fabric.tokens.createInviteToken({ resource_id: relayId });
113
+ console.log(` Invite token: ${String(invite.token ?? '').slice(0, 40)}...`);
114
+ } catch (err) {
115
+ if (err instanceof RestError) {
116
+ console.log(` Invite token failed (expected in demo): ${err.statusCode}`);
117
+ } else throw err;
118
+ }
119
+
120
+ try {
121
+ const embed = await client.fabric.tokens.createEmbedToken({ resource_id: relayId });
122
+ console.log(` Embed token: ${String(embed.token ?? '').slice(0, 40)}...`);
123
+ } catch (err) {
124
+ if (err instanceof RestError) {
125
+ console.log(` Embed token failed (expected in demo): ${err.statusCode}`);
126
+ } else throw err;
127
+ }
128
+
129
+ // 11. Clean up
130
+ console.log('\nCleaning up...');
131
+ await client.fabric.relayApplications.delete(relayId);
132
+ console.log(` Deleted relay application ${relayId}`);
133
+ await client.fabric.cxmlWebhooks.delete(cxmlWhId);
134
+ console.log(` Deleted cXML webhook ${cxmlWhId}`);
135
+ await client.fabric.cxmlScripts.delete(cxmlId);
136
+ console.log(` Deleted cXML script ${cxmlId}`);
137
+ await client.fabric.conferenceRooms.delete(roomId);
138
+ console.log(` Deleted conference room ${roomId}`);
139
+ }
140
+
141
+ main().catch(err => {
142
+ console.error('Error:', err.message);
143
+ process.exit(1);
144
+ });
@@ -0,0 +1,108 @@
1
+ /**
2
+ * REST Example: Provision a SIP-enabled user on Fabric.
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-fabric-subscribers-and-sip.ts
11
+ */
12
+
13
+ import { RestClient, RestError } from '../../src/index.js';
14
+
15
+ const client = new RestClient();
16
+
17
+ async function main() {
18
+ // 1. Create a subscriber
19
+ console.log('Creating subscriber...');
20
+ const subscriber: any = await client.fabric.subscribers.create({
21
+ name: 'Alice Johnson',
22
+ email: 'alice@example.com',
23
+ });
24
+ const subId = subscriber.id;
25
+ const innerSubId = subscriber.subscriber?.id ?? subId;
26
+ console.log(` Created subscriber: ${subId}`);
27
+
28
+ // 2. Add a SIP endpoint to the subscriber
29
+ console.log('\nCreating SIP endpoint on subscriber...');
30
+ const endpoint = await client.fabric.subscribers.createSipEndpoint(subId, {
31
+ username: 'alice_sip',
32
+ password: 'SecurePass123!',
33
+ });
34
+ const epId = endpoint.id;
35
+ console.log(` Created SIP endpoint: ${epId}`);
36
+
37
+ // 3. List SIP endpoints on the subscriber
38
+ console.log('\nListing subscriber SIP endpoints...');
39
+ const endpoints = await client.fabric.subscribers.listSipEndpoints(subId);
40
+ for (const ep of endpoints.data ?? []) {
41
+ console.log(` - ${ep.id}: ${ep.username ?? 'unknown'}`);
42
+ }
43
+
44
+ // 4. Get specific SIP endpoint details
45
+ console.log(`\nGetting SIP endpoint ${epId}...`);
46
+ const epDetail = await client.fabric.subscribers.getSipEndpoint(subId, epId);
47
+ console.log(` Username: ${epDetail.username ?? 'N/A'}`);
48
+
49
+ // 5. Create a standalone SIP gateway
50
+ console.log('\nCreating SIP gateway...');
51
+ const gateway = await client.fabric.sipGateways.create({
52
+ name: 'Office PBX Gateway',
53
+ uri: 'sip:pbx.example.com',
54
+ encryption: 'required',
55
+ ciphers: ['AES_256_CM_HMAC_SHA1_80'],
56
+ codecs: ['PCMU', 'PCMA'],
57
+ });
58
+ const gwId = gateway.id;
59
+ console.log(` Created SIP gateway: ${gwId}`);
60
+
61
+ // 6. List fabric addresses
62
+ console.log('\nListing fabric addresses...');
63
+ try {
64
+ const addresses = await client.fabric.addresses.list();
65
+ for (const addr of (addresses.data ?? []).slice(0, 5)) {
66
+ console.log(` - ${addr.display_name ?? addr.id ?? 'unknown'}`);
67
+ }
68
+
69
+ // 7. Get a specific fabric address
70
+ const firstAddr = (addresses.data ?? [{}])[0];
71
+ if (firstAddr?.id) {
72
+ const addrDetail = await client.fabric.addresses.get(firstAddr.id);
73
+ console.log(` Address detail: ${addrDetail.display_name ?? 'N/A'}`);
74
+ }
75
+ } catch (err) {
76
+ if (err instanceof RestError) {
77
+ console.log(` Fabric addresses failed: ${err.statusCode}`);
78
+ } else throw err;
79
+ }
80
+
81
+ // 8. Generate a subscriber token
82
+ console.log('\nGenerating subscriber token...');
83
+ try {
84
+ const token = await client.fabric.tokens.createSubscriberToken({
85
+ subscriber_id: innerSubId,
86
+ reference: innerSubId,
87
+ });
88
+ console.log(` Token: ${String(token.token ?? '').slice(0, 40)}...`);
89
+ } catch (err) {
90
+ if (err instanceof RestError) {
91
+ console.log(` Token generation failed (expected in demo): ${err.statusCode}`);
92
+ } else throw err;
93
+ }
94
+
95
+ // 9. Clean up
96
+ console.log('\nCleaning up...');
97
+ await client.fabric.subscribers.deleteSipEndpoint(subId, epId);
98
+ console.log(` Deleted SIP endpoint ${epId}`);
99
+ await client.fabric.subscribers.delete(subId);
100
+ console.log(` Deleted subscriber ${subId}`);
101
+ await client.fabric.sipGateways.delete(gwId);
102
+ console.log(` Deleted SIP gateway ${gwId}`);
103
+ }
104
+
105
+ main().catch(err => {
106
+ console.error('Error:', err.message);
107
+ process.exit(1);
108
+ });
@@ -0,0 +1,99 @@
1
+ /**
2
+ * REST Example: Deploy a voice application with SWML scripts and call flows.
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-fabric-swml-and-callflows.ts
11
+ */
12
+
13
+ import { RestClient, RestError } from '../../src/index.js';
14
+
15
+ const client = new RestClient();
16
+
17
+ async function main() {
18
+ // 1. Create a SWML script
19
+ console.log('Creating SWML script...');
20
+ const swml = await client.fabric.swmlScripts.create({
21
+ name: 'Greeting Script',
22
+ contents: { sections: { main: [{ play: { url: 'say:Hello from SignalWire' } }] } },
23
+ });
24
+ const swmlId = swml.id;
25
+ console.log(` Created SWML script: ${swmlId}`);
26
+
27
+ // 2. List SWML scripts to confirm
28
+ console.log('\nListing SWML scripts...');
29
+ const scripts = await client.fabric.swmlScripts.list();
30
+ for (const s of scripts.data ?? []) {
31
+ console.log(` - ${s.id}: ${s.display_name ?? 'unnamed'}`);
32
+ }
33
+
34
+ // 3. Create a call flow
35
+ console.log('\nCreating call flow...');
36
+ const flow = await client.fabric.callFlows.create({ title: 'Main IVR Flow' });
37
+ const flowId = flow.id;
38
+ console.log(` Created call flow: ${flowId}`);
39
+
40
+ // 4. Deploy a version of the call flow
41
+ console.log('\nDeploying call flow version...');
42
+ try {
43
+ const version = await client.fabric.callFlows.deployVersion(flowId, { label: 'v1' });
44
+ console.log(` Deployed version: ${JSON.stringify(version)}`);
45
+ } catch (err) {
46
+ if (err instanceof RestError) {
47
+ console.log(` Deploy failed (expected in demo): ${err.statusCode}`);
48
+ } else throw err;
49
+ }
50
+
51
+ // 5. List call flow versions
52
+ console.log('\nListing call flow versions...');
53
+ try {
54
+ const versions = await client.fabric.callFlows.listVersions(flowId);
55
+ for (const v of versions.data ?? []) {
56
+ console.log(` - Version: ${v.label ?? v.id ?? 'unknown'}`);
57
+ }
58
+ } catch (err) {
59
+ if (err instanceof RestError) {
60
+ console.log(` List versions failed: ${err.statusCode}`);
61
+ } else throw err;
62
+ }
63
+
64
+ // 6. List addresses for the call flow
65
+ console.log('\nListing call flow addresses...');
66
+ try {
67
+ const addrs = await client.fabric.callFlows.listAddresses(flowId);
68
+ for (const a of addrs.data ?? []) {
69
+ console.log(` - ${a.display_name ?? a.id ?? 'unknown'}`);
70
+ }
71
+ } catch (err) {
72
+ if (err instanceof RestError) {
73
+ console.log(` List addresses failed: ${err.statusCode}`);
74
+ } else throw err;
75
+ }
76
+
77
+ // 7. Create a SWML webhook as an alternative approach
78
+ console.log('\nCreating SWML webhook...');
79
+ const webhook = await client.fabric.swmlWebhooks.create({
80
+ name: 'External Handler',
81
+ primary_request_url: 'https://example.com/swml-handler',
82
+ });
83
+ const webhookId = webhook.id;
84
+ console.log(` Created webhook: ${webhookId}`);
85
+
86
+ // 8. Clean up
87
+ console.log('\nCleaning up...');
88
+ await client.fabric.swmlWebhooks.delete(webhookId);
89
+ console.log(` Deleted webhook ${webhookId}`);
90
+ await client.fabric.callFlows.delete(flowId);
91
+ console.log(` Deleted call flow ${flowId}`);
92
+ await client.fabric.swmlScripts.delete(swmlId);
93
+ console.log(` Deleted SWML script ${swmlId}`);
94
+ }
95
+
96
+ main().catch(err => {
97
+ console.error('Error:', err.message);
98
+ process.exit(1);
99
+ });