@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,68 @@
1
+ import { HttpClient } from '../../src/rest/HttpClient.js';
2
+ import { LogsNamespace } from '../../src/rest/namespaces/logs.js';
3
+ import { mockClientOptions } from './helpers.js';
4
+
5
+ describe('LogsNamespace', () => {
6
+ function setup(responses: any[] = [{ status: 200, body: { data: [] } }]) {
7
+ const { options, getRequests } = mockClientOptions(responses);
8
+ const http = new HttpClient(options);
9
+ const logs = new LogsNamespace(http);
10
+ return { logs, getRequests };
11
+ }
12
+
13
+ describe('Message Logs', () => {
14
+ it('lists message logs', async () => {
15
+ const { logs, getRequests } = setup();
16
+ await logs.messages.list();
17
+ expect(getRequests()[0].url).toContain('/api/messaging/logs');
18
+ });
19
+
20
+ it('gets a message log', async () => {
21
+ const { logs, getRequests } = setup([{ status: 200, body: { id: 'ml1' } }]);
22
+ await logs.messages.get('ml1');
23
+ expect(getRequests()[0].url).toContain('/api/messaging/logs/ml1');
24
+ });
25
+ });
26
+
27
+ describe('Voice Logs', () => {
28
+ it('lists voice logs', async () => {
29
+ const { logs, getRequests } = setup();
30
+ await logs.voice.list();
31
+ expect(getRequests()[0].url).toContain('/api/voice/logs');
32
+ });
33
+
34
+ it('gets a voice log', async () => {
35
+ const { logs, getRequests } = setup([{ status: 200, body: { id: 'vl1' } }]);
36
+ await logs.voice.get('vl1');
37
+ expect(getRequests()[0].url).toContain('/api/voice/logs/vl1');
38
+ });
39
+
40
+ it('lists events for a voice log', async () => {
41
+ const { logs, getRequests } = setup();
42
+ await logs.voice.listEvents('vl1');
43
+ expect(getRequests()[0].url).toContain('/api/voice/logs/vl1/events');
44
+ });
45
+ });
46
+
47
+ describe('Fax Logs', () => {
48
+ it('lists fax logs', async () => {
49
+ const { logs, getRequests } = setup();
50
+ await logs.fax.list();
51
+ expect(getRequests()[0].url).toContain('/api/fax/logs');
52
+ });
53
+
54
+ it('gets a fax log', async () => {
55
+ const { logs, getRequests } = setup([{ status: 200, body: { id: 'fl1' } }]);
56
+ await logs.fax.get('fl1');
57
+ expect(getRequests()[0].url).toContain('/api/fax/logs/fl1');
58
+ });
59
+ });
60
+
61
+ describe('Conference Logs', () => {
62
+ it('lists conference logs', async () => {
63
+ const { logs, getRequests } = setup();
64
+ await logs.conferences.list();
65
+ expect(getRequests()[0].url).toContain('/api/logs/conferences');
66
+ });
67
+ });
68
+ });
@@ -0,0 +1,133 @@
1
+ import { HttpClient } from '../../src/rest/HttpClient.js';
2
+ import { paginate, paginateAll } from '../../src/rest/pagination.js';
3
+ import { mockClientOptions } from './helpers.js';
4
+
5
+ describe('paginate', () => {
6
+ it('yields items from a single page', async () => {
7
+ const { options } = mockClientOptions([
8
+ { status: 200, body: { data: [{ id: 1 }, { id: 2 }] } },
9
+ ]);
10
+ const http = new HttpClient(options);
11
+
12
+ const items: any[] = [];
13
+ for await (const item of paginate(http, '/api/test')) {
14
+ items.push(item);
15
+ }
16
+ expect(items).toEqual([{ id: 1 }, { id: 2 }]);
17
+ });
18
+
19
+ it('follows links.next across multiple pages', async () => {
20
+ const { options } = mockClientOptions([
21
+ {
22
+ status: 200,
23
+ body: {
24
+ data: [{ id: 1 }],
25
+ links: { next: 'https://test.signalwire.com/api/test?page=2' },
26
+ },
27
+ },
28
+ {
29
+ status: 200,
30
+ body: {
31
+ data: [{ id: 2 }],
32
+ links: { next: 'https://test.signalwire.com/api/test?page=3' },
33
+ },
34
+ },
35
+ {
36
+ status: 200,
37
+ body: {
38
+ data: [{ id: 3 }],
39
+ links: {},
40
+ },
41
+ },
42
+ ]);
43
+ const http = new HttpClient(options);
44
+
45
+ const items = await paginateAll(http, '/api/test');
46
+ expect(items).toEqual([{ id: 1 }, { id: 2 }, { id: 3 }]);
47
+ });
48
+
49
+ it('follows next_page_uri for LAML-style pagination', async () => {
50
+ const { options } = mockClientOptions([
51
+ {
52
+ status: 200,
53
+ body: {
54
+ calls: [{ sid: 'CA1' }],
55
+ next_page_uri: '/api/laml/2010-04-01/Accounts/xxx/Calls?page=1',
56
+ },
57
+ },
58
+ {
59
+ status: 200,
60
+ body: {
61
+ calls: [{ sid: 'CA2' }],
62
+ next_page_uri: null,
63
+ },
64
+ },
65
+ ]);
66
+ const http = new HttpClient(options);
67
+
68
+ const items = await paginateAll(http, '/api/laml/2010-04-01/Accounts/xxx/Calls', undefined, 'calls');
69
+ expect(items).toEqual([{ sid: 'CA1' }, { sid: 'CA2' }]);
70
+ });
71
+
72
+ it('handles empty first page', async () => {
73
+ const { options } = mockClientOptions([
74
+ { status: 200, body: { data: [] } },
75
+ ]);
76
+ const http = new HttpClient(options);
77
+
78
+ const items = await paginateAll(http, '/api/test');
79
+ expect(items).toEqual([]);
80
+ });
81
+
82
+ it('handles missing data key gracefully', async () => {
83
+ const { options } = mockClientOptions([
84
+ { status: 200, body: { other: 'stuff' } },
85
+ ]);
86
+ const http = new HttpClient(options);
87
+
88
+ const items = await paginateAll(http, '/api/test');
89
+ expect(items).toEqual([]);
90
+ });
91
+
92
+ it('supports custom data key', async () => {
93
+ const { options } = mockClientOptions([
94
+ { status: 200, body: { results: [{ name: 'a' }, { name: 'b' }] } },
95
+ ]);
96
+ const http = new HttpClient(options);
97
+
98
+ const items = await paginateAll(http, '/api/test', undefined, 'results');
99
+ expect(items).toEqual([{ name: 'a' }, { name: 'b' }]);
100
+ });
101
+
102
+ it('passes initial query params', async () => {
103
+ const { options, getRequests } = mockClientOptions([
104
+ { status: 200, body: { data: [{ id: 1 }] } },
105
+ ]);
106
+ const http = new HttpClient(options);
107
+
108
+ await paginateAll(http, '/api/test', { page_size: 5 });
109
+
110
+ const reqs = getRequests();
111
+ expect(reqs[0].url).toContain('page_size=5');
112
+ });
113
+
114
+ it('handles relative links.next', async () => {
115
+ const { options } = mockClientOptions([
116
+ {
117
+ status: 200,
118
+ body: {
119
+ data: [{ id: 1 }],
120
+ links: { next: '/api/test?page=2' },
121
+ },
122
+ },
123
+ {
124
+ status: 200,
125
+ body: { data: [{ id: 2 }] },
126
+ },
127
+ ]);
128
+ const http = new HttpClient(options);
129
+
130
+ const items = await paginateAll(http, '/api/test');
131
+ expect(items).toEqual([{ id: 1 }, { id: 2 }]);
132
+ });
133
+ });
@@ -0,0 +1,94 @@
1
+ import { HttpClient } from '../../src/rest/HttpClient.js';
2
+ import { RegistryNamespace } from '../../src/rest/namespaces/registry.js';
3
+ import { mockClientOptions } from './helpers.js';
4
+
5
+ describe('RegistryNamespace', () => {
6
+ function setup(responses: any[] = [{ status: 200, body: { data: [] } }]) {
7
+ const { options, getRequests } = mockClientOptions(responses);
8
+ const http = new HttpClient(options);
9
+ const registry = new RegistryNamespace(http);
10
+ return { registry, getRequests };
11
+ }
12
+
13
+ describe('Brands', () => {
14
+ it('lists brands', async () => {
15
+ const { registry, getRequests } = setup();
16
+ await registry.brands.list();
17
+ expect(getRequests()[0].url).toContain('/api/relay/rest/registry/beta/brands');
18
+ });
19
+
20
+ it('creates a brand', async () => {
21
+ const { registry, getRequests } = setup([{ status: 200, body: { id: 'b1' } }]);
22
+ await registry.brands.create({ name: 'Acme' });
23
+ expect(getRequests()[0].method).toBe('POST');
24
+ });
25
+
26
+ it('gets a brand', async () => {
27
+ const { registry, getRequests } = setup([{ status: 200, body: { id: 'b1' } }]);
28
+ await registry.brands.get('b1');
29
+ expect(getRequests()[0].url).toContain('/brands/b1');
30
+ });
31
+
32
+ it('lists campaigns for a brand', async () => {
33
+ const { registry, getRequests } = setup();
34
+ await registry.brands.listCampaigns('b1');
35
+ expect(getRequests()[0].url).toContain('/brands/b1/campaigns');
36
+ });
37
+
38
+ it('creates a campaign for a brand', async () => {
39
+ const { registry, getRequests } = setup([{ status: 200, body: { id: 'c1' } }]);
40
+ await registry.brands.createCampaign('b1', { use_case: 'marketing' });
41
+ expect(getRequests()[0].method).toBe('POST');
42
+ expect(getRequests()[0].url).toContain('/brands/b1/campaigns');
43
+ });
44
+ });
45
+
46
+ describe('Campaigns', () => {
47
+ it('gets a campaign', async () => {
48
+ const { registry, getRequests } = setup([{ status: 200, body: { id: 'c1' } }]);
49
+ await registry.campaigns.get('c1');
50
+ expect(getRequests()[0].url).toContain('/campaigns/c1');
51
+ });
52
+
53
+ it('updates a campaign with PUT', async () => {
54
+ const { registry, getRequests } = setup([{ status: 200, body: {} }]);
55
+ await registry.campaigns.update('c1', { description: 'updated' });
56
+ expect(getRequests()[0].method).toBe('PUT');
57
+ });
58
+
59
+ it('lists numbers for a campaign', async () => {
60
+ const { registry, getRequests } = setup();
61
+ await registry.campaigns.listNumbers('c1');
62
+ expect(getRequests()[0].url).toContain('/campaigns/c1/numbers');
63
+ });
64
+
65
+ it('lists orders for a campaign', async () => {
66
+ const { registry, getRequests } = setup();
67
+ await registry.campaigns.listOrders('c1');
68
+ expect(getRequests()[0].url).toContain('/campaigns/c1/orders');
69
+ });
70
+
71
+ it('creates an order for a campaign', async () => {
72
+ const { registry, getRequests } = setup([{ status: 200, body: { id: 'o1' } }]);
73
+ await registry.campaigns.createOrder('c1', { number_ids: ['n1'] });
74
+ expect(getRequests()[0].method).toBe('POST');
75
+ });
76
+ });
77
+
78
+ describe('Orders', () => {
79
+ it('gets an order', async () => {
80
+ const { registry, getRequests } = setup([{ status: 200, body: { id: 'o1' } }]);
81
+ await registry.orders.get('o1');
82
+ expect(getRequests()[0].url).toContain('/orders/o1');
83
+ });
84
+ });
85
+
86
+ describe('Numbers', () => {
87
+ it('deletes a number assignment', async () => {
88
+ const { registry, getRequests } = setup([{ status: 204 }]);
89
+ await registry.numbers.delete('n1');
90
+ expect(getRequests()[0].method).toBe('DELETE');
91
+ expect(getRequests()[0].url).toContain('/numbers/n1');
92
+ });
93
+ });
94
+ });
@@ -0,0 +1,290 @@
1
+ import { HttpClient } from '../../src/rest/HttpClient.js';
2
+ import { PhoneNumbersResource } from '../../src/rest/namespaces/phone-numbers.js';
3
+ import { AddressesResource } from '../../src/rest/namespaces/addresses.js';
4
+ import { QueuesResource } from '../../src/rest/namespaces/queues.js';
5
+ import { RecordingsResource } from '../../src/rest/namespaces/recordings.js';
6
+ import { NumberGroupsResource } from '../../src/rest/namespaces/number-groups.js';
7
+ import { VerifiedCallersResource } from '../../src/rest/namespaces/verified-callers.js';
8
+ import { SipProfileResource } from '../../src/rest/namespaces/sip-profile.js';
9
+ import { LookupResource } from '../../src/rest/namespaces/lookup.js';
10
+ import { ShortCodesResource } from '../../src/rest/namespaces/short-codes.js';
11
+ import { ImportedNumbersResource } from '../../src/rest/namespaces/imported-numbers.js';
12
+ import { mockClientOptions } from './helpers.js';
13
+
14
+ function makeHttp(responses: any[] = [{ status: 200, body: { data: [] } }]) {
15
+ const { options, getRequests } = mockClientOptions(responses);
16
+ return { http: new HttpClient(options), getRequests };
17
+ }
18
+
19
+ describe('PhoneNumbersResource', () => {
20
+ it('lists phone numbers', async () => {
21
+ const { http, getRequests } = makeHttp();
22
+ const res = new PhoneNumbersResource(http);
23
+ await res.list();
24
+ expect(getRequests()[0].url).toContain('/api/relay/rest/phone_numbers');
25
+ });
26
+
27
+ it('searches available numbers', async () => {
28
+ const { http, getRequests } = makeHttp();
29
+ const res = new PhoneNumbersResource(http);
30
+ await res.search({ areaCode: '512' });
31
+ expect(getRequests()[0].url).toContain('/api/relay/rest/phone_numbers/search');
32
+ expect(getRequests()[0].url).toContain('areaCode=512');
33
+ });
34
+
35
+ it('updates with PUT', async () => {
36
+ const { http, getRequests } = makeHttp([{ status: 200, body: {} }]);
37
+ const res = new PhoneNumbersResource(http);
38
+ await res.update('pn1', { name: 'main' });
39
+ expect(getRequests()[0].method).toBe('PUT');
40
+ });
41
+
42
+ it('creates (purchases) a number', async () => {
43
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'pn1' } }]);
44
+ const res = new PhoneNumbersResource(http);
45
+ await res.create({ number: '+15551234567' });
46
+ expect(getRequests()[0].method).toBe('POST');
47
+ });
48
+
49
+ it('deletes (releases) a number', async () => {
50
+ const { http, getRequests } = makeHttp([{ status: 204 }]);
51
+ const res = new PhoneNumbersResource(http);
52
+ await res.delete('pn1');
53
+ expect(getRequests()[0].method).toBe('DELETE');
54
+ });
55
+ });
56
+
57
+ describe('AddressesResource', () => {
58
+ it('lists addresses', async () => {
59
+ const { http, getRequests } = makeHttp();
60
+ const res = new AddressesResource(http);
61
+ await res.list();
62
+ expect(getRequests()[0].url).toContain('/api/relay/rest/addresses');
63
+ });
64
+
65
+ it('creates an address', async () => {
66
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'a1' } }]);
67
+ const res = new AddressesResource(http);
68
+ await res.create({ street: '123 Main' });
69
+ expect(getRequests()[0].method).toBe('POST');
70
+ });
71
+
72
+ it('gets an address', async () => {
73
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'a1' } }]);
74
+ const res = new AddressesResource(http);
75
+ await res.get('a1');
76
+ expect(getRequests()[0].url).toContain('/api/relay/rest/addresses/a1');
77
+ });
78
+
79
+ it('deletes an address', async () => {
80
+ const { http, getRequests } = makeHttp([{ status: 204 }]);
81
+ const res = new AddressesResource(http);
82
+ await res.delete('a1');
83
+ expect(getRequests()[0].method).toBe('DELETE');
84
+ });
85
+ });
86
+
87
+ describe('QueuesResource', () => {
88
+ it('lists queues', async () => {
89
+ const { http, getRequests } = makeHttp();
90
+ const res = new QueuesResource(http);
91
+ await res.list();
92
+ expect(getRequests()[0].url).toContain('/api/relay/rest/queues');
93
+ });
94
+
95
+ it('updates with PUT', async () => {
96
+ const { http, getRequests } = makeHttp([{ status: 200, body: {} }]);
97
+ const res = new QueuesResource(http);
98
+ await res.update('q1', { name: 'support' });
99
+ expect(getRequests()[0].method).toBe('PUT');
100
+ });
101
+
102
+ it('lists members', async () => {
103
+ const { http, getRequests } = makeHttp();
104
+ const res = new QueuesResource(http);
105
+ await res.listMembers('q1');
106
+ expect(getRequests()[0].url).toContain('/api/relay/rest/queues/q1/members');
107
+ });
108
+
109
+ it('gets next member', async () => {
110
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'm1' } }]);
111
+ const res = new QueuesResource(http);
112
+ await res.getNextMember('q1');
113
+ expect(getRequests()[0].url).toContain('/api/relay/rest/queues/q1/members/next');
114
+ });
115
+
116
+ it('gets a specific member', async () => {
117
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'm1' } }]);
118
+ const res = new QueuesResource(http);
119
+ await res.getMember('q1', 'm1');
120
+ expect(getRequests()[0].url).toContain('/api/relay/rest/queues/q1/members/m1');
121
+ });
122
+ });
123
+
124
+ describe('RecordingsResource', () => {
125
+ it('lists recordings', async () => {
126
+ const { http, getRequests } = makeHttp();
127
+ const res = new RecordingsResource(http);
128
+ await res.list();
129
+ expect(getRequests()[0].url).toContain('/api/relay/rest/recordings');
130
+ });
131
+
132
+ it('gets a recording', async () => {
133
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'r1' } }]);
134
+ const res = new RecordingsResource(http);
135
+ await res.get('r1');
136
+ expect(getRequests()[0].url).toContain('/api/relay/rest/recordings/r1');
137
+ });
138
+
139
+ it('deletes a recording', async () => {
140
+ const { http, getRequests } = makeHttp([{ status: 204 }]);
141
+ const res = new RecordingsResource(http);
142
+ await res.delete('r1');
143
+ expect(getRequests()[0].method).toBe('DELETE');
144
+ });
145
+ });
146
+
147
+ describe('NumberGroupsResource', () => {
148
+ it('lists number groups', async () => {
149
+ const { http, getRequests } = makeHttp();
150
+ const res = new NumberGroupsResource(http);
151
+ await res.list();
152
+ expect(getRequests()[0].url).toContain('/api/relay/rest/number_groups');
153
+ });
154
+
155
+ it('updates with PUT', async () => {
156
+ const { http, getRequests } = makeHttp([{ status: 200, body: {} }]);
157
+ const res = new NumberGroupsResource(http);
158
+ await res.update('ng1', { name: 'group1' });
159
+ expect(getRequests()[0].method).toBe('PUT');
160
+ });
161
+
162
+ it('lists memberships', async () => {
163
+ const { http, getRequests } = makeHttp();
164
+ const res = new NumberGroupsResource(http);
165
+ await res.listMemberships('ng1');
166
+ expect(getRequests()[0].url).toContain('/api/relay/rest/number_groups/ng1/number_group_memberships');
167
+ });
168
+
169
+ it('adds a membership', async () => {
170
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'ngm1' } }]);
171
+ const res = new NumberGroupsResource(http);
172
+ await res.addMembership('ng1', { phone_number_id: 'pn1' });
173
+ expect(getRequests()[0].method).toBe('POST');
174
+ expect(getRequests()[0].url).toContain('/number_group_memberships');
175
+ });
176
+
177
+ it('gets a membership by ID', async () => {
178
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'ngm1' } }]);
179
+ const res = new NumberGroupsResource(http);
180
+ await res.getMembership('ngm1');
181
+ expect(getRequests()[0].url).toContain('/api/relay/rest/number_group_memberships/ngm1');
182
+ });
183
+
184
+ it('deletes a membership', async () => {
185
+ const { http, getRequests } = makeHttp([{ status: 204 }]);
186
+ const res = new NumberGroupsResource(http);
187
+ await res.deleteMembership('ngm1');
188
+ expect(getRequests()[0].url).toContain('/api/relay/rest/number_group_memberships/ngm1');
189
+ expect(getRequests()[0].method).toBe('DELETE');
190
+ });
191
+ });
192
+
193
+ describe('VerifiedCallersResource', () => {
194
+ it('lists verified callers', async () => {
195
+ const { http, getRequests } = makeHttp();
196
+ const res = new VerifiedCallersResource(http);
197
+ await res.list();
198
+ expect(getRequests()[0].url).toContain('/api/relay/rest/verified_caller_ids');
199
+ });
200
+
201
+ it('updates with PUT', async () => {
202
+ const { http, getRequests } = makeHttp([{ status: 200, body: {} }]);
203
+ const res = new VerifiedCallersResource(http);
204
+ await res.update('vc1', { name: 'main' });
205
+ expect(getRequests()[0].method).toBe('PUT');
206
+ });
207
+
208
+ it('redials verification', async () => {
209
+ const { http, getRequests } = makeHttp([{ status: 200, body: {} }]);
210
+ const res = new VerifiedCallersResource(http);
211
+ await res.redialVerification('vc1');
212
+ expect(getRequests()[0].url).toContain('/verified_caller_ids/vc1/verification');
213
+ expect(getRequests()[0].method).toBe('POST');
214
+ });
215
+
216
+ it('submits verification code', async () => {
217
+ const { http, getRequests } = makeHttp([{ status: 200, body: {} }]);
218
+ const res = new VerifiedCallersResource(http);
219
+ await res.submitVerification('vc1', { code: '1234' });
220
+ expect(getRequests()[0].url).toContain('/verified_caller_ids/vc1/verification');
221
+ expect(getRequests()[0].method).toBe('PUT');
222
+ });
223
+ });
224
+
225
+ describe('SipProfileResource', () => {
226
+ it('gets SIP profile', async () => {
227
+ const { http, getRequests } = makeHttp([{ status: 200, body: { name: 'default' } }]);
228
+ const res = new SipProfileResource(http);
229
+ await res.get();
230
+ expect(getRequests()[0].url).toContain('/api/relay/rest/sip_profile');
231
+ expect(getRequests()[0].method).toBe('GET');
232
+ });
233
+
234
+ it('updates SIP profile with PUT', async () => {
235
+ const { http, getRequests } = makeHttp([{ status: 200, body: {} }]);
236
+ const res = new SipProfileResource(http);
237
+ await res.update({ codecs: ['PCMU'] });
238
+ expect(getRequests()[0].url).toContain('/api/relay/rest/sip_profile');
239
+ expect(getRequests()[0].method).toBe('PUT');
240
+ });
241
+ });
242
+
243
+ describe('LookupResource', () => {
244
+ it('looks up a phone number', async () => {
245
+ const { http, getRequests } = makeHttp([{ status: 200, body: { carrier: 'T-Mobile' } }]);
246
+ const res = new LookupResource(http);
247
+ await res.phoneNumber('+15551234567');
248
+ expect(getRequests()[0].url).toContain('/api/relay/rest/lookup/phone_number/+15551234567');
249
+ });
250
+
251
+ it('passes include params', async () => {
252
+ const { http, getRequests } = makeHttp([{ status: 200, body: {} }]);
253
+ const res = new LookupResource(http);
254
+ await res.phoneNumber('+15551234567', { include: 'cnam' });
255
+ expect(getRequests()[0].url).toContain('include=cnam');
256
+ });
257
+ });
258
+
259
+ describe('ShortCodesResource', () => {
260
+ it('lists short codes', async () => {
261
+ const { http, getRequests } = makeHttp();
262
+ const res = new ShortCodesResource(http);
263
+ await res.list();
264
+ expect(getRequests()[0].url).toContain('/api/relay/rest/short_codes');
265
+ });
266
+
267
+ it('gets a short code', async () => {
268
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'sc1' } }]);
269
+ const res = new ShortCodesResource(http);
270
+ await res.get('sc1');
271
+ expect(getRequests()[0].url).toContain('/api/relay/rest/short_codes/sc1');
272
+ });
273
+
274
+ it('updates with PUT', async () => {
275
+ const { http, getRequests } = makeHttp([{ status: 200, body: {} }]);
276
+ const res = new ShortCodesResource(http);
277
+ await res.update('sc1', { name: 'promo' });
278
+ expect(getRequests()[0].method).toBe('PUT');
279
+ });
280
+ });
281
+
282
+ describe('ImportedNumbersResource', () => {
283
+ it('creates (imports) a number', async () => {
284
+ const { http, getRequests } = makeHttp([{ status: 200, body: { id: 'in1' } }]);
285
+ const res = new ImportedNumbersResource(http);
286
+ await res.create({ number: '+15551234567' });
287
+ expect(getRequests()[0].url).toContain('/api/relay/rest/imported_phone_numbers');
288
+ expect(getRequests()[0].method).toBe('POST');
289
+ });
290
+ });