@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,200 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SignalWire REST Client — typed HTTP access to all SignalWire platform APIs.
|
|
3
|
+
*
|
|
4
|
+
* Standalone module (not coupled to AgentBase). Shares Logger + env var conventions.
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { getLogger } from '../Logger.js';
|
|
8
|
+
import { HttpClient } from './HttpClient.js';
|
|
9
|
+
import type { ClientOptions } from './types.js';
|
|
10
|
+
|
|
11
|
+
// Namespaces
|
|
12
|
+
import { FabricNamespace } from './namespaces/fabric.js';
|
|
13
|
+
import { CallingNamespace } from './namespaces/calling.js';
|
|
14
|
+
import { PhoneNumbersResource } from './namespaces/phone-numbers.js';
|
|
15
|
+
import { AddressesResource } from './namespaces/addresses.js';
|
|
16
|
+
import { QueuesResource } from './namespaces/queues.js';
|
|
17
|
+
import { RecordingsResource } from './namespaces/recordings.js';
|
|
18
|
+
import { NumberGroupsResource } from './namespaces/number-groups.js';
|
|
19
|
+
import { VerifiedCallersResource } from './namespaces/verified-callers.js';
|
|
20
|
+
import { SipProfileResource } from './namespaces/sip-profile.js';
|
|
21
|
+
import { LookupResource } from './namespaces/lookup.js';
|
|
22
|
+
import { ShortCodesResource } from './namespaces/short-codes.js';
|
|
23
|
+
import { ImportedNumbersResource } from './namespaces/imported-numbers.js';
|
|
24
|
+
import { MfaResource } from './namespaces/mfa.js';
|
|
25
|
+
import { RegistryNamespace } from './namespaces/registry.js';
|
|
26
|
+
import { DatasphereNamespace } from './namespaces/datasphere.js';
|
|
27
|
+
import { VideoNamespace } from './namespaces/video.js';
|
|
28
|
+
import { LogsNamespace } from './namespaces/logs.js';
|
|
29
|
+
import { ProjectNamespace } from './namespaces/project.js';
|
|
30
|
+
import { PubSubResource } from './namespaces/pubsub.js';
|
|
31
|
+
import { ChatResource } from './namespaces/chat.js';
|
|
32
|
+
import { CompatNamespace } from './namespaces/compat.js';
|
|
33
|
+
|
|
34
|
+
const logger = getLogger('rest_client');
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* REST client for the SignalWire platform APIs.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* const client = new RestClient({
|
|
42
|
+
* project: 'your-project-id',
|
|
43
|
+
* token: 'your-api-token',
|
|
44
|
+
* host: 'your-space.signalwire.com',
|
|
45
|
+
* });
|
|
46
|
+
*
|
|
47
|
+
* // Or use env vars: SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE
|
|
48
|
+
* const client = new RestClient();
|
|
49
|
+
*
|
|
50
|
+
* // Use namespaced resources
|
|
51
|
+
* await client.fabric.aiAgents.list();
|
|
52
|
+
* await client.calling.play(callId, { play: [...] });
|
|
53
|
+
* await client.phoneNumbers.search({ areaCode: '512' });
|
|
54
|
+
* await client.video.rooms.create({ name: 'standup' });
|
|
55
|
+
* await client.compat.calls.list();
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
58
|
+
export class RestClient {
|
|
59
|
+
// Fabric API
|
|
60
|
+
readonly fabric: FabricNamespace;
|
|
61
|
+
|
|
62
|
+
// Calling API
|
|
63
|
+
readonly calling: CallingNamespace;
|
|
64
|
+
|
|
65
|
+
// Relay REST resources
|
|
66
|
+
readonly phoneNumbers: PhoneNumbersResource;
|
|
67
|
+
readonly addresses: AddressesResource;
|
|
68
|
+
readonly queues: QueuesResource;
|
|
69
|
+
readonly recordings: RecordingsResource;
|
|
70
|
+
readonly numberGroups: NumberGroupsResource;
|
|
71
|
+
readonly verifiedCallers: VerifiedCallersResource;
|
|
72
|
+
readonly sipProfile: SipProfileResource;
|
|
73
|
+
readonly lookup: LookupResource;
|
|
74
|
+
readonly shortCodes: ShortCodesResource;
|
|
75
|
+
readonly importedNumbers: ImportedNumbersResource;
|
|
76
|
+
readonly mfa: MfaResource;
|
|
77
|
+
readonly registry: RegistryNamespace;
|
|
78
|
+
|
|
79
|
+
// Datasphere API
|
|
80
|
+
readonly datasphere: DatasphereNamespace;
|
|
81
|
+
|
|
82
|
+
// Video API
|
|
83
|
+
readonly video: VideoNamespace;
|
|
84
|
+
|
|
85
|
+
// Logs
|
|
86
|
+
readonly logs: LogsNamespace;
|
|
87
|
+
|
|
88
|
+
// Project management
|
|
89
|
+
readonly project: ProjectNamespace;
|
|
90
|
+
|
|
91
|
+
// PubSub & Chat
|
|
92
|
+
readonly pubsub: PubSubResource;
|
|
93
|
+
readonly chat: ChatResource;
|
|
94
|
+
|
|
95
|
+
// Compatibility (Twilio-compatible) API
|
|
96
|
+
readonly compat: CompatNamespace;
|
|
97
|
+
|
|
98
|
+
constructor(options: ClientOptions = {}) {
|
|
99
|
+
const project = options.project || process.env['SIGNALWIRE_PROJECT_ID'] || '';
|
|
100
|
+
const token = options.token || process.env['SIGNALWIRE_API_TOKEN'] || '';
|
|
101
|
+
const host = options.host || process.env['SIGNALWIRE_SPACE'] || '';
|
|
102
|
+
|
|
103
|
+
if (!project || !token || !host) {
|
|
104
|
+
throw new Error(
|
|
105
|
+
'project, token, and host are required. ' +
|
|
106
|
+
'Provide them as arguments or set SIGNALWIRE_PROJECT_ID, ' +
|
|
107
|
+
'SIGNALWIRE_API_TOKEN, and SIGNALWIRE_SPACE environment variables.',
|
|
108
|
+
);
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
// Normalize host — ensure it has https:// prefix
|
|
112
|
+
const baseUrl = host.startsWith('http') ? host : `https://${host}`;
|
|
113
|
+
|
|
114
|
+
const http = new HttpClient({
|
|
115
|
+
baseUrl,
|
|
116
|
+
project,
|
|
117
|
+
token,
|
|
118
|
+
fetchImpl: options.fetchImpl,
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
logger.info('RestClient initialized', { host });
|
|
122
|
+
|
|
123
|
+
// Fabric API
|
|
124
|
+
this.fabric = new FabricNamespace(http);
|
|
125
|
+
|
|
126
|
+
// Calling API
|
|
127
|
+
this.calling = new CallingNamespace(http);
|
|
128
|
+
|
|
129
|
+
// Relay REST resources
|
|
130
|
+
this.phoneNumbers = new PhoneNumbersResource(http);
|
|
131
|
+
this.addresses = new AddressesResource(http);
|
|
132
|
+
this.queues = new QueuesResource(http);
|
|
133
|
+
this.recordings = new RecordingsResource(http);
|
|
134
|
+
this.numberGroups = new NumberGroupsResource(http);
|
|
135
|
+
this.verifiedCallers = new VerifiedCallersResource(http);
|
|
136
|
+
this.sipProfile = new SipProfileResource(http);
|
|
137
|
+
this.lookup = new LookupResource(http);
|
|
138
|
+
this.shortCodes = new ShortCodesResource(http);
|
|
139
|
+
this.importedNumbers = new ImportedNumbersResource(http);
|
|
140
|
+
this.mfa = new MfaResource(http);
|
|
141
|
+
this.registry = new RegistryNamespace(http);
|
|
142
|
+
|
|
143
|
+
// Datasphere API
|
|
144
|
+
this.datasphere = new DatasphereNamespace(http);
|
|
145
|
+
|
|
146
|
+
// Video API
|
|
147
|
+
this.video = new VideoNamespace(http);
|
|
148
|
+
|
|
149
|
+
// Logs
|
|
150
|
+
this.logs = new LogsNamespace(http);
|
|
151
|
+
|
|
152
|
+
// Project management
|
|
153
|
+
this.project = new ProjectNamespace(http);
|
|
154
|
+
|
|
155
|
+
// PubSub & Chat
|
|
156
|
+
this.pubsub = new PubSubResource(http);
|
|
157
|
+
this.chat = new ChatResource(http);
|
|
158
|
+
|
|
159
|
+
// Compatibility (Twilio-compatible) API
|
|
160
|
+
this.compat = new CompatNamespace(http, project);
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
// --- Barrel exports ---
|
|
165
|
+
|
|
166
|
+
// Client
|
|
167
|
+
export { HttpClient } from './HttpClient.js';
|
|
168
|
+
export { RestError, SignalWireRestError } from './RestError.js';
|
|
169
|
+
export { paginate, paginateAll } from './pagination.js';
|
|
170
|
+
|
|
171
|
+
// Types
|
|
172
|
+
export type { ClientOptions, HttpClientOptions, PaginatedResponse, LamlPaginatedResponse, QueryParams } from './types.js';
|
|
173
|
+
|
|
174
|
+
// Base classes
|
|
175
|
+
export { BaseResource } from './base/BaseResource.js';
|
|
176
|
+
export { CrudResource } from './base/CrudResource.js';
|
|
177
|
+
export { CrudWithAddresses } from './base/CrudWithAddresses.js';
|
|
178
|
+
|
|
179
|
+
// Namespaces
|
|
180
|
+
export { FabricNamespace, FabricResource, FabricResourcePUT, CallFlowsResource, ConferenceRoomsResource, SubscribersResource, CxmlApplicationsResource, GenericResources, FabricAddresses, FabricTokens } from './namespaces/fabric.js';
|
|
181
|
+
export { CallingNamespace } from './namespaces/calling.js';
|
|
182
|
+
export { DatasphereNamespace, DatasphereDocuments } from './namespaces/datasphere.js';
|
|
183
|
+
export { PhoneNumbersResource } from './namespaces/phone-numbers.js';
|
|
184
|
+
export { AddressesResource } from './namespaces/addresses.js';
|
|
185
|
+
export { QueuesResource } from './namespaces/queues.js';
|
|
186
|
+
export { RecordingsResource } from './namespaces/recordings.js';
|
|
187
|
+
export { NumberGroupsResource } from './namespaces/number-groups.js';
|
|
188
|
+
export { VerifiedCallersResource } from './namespaces/verified-callers.js';
|
|
189
|
+
export { SipProfileResource } from './namespaces/sip-profile.js';
|
|
190
|
+
export { LookupResource } from './namespaces/lookup.js';
|
|
191
|
+
export { ShortCodesResource } from './namespaces/short-codes.js';
|
|
192
|
+
export { ImportedNumbersResource } from './namespaces/imported-numbers.js';
|
|
193
|
+
export { MfaResource } from './namespaces/mfa.js';
|
|
194
|
+
export { RegistryNamespace, RegistryBrands, RegistryCampaigns, RegistryOrders, RegistryNumbers } from './namespaces/registry.js';
|
|
195
|
+
export { VideoNamespace, VideoRooms, VideoRoomTokens, VideoRoomSessions, VideoRoomRecordings, VideoConferences, VideoConferenceTokens, VideoStreams } from './namespaces/video.js';
|
|
196
|
+
export { LogsNamespace, MessageLogs, VoiceLogs, FaxLogs, ConferenceLogs } from './namespaces/logs.js';
|
|
197
|
+
export { ProjectNamespace, ProjectTokens } from './namespaces/project.js';
|
|
198
|
+
export { PubSubResource } from './namespaces/pubsub.js';
|
|
199
|
+
export { ChatResource } from './namespaces/chat.js';
|
|
200
|
+
export { CompatNamespace, CompatAccounts, CompatCalls, CompatMessages, CompatFaxes, CompatConferences, CompatPhoneNumbers, CompatApplications, CompatLamlBins, CompatQueues, CompatRecordings, CompatTranscriptions, CompatTokens } from './namespaces/compat.js';
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Addresses namespace — list, create, get, delete (no update).
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
6
|
+
|
|
7
|
+
import type { HttpClient } from '../HttpClient.js';
|
|
8
|
+
import type { QueryParams } from '../types.js';
|
|
9
|
+
import { BaseResource } from '../base/BaseResource.js';
|
|
10
|
+
|
|
11
|
+
/** Address management (no update endpoint). */
|
|
12
|
+
export class AddressesResource extends BaseResource {
|
|
13
|
+
constructor(http: HttpClient) {
|
|
14
|
+
super(http, '/api/relay/rest/addresses');
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
async list(params?: QueryParams): Promise<any> {
|
|
18
|
+
return this._http.get(this._basePath, params);
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
async create(body: any): Promise<any> {
|
|
22
|
+
return this._http.post(this._basePath, body);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
async get(addressId: string): Promise<any> {
|
|
26
|
+
return this._http.get(this._path(addressId));
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
async delete(addressId: string): Promise<any> {
|
|
30
|
+
return this._http.delete(this._path(addressId));
|
|
31
|
+
}
|
|
32
|
+
}
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Calling API namespace — REST-based call control via command dispatch.
|
|
3
|
+
*
|
|
4
|
+
* All commands are sent as POST /api/calling/calls with a command field.
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
8
|
+
|
|
9
|
+
import type { HttpClient } from '../HttpClient.js';
|
|
10
|
+
import { BaseResource } from '../base/BaseResource.js';
|
|
11
|
+
|
|
12
|
+
/** REST call control — all 37 commands dispatched via single POST endpoint. */
|
|
13
|
+
export class CallingNamespace extends BaseResource {
|
|
14
|
+
constructor(http: HttpClient) {
|
|
15
|
+
super(http, '/api/calling/calls');
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
private async _execute(command: string, callId?: string, params: any = {}): Promise<any> {
|
|
19
|
+
const body: any = { command, params };
|
|
20
|
+
if (callId !== undefined) {
|
|
21
|
+
body.id = callId;
|
|
22
|
+
}
|
|
23
|
+
return this._http.post(this._basePath, body);
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
// Call lifecycle
|
|
27
|
+
async dial(params: any = {}): Promise<any> {
|
|
28
|
+
return this._execute('dial', undefined, params);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
async update(params: any = {}): Promise<any> {
|
|
32
|
+
return this._execute('update', undefined, params);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
async end(callId: string, params: any = {}): Promise<any> {
|
|
36
|
+
return this._execute('calling.end', callId, params);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
async transfer(callId: string, params: any = {}): Promise<any> {
|
|
40
|
+
return this._execute('calling.transfer', callId, params);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
async disconnect(callId: string, params: any = {}): Promise<any> {
|
|
44
|
+
return this._execute('calling.disconnect', callId, params);
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// Play
|
|
48
|
+
async play(callId: string, params: any = {}): Promise<any> {
|
|
49
|
+
return this._execute('calling.play', callId, params);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
async playPause(callId: string, params: any = {}): Promise<any> {
|
|
53
|
+
return this._execute('calling.play.pause', callId, params);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
async playResume(callId: string, params: any = {}): Promise<any> {
|
|
57
|
+
return this._execute('calling.play.resume', callId, params);
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
async playStop(callId: string, params: any = {}): Promise<any> {
|
|
61
|
+
return this._execute('calling.play.stop', callId, params);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
async playVolume(callId: string, params: any = {}): Promise<any> {
|
|
65
|
+
return this._execute('calling.play.volume', callId, params);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
// Record
|
|
69
|
+
async record(callId: string, params: any = {}): Promise<any> {
|
|
70
|
+
return this._execute('calling.record', callId, params);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
async recordPause(callId: string, params: any = {}): Promise<any> {
|
|
74
|
+
return this._execute('calling.record.pause', callId, params);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
async recordResume(callId: string, params: any = {}): Promise<any> {
|
|
78
|
+
return this._execute('calling.record.resume', callId, params);
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
async recordStop(callId: string, params: any = {}): Promise<any> {
|
|
82
|
+
return this._execute('calling.record.stop', callId, params);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// Collect
|
|
86
|
+
async collect(callId: string, params: any = {}): Promise<any> {
|
|
87
|
+
return this._execute('calling.collect', callId, params);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
async collectStop(callId: string, params: any = {}): Promise<any> {
|
|
91
|
+
return this._execute('calling.collect.stop', callId, params);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
async collectStartInputTimers(callId: string, params: any = {}): Promise<any> {
|
|
95
|
+
return this._execute('calling.collect.start_input_timers', callId, params);
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
// Detect
|
|
99
|
+
async detect(callId: string, params: any = {}): Promise<any> {
|
|
100
|
+
return this._execute('calling.detect', callId, params);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
async detectStop(callId: string, params: any = {}): Promise<any> {
|
|
104
|
+
return this._execute('calling.detect.stop', callId, params);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
// Tap
|
|
108
|
+
async tap(callId: string, params: any = {}): Promise<any> {
|
|
109
|
+
return this._execute('calling.tap', callId, params);
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
async tapStop(callId: string, params: any = {}): Promise<any> {
|
|
113
|
+
return this._execute('calling.tap.stop', callId, params);
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
// Stream
|
|
117
|
+
async stream(callId: string, params: any = {}): Promise<any> {
|
|
118
|
+
return this._execute('calling.stream', callId, params);
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
async streamStop(callId: string, params: any = {}): Promise<any> {
|
|
122
|
+
return this._execute('calling.stream.stop', callId, params);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
// Denoise
|
|
126
|
+
async denoise(callId: string, params: any = {}): Promise<any> {
|
|
127
|
+
return this._execute('calling.denoise', callId, params);
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
async denoiseStop(callId: string, params: any = {}): Promise<any> {
|
|
131
|
+
return this._execute('calling.denoise.stop', callId, params);
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
// Transcribe
|
|
135
|
+
async transcribe(callId: string, params: any = {}): Promise<any> {
|
|
136
|
+
return this._execute('calling.transcribe', callId, params);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
async transcribeStop(callId: string, params: any = {}): Promise<any> {
|
|
140
|
+
return this._execute('calling.transcribe.stop', callId, params);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
// AI
|
|
144
|
+
async aiMessage(callId: string, params: any = {}): Promise<any> {
|
|
145
|
+
return this._execute('calling.ai_message', callId, params);
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
async aiHold(callId: string, params: any = {}): Promise<any> {
|
|
149
|
+
return this._execute('calling.ai_hold', callId, params);
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
async aiUnhold(callId: string, params: any = {}): Promise<any> {
|
|
153
|
+
return this._execute('calling.ai_unhold', callId, params);
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
async aiStop(callId: string, params: any = {}): Promise<any> {
|
|
157
|
+
return this._execute('calling.ai.stop', callId, params);
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
// Live transcribe / translate
|
|
161
|
+
async liveTranscribe(callId: string, params: any = {}): Promise<any> {
|
|
162
|
+
return this._execute('calling.live_transcribe', callId, params);
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
async liveTranslate(callId: string, params: any = {}): Promise<any> {
|
|
166
|
+
return this._execute('calling.live_translate', callId, params);
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
// Fax
|
|
170
|
+
async sendFaxStop(callId: string, params: any = {}): Promise<any> {
|
|
171
|
+
return this._execute('calling.send_fax.stop', callId, params);
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
async receiveFaxStop(callId: string, params: any = {}): Promise<any> {
|
|
175
|
+
return this._execute('calling.receive_fax.stop', callId, params);
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
// SIP
|
|
179
|
+
async refer(callId: string, params: any = {}): Promise<any> {
|
|
180
|
+
return this._execute('calling.refer', callId, params);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
// Custom events
|
|
184
|
+
async userEvent(callId: string, params: any = {}): Promise<any> {
|
|
185
|
+
return this._execute('calling.user_event', callId, params);
|
|
186
|
+
}
|
|
187
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Chat API namespace — token creation.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
6
|
+
|
|
7
|
+
import type { HttpClient } from '../HttpClient.js';
|
|
8
|
+
import { BaseResource } from '../base/BaseResource.js';
|
|
9
|
+
|
|
10
|
+
/** Chat token generation. */
|
|
11
|
+
export class ChatResource extends BaseResource {
|
|
12
|
+
constructor(http: HttpClient) {
|
|
13
|
+
super(http, '/api/chat/tokens');
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
/** Generate a Chat token. */
|
|
17
|
+
async createToken(body: any): Promise<any> {
|
|
18
|
+
return this._http.post(this._basePath, body);
|
|
19
|
+
}
|
|
20
|
+
}
|