@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,65 @@
1
+ /**
2
+ * REST Example: Create an AI agent, assign a phone number, and place a test call.
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-manage-resources.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 an AI agent
19
+ console.log('Creating AI agent...');
20
+ const agent = await client.fabric.aiAgents.create({
21
+ name: 'Demo Support Bot',
22
+ prompt: { text: 'You are a friendly support agent for Acme Corp.' },
23
+ });
24
+ const agentId = agent.id;
25
+ console.log(` Created agent: ${agentId}`);
26
+
27
+ // 2. List all AI agents
28
+ console.log('\nListing AI agents...');
29
+ const agents = await client.fabric.aiAgents.list();
30
+ for (const a of agents.data ?? []) {
31
+ console.log(` - ${a.id}: ${a.name ?? 'unnamed'}`);
32
+ }
33
+
34
+ // 3. Search for a phone number
35
+ console.log('\nSearching for available phone numbers...');
36
+ const available = await client.phoneNumbers.search({ area_code: '512', max_results: 3 });
37
+ for (const num of available.data ?? []) {
38
+ console.log(` - ${num.e164 ?? num.number ?? 'unknown'}`);
39
+ }
40
+
41
+ // 4. Place a test call (requires valid numbers)
42
+ console.log('\nPlacing a test call...');
43
+ try {
44
+ const result = await client.calling.dial({
45
+ from: '+15559876543',
46
+ to: '+15551234567',
47
+ url: 'https://example.com/call-handler',
48
+ });
49
+ console.log(` Call initiated: ${JSON.stringify(result)}`);
50
+ } catch (err) {
51
+ if (err instanceof RestError) {
52
+ console.log(` Call failed (expected in demo): ${err.statusCode}`);
53
+ } else throw err;
54
+ }
55
+
56
+ // 5. Clean up: delete the agent
57
+ console.log(`\nDeleting agent ${agentId}...`);
58
+ await client.fabric.aiAgents.delete(agentId);
59
+ console.log(' Deleted.');
60
+ }
61
+
62
+ main().catch(err => {
63
+ console.error('Error:', err.message);
64
+ process.exit(1);
65
+ });
@@ -0,0 +1,197 @@
1
+ /**
2
+ * REST Example: Full phone number inventory lifecycle.
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-phone-number-management.ts
11
+ */
12
+
13
+ import { RestClient, RestError } from '../../src/index.js';
14
+
15
+ const client = new RestClient();
16
+
17
+ async function main() {
18
+ // 1. Search for available phone numbers
19
+ console.log('Searching available numbers...');
20
+ const available = await client.phoneNumbers.search({ area_code: '512', max_results: 3 });
21
+ for (const num of available.data ?? []) {
22
+ console.log(` - ${num.e164 ?? num.number ?? 'unknown'}`);
23
+ }
24
+
25
+ // 2. Purchase a number
26
+ console.log('\nPurchasing a phone number...');
27
+ let numId: string | null = null;
28
+ try {
29
+ const first = (available.data ?? [{}])[0];
30
+ const number = await client.phoneNumbers.create({ number: first.e164 ?? '+15125551234' });
31
+ numId = number.id;
32
+ console.log(` Purchased: ${numId}`);
33
+ } catch (err) {
34
+ if (err instanceof RestError) {
35
+ console.log(` Purchase failed (expected in demo): ${err.statusCode}`);
36
+ } else throw err;
37
+ }
38
+
39
+ // 3. List and get owned numbers
40
+ console.log('\nListing owned numbers...');
41
+ const owned = await client.phoneNumbers.list();
42
+ for (const n of (owned.data ?? []).slice(0, 5)) {
43
+ console.log(` - ${n.number ?? 'unknown'} (${n.id})`);
44
+ }
45
+
46
+ if (numId) {
47
+ const detail = await client.phoneNumbers.get(numId);
48
+ console.log(` Detail: ${detail.number ?? 'N/A'}`);
49
+ }
50
+
51
+ // 4. Update a number
52
+ if (numId) {
53
+ console.log(`\nUpdating number ${numId}...`);
54
+ await client.phoneNumbers.update(numId, { name: 'Main Line' });
55
+ console.log(" Updated name to 'Main Line'");
56
+ }
57
+
58
+ // 5. Create a number group
59
+ console.log('\nCreating number group...');
60
+ let groupId: string | null = null;
61
+ try {
62
+ const group = await client.numberGroups.create({ name: 'Sales Pool' });
63
+ groupId = group.id;
64
+ console.log(` Created group: ${groupId}`);
65
+ } catch (err) {
66
+ if (err instanceof RestError) {
67
+ console.log(` Group creation failed (expected in demo): ${err.statusCode}`);
68
+ } else throw err;
69
+ }
70
+
71
+ // 6. Add a membership and list memberships
72
+ if (groupId && numId) {
73
+ console.log('\nAdding number to group...');
74
+ try {
75
+ const membership = await client.numberGroups.addMembership(groupId, { phone_number_id: numId });
76
+ const memId = membership.id;
77
+ console.log(` Membership: ${memId}`);
78
+
79
+ const memberships = await client.numberGroups.listMemberships(groupId);
80
+ for (const m of memberships.data ?? []) {
81
+ console.log(` - Member: ${m.id ?? 'unknown'}`);
82
+ }
83
+ } catch (err) {
84
+ if (err instanceof RestError) {
85
+ console.log(` Membership failed (expected in demo): ${err.statusCode}`);
86
+ } else throw err;
87
+ }
88
+ }
89
+
90
+ // 7. Lookup carrier info
91
+ console.log('\nLooking up carrier info...');
92
+ try {
93
+ const info = await client.lookup.phoneNumber('+15125551234');
94
+ console.log(` Carrier: ${info.carrier?.name ?? 'unknown'}`);
95
+ } catch (err) {
96
+ if (err instanceof RestError) {
97
+ console.log(` Lookup failed (expected in demo): ${err.statusCode}`);
98
+ } else throw err;
99
+ }
100
+
101
+ // 8. Create a verified caller
102
+ console.log('\nCreating verified caller...');
103
+ let callerId: string | null = null;
104
+ try {
105
+ const caller = await client.verifiedCallers.create({ phone_number: '+15125559999' });
106
+ callerId = caller.id;
107
+ console.log(` Created verified caller: ${callerId}`);
108
+ await client.verifiedCallers.submitVerification(callerId, { verification_code: '123456' });
109
+ console.log(' Verification code submitted');
110
+ } catch (err) {
111
+ if (err instanceof RestError) {
112
+ console.log(` Verified caller failed (expected in demo): ${err.statusCode}`);
113
+ } else throw err;
114
+ }
115
+
116
+ // 9. Get and update SIP profile
117
+ console.log('\nGetting SIP profile...');
118
+ try {
119
+ const profile = await client.sipProfile.get();
120
+ console.log(` SIP profile: ${JSON.stringify(profile)}`);
121
+ await client.sipProfile.update({ default_codecs: ['PCMU', 'PCMA'] });
122
+ console.log(' Updated SIP codecs');
123
+ } catch (err) {
124
+ if (err instanceof RestError) {
125
+ console.log(` SIP profile failed (expected in demo): ${err.statusCode}`);
126
+ } else throw err;
127
+ }
128
+
129
+ // 10. List short codes
130
+ console.log('\nListing short codes...');
131
+ try {
132
+ const codes = await client.shortCodes.list();
133
+ for (const sc of codes.data ?? []) {
134
+ console.log(` - ${sc.short_code ?? 'unknown'}`);
135
+ }
136
+ } catch (err) {
137
+ if (err instanceof RestError) {
138
+ console.log(` Short codes failed (expected in demo): ${err.statusCode}`);
139
+ } else throw err;
140
+ }
141
+
142
+ // 11. Create an address
143
+ console.log('\nCreating address...');
144
+ let addrId: string | null = null;
145
+ try {
146
+ const addr = await client.addresses.create({
147
+ friendly_name: 'HQ Address',
148
+ street: '123 Main St',
149
+ city: 'Austin',
150
+ region: 'TX',
151
+ postal_code: '78701',
152
+ iso_country: 'US',
153
+ });
154
+ addrId = addr.id;
155
+ console.log(` Created address: ${addrId}`);
156
+ } catch (err) {
157
+ if (err instanceof RestError) {
158
+ console.log(` Address creation failed (expected in demo): ${err.statusCode}`);
159
+ } else throw err;
160
+ }
161
+
162
+ // 12. Clean up
163
+ console.log('\nCleaning up...');
164
+ if (addrId) {
165
+ await client.addresses.delete(addrId);
166
+ console.log(` Deleted address ${addrId}`);
167
+ }
168
+ if (callerId) {
169
+ try {
170
+ await client.verifiedCallers.delete(callerId);
171
+ console.log(` Deleted verified caller ${callerId}`);
172
+ } catch (err) {
173
+ if (err instanceof RestError) {
174
+ console.log(` Verified caller delete failed: ${err.statusCode}`);
175
+ } else throw err;
176
+ }
177
+ }
178
+ if (groupId) {
179
+ await client.numberGroups.delete(groupId);
180
+ console.log(` Deleted number group ${groupId}`);
181
+ }
182
+ if (numId) {
183
+ try {
184
+ await client.phoneNumbers.delete(numId);
185
+ console.log(` Released number ${numId}`);
186
+ } catch (err) {
187
+ if (err instanceof RestError) {
188
+ console.log(` Release number failed (recently purchased): ${err.statusCode}`);
189
+ } else throw err;
190
+ }
191
+ }
192
+ }
193
+
194
+ main().catch(err => {
195
+ console.error('Error:', err.message);
196
+ process.exit(1);
197
+ });
@@ -0,0 +1,143 @@
1
+ /**
2
+ * REST Example: Call queues, recording review, and MFA verification.
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-queues-mfa-and-recordings.ts
11
+ */
12
+
13
+ import { RestClient, RestError } from '../../src/index.js';
14
+
15
+ const client = new RestClient();
16
+
17
+ async function main() {
18
+ // --- Queues ---
19
+
20
+ // 1. Create a queue
21
+ console.log('Creating call queue...');
22
+ let queueId: string | null = null;
23
+ try {
24
+ const queue = await client.queues.create({ name: 'Support Queue', max_size: 50 });
25
+ queueId = queue.id;
26
+ console.log(` Created queue: ${queueId}`);
27
+ } catch (err) {
28
+ if (err instanceof RestError) {
29
+ console.log(` Queue creation failed (expected in demo): ${err.statusCode}`);
30
+ } else throw err;
31
+ }
32
+
33
+ // 2. List queues
34
+ console.log('\nListing queues...');
35
+ const queues = await client.queues.list();
36
+ for (const q of queues.data ?? []) {
37
+ console.log(` - ${q.id}: ${q.friendly_name ?? q.name ?? 'unnamed'}`);
38
+ }
39
+
40
+ // 3. Get and update queue
41
+ if (queueId) {
42
+ const detail = await client.queues.get(queueId);
43
+ console.log(`\nQueue detail: ${detail.friendly_name ?? 'N/A'} (max: ${detail.max_size ?? 'N/A'})`);
44
+
45
+ await client.queues.update(queueId, { name: 'Priority Support Queue' });
46
+ console.log(' Updated queue name');
47
+ }
48
+
49
+ // 4. Queue members
50
+ if (queueId) {
51
+ console.log('\nListing queue members...');
52
+ try {
53
+ const members = await client.queues.listMembers(queueId);
54
+ for (const m of members.data ?? []) {
55
+ console.log(` - Member: ${m.call_id ?? m.id ?? 'unknown'}`);
56
+ }
57
+
58
+ const nextMember = await client.queues.getNextMember(queueId);
59
+ console.log(` Next member: ${JSON.stringify(nextMember)}`);
60
+ } catch (err) {
61
+ if (err instanceof RestError) {
62
+ console.log(` Member ops failed (expected if queue empty): ${err.statusCode}`);
63
+ } else throw err;
64
+ }
65
+ }
66
+
67
+ // --- Recordings ---
68
+
69
+ // 5. List recordings
70
+ console.log('\nListing recordings...');
71
+ const recordings = await client.recordings.list();
72
+ for (const r of (recordings.data ?? []).slice(0, 5)) {
73
+ console.log(` - ${r.id}: ${r.duration ?? 'N/A'}s`);
74
+ }
75
+
76
+ // 6. Get recording details
77
+ const firstRec = (recordings.data ?? [{}])[0];
78
+ if (firstRec?.id) {
79
+ const recDetail = await client.recordings.get(firstRec.id);
80
+ console.log(` Recording: ${recDetail.duration ?? 'N/A'}s, ${recDetail.format ?? 'N/A'}`);
81
+ }
82
+
83
+ // --- MFA ---
84
+
85
+ // 7. Send MFA via SMS
86
+ console.log('\nSending MFA SMS code...');
87
+ let requestId: string | null = null;
88
+ try {
89
+ const smsResult = await client.mfa.sms({
90
+ to: '+15551234567',
91
+ from: '+15559876543',
92
+ message: 'Your code is {{code}}',
93
+ token_length: 6,
94
+ });
95
+ requestId = smsResult.id ?? smsResult.request_id ?? null;
96
+ console.log(` MFA SMS sent: ${requestId}`);
97
+ } catch (err) {
98
+ if (err instanceof RestError) {
99
+ console.log(` MFA SMS failed (expected in demo): ${err.statusCode}`);
100
+ } else throw err;
101
+ }
102
+
103
+ // 8. Send MFA via voice call
104
+ console.log('\nSending MFA voice code...');
105
+ try {
106
+ const voiceResult = await client.mfa.call({
107
+ to: '+15551234567',
108
+ from: '+15559876543',
109
+ message: 'Your verification code is {{code}}',
110
+ token_length: 6,
111
+ });
112
+ console.log(` MFA call sent: ${voiceResult.id ?? voiceResult.request_id}`);
113
+ } catch (err) {
114
+ if (err instanceof RestError) {
115
+ console.log(` MFA call failed (expected in demo): ${err.statusCode}`);
116
+ } else throw err;
117
+ }
118
+
119
+ // 9. Verify MFA token
120
+ if (requestId) {
121
+ console.log('\nVerifying MFA token...');
122
+ try {
123
+ const verify = await client.mfa.verify(requestId, { token: '123456' });
124
+ console.log(` Verification result: ${JSON.stringify(verify)}`);
125
+ } catch (err) {
126
+ if (err instanceof RestError) {
127
+ console.log(` Verify failed (expected in demo): ${err.statusCode}`);
128
+ } else throw err;
129
+ }
130
+ }
131
+
132
+ // 10. Clean up
133
+ console.log('\nCleaning up...');
134
+ if (queueId) {
135
+ await client.queues.delete(queueId);
136
+ console.log(` Deleted queue ${queueId}`);
137
+ }
138
+ }
139
+
140
+ main().catch(err => {
141
+ console.error('Error:', err.message);
142
+ process.exit(1);
143
+ });
@@ -0,0 +1,186 @@
1
+ /**
2
+ * REST Example: Video rooms for team standup and conference streaming.
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-video-rooms.ts
11
+ */
12
+
13
+ import { RestClient, RestError } from '../../src/index.js';
14
+
15
+ const client = new RestClient();
16
+
17
+ async function main() {
18
+ // --- Video Rooms ---
19
+
20
+ // 1. Create a video room
21
+ console.log('Creating video room...');
22
+ const room = await client.video.rooms.create({
23
+ name: 'daily-standup',
24
+ display_name: 'Daily Standup',
25
+ max_members: 10,
26
+ layout: 'grid-responsive',
27
+ });
28
+ const roomId = room.id;
29
+ console.log(` Created room: ${roomId}`);
30
+
31
+ // 2. List video rooms
32
+ console.log('\nListing video rooms...');
33
+ const rooms = await client.video.rooms.list();
34
+ for (const r of (rooms.data ?? []).slice(0, 5)) {
35
+ console.log(` - ${r.id}: ${r.name ?? 'unnamed'}`);
36
+ }
37
+
38
+ // 3. Generate a join token
39
+ console.log('\nGenerating room token...');
40
+ try {
41
+ const token = await client.video.roomTokens.create({
42
+ room_name: 'daily-standup',
43
+ user_name: 'alice',
44
+ permissions: ['room.self.audio_mute', 'room.self.video_mute'],
45
+ });
46
+ console.log(` Token: ${String(token.token ?? '').slice(0, 40)}...`);
47
+ } catch (err) {
48
+ if (err instanceof RestError) {
49
+ console.log(` Token failed (expected in demo): ${err.statusCode}`);
50
+ } else throw err;
51
+ }
52
+
53
+ // --- Sessions ---
54
+
55
+ // 4. List room sessions
56
+ console.log('\nListing room sessions...');
57
+ const sessions = await client.video.roomSessions.list();
58
+ for (const s of (sessions.data ?? []).slice(0, 3)) {
59
+ console.log(` - Session ${s.id}: ${s.status ?? 'unknown'}`);
60
+ }
61
+
62
+ // 5. Get session details with members, events, recordings
63
+ const firstSession = (sessions.data ?? [{}])[0];
64
+ if (firstSession?.id) {
65
+ const sid = firstSession.id;
66
+ const detail = await client.video.roomSessions.get(sid);
67
+ console.log(` Session: ${detail.name ?? 'N/A'} (${detail.status ?? 'N/A'})`);
68
+
69
+ const members = await client.video.roomSessions.listMembers(sid);
70
+ console.log(` Members: ${(members.data ?? []).length}`);
71
+
72
+ const events = await client.video.roomSessions.listEvents(sid);
73
+ console.log(` Events: ${(events.data ?? []).length}`);
74
+
75
+ const recs = await client.video.roomSessions.listRecordings(sid);
76
+ console.log(` Recordings: ${(recs.data ?? []).length}`);
77
+ }
78
+
79
+ // --- Room Recordings ---
80
+
81
+ // 6. List and get room recordings
82
+ console.log('\nListing room recordings...');
83
+ const roomRecs = await client.video.roomRecordings.list();
84
+ for (const rr of (roomRecs.data ?? []).slice(0, 3)) {
85
+ console.log(` - Recording ${rr.id}: ${rr.duration ?? 'N/A'}s`);
86
+ }
87
+
88
+ const firstRec = (roomRecs.data ?? [{}])[0];
89
+ if (firstRec?.id) {
90
+ const recDetail = await client.video.roomRecordings.get(firstRec.id);
91
+ console.log(` Recording detail: ${recDetail.duration ?? 'N/A'}s`);
92
+
93
+ const recEvents = await client.video.roomRecordings.listEvents(firstRec.id);
94
+ console.log(` Recording events: ${(recEvents.data ?? []).length}`);
95
+ }
96
+
97
+ // --- Video Conferences ---
98
+
99
+ // 7. Create a video conference
100
+ console.log('\nCreating video conference...');
101
+ let confId: string | null = null;
102
+ try {
103
+ const conf = await client.video.conferences.create({
104
+ name: 'all-hands-stream',
105
+ display_name: 'All Hands Meeting',
106
+ });
107
+ confId = conf.id;
108
+ console.log(` Created conference: ${confId}`);
109
+ } catch (err) {
110
+ if (err instanceof RestError) {
111
+ console.log(` Conference creation failed (expected in demo): ${err.statusCode}`);
112
+ } else throw err;
113
+ }
114
+
115
+ // 8. List conference tokens
116
+ if (confId) {
117
+ console.log('\nListing conference tokens...');
118
+ try {
119
+ const tokens = await client.video.conferences.listConferenceTokens(confId);
120
+ for (const t of tokens.data ?? []) {
121
+ console.log(` - Token: ${t.id ?? 'unknown'}`);
122
+ }
123
+ } catch (err) {
124
+ if (err instanceof RestError) {
125
+ console.log(` Conference tokens failed: ${err.statusCode}`);
126
+ } else throw err;
127
+ }
128
+ }
129
+
130
+ // 9. Create a stream on the conference
131
+ let streamId: string | null = null;
132
+ if (confId) {
133
+ console.log('\nCreating stream on conference...');
134
+ try {
135
+ const stream = await client.video.conferences.createStream(confId, {
136
+ url: 'rtmp://live.example.com/stream-key',
137
+ });
138
+ streamId = stream.id;
139
+ console.log(` Created stream: ${streamId}`);
140
+ } catch (err) {
141
+ if (err instanceof RestError) {
142
+ console.log(` Stream creation failed (expected in demo): ${err.statusCode}`);
143
+ } else throw err;
144
+ }
145
+ }
146
+
147
+ // 10. Get and update stream
148
+ if (streamId) {
149
+ console.log(`\nManaging stream ${streamId}...`);
150
+ try {
151
+ const sDetail = await client.video.streams.get(streamId);
152
+ console.log(` Stream URL: ${sDetail.url ?? 'N/A'}`);
153
+
154
+ await client.video.streams.update(streamId, { url: 'rtmp://backup.example.com/stream-key' });
155
+ console.log(' Stream URL updated');
156
+ } catch (err) {
157
+ if (err instanceof RestError) {
158
+ console.log(` Stream ops failed: ${err.statusCode}`);
159
+ } else throw err;
160
+ }
161
+ }
162
+
163
+ // 11. Clean up
164
+ console.log('\nCleaning up...');
165
+ if (streamId) {
166
+ try {
167
+ await client.video.streams.delete(streamId);
168
+ console.log(` Deleted stream ${streamId}`);
169
+ } catch (err) {
170
+ if (err instanceof RestError) {
171
+ console.log(` Stream delete failed: ${err.statusCode}`);
172
+ } else throw err;
173
+ }
174
+ }
175
+ if (confId) {
176
+ await client.video.conferences.delete(confId);
177
+ console.log(` Deleted conference ${confId}`);
178
+ }
179
+ await client.video.rooms.delete(roomId);
180
+ console.log(` Deleted room ${roomId}`);
181
+ }
182
+
183
+ main().catch(err => {
184
+ console.error('Error:', err.message);
185
+ process.exit(1);
186
+ });