@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.
- package/.github/workflows/publish.yml +27 -0
- package/.github/workflows/test.yml +17 -0
- package/CLAUDE.md +112 -0
- package/README.md +254 -0
- package/docs/MIGRATION-2.0.md +81 -0
- package/docs/agent-guide.md +869 -0
- package/docs/agent_guide.md +1026 -0
- package/docs/api-reference.md +2420 -0
- package/docs/api_reference.md +1301 -0
- package/docs/architecture.md +843 -0
- package/docs/cli-guide.md +579 -0
- package/docs/cli_guide.md +448 -0
- package/docs/cloud_functions_guide.md +474 -0
- package/docs/configuration.md +422 -0
- package/docs/contexts-guide.md +787 -0
- package/docs/contexts_guide.md +511 -0
- package/docs/datamap-guide.md +1141 -0
- package/docs/datamap_guide.md +595 -0
- package/docs/llm_parameters.md +239 -0
- package/docs/mcp_gateway_reference.md +648 -0
- package/docs/mcp_integration.md +108 -0
- package/docs/prefabs-guide.md +800 -0
- package/docs/sdk_features.md +477 -0
- package/docs/security.md +436 -0
- package/docs/serverless-guide.md +513 -0
- package/docs/skills-guide.md +857 -0
- package/docs/skills-system.md +301 -0
- package/docs/skills_parameter_schema.md +392 -0
- package/docs/skills_system.md +467 -0
- package/docs/swaig-reference.md +1627 -0
- package/docs/swaig_reference.md +910 -0
- package/docs/swml_service_guide.md +600 -0
- package/docs/third_party_skills.md +533 -0
- package/docs/web_service.md +677 -0
- package/examples/README.md +131 -0
- package/examples/advanced-datamap.ts +100 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +94 -0
- package/examples/call-flow.ts +63 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +55 -0
- package/examples/datasphere-multi-instance.ts +63 -0
- package/examples/datasphere-serverless-env.ts +68 -0
- package/examples/datasphere-webhook-env.ts +66 -0
- package/examples/datasphere.ts +37 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +71 -0
- package/examples/gather-per-question-functions-demo.ts +140 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +69 -0
- package/examples/mcp-agent.ts +84 -0
- package/examples/mcp-gateway.ts +35 -0
- package/examples/multi-agent.ts +73 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pom-prompt.ts +71 -0
- package/examples/prefab-concierge.ts +47 -0
- package/examples/prefab-faq.ts +54 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +68 -0
- package/examples/record-call.ts +67 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +94 -0
- package/examples/serverless-lambda.ts +35 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +38 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +187 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/tap.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +72 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +140 -0
- package/livewire/docs/migration-guide.md +228 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +197 -0
- package/livewire/examples/livewire-multi-tool.ts +117 -0
- package/package.json +38 -0
- package/relay/README.md +70 -0
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
- package/relay/docs/call-methods.md +474 -0
- package/relay/docs/client-reference.md +142 -0
- package/relay/docs/events.md +134 -0
- package/relay/docs/getting-started.md +134 -0
- package/relay/docs/guide.md +306 -0
- package/relay/docs/messaging.md +182 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +71 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +95 -0
- package/rest/docs/calling.md +273 -0
- package/rest/docs/client-reference.md +107 -0
- package/rest/docs/compat.md +204 -0
- package/rest/docs/fabric.md +183 -0
- package/rest/docs/getting-started.md +110 -0
- package/rest/docs/guide.md +351 -0
- package/rest/docs/namespaces.md +285 -0
- package/rest/examples/rest-10dlc-registration.ts +161 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
- package/rest/examples/rest-calling-play-and-record.ts +91 -0
- package/rest/examples/rest-client.ts +65 -0
- package/rest/examples/rest-compat-laml.ts +210 -0
- package/rest/examples/rest-datasphere-search.ts +82 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
- package/rest/examples/rest-manage-resources.ts +65 -0
- package/rest/examples/rest-phone-number-management.ts +197 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/src/AgentBase.ts +2489 -0
- package/src/AgentServer.ts +415 -0
- package/src/AuthHandler.ts +256 -0
- package/src/ConfigLoader.ts +447 -0
- package/src/ContextBuilder.ts +1150 -0
- package/src/DataMap.ts +449 -0
- package/src/FunctionResult.ts +866 -0
- package/src/Logger.ts +337 -0
- package/src/PomBuilder.ts +439 -0
- package/src/PromptManager.ts +133 -0
- package/src/SWMLHandler.ts +298 -0
- package/src/SWMLService.ts +717 -0
- package/src/SchemaUtils.ts +361 -0
- package/src/SecurityUtils.ts +153 -0
- package/src/ServerlessAdapter.ts +221 -0
- package/src/SessionManager.ts +311 -0
- package/src/SslConfig.ts +118 -0
- package/src/SwaigFunction.ts +276 -0
- package/src/SwmlBuilder.ts +258 -0
- package/src/SwmlVerbMethods.generated.ts +234 -0
- package/src/TypeInference.ts +181 -0
- package/src/WebService.ts +619 -0
- package/src/cli/agent-loader.ts +166 -0
- package/src/cli/mock-data.ts +111 -0
- package/src/cli/swaig-test.ts +452 -0
- package/src/generateVerbTypes.ts +322 -0
- package/src/index.ts +167 -0
- package/src/livewire/index.ts +950 -0
- package/src/prefabs/ConciergeAgent.ts +287 -0
- package/src/prefabs/FAQBotAgent.ts +384 -0
- package/src/prefabs/InfoGathererAgent.ts +339 -0
- package/src/prefabs/ReceptionistAgent.ts +366 -0
- package/src/prefabs/SurveyAgent.ts +646 -0
- package/src/prefabs/index.ts +27 -0
- package/src/relay/Action.ts +314 -0
- package/src/relay/Call.ts +854 -0
- package/src/relay/Deferred.ts +71 -0
- package/src/relay/Message.ts +148 -0
- package/src/relay/RelayClient.ts +1036 -0
- package/src/relay/RelayError.ts +14 -0
- package/src/relay/RelayEvent.ts +892 -0
- package/src/relay/constants.ts +132 -0
- package/src/relay/index.ts +123 -0
- package/src/relay/types.ts +149 -0
- package/src/rest/HttpClient.ts +103 -0
- package/src/rest/RestError.ts +31 -0
- package/src/rest/base/BaseResource.ts +19 -0
- package/src/rest/base/CrudResource.ts +51 -0
- package/src/rest/base/CrudWithAddresses.ts +26 -0
- package/src/rest/index.ts +200 -0
- package/src/rest/namespaces/addresses.ts +32 -0
- package/src/rest/namespaces/calling.ts +187 -0
- package/src/rest/namespaces/chat.ts +20 -0
- package/src/rest/namespaces/compat.ts +352 -0
- package/src/rest/namespaces/datasphere.ts +45 -0
- package/src/rest/namespaces/fabric.ts +222 -0
- package/src/rest/namespaces/imported-numbers.ts +20 -0
- package/src/rest/namespaces/logs.ts +84 -0
- package/src/rest/namespaces/lookup.ts +21 -0
- package/src/rest/namespaces/mfa.ts +30 -0
- package/src/rest/namespaces/number-groups.ts +38 -0
- package/src/rest/namespaces/phone-numbers.ts +44 -0
- package/src/rest/namespaces/project.ts +36 -0
- package/src/rest/namespaces/pubsub.ts +20 -0
- package/src/rest/namespaces/queues.ts +33 -0
- package/src/rest/namespaces/recordings.ts +28 -0
- package/src/rest/namespaces/registry.ts +101 -0
- package/src/rest/namespaces/short-codes.ts +28 -0
- package/src/rest/namespaces/sip-profile.ts +25 -0
- package/src/rest/namespaces/verified-callers.ts +27 -0
- package/src/rest/namespaces/video.ts +165 -0
- package/src/rest/pagination.ts +84 -0
- package/src/rest/types.ts +61 -0
- package/src/schema.json +12250 -0
- package/src/skills/SkillBase.ts +547 -0
- package/src/skills/SkillManager.ts +415 -0
- package/src/skills/SkillRegistry.ts +367 -0
- package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
- package/src/skills/builtin/ask_claude.ts +241 -0
- package/src/skills/builtin/claude_skills.ts +978 -0
- package/src/skills/builtin/custom_skills.ts +312 -0
- package/src/skills/builtin/datasphere.ts +438 -0
- package/src/skills/builtin/datasphere_serverless.ts +339 -0
- package/src/skills/builtin/datetime.ts +130 -0
- package/src/skills/builtin/google_maps.ts +651 -0
- package/src/skills/builtin/index.ts +88 -0
- package/src/skills/builtin/info_gatherer.ts +405 -0
- package/src/skills/builtin/joke.ts +191 -0
- package/src/skills/builtin/math.ts +142 -0
- package/src/skills/builtin/mcp_gateway.ts +677 -0
- package/src/skills/builtin/native_vector_search.ts +901 -0
- package/src/skills/builtin/play_background_file.ts +358 -0
- package/src/skills/builtin/spider.ts +869 -0
- package/src/skills/builtin/swml_transfer.ts +635 -0
- package/src/skills/builtin/weather_api.ts +248 -0
- package/src/skills/builtin/web_search.ts +1074 -0
- package/src/skills/builtin/wikipedia_search.ts +299 -0
- package/src/skills/index.ts +12 -0
- package/src/types.ts +132 -0
- package/tests/AgentBase.test.ts +1093 -0
- package/tests/AgentServer.test.ts +126 -0
- package/tests/AuthHandler.test.ts +133 -0
- package/tests/ConfigLoader.test.ts +151 -0
- package/tests/ContextBuilder.test.ts +108 -0
- package/tests/DataMap.test.ts +367 -0
- package/tests/EphemeralSkillCopy.test.ts +107 -0
- package/tests/FunctionResult.test.ts +298 -0
- package/tests/GracefulShutdown.test.ts +46 -0
- package/tests/Logger.test.ts +420 -0
- package/tests/PomBuilder.test.ts +228 -0
- package/tests/ProxyDetection.test.ts +228 -0
- package/tests/SWMLService.test.ts +320 -0
- package/tests/SWMLVerbHandler.test.ts +523 -0
- package/tests/SchemaUtils.test.ts +106 -0
- package/tests/SchemaUtils.verb.test.ts +206 -0
- package/tests/SecurityUtils.test.ts +192 -0
- package/tests/ServerlessAdapter.test.ts +222 -0
- package/tests/SessionManager.test.ts +257 -0
- package/tests/SkillBaseFeatures.test.ts +130 -0
- package/tests/SkillMultiInstance.test.ts +102 -0
- package/tests/SkillParameterSchemas.test.ts +134 -0
- package/tests/SkillRegistrySchema.test.ts +84 -0
- package/tests/SslConfig.test.ts +97 -0
- package/tests/SwmlBuilder.test.ts +400 -0
- package/tests/TypeInference.test.ts +165 -0
- package/tests/VerbHandlerRegistry.test.ts +128 -0
- package/tests/cli/mock-data.test.ts +113 -0
- package/tests/cli/swaig-test.test.ts +108 -0
- package/tests/examples.test.ts +194 -0
- package/tests/fixtures/scrape-parity/README.md +53 -0
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
- package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
- package/tests/fixtures/scrape-parity/python_extract.py +109 -0
- package/tests/livewire/livewire.test.ts +780 -0
- package/tests/mcp.test.ts +221 -0
- package/tests/prefabs/prefabs.test.ts +1093 -0
- package/tests/relay/Action.test.ts +392 -0
- package/tests/relay/Call.test.ts +535 -0
- package/tests/relay/Deferred.test.ts +71 -0
- package/tests/relay/Message.test.ts +164 -0
- package/tests/relay/RelayClient.test.ts +779 -0
- package/tests/relay/RelayEvent.test.ts +463 -0
- package/tests/relay/helpers.ts +79 -0
- package/tests/rest/HttpClient.test.ts +274 -0
- package/tests/rest/RestError.test.ts +53 -0
- package/tests/rest/calling.test.ts +156 -0
- package/tests/rest/client.test.ts +197 -0
- package/tests/rest/compat.test.ts +335 -0
- package/tests/rest/datasphere.test.ts +71 -0
- package/tests/rest/fabric.test.ts +186 -0
- package/tests/rest/helpers.ts +95 -0
- package/tests/rest/logs.test.ts +68 -0
- package/tests/rest/pagination.test.ts +133 -0
- package/tests/rest/registry.test.ts +94 -0
- package/tests/rest/relay-rest.test.ts +290 -0
- package/tests/rest/video.test.ts +173 -0
- package/tests/setup.ts +6 -0
- package/tests/skills/SkillBase.test.ts +108 -0
- package/tests/skills/SkillManager.test.ts +268 -0
- package/tests/skills/SkillRegistry.test.ts +176 -0
- package/tests/skills/builtin.test.ts +1472 -0
- package/tests/skills/claude-skills.test.ts +54 -0
- package/tests/skills/custom-skills.test.ts +53 -0
- package/tests/skills/datasphere-serverless.test.ts +70 -0
- package/tests/skills/datasphere.test.ts +107 -0
- package/tests/skills/datetime.test.ts +101 -0
- package/tests/skills/google-maps.test.ts +78 -0
- package/tests/skills/info-gatherer.test.ts +411 -0
- package/tests/skills/joke.test.ts +81 -0
- package/tests/skills/math.test.ts +68 -0
- package/tests/skills/mcp-gateway.test.ts +101 -0
- package/tests/skills/play-background.test.ts +54 -0
- package/tests/skills/spider.test.ts +108 -0
- package/tests/skills/swml-transfer.test.ts +178 -0
- package/tests/skills/trivia.test.ts +54 -0
- package/tests/skills/vector-search.test.ts +135 -0
- package/tests/skills/weather-api.test.ts +77 -0
- package/tests/skills/web-search-parity.test.ts +59 -0
- package/tests/skills/web-search.test.ts +103 -0
- package/tests/skills/wikipedia.test.ts +63 -0
- package/tsconfig.json +18 -0
- package/vitest.config.ts +9 -0
|
@@ -0,0 +1,335 @@
|
|
|
1
|
+
import { HttpClient } from '../../src/rest/HttpClient.js';
|
|
2
|
+
import { CompatNamespace } from '../../src/rest/namespaces/compat.js';
|
|
3
|
+
import { mockClientOptions } from './helpers.js';
|
|
4
|
+
|
|
5
|
+
const SID = 'AC-test-sid';
|
|
6
|
+
|
|
7
|
+
describe('CompatNamespace', () => {
|
|
8
|
+
function setup(responses: any[] = [{ status: 200, body: {} }]) {
|
|
9
|
+
const { options, getRequests } = mockClientOptions(responses);
|
|
10
|
+
const http = new HttpClient(options);
|
|
11
|
+
const compat = new CompatNamespace(http, SID);
|
|
12
|
+
return { compat, getRequests };
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
const base = `/api/laml/2010-04-01/Accounts/${SID}`;
|
|
16
|
+
|
|
17
|
+
describe('Accounts', () => {
|
|
18
|
+
it('lists accounts (unscoped)', async () => {
|
|
19
|
+
const { compat, getRequests } = setup();
|
|
20
|
+
await compat.accounts.list();
|
|
21
|
+
expect(getRequests()[0].url).toContain('/api/laml/2010-04-01/Accounts');
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
it('updates account with POST', async () => {
|
|
25
|
+
const { compat, getRequests } = setup();
|
|
26
|
+
await compat.accounts.update('AC1', { friendly_name: 'test' });
|
|
27
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
28
|
+
});
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
describe('Calls', () => {
|
|
32
|
+
it('lists calls at correct path', async () => {
|
|
33
|
+
const { compat, getRequests } = setup();
|
|
34
|
+
await compat.calls.list();
|
|
35
|
+
expect(getRequests()[0].url).toContain(`${base}/Calls`);
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
it('creates a call', async () => {
|
|
39
|
+
const { compat, getRequests } = setup();
|
|
40
|
+
await compat.calls.create({ To: '+15551234567', From: '+15559876543' });
|
|
41
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
42
|
+
expect(getRequests()[0].body.To).toBe('+15551234567');
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
it('updates with POST (not PATCH)', async () => {
|
|
46
|
+
const { compat, getRequests } = setup();
|
|
47
|
+
await compat.calls.update('CA1', { Status: 'completed' });
|
|
48
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
49
|
+
expect(getRequests()[0].url).toContain(`${base}/Calls/CA1`);
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
it('starts a recording', async () => {
|
|
53
|
+
const { compat, getRequests } = setup();
|
|
54
|
+
await compat.calls.startRecording('CA1');
|
|
55
|
+
expect(getRequests()[0].url).toContain(`${base}/Calls/CA1/Recordings`);
|
|
56
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it('updates a recording', async () => {
|
|
60
|
+
const { compat, getRequests } = setup();
|
|
61
|
+
await compat.calls.updateRecording('CA1', 'RE1', { Status: 'paused' });
|
|
62
|
+
expect(getRequests()[0].url).toContain(`${base}/Calls/CA1/Recordings/RE1`);
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
it('starts a stream', async () => {
|
|
66
|
+
const { compat, getRequests } = setup();
|
|
67
|
+
await compat.calls.startStream('CA1');
|
|
68
|
+
expect(getRequests()[0].url).toContain(`${base}/Calls/CA1/Streams`);
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
it('stops a stream', async () => {
|
|
72
|
+
const { compat, getRequests } = setup();
|
|
73
|
+
await compat.calls.stopStream('CA1', 'ST1');
|
|
74
|
+
expect(getRequests()[0].url).toContain(`${base}/Calls/CA1/Streams/ST1`);
|
|
75
|
+
});
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
describe('Messages', () => {
|
|
79
|
+
it('creates a message', async () => {
|
|
80
|
+
const { compat, getRequests } = setup();
|
|
81
|
+
await compat.messages.create({ To: '+15551234567', Body: 'hi' });
|
|
82
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
83
|
+
expect(getRequests()[0].url).toContain(`${base}/Messages`);
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it('updates with POST', async () => {
|
|
87
|
+
const { compat, getRequests } = setup();
|
|
88
|
+
await compat.messages.update('MM1', { Body: 'updated' });
|
|
89
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
it('lists media for a message', async () => {
|
|
93
|
+
const { compat, getRequests } = setup();
|
|
94
|
+
await compat.messages.listMedia('MM1');
|
|
95
|
+
expect(getRequests()[0].url).toContain(`${base}/Messages/MM1/Media`);
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
it('gets media for a message', async () => {
|
|
99
|
+
const { compat, getRequests } = setup();
|
|
100
|
+
await compat.messages.getMedia('MM1', 'ME1');
|
|
101
|
+
expect(getRequests()[0].url).toContain(`${base}/Messages/MM1/Media/ME1`);
|
|
102
|
+
});
|
|
103
|
+
|
|
104
|
+
it('deletes media', async () => {
|
|
105
|
+
const { compat, getRequests } = setup([{ status: 204 }]);
|
|
106
|
+
await compat.messages.deleteMedia('MM1', 'ME1');
|
|
107
|
+
expect(getRequests()[0].method).toBe('DELETE');
|
|
108
|
+
});
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
describe('Faxes', () => {
|
|
112
|
+
it('lists faxes', async () => {
|
|
113
|
+
const { compat, getRequests } = setup();
|
|
114
|
+
await compat.faxes.list();
|
|
115
|
+
expect(getRequests()[0].url).toContain(`${base}/Faxes`);
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
it('lists media for a fax', async () => {
|
|
119
|
+
const { compat, getRequests } = setup();
|
|
120
|
+
await compat.faxes.listMedia('FX1');
|
|
121
|
+
expect(getRequests()[0].url).toContain(`${base}/Faxes/FX1/Media`);
|
|
122
|
+
});
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
describe('Conferences', () => {
|
|
126
|
+
it('lists conferences', async () => {
|
|
127
|
+
const { compat, getRequests } = setup();
|
|
128
|
+
await compat.conferences.list();
|
|
129
|
+
expect(getRequests()[0].url).toContain(`${base}/Conferences`);
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
it('updates with POST', async () => {
|
|
133
|
+
const { compat, getRequests } = setup();
|
|
134
|
+
await compat.conferences.update('CF1', { Status: 'completed' });
|
|
135
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
it('lists participants', async () => {
|
|
139
|
+
const { compat, getRequests } = setup();
|
|
140
|
+
await compat.conferences.listParticipants('CF1');
|
|
141
|
+
expect(getRequests()[0].url).toContain(`${base}/Conferences/CF1/Participants`);
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
it('gets a participant', async () => {
|
|
145
|
+
const { compat, getRequests } = setup();
|
|
146
|
+
await compat.conferences.getParticipant('CF1', 'CA1');
|
|
147
|
+
expect(getRequests()[0].url).toContain(`${base}/Conferences/CF1/Participants/CA1`);
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
it('updates a participant with POST', async () => {
|
|
151
|
+
const { compat, getRequests } = setup();
|
|
152
|
+
await compat.conferences.updateParticipant('CF1', 'CA1', { Muted: true });
|
|
153
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
154
|
+
});
|
|
155
|
+
|
|
156
|
+
it('removes a participant', async () => {
|
|
157
|
+
const { compat, getRequests } = setup([{ status: 204 }]);
|
|
158
|
+
await compat.conferences.removeParticipant('CF1', 'CA1');
|
|
159
|
+
expect(getRequests()[0].method).toBe('DELETE');
|
|
160
|
+
});
|
|
161
|
+
|
|
162
|
+
it('lists conference recordings', async () => {
|
|
163
|
+
const { compat, getRequests } = setup();
|
|
164
|
+
await compat.conferences.listRecordings('CF1');
|
|
165
|
+
expect(getRequests()[0].url).toContain(`${base}/Conferences/CF1/Recordings`);
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
it('updates a conference recording with POST', async () => {
|
|
169
|
+
const { compat, getRequests } = setup();
|
|
170
|
+
await compat.conferences.updateRecording('CF1', 'RE1', { Status: 'paused' });
|
|
171
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
172
|
+
});
|
|
173
|
+
|
|
174
|
+
it('deletes a conference recording', async () => {
|
|
175
|
+
const { compat, getRequests } = setup([{ status: 204 }]);
|
|
176
|
+
await compat.conferences.deleteRecording('CF1', 'RE1');
|
|
177
|
+
expect(getRequests()[0].method).toBe('DELETE');
|
|
178
|
+
});
|
|
179
|
+
|
|
180
|
+
it('starts a stream', async () => {
|
|
181
|
+
const { compat, getRequests } = setup();
|
|
182
|
+
await compat.conferences.startStream('CF1');
|
|
183
|
+
expect(getRequests()[0].url).toContain(`${base}/Conferences/CF1/Streams`);
|
|
184
|
+
});
|
|
185
|
+
|
|
186
|
+
it('stops a stream', async () => {
|
|
187
|
+
const { compat, getRequests } = setup();
|
|
188
|
+
await compat.conferences.stopStream('CF1', 'ST1');
|
|
189
|
+
expect(getRequests()[0].url).toContain(`${base}/Conferences/CF1/Streams/ST1`);
|
|
190
|
+
});
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
describe('Phone Numbers', () => {
|
|
194
|
+
it('lists incoming numbers', async () => {
|
|
195
|
+
const { compat, getRequests } = setup();
|
|
196
|
+
await compat.phoneNumbers.list();
|
|
197
|
+
expect(getRequests()[0].url).toContain(`${base}/IncomingPhoneNumbers`);
|
|
198
|
+
});
|
|
199
|
+
|
|
200
|
+
it('purchases a number', async () => {
|
|
201
|
+
const { compat, getRequests } = setup();
|
|
202
|
+
await compat.phoneNumbers.purchase({ PhoneNumber: '+15551234567' });
|
|
203
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
204
|
+
});
|
|
205
|
+
|
|
206
|
+
it('updates with POST', async () => {
|
|
207
|
+
const { compat, getRequests } = setup();
|
|
208
|
+
await compat.phoneNumbers.update('PN1', { FriendlyName: 'main' });
|
|
209
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
it('imports a number', async () => {
|
|
213
|
+
const { compat, getRequests } = setup();
|
|
214
|
+
await compat.phoneNumbers.importNumber({ PhoneNumber: '+15551234567' });
|
|
215
|
+
expect(getRequests()[0].url).toContain(`${base}/ImportedPhoneNumbers`);
|
|
216
|
+
});
|
|
217
|
+
|
|
218
|
+
it('lists available countries', async () => {
|
|
219
|
+
const { compat, getRequests } = setup();
|
|
220
|
+
await compat.phoneNumbers.listAvailableCountries();
|
|
221
|
+
expect(getRequests()[0].url).toContain(`${base}/AvailablePhoneNumbers`);
|
|
222
|
+
});
|
|
223
|
+
|
|
224
|
+
it('searches local numbers', async () => {
|
|
225
|
+
const { compat, getRequests } = setup();
|
|
226
|
+
await compat.phoneNumbers.searchLocal('US', { AreaCode: '512' });
|
|
227
|
+
expect(getRequests()[0].url).toContain(`${base}/AvailablePhoneNumbers/US/Local`);
|
|
228
|
+
expect(getRequests()[0].url).toContain('AreaCode=512');
|
|
229
|
+
});
|
|
230
|
+
|
|
231
|
+
it('searches toll-free numbers', async () => {
|
|
232
|
+
const { compat, getRequests } = setup();
|
|
233
|
+
await compat.phoneNumbers.searchTollFree('US');
|
|
234
|
+
expect(getRequests()[0].url).toContain(`${base}/AvailablePhoneNumbers/US/TollFree`);
|
|
235
|
+
});
|
|
236
|
+
});
|
|
237
|
+
|
|
238
|
+
describe('Applications', () => {
|
|
239
|
+
it('lists applications', async () => {
|
|
240
|
+
const { compat, getRequests } = setup();
|
|
241
|
+
await compat.applications.list();
|
|
242
|
+
expect(getRequests()[0].url).toContain(`${base}/Applications`);
|
|
243
|
+
});
|
|
244
|
+
|
|
245
|
+
it('updates with POST', async () => {
|
|
246
|
+
const { compat, getRequests } = setup();
|
|
247
|
+
await compat.applications.update('AP1', { FriendlyName: 'updated' });
|
|
248
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
249
|
+
});
|
|
250
|
+
});
|
|
251
|
+
|
|
252
|
+
describe('LaML Bins', () => {
|
|
253
|
+
it('creates a LaML bin', async () => {
|
|
254
|
+
const { compat, getRequests } = setup();
|
|
255
|
+
await compat.lamlBins.create({ Name: 'test', Contents: '<Response/>' });
|
|
256
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
257
|
+
expect(getRequests()[0].url).toContain(`${base}/LamlBins`);
|
|
258
|
+
});
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
describe('Queues', () => {
|
|
262
|
+
it('lists queues', async () => {
|
|
263
|
+
const { compat, getRequests } = setup();
|
|
264
|
+
await compat.queues.list();
|
|
265
|
+
expect(getRequests()[0].url).toContain(`${base}/Queues`);
|
|
266
|
+
});
|
|
267
|
+
|
|
268
|
+
it('lists members', async () => {
|
|
269
|
+
const { compat, getRequests } = setup();
|
|
270
|
+
await compat.queues.listMembers('QU1');
|
|
271
|
+
expect(getRequests()[0].url).toContain(`${base}/Queues/QU1/Members`);
|
|
272
|
+
});
|
|
273
|
+
|
|
274
|
+
it('gets a member', async () => {
|
|
275
|
+
const { compat, getRequests } = setup();
|
|
276
|
+
await compat.queues.getMember('QU1', 'CA1');
|
|
277
|
+
expect(getRequests()[0].url).toContain(`${base}/Queues/QU1/Members/CA1`);
|
|
278
|
+
});
|
|
279
|
+
|
|
280
|
+
it('dequeues a member', async () => {
|
|
281
|
+
const { compat, getRequests } = setup();
|
|
282
|
+
await compat.queues.dequeueMember('QU1', 'CA1');
|
|
283
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
284
|
+
});
|
|
285
|
+
});
|
|
286
|
+
|
|
287
|
+
describe('Recordings', () => {
|
|
288
|
+
it('lists recordings', async () => {
|
|
289
|
+
const { compat, getRequests } = setup();
|
|
290
|
+
await compat.recordings.list();
|
|
291
|
+
expect(getRequests()[0].url).toContain(`${base}/Recordings`);
|
|
292
|
+
});
|
|
293
|
+
|
|
294
|
+
it('deletes a recording', async () => {
|
|
295
|
+
const { compat, getRequests } = setup([{ status: 204 }]);
|
|
296
|
+
await compat.recordings.delete('RE1');
|
|
297
|
+
expect(getRequests()[0].method).toBe('DELETE');
|
|
298
|
+
});
|
|
299
|
+
});
|
|
300
|
+
|
|
301
|
+
describe('Transcriptions', () => {
|
|
302
|
+
it('lists transcriptions', async () => {
|
|
303
|
+
const { compat, getRequests } = setup();
|
|
304
|
+
await compat.transcriptions.list();
|
|
305
|
+
expect(getRequests()[0].url).toContain(`${base}/Transcriptions`);
|
|
306
|
+
});
|
|
307
|
+
|
|
308
|
+
it('deletes a transcription', async () => {
|
|
309
|
+
const { compat, getRequests } = setup([{ status: 204 }]);
|
|
310
|
+
await compat.transcriptions.delete('TR1');
|
|
311
|
+
expect(getRequests()[0].method).toBe('DELETE');
|
|
312
|
+
});
|
|
313
|
+
});
|
|
314
|
+
|
|
315
|
+
describe('Tokens', () => {
|
|
316
|
+
it('creates a token', async () => {
|
|
317
|
+
const { compat, getRequests } = setup();
|
|
318
|
+
await compat.tokens.create({ label: 'test' });
|
|
319
|
+
expect(getRequests()[0].url).toContain(`${base}/tokens`);
|
|
320
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
321
|
+
});
|
|
322
|
+
|
|
323
|
+
it('updates a token with PATCH', async () => {
|
|
324
|
+
const { compat, getRequests } = setup();
|
|
325
|
+
await compat.tokens.update('t1', { label: 'updated' });
|
|
326
|
+
expect(getRequests()[0].method).toBe('PATCH');
|
|
327
|
+
});
|
|
328
|
+
|
|
329
|
+
it('deletes a token', async () => {
|
|
330
|
+
const { compat, getRequests } = setup([{ status: 204 }]);
|
|
331
|
+
await compat.tokens.delete('t1');
|
|
332
|
+
expect(getRequests()[0].method).toBe('DELETE');
|
|
333
|
+
});
|
|
334
|
+
});
|
|
335
|
+
});
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { HttpClient } from '../../src/rest/HttpClient.js';
|
|
2
|
+
import { DatasphereNamespace } from '../../src/rest/namespaces/datasphere.js';
|
|
3
|
+
import { mockClientOptions } from './helpers.js';
|
|
4
|
+
|
|
5
|
+
describe('DatasphereNamespace', () => {
|
|
6
|
+
function setup(responses: any[] = [{ status: 200, body: { data: [] } }]) {
|
|
7
|
+
const { options, getRequests } = mockClientOptions(responses);
|
|
8
|
+
const http = new HttpClient(options);
|
|
9
|
+
const ds = new DatasphereNamespace(http);
|
|
10
|
+
return { ds, getRequests };
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
it('lists documents', async () => {
|
|
14
|
+
const { ds, getRequests } = setup();
|
|
15
|
+
await ds.documents.list();
|
|
16
|
+
expect(getRequests()[0].url).toContain('/api/datasphere/documents');
|
|
17
|
+
expect(getRequests()[0].method).toBe('GET');
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
it('creates a document', async () => {
|
|
21
|
+
const { ds, getRequests } = setup([{ status: 200, body: { id: 'doc1' } }]);
|
|
22
|
+
await ds.documents.create({ name: 'test', content: 'hello' });
|
|
23
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
24
|
+
expect(getRequests()[0].body).toEqual({ name: 'test', content: 'hello' });
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
it('gets a document', async () => {
|
|
28
|
+
const { ds, getRequests } = setup([{ status: 200, body: { id: 'doc1' } }]);
|
|
29
|
+
await ds.documents.get('doc1');
|
|
30
|
+
expect(getRequests()[0].url).toContain('/api/datasphere/documents/doc1');
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
it('updates a document', async () => {
|
|
34
|
+
const { ds, getRequests } = setup([{ status: 200, body: { id: 'doc1' } }]);
|
|
35
|
+
await ds.documents.update('doc1', { name: 'updated' });
|
|
36
|
+
expect(getRequests()[0].method).toBe('PATCH');
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it('deletes a document', async () => {
|
|
40
|
+
const { ds, getRequests } = setup([{ status: 204 }]);
|
|
41
|
+
await ds.documents.delete('doc1');
|
|
42
|
+
expect(getRequests()[0].method).toBe('DELETE');
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
it('searches documents', async () => {
|
|
46
|
+
const { ds, getRequests } = setup([{ status: 200, body: { results: [] } }]);
|
|
47
|
+
await ds.documents.search({ query: 'test query', count: 5 });
|
|
48
|
+
expect(getRequests()[0].url).toContain('/api/datasphere/documents/search');
|
|
49
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
50
|
+
expect(getRequests()[0].body).toEqual({ query: 'test query', count: 5 });
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it('lists chunks for a document', async () => {
|
|
54
|
+
const { ds, getRequests } = setup();
|
|
55
|
+
await ds.documents.listChunks('doc1');
|
|
56
|
+
expect(getRequests()[0].url).toContain('/api/datasphere/documents/doc1/chunks');
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it('gets a specific chunk', async () => {
|
|
60
|
+
const { ds, getRequests } = setup([{ status: 200, body: { id: 'c1' } }]);
|
|
61
|
+
await ds.documents.getChunk('doc1', 'c1');
|
|
62
|
+
expect(getRequests()[0].url).toContain('/api/datasphere/documents/doc1/chunks/c1');
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
it('deletes a specific chunk', async () => {
|
|
66
|
+
const { ds, getRequests } = setup([{ status: 204 }]);
|
|
67
|
+
await ds.documents.deleteChunk('doc1', 'c1');
|
|
68
|
+
expect(getRequests()[0].method).toBe('DELETE');
|
|
69
|
+
expect(getRequests()[0].url).toContain('/api/datasphere/documents/doc1/chunks/c1');
|
|
70
|
+
});
|
|
71
|
+
});
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
import { HttpClient } from '../../src/rest/HttpClient.js';
|
|
2
|
+
import { FabricNamespace } from '../../src/rest/namespaces/fabric.js';
|
|
3
|
+
import { mockClientOptions } from './helpers.js';
|
|
4
|
+
|
|
5
|
+
describe('FabricNamespace', () => {
|
|
6
|
+
function setup(responses: any[] = [{ status: 200, body: { data: [] } }]) {
|
|
7
|
+
const { options, getRequests } = mockClientOptions(responses);
|
|
8
|
+
const http = new HttpClient(options);
|
|
9
|
+
const fabric = new FabricNamespace(http);
|
|
10
|
+
return { fabric, getRequests };
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
describe('AI Agents (PATCH-update)', () => {
|
|
14
|
+
it('lists ai agents', async () => {
|
|
15
|
+
const { fabric, getRequests } = setup();
|
|
16
|
+
await fabric.aiAgents.list();
|
|
17
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources/ai_agents');
|
|
18
|
+
expect(getRequests()[0].method).toBe('GET');
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
it('creates an ai agent', async () => {
|
|
22
|
+
const { fabric, getRequests } = setup([{ status: 200, body: { id: 'a1' } }]);
|
|
23
|
+
await fabric.aiAgents.create({ name: 'test' });
|
|
24
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
25
|
+
expect(getRequests()[0].body).toEqual({ name: 'test' });
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
it('updates ai agent with PATCH', async () => {
|
|
29
|
+
const { fabric, getRequests } = setup([{ status: 200, body: { id: 'a1' } }]);
|
|
30
|
+
await fabric.aiAgents.update('a1', { name: 'updated' });
|
|
31
|
+
expect(getRequests()[0].method).toBe('PATCH');
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
it('lists addresses for ai agent', async () => {
|
|
35
|
+
const { fabric, getRequests } = setup();
|
|
36
|
+
await fabric.aiAgents.listAddresses('a1');
|
|
37
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources/ai_agents/a1/addresses');
|
|
38
|
+
});
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
describe('SWML Scripts (PUT-update)', () => {
|
|
42
|
+
it('updates swml script with PUT', async () => {
|
|
43
|
+
const { fabric, getRequests } = setup([{ status: 200, body: { id: 's1' } }]);
|
|
44
|
+
await fabric.swmlScripts.update('s1', { code: 'new' });
|
|
45
|
+
expect(getRequests()[0].method).toBe('PUT');
|
|
46
|
+
});
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
describe('Call Flows', () => {
|
|
50
|
+
it('uses singular call_flow for addresses', async () => {
|
|
51
|
+
const { fabric, getRequests } = setup();
|
|
52
|
+
await fabric.callFlows.listAddresses('cf1');
|
|
53
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources/call_flow/cf1/addresses');
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
it('lists versions', async () => {
|
|
57
|
+
const { fabric, getRequests } = setup();
|
|
58
|
+
await fabric.callFlows.listVersions('cf1');
|
|
59
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources/call_flow/cf1/versions');
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
it('deploys a version', async () => {
|
|
63
|
+
const { fabric, getRequests } = setup([{ status: 200, body: { version: 2 } }]);
|
|
64
|
+
await fabric.callFlows.deployVersion('cf1', { version: 2 });
|
|
65
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
66
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources/call_flow/cf1/versions');
|
|
67
|
+
});
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
describe('Conference Rooms', () => {
|
|
71
|
+
it('uses singular conference_room for addresses', async () => {
|
|
72
|
+
const { fabric, getRequests } = setup();
|
|
73
|
+
await fabric.conferenceRooms.listAddresses('cr1');
|
|
74
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources/conference_room/cr1/addresses');
|
|
75
|
+
});
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
describe('Subscribers', () => {
|
|
79
|
+
it('lists SIP endpoints', async () => {
|
|
80
|
+
const { fabric, getRequests } = setup();
|
|
81
|
+
await fabric.subscribers.listSipEndpoints('sub1');
|
|
82
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources/subscribers/sub1/sip_endpoints');
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it('creates a SIP endpoint', async () => {
|
|
86
|
+
const { fabric, getRequests } = setup([{ status: 200, body: { id: 'ep1' } }]);
|
|
87
|
+
await fabric.subscribers.createSipEndpoint('sub1', { username: 'test' });
|
|
88
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
89
|
+
expect(getRequests()[0].body).toEqual({ username: 'test' });
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
it('gets a SIP endpoint', async () => {
|
|
93
|
+
const { fabric, getRequests } = setup([{ status: 200, body: { id: 'ep1' } }]);
|
|
94
|
+
await fabric.subscribers.getSipEndpoint('sub1', 'ep1');
|
|
95
|
+
expect(getRequests()[0].url).toContain('/subscribers/sub1/sip_endpoints/ep1');
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
it('updates a SIP endpoint with PATCH', async () => {
|
|
99
|
+
const { fabric, getRequests } = setup([{ status: 200, body: {} }]);
|
|
100
|
+
await fabric.subscribers.updateSipEndpoint('sub1', 'ep1', { password: 'new' });
|
|
101
|
+
expect(getRequests()[0].method).toBe('PATCH');
|
|
102
|
+
});
|
|
103
|
+
|
|
104
|
+
it('deletes a SIP endpoint', async () => {
|
|
105
|
+
const { fabric, getRequests } = setup([{ status: 204 }]);
|
|
106
|
+
await fabric.subscribers.deleteSipEndpoint('sub1', 'ep1');
|
|
107
|
+
expect(getRequests()[0].method).toBe('DELETE');
|
|
108
|
+
});
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
describe('CXML Applications', () => {
|
|
112
|
+
it('throws on create', async () => {
|
|
113
|
+
const { fabric } = setup();
|
|
114
|
+
await expect(fabric.cxmlApplications.create()).rejects.toThrow('cannot be created');
|
|
115
|
+
});
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
describe('Generic Resources', () => {
|
|
119
|
+
it('lists all resources', async () => {
|
|
120
|
+
const { fabric, getRequests } = setup();
|
|
121
|
+
await fabric.resources.list();
|
|
122
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources');
|
|
123
|
+
expect(getRequests()[0].url).not.toContain('/api/fabric/resources/');
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
it('assigns phone route', async () => {
|
|
127
|
+
const { fabric, getRequests } = setup([{ status: 200, body: {} }]);
|
|
128
|
+
await fabric.resources.assignPhoneRoute('r1', { number: '+15551234567' });
|
|
129
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources/r1/phone_routes');
|
|
130
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
it('assigns domain application', async () => {
|
|
134
|
+
const { fabric, getRequests } = setup([{ status: 200, body: {} }]);
|
|
135
|
+
await fabric.resources.assignDomainApplication('r1', { domain: 'test.com' });
|
|
136
|
+
expect(getRequests()[0].url).toContain('/api/fabric/resources/r1/domain_applications');
|
|
137
|
+
});
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
describe('Addresses', () => {
|
|
141
|
+
it('lists addresses', async () => {
|
|
142
|
+
const { fabric, getRequests } = setup();
|
|
143
|
+
await fabric.addresses.list();
|
|
144
|
+
expect(getRequests()[0].url).toContain('/api/fabric/addresses');
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
it('gets an address', async () => {
|
|
148
|
+
const { fabric, getRequests } = setup([{ status: 200, body: { id: 'addr1' } }]);
|
|
149
|
+
await fabric.addresses.get('addr1');
|
|
150
|
+
expect(getRequests()[0].url).toContain('/api/fabric/addresses/addr1');
|
|
151
|
+
});
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
describe('Tokens', () => {
|
|
155
|
+
it('creates subscriber token', async () => {
|
|
156
|
+
const { fabric, getRequests } = setup([{ status: 200, body: { token: 'xxx' } }]);
|
|
157
|
+
await fabric.tokens.createSubscriberToken({ subscriber_id: 's1' });
|
|
158
|
+
expect(getRequests()[0].url).toContain('/api/fabric/subscribers/tokens');
|
|
159
|
+
expect(getRequests()[0].method).toBe('POST');
|
|
160
|
+
});
|
|
161
|
+
|
|
162
|
+
it('refreshes subscriber token', async () => {
|
|
163
|
+
const { fabric, getRequests } = setup([{ status: 200, body: { token: 'xxx' } }]);
|
|
164
|
+
await fabric.tokens.refreshSubscriberToken({ token: 'old' });
|
|
165
|
+
expect(getRequests()[0].url).toContain('/api/fabric/subscribers/tokens/refresh');
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
it('creates invite token', async () => {
|
|
169
|
+
const { fabric, getRequests } = setup([{ status: 200, body: {} }]);
|
|
170
|
+
await fabric.tokens.createInviteToken({});
|
|
171
|
+
expect(getRequests()[0].url).toContain('/api/fabric/subscriber/invites');
|
|
172
|
+
});
|
|
173
|
+
|
|
174
|
+
it('creates guest token', async () => {
|
|
175
|
+
const { fabric, getRequests } = setup([{ status: 200, body: {} }]);
|
|
176
|
+
await fabric.tokens.createGuestToken({});
|
|
177
|
+
expect(getRequests()[0].url).toContain('/api/fabric/guests/tokens');
|
|
178
|
+
});
|
|
179
|
+
|
|
180
|
+
it('creates embed token', async () => {
|
|
181
|
+
const { fabric, getRequests } = setup([{ status: 200, body: {} }]);
|
|
182
|
+
await fabric.tokens.createEmbedToken({});
|
|
183
|
+
expect(getRequests()[0].url).toContain('/api/fabric/embeds/tokens');
|
|
184
|
+
});
|
|
185
|
+
});
|
|
186
|
+
});
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Test utilities for REST client tests.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
6
|
+
|
|
7
|
+
interface MockResponse {
|
|
8
|
+
status?: number;
|
|
9
|
+
body?: any;
|
|
10
|
+
headers?: Record<string, string>;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
interface RecordedRequest {
|
|
14
|
+
url: string;
|
|
15
|
+
method: string;
|
|
16
|
+
headers: Record<string, string>;
|
|
17
|
+
body: any;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Create a mock fetch function that records requests and returns canned responses.
|
|
22
|
+
*
|
|
23
|
+
* @param responses - Array of responses to return in order. If exhausted, returns 200 {}.
|
|
24
|
+
* @returns [mockFetch, getRequests] - The mock function and a getter for recorded requests.
|
|
25
|
+
*/
|
|
26
|
+
export function createMockFetch(responses: MockResponse[] = []): [typeof globalThis.fetch, () => RecordedRequest[]] {
|
|
27
|
+
const requests: RecordedRequest[] = [];
|
|
28
|
+
let responseIndex = 0;
|
|
29
|
+
|
|
30
|
+
const mockFetch: typeof globalThis.fetch = async (input: RequestInfo | URL, init?: RequestInit): Promise<Response> => {
|
|
31
|
+
const url = typeof input === 'string' ? input : input.toString();
|
|
32
|
+
const method = init?.method ?? 'GET';
|
|
33
|
+
const headers: Record<string, string> = {};
|
|
34
|
+
|
|
35
|
+
if (init?.headers) {
|
|
36
|
+
if (init.headers instanceof Headers) {
|
|
37
|
+
init.headers.forEach((v, k) => { headers[k] = v; });
|
|
38
|
+
} else if (Array.isArray(init.headers)) {
|
|
39
|
+
for (const [k, v] of init.headers) { headers[k] = v; }
|
|
40
|
+
} else {
|
|
41
|
+
Object.assign(headers, init.headers);
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
let body: any = undefined;
|
|
46
|
+
if (init?.body) {
|
|
47
|
+
try {
|
|
48
|
+
body = JSON.parse(init.body as string);
|
|
49
|
+
} catch {
|
|
50
|
+
body = init.body;
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
requests.push({ url, method, headers, body });
|
|
55
|
+
|
|
56
|
+
const resp = responses[responseIndex] ?? { status: 200, body: {} };
|
|
57
|
+
if (responseIndex < responses.length) responseIndex++;
|
|
58
|
+
|
|
59
|
+
const status = resp.status ?? 200;
|
|
60
|
+
const respHeaders = new Headers(resp.headers ?? {});
|
|
61
|
+
if (!respHeaders.has('content-type')) {
|
|
62
|
+
respHeaders.set('content-type', 'application/json');
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// 204 No Content must have null body per spec
|
|
66
|
+
if (status === 204) {
|
|
67
|
+
return new Response(null, { status, statusText: 'No Content', headers: respHeaders });
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
const respBody = resp.body !== undefined ? JSON.stringify(resp.body) : '';
|
|
71
|
+
return new Response(respBody, {
|
|
72
|
+
status,
|
|
73
|
+
statusText: 'OK',
|
|
74
|
+
headers: respHeaders,
|
|
75
|
+
});
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
return [mockFetch as typeof globalThis.fetch, () => requests];
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Create an HttpClient options object with a mock fetch.
|
|
83
|
+
*/
|
|
84
|
+
export function mockClientOptions(responses: MockResponse[] = []) {
|
|
85
|
+
const [fetchImpl, getRequests] = createMockFetch(responses);
|
|
86
|
+
return {
|
|
87
|
+
options: {
|
|
88
|
+
baseUrl: 'https://test.signalwire.com',
|
|
89
|
+
project: 'test-project',
|
|
90
|
+
token: 'test-token',
|
|
91
|
+
fetchImpl,
|
|
92
|
+
},
|
|
93
|
+
getRequests,
|
|
94
|
+
};
|
|
95
|
+
}
|