@signalwire/sdk 2.0.0 → 2.0.2
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/dist/AgentBase.d.ts +1045 -0
- package/dist/AgentBase.js +2375 -0
- package/dist/AgentBase.js.map +1 -0
- package/dist/AgentServer.d.ts +146 -0
- package/dist/AgentServer.js +388 -0
- package/dist/AgentServer.js.map +1 -0
- package/dist/AuthHandler.d.ts +127 -0
- package/dist/AuthHandler.js +212 -0
- package/dist/AuthHandler.js.map +1 -0
- package/dist/ConfigLoader.d.ts +170 -0
- package/dist/ConfigLoader.js +393 -0
- package/dist/ConfigLoader.js.map +1 -0
- package/dist/ContextBuilder.d.ts +652 -0
- package/dist/ContextBuilder.js +1115 -0
- package/dist/ContextBuilder.js.map +1 -0
- package/dist/DataMap.d.ts +271 -0
- package/dist/DataMap.js +430 -0
- package/dist/DataMap.js.map +1 -0
- package/dist/FunctionResult.d.ts +481 -0
- package/dist/FunctionResult.js +775 -0
- package/dist/FunctionResult.js.map +1 -0
- package/dist/Logger.d.ts +113 -0
- package/dist/Logger.js +320 -0
- package/dist/Logger.js.map +1 -0
- package/dist/PomBuilder.d.ts +208 -0
- package/dist/PomBuilder.js +409 -0
- package/dist/PomBuilder.js.map +1 -0
- package/dist/PromptManager.d.ts +85 -0
- package/dist/PromptManager.js +108 -0
- package/dist/PromptManager.js.map +1 -0
- package/dist/SWMLHandler.d.ts +159 -0
- package/dist/SWMLHandler.js +229 -0
- package/dist/SWMLHandler.js.map +1 -0
- package/dist/SWMLService.d.ts +326 -0
- package/dist/SWMLService.js +610 -0
- package/dist/SWMLService.js.map +1 -0
- package/dist/SchemaUtils.d.ts +108 -0
- package/dist/SchemaUtils.js +317 -0
- package/dist/SchemaUtils.js.map +1 -0
- package/dist/SecurityUtils.d.ts +60 -0
- package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
- package/dist/SecurityUtils.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +119 -0
- package/dist/ServerlessAdapter.js +188 -0
- package/dist/ServerlessAdapter.js.map +1 -0
- package/dist/SessionManager.d.ts +142 -0
- package/dist/SessionManager.js +260 -0
- package/dist/SessionManager.js.map +1 -0
- package/dist/SslConfig.d.ts +77 -0
- package/dist/SslConfig.js +100 -0
- package/dist/SslConfig.js.map +1 -0
- package/dist/SwaigFunction.d.ts +159 -0
- package/dist/SwaigFunction.js +209 -0
- package/dist/SwaigFunction.js.map +1 -0
- package/dist/SwmlBuilder.d.ts +165 -0
- package/dist/SwmlBuilder.js +247 -0
- package/dist/SwmlBuilder.js.map +1 -0
- package/dist/SwmlVerbMethods.generated.d.ts +254 -0
- package/dist/SwmlVerbMethods.generated.js +9 -0
- package/dist/SwmlVerbMethods.generated.js.map +1 -0
- package/dist/TypeInference.d.ts +71 -0
- package/dist/TypeInference.js +164 -0
- package/dist/TypeInference.js.map +1 -0
- package/dist/WebService.d.ts +148 -0
- package/dist/WebService.js +532 -0
- package/dist/WebService.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +22 -0
- package/dist/cli/agent-loader.js +144 -0
- package/dist/cli/agent-loader.js.map +1 -0
- package/dist/cli/mock-data.d.ts +37 -0
- package/dist/cli/mock-data.js +80 -0
- package/dist/cli/mock-data.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +32 -0
- package/dist/cli/swaig-test.js +418 -0
- package/dist/cli/swaig-test.js.map +1 -0
- package/dist/generateVerbTypes.d.ts +11 -0
- package/dist/generateVerbTypes.js +265 -0
- package/dist/generateVerbTypes.js.map +1 -0
- package/dist/index.d.ts +146 -0
- package/dist/index.js +152 -0
- package/dist/index.js.map +1 -0
- package/dist/livewire/index.d.ts +653 -0
- package/dist/livewire/index.js +992 -0
- package/dist/livewire/index.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +89 -0
- package/dist/prefabs/ConciergeAgent.js +245 -0
- package/dist/prefabs/ConciergeAgent.js.map +1 -0
- package/dist/prefabs/FAQBotAgent.d.ts +113 -0
- package/dist/prefabs/FAQBotAgent.js +329 -0
- package/dist/prefabs/FAQBotAgent.js.map +1 -0
- package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
- package/dist/prefabs/InfoGathererAgent.js +287 -0
- package/dist/prefabs/InfoGathererAgent.js.map +1 -0
- package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
- package/dist/prefabs/ReceptionistAgent.js +303 -0
- package/dist/prefabs/ReceptionistAgent.js.map +1 -0
- package/dist/prefabs/SurveyAgent.d.ts +148 -0
- package/dist/prefabs/SurveyAgent.js +540 -0
- package/dist/prefabs/SurveyAgent.js.map +1 -0
- package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
- package/dist/prefabs/index.js +14 -0
- package/dist/prefabs/index.js.map +1 -0
- package/dist/relay/Action.d.ts +258 -0
- package/dist/relay/Action.js +402 -0
- package/dist/relay/Action.js.map +1 -0
- package/dist/relay/Call.d.ts +697 -0
- package/dist/relay/Call.js +1062 -0
- package/dist/relay/Call.js.map +1 -0
- package/dist/relay/Deferred.d.ts +44 -0
- package/dist/relay/Deferred.js +69 -0
- package/dist/relay/Deferred.js.map +1 -0
- package/dist/relay/Message.d.ts +103 -0
- package/dist/relay/Message.js +169 -0
- package/dist/relay/Message.js.map +1 -0
- package/dist/relay/RelayClient.d.ts +302 -0
- package/dist/relay/RelayClient.js +1019 -0
- package/dist/relay/RelayClient.js.map +1 -0
- package/dist/relay/RelayError.d.ts +15 -0
- package/dist/relay/RelayError.js +20 -0
- package/dist/relay/RelayError.js.map +1 -0
- package/dist/relay/RelayEvent.d.ts +254 -0
- package/dist/relay/RelayEvent.js +509 -0
- package/dist/relay/RelayEvent.js.map +1 -0
- package/dist/relay/constants.d.ts +90 -0
- package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
- package/dist/relay/constants.js.map +1 -0
- package/dist/relay/index.d.ts +16 -0
- package/dist/relay/index.js +18 -0
- package/dist/relay/index.js.map +1 -0
- package/dist/relay/types.d.ts +142 -0
- package/dist/relay/types.js +5 -0
- package/dist/relay/types.js.map +1 -0
- package/dist/rest/HttpClient.d.ts +80 -0
- package/dist/rest/HttpClient.js +148 -0
- package/dist/rest/HttpClient.js.map +1 -0
- package/dist/rest/RestError.d.ts +30 -0
- package/dist/rest/RestError.js +39 -0
- package/dist/rest/RestError.js.map +1 -0
- package/dist/rest/base/BaseResource.d.ts +24 -0
- package/dist/rest/base/BaseResource.js +29 -0
- package/dist/rest/base/BaseResource.js.map +1 -0
- package/dist/rest/base/CrudResource.d.ts +68 -0
- package/dist/rest/base/CrudResource.js +82 -0
- package/dist/rest/base/CrudResource.js.map +1 -0
- package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
- package/dist/rest/base/CrudWithAddresses.js +25 -0
- package/dist/rest/base/CrudWithAddresses.js.map +1 -0
- package/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
- package/dist/rest/index.js +195 -0
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +46 -0
- package/dist/rest/namespaces/addresses.js +55 -0
- package/dist/rest/namespaces/addresses.js.map +1 -0
- package/dist/rest/namespaces/calling.d.ts +382 -0
- package/dist/rest/namespaces/calling.js +478 -0
- package/dist/rest/namespaces/calling.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +22 -0
- package/dist/rest/namespaces/chat.js +26 -0
- package/dist/rest/namespaces/chat.js.map +1 -0
- package/dist/rest/namespaces/compat.d.ts +585 -0
- package/dist/rest/namespaces/compat.js +735 -0
- package/dist/rest/namespaces/compat.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +66 -0
- package/dist/rest/namespaces/datasphere.js +77 -0
- package/dist/rest/namespaces/datasphere.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +282 -0
- package/dist/rest/namespaces/fabric.js +373 -0
- package/dist/rest/namespaces/fabric.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
- package/dist/rest/namespaces/imported-numbers.js +26 -0
- package/dist/rest/namespaces/imported-numbers.js.map +1 -0
- package/dist/rest/namespaces/logs.d.ts +105 -0
- package/dist/rest/namespaces/logs.js +133 -0
- package/dist/rest/namespaces/logs.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +29 -0
- package/dist/rest/namespaces/lookup.js +32 -0
- package/dist/rest/namespaces/lookup.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +46 -0
- package/dist/rest/namespaces/mfa.js +54 -0
- package/dist/rest/namespaces/mfa.js.map +1 -0
- package/dist/rest/namespaces/number-groups.d.ts +49 -0
- package/dist/rest/namespaces/number-groups.js +58 -0
- package/dist/rest/namespaces/number-groups.js.map +1 -0
- package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
- package/dist/rest/namespaces/phone-numbers.js +67 -0
- package/dist/rest/namespaces/phone-numbers.js.map +1 -0
- package/dist/rest/namespaces/project.d.ts +46 -0
- package/dist/rest/namespaces/project.js +56 -0
- package/dist/rest/namespaces/project.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +22 -0
- package/dist/rest/namespaces/pubsub.js +26 -0
- package/dist/rest/namespaces/pubsub.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +42 -0
- package/dist/rest/namespaces/queues.js +49 -0
- package/dist/rest/namespaces/queues.js.map +1 -0
- package/dist/rest/namespaces/recordings.d.ts +38 -0
- package/dist/rest/namespaces/recordings.js +45 -0
- package/dist/rest/namespaces/recordings.js.map +1 -0
- package/dist/rest/namespaces/registry.d.ts +141 -0
- package/dist/rest/namespaces/registry.js +178 -0
- package/dist/rest/namespaces/registry.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +39 -0
- package/dist/rest/namespaces/short-codes.js +46 -0
- package/dist/rest/namespaces/short-codes.js.map +1 -0
- package/dist/rest/namespaces/sip-profile.d.ts +28 -0
- package/dist/rest/namespaces/sip-profile.js +34 -0
- package/dist/rest/namespaces/sip-profile.js.map +1 -0
- package/dist/rest/namespaces/verified-callers.d.ts +33 -0
- package/dist/rest/namespaces/verified-callers.js +39 -0
- package/dist/rest/namespaces/verified-callers.js.map +1 -0
- package/dist/rest/namespaces/video.d.ts +235 -0
- package/dist/rest/namespaces/video.js +297 -0
- package/dist/rest/namespaces/video.js.map +1 -0
- package/dist/rest/pagination.d.ts +39 -0
- package/dist/rest/pagination.js +78 -0
- package/dist/rest/pagination.js.map +1 -0
- package/dist/rest/types.d.ts +54 -0
- package/dist/rest/types.js +5 -0
- package/dist/rest/types.js.map +1 -0
- package/dist/skills/SkillBase.d.ts +404 -0
- package/dist/skills/SkillBase.js +471 -0
- package/dist/skills/SkillBase.js.map +1 -0
- package/dist/skills/SkillManager.d.ts +195 -0
- package/dist/skills/SkillManager.js +378 -0
- package/dist/skills/SkillManager.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +176 -0
- package/dist/skills/SkillRegistry.js +310 -0
- package/dist/skills/SkillRegistry.js.map +1 -0
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
- package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
- package/dist/skills/builtin/ask_claude.d.ts +37 -0
- package/dist/skills/builtin/ask_claude.js +162 -0
- package/dist/skills/builtin/ask_claude.js.map +1 -0
- package/dist/skills/builtin/claude_skills.d.ts +75 -0
- package/dist/skills/builtin/claude_skills.js +753 -0
- package/dist/skills/builtin/claude_skills.js.map +1 -0
- package/dist/skills/builtin/custom_skills.d.ts +79 -0
- package/dist/skills/builtin/custom_skills.js +227 -0
- package/dist/skills/builtin/custom_skills.js.map +1 -0
- package/dist/skills/builtin/datasphere.d.ts +73 -0
- package/dist/skills/builtin/datasphere.js +350 -0
- package/dist/skills/builtin/datasphere.js.map +1 -0
- package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
- package/dist/skills/builtin/datasphere_serverless.js +291 -0
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
- package/dist/skills/builtin/datetime.d.ts +40 -0
- package/dist/skills/builtin/datetime.js +118 -0
- package/dist/skills/builtin/datetime.js.map +1 -0
- package/dist/skills/builtin/google_maps.d.ts +48 -0
- package/dist/skills/builtin/google_maps.js +470 -0
- package/dist/skills/builtin/google_maps.js.map +1 -0
- package/dist/skills/builtin/index.d.ts +31 -0
- package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
- package/dist/skills/builtin/index.js.map +1 -0
- package/dist/skills/builtin/info_gatherer.d.ts +115 -0
- package/dist/skills/builtin/info_gatherer.js +328 -0
- package/dist/skills/builtin/info_gatherer.js.map +1 -0
- package/dist/skills/builtin/joke.d.ts +41 -0
- package/dist/skills/builtin/joke.js +156 -0
- package/dist/skills/builtin/joke.js.map +1 -0
- package/dist/skills/builtin/math.d.ts +39 -0
- package/dist/skills/builtin/math.js +119 -0
- package/dist/skills/builtin/math.js.map +1 -0
- package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
- package/dist/skills/builtin/mcp_gateway.js +574 -0
- package/dist/skills/builtin/mcp_gateway.js.map +1 -0
- package/dist/skills/builtin/native_vector_search.d.ts +128 -0
- package/dist/skills/builtin/native_vector_search.js +752 -0
- package/dist/skills/builtin/native_vector_search.js.map +1 -0
- package/dist/skills/builtin/play_background_file.d.ts +59 -0
- package/dist/skills/builtin/play_background_file.js +274 -0
- package/dist/skills/builtin/play_background_file.js.map +1 -0
- package/dist/skills/builtin/spider.d.ts +91 -0
- package/dist/skills/builtin/spider.js +758 -0
- package/dist/skills/builtin/spider.js.map +1 -0
- package/dist/skills/builtin/swml_transfer.d.ts +66 -0
- package/dist/skills/builtin/swml_transfer.js +475 -0
- package/dist/skills/builtin/swml_transfer.js.map +1 -0
- package/dist/skills/builtin/weather_api.d.ts +59 -0
- package/dist/skills/builtin/weather_api.js +196 -0
- package/dist/skills/builtin/weather_api.js.map +1 -0
- package/dist/skills/builtin/web_search.d.ts +160 -0
- package/dist/skills/builtin/web_search.js +894 -0
- package/dist/skills/builtin/web_search.js.map +1 -0
- package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
- package/dist/skills/builtin/wikipedia_search.js +241 -0
- package/dist/skills/builtin/wikipedia_search.js.map +1 -0
- package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
- package/dist/skills/index.js +10 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/types.d.ts +118 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +7 -1
- package/.github/workflows/publish.yml +0 -27
- package/.github/workflows/test.yml +0 -17
- package/CLAUDE.md +0 -112
- package/docs/MIGRATION-2.0.md +0 -81
- package/docs/agent-guide.md +0 -869
- package/docs/agent_guide.md +0 -1026
- package/docs/api-reference.md +0 -2420
- package/docs/api_reference.md +0 -1301
- package/docs/architecture.md +0 -843
- package/docs/cli-guide.md +0 -579
- package/docs/cli_guide.md +0 -448
- package/docs/cloud_functions_guide.md +0 -474
- package/docs/configuration.md +0 -422
- package/docs/contexts-guide.md +0 -787
- package/docs/contexts_guide.md +0 -511
- package/docs/datamap-guide.md +0 -1141
- package/docs/datamap_guide.md +0 -595
- package/docs/llm_parameters.md +0 -239
- package/docs/mcp_gateway_reference.md +0 -648
- package/docs/mcp_integration.md +0 -108
- package/docs/prefabs-guide.md +0 -800
- package/docs/sdk_features.md +0 -477
- package/docs/security.md +0 -436
- package/docs/serverless-guide.md +0 -513
- package/docs/skills-guide.md +0 -857
- package/docs/skills-system.md +0 -301
- package/docs/skills_parameter_schema.md +0 -392
- package/docs/skills_system.md +0 -467
- package/docs/swaig-reference.md +0 -1627
- package/docs/swaig_reference.md +0 -910
- package/docs/swml_service_guide.md +0 -600
- package/docs/third_party_skills.md +0 -533
- package/docs/web_service.md +0 -677
- package/examples/README.md +0 -131
- package/examples/advanced-datamap.ts +0 -100
- package/examples/advanced-dynamic-config.ts +0 -70
- package/examples/auto-vivified.ts +0 -94
- package/examples/call-flow.ts +0 -63
- package/examples/comprehensive-dynamic.ts +0 -125
- package/examples/contexts-steps.ts +0 -65
- package/examples/custom-path.ts +0 -45
- package/examples/datamap-tools.ts +0 -55
- package/examples/datasphere-multi-instance.ts +0 -63
- package/examples/datasphere-serverless-env.ts +0 -68
- package/examples/datasphere-webhook-env.ts +0 -66
- package/examples/datasphere.ts +0 -37
- package/examples/declarative.ts +0 -100
- package/examples/dynamic-config.ts +0 -54
- package/examples/dynamic-info-gatherer.ts +0 -69
- package/examples/dynamic-swml-service.ts +0 -67
- package/examples/gather-info.ts +0 -71
- package/examples/gather-per-question-functions-demo.ts +0 -140
- package/examples/joke-agent.ts +0 -34
- package/examples/kubernetes-agent.ts +0 -45
- package/examples/llm-params.ts +0 -69
- package/examples/mcp-agent.ts +0 -84
- package/examples/mcp-gateway.ts +0 -35
- package/examples/multi-agent.ts +0 -73
- package/examples/multi-endpoint.ts +0 -79
- package/examples/pom-prompt.ts +0 -71
- package/examples/prefab-concierge.ts +0 -47
- package/examples/prefab-faq.ts +0 -54
- package/examples/prefab-info-gatherer.ts +0 -33
- package/examples/prefab-receptionist.ts +0 -36
- package/examples/prefab-survey.ts +0 -68
- package/examples/record-call.ts +0 -67
- package/examples/relay-demo.ts +0 -33
- package/examples/room-and-sip.ts +0 -94
- package/examples/serverless-lambda.ts +0 -35
- package/examples/session-state.ts +0 -83
- package/examples/simple-agent.ts +0 -36
- package/examples/simple-static.ts +0 -29
- package/examples/skills-demo.ts +0 -38
- package/examples/step-function-inheritance-demo.ts +0 -124
- package/examples/swaig-features.ts +0 -187
- package/examples/swml-service-routing.ts +0 -66
- package/examples/swml-service.ts +0 -38
- package/examples/tap.ts +0 -68
- package/examples/verb-methods.ts +0 -45
- package/examples/web-search-multi-instance.ts +0 -72
- package/examples/web-search.ts +0 -38
- package/examples/wikipedia.ts +0 -36
- package/livewire/README.md +0 -140
- package/livewire/docs/migration-guide.md +0 -228
- package/livewire/examples/livewire-basic-agent.ts +0 -74
- package/livewire/examples/livewire-handoff.ts +0 -197
- package/livewire/examples/livewire-multi-tool.ts +0 -117
- package/relay/README.md +0 -70
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
- package/relay/docs/call-methods.md +0 -474
- package/relay/docs/client-reference.md +0 -142
- package/relay/docs/events.md +0 -134
- package/relay/docs/getting-started.md +0 -134
- package/relay/docs/guide.md +0 -306
- package/relay/docs/messaging.md +0 -182
- package/relay/examples/relay-inbound.ts +0 -66
- package/relay/examples/relay-messaging.ts +0 -71
- package/relay/examples/relay-outbound.ts +0 -76
- package/rest/README.md +0 -95
- package/rest/docs/calling.md +0 -273
- package/rest/docs/client-reference.md +0 -107
- package/rest/docs/compat.md +0 -204
- package/rest/docs/fabric.md +0 -183
- package/rest/docs/getting-started.md +0 -110
- package/rest/docs/guide.md +0 -351
- package/rest/docs/namespaces.md +0 -285
- package/rest/examples/rest-10dlc-registration.ts +0 -161
- package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
- package/rest/examples/rest-calling-play-and-record.ts +0 -91
- package/rest/examples/rest-client.ts +0 -65
- package/rest/examples/rest-compat-laml.ts +0 -210
- package/rest/examples/rest-datasphere-search.ts +0 -82
- package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
- package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
- package/rest/examples/rest-manage-resources.ts +0 -65
- package/rest/examples/rest-phone-number-management.ts +0 -197
- package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
- package/rest/examples/rest-video-rooms.ts +0 -186
- package/src/AgentBase.ts +0 -2489
- package/src/AgentServer.ts +0 -415
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1150
- package/src/DataMap.ts +0 -449
- package/src/FunctionResult.ts +0 -866
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -439
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -717
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -221
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -258
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -181
- package/src/WebService.ts +0 -619
- package/src/cli/agent-loader.ts +0 -166
- package/src/cli/mock-data.ts +0 -111
- package/src/cli/swaig-test.ts +0 -452
- package/src/generateVerbTypes.ts +0 -322
- package/src/index.ts +0 -167
- package/src/livewire/index.ts +0 -950
- package/src/prefabs/ConciergeAgent.ts +0 -287
- package/src/prefabs/FAQBotAgent.ts +0 -384
- package/src/prefabs/InfoGathererAgent.ts +0 -339
- package/src/prefabs/ReceptionistAgent.ts +0 -366
- package/src/prefabs/SurveyAgent.ts +0 -646
- package/src/relay/Action.ts +0 -314
- package/src/relay/Call.ts +0 -854
- package/src/relay/Deferred.ts +0 -71
- package/src/relay/Message.ts +0 -148
- package/src/relay/RelayClient.ts +0 -1036
- package/src/relay/RelayError.ts +0 -14
- package/src/relay/RelayEvent.ts +0 -892
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -103
- package/src/rest/RestError.ts +0 -31
- package/src/rest/base/BaseResource.ts +0 -19
- package/src/rest/base/CrudResource.ts +0 -51
- package/src/rest/base/CrudWithAddresses.ts +0 -26
- package/src/rest/namespaces/addresses.ts +0 -32
- package/src/rest/namespaces/calling.ts +0 -187
- package/src/rest/namespaces/chat.ts +0 -20
- package/src/rest/namespaces/compat.ts +0 -352
- package/src/rest/namespaces/datasphere.ts +0 -45
- package/src/rest/namespaces/fabric.ts +0 -222
- package/src/rest/namespaces/imported-numbers.ts +0 -20
- package/src/rest/namespaces/logs.ts +0 -84
- package/src/rest/namespaces/lookup.ts +0 -21
- package/src/rest/namespaces/mfa.ts +0 -30
- package/src/rest/namespaces/number-groups.ts +0 -38
- package/src/rest/namespaces/phone-numbers.ts +0 -44
- package/src/rest/namespaces/project.ts +0 -36
- package/src/rest/namespaces/pubsub.ts +0 -20
- package/src/rest/namespaces/queues.ts +0 -33
- package/src/rest/namespaces/recordings.ts +0 -28
- package/src/rest/namespaces/registry.ts +0 -101
- package/src/rest/namespaces/short-codes.ts +0 -28
- package/src/rest/namespaces/sip-profile.ts +0 -25
- package/src/rest/namespaces/verified-callers.ts +0 -27
- package/src/rest/namespaces/video.ts +0 -165
- package/src/rest/pagination.ts +0 -84
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -547
- package/src/skills/SkillManager.ts +0 -415
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
- package/src/skills/builtin/ask_claude.ts +0 -241
- package/src/skills/builtin/claude_skills.ts +0 -978
- package/src/skills/builtin/custom_skills.ts +0 -312
- package/src/skills/builtin/datasphere.ts +0 -438
- package/src/skills/builtin/datasphere_serverless.ts +0 -339
- package/src/skills/builtin/datetime.ts +0 -130
- package/src/skills/builtin/google_maps.ts +0 -651
- package/src/skills/builtin/info_gatherer.ts +0 -405
- package/src/skills/builtin/joke.ts +0 -191
- package/src/skills/builtin/math.ts +0 -142
- package/src/skills/builtin/mcp_gateway.ts +0 -677
- package/src/skills/builtin/native_vector_search.ts +0 -901
- package/src/skills/builtin/play_background_file.ts +0 -358
- package/src/skills/builtin/spider.ts +0 -869
- package/src/skills/builtin/swml_transfer.ts +0 -635
- package/src/skills/builtin/weather_api.ts +0 -248
- package/src/skills/builtin/web_search.ts +0 -1074
- package/src/skills/builtin/wikipedia_search.ts +0 -299
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
|
@@ -0,0 +1,1062 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Call object — represents a live RELAY call with command methods.
|
|
3
|
+
*
|
|
4
|
+
* Created by RelayClient on inbound calling.call.receive events or
|
|
5
|
+
* outbound dial responses.
|
|
6
|
+
*/
|
|
7
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
8
|
+
import { randomUUID } from 'node:crypto';
|
|
9
|
+
import { getLogger } from '../Logger.js';
|
|
10
|
+
import { PlayAction, RecordAction, DetectAction, CollectAction, StandaloneCollectAction, FaxAction, TapAction, StreamAction, PayAction, TranscribeAction, AIAction, } from './Action.js';
|
|
11
|
+
import { createDeferred } from './Deferred.js';
|
|
12
|
+
import { CALL_STATE_ENDED, EVENT_CALL_STATE } from './constants.js';
|
|
13
|
+
import { RelayEvent, parseEvent } from './RelayEvent.js';
|
|
14
|
+
const logger = getLogger('relay_call');
|
|
15
|
+
/**
|
|
16
|
+
* Live RELAY call with command methods.
|
|
17
|
+
*
|
|
18
|
+
* Don't construct directly — `Call` instances are created by {@link RelayClient}
|
|
19
|
+
* for inbound calls (delivered to your `onCall` handler) and for outbound dials.
|
|
20
|
+
*
|
|
21
|
+
* Each command method (`answer()`, `play()`, `record()`, etc.) returns when the
|
|
22
|
+
* platform acknowledges the command; event-driven completion is exposed via
|
|
23
|
+
* {@link Action} objects returned from the async "play/record/..." variants.
|
|
24
|
+
*
|
|
25
|
+
* @example Inside an onCall handler
|
|
26
|
+
* ```ts
|
|
27
|
+
* client.onCall(async (call) => {
|
|
28
|
+
* await call.answer();
|
|
29
|
+
* const play = await call.playAsync({ play: [{ type: 'tts', text: 'Hello!' }] });
|
|
30
|
+
* await play.wait();
|
|
31
|
+
* await call.hangup();
|
|
32
|
+
* });
|
|
33
|
+
* ```
|
|
34
|
+
*
|
|
35
|
+
* @see {@link RelayClient}
|
|
36
|
+
* @see {@link Action}
|
|
37
|
+
*/
|
|
38
|
+
export class Call {
|
|
39
|
+
/** @internal */ _client;
|
|
40
|
+
/** Unique call identifier assigned by the platform. */
|
|
41
|
+
callId;
|
|
42
|
+
/** RELAY node that owns this call. */
|
|
43
|
+
nodeId;
|
|
44
|
+
/** SignalWire project ID. */
|
|
45
|
+
projectId;
|
|
46
|
+
/** RELAY context this call was received on. */
|
|
47
|
+
context;
|
|
48
|
+
/** Opaque correlation tag attached at dial time. */
|
|
49
|
+
tag;
|
|
50
|
+
/** `"inbound"` or `"outbound"`. */
|
|
51
|
+
direction;
|
|
52
|
+
/** Device descriptor the call is associated with (phone, SIP, etc.). */
|
|
53
|
+
device;
|
|
54
|
+
/** Current call state (e.g. `"created"`, `"answered"`, `"ended"`). */
|
|
55
|
+
state;
|
|
56
|
+
/** Call segment ID used for event correlation. */
|
|
57
|
+
segmentId;
|
|
58
|
+
/** @internal */ _listeners = new Map();
|
|
59
|
+
/** @internal */ _actions = new Map();
|
|
60
|
+
/** @internal */ _ended;
|
|
61
|
+
constructor(client, callId, nodeId, projectId, context, options = {}) {
|
|
62
|
+
this._client = client;
|
|
63
|
+
this.callId = callId;
|
|
64
|
+
this.nodeId = nodeId;
|
|
65
|
+
this.projectId = projectId;
|
|
66
|
+
this.context = context;
|
|
67
|
+
this.tag = options.tag ?? '';
|
|
68
|
+
this.direction = options.direction ?? '';
|
|
69
|
+
this.device = options.device ?? {};
|
|
70
|
+
this.state = options.state ?? '';
|
|
71
|
+
this.segmentId = options.segmentId ?? '';
|
|
72
|
+
this._ended = createDeferred();
|
|
73
|
+
}
|
|
74
|
+
// ─── Internal RPC Primitive ──────────────────────────────────────
|
|
75
|
+
/** @internal Send a calling.<method> JSON-RPC request for this call. */
|
|
76
|
+
async _execute(method, extraParams) {
|
|
77
|
+
const rpcMethod = `calling.${method}`;
|
|
78
|
+
const params = {
|
|
79
|
+
node_id: this.nodeId,
|
|
80
|
+
call_id: this.callId,
|
|
81
|
+
};
|
|
82
|
+
if (extraParams) {
|
|
83
|
+
Object.assign(params, extraParams);
|
|
84
|
+
}
|
|
85
|
+
try {
|
|
86
|
+
return await this._client.execute(rpcMethod, params);
|
|
87
|
+
}
|
|
88
|
+
catch (err) {
|
|
89
|
+
if (err?.code !== undefined) {
|
|
90
|
+
logger.warn(`Call ${this.callId} error during ${method} (code=${err.code}): ${err}`);
|
|
91
|
+
return {};
|
|
92
|
+
}
|
|
93
|
+
throw err;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
// ─── Event Plumbing ──────────────────────────────────────────────
|
|
97
|
+
/**
|
|
98
|
+
* Register an event listener for this call.
|
|
99
|
+
*
|
|
100
|
+
* Multiple listeners for the same event type are supported. Listener errors
|
|
101
|
+
* are logged but do not disrupt dispatch to other listeners.
|
|
102
|
+
*
|
|
103
|
+
* @param eventType - Fully-qualified event type (e.g.
|
|
104
|
+
* `"calling.call.state"`, `"calling.call.play"`).
|
|
105
|
+
* @param handler - Callback invoked for each matching event.
|
|
106
|
+
*/
|
|
107
|
+
on(eventType, handler) {
|
|
108
|
+
const handlers = this._listeners.get(eventType) ?? [];
|
|
109
|
+
handlers.push(handler);
|
|
110
|
+
this._listeners.set(eventType, handlers);
|
|
111
|
+
}
|
|
112
|
+
/** @internal Called by RelayClient when an event arrives for this call. */
|
|
113
|
+
async _dispatchEvent(payload) {
|
|
114
|
+
const event = parseEvent(payload);
|
|
115
|
+
const eventType = event.eventType;
|
|
116
|
+
// Update call state
|
|
117
|
+
if (eventType === EVENT_CALL_STATE) {
|
|
118
|
+
const callState = (event.params.call_state ?? this.state);
|
|
119
|
+
this.state = callState;
|
|
120
|
+
if (this.state === CALL_STATE_ENDED && !this._ended.settled) {
|
|
121
|
+
this._ended.resolve(event);
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
// Route to active actions by control_id
|
|
125
|
+
const controlId = (event.params.control_id ?? '');
|
|
126
|
+
if (controlId) {
|
|
127
|
+
const action = this._actions.get(controlId);
|
|
128
|
+
if (action) {
|
|
129
|
+
action._checkEvent(event);
|
|
130
|
+
if (action.completed) {
|
|
131
|
+
this._actions.delete(controlId);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
// Notify registered listeners (snapshot to allow modification during iteration)
|
|
136
|
+
const handlers = [...(this._listeners.get(eventType) ?? [])];
|
|
137
|
+
for (const handler of handlers) {
|
|
138
|
+
try {
|
|
139
|
+
await handler(event);
|
|
140
|
+
}
|
|
141
|
+
catch (err) {
|
|
142
|
+
logger.error(`Error in event handler for ${eventType}: ${err}`);
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* Wait for a specific event, optionally filtered by predicate.
|
|
148
|
+
*
|
|
149
|
+
* Registers a one-shot listener that is removed after resolving (or after
|
|
150
|
+
* the timeout elapses). Useful for awaiting a specific state transition.
|
|
151
|
+
*
|
|
152
|
+
* @param eventType - Event type to wait for.
|
|
153
|
+
* @param predicate - Optional filter — only events for which this returns
|
|
154
|
+
* `true` resolve the wait.
|
|
155
|
+
* @param timeout - Optional timeout in milliseconds. Omit to wait forever.
|
|
156
|
+
* @returns The first matching {@link RelayEvent}.
|
|
157
|
+
* @throws {Error} When the optional timeout elapses before a match.
|
|
158
|
+
*/
|
|
159
|
+
async waitFor(eventType, predicate, timeout) {
|
|
160
|
+
const deferred = createDeferred();
|
|
161
|
+
const handler = (event) => {
|
|
162
|
+
if (deferred.settled)
|
|
163
|
+
return;
|
|
164
|
+
if (predicate == null || predicate(event)) {
|
|
165
|
+
deferred.resolve(event);
|
|
166
|
+
}
|
|
167
|
+
};
|
|
168
|
+
this.on(eventType, handler);
|
|
169
|
+
try {
|
|
170
|
+
if (timeout != null) {
|
|
171
|
+
return await new Promise((resolve, reject) => {
|
|
172
|
+
const timer = setTimeout(() => {
|
|
173
|
+
reject(new Error(`waitFor(${eventType}) timed out after ${timeout}ms`));
|
|
174
|
+
}, timeout);
|
|
175
|
+
deferred.promise.then((v) => { clearTimeout(timer); resolve(v); }, (e) => { clearTimeout(timer); reject(e); });
|
|
176
|
+
});
|
|
177
|
+
}
|
|
178
|
+
return await deferred.promise;
|
|
179
|
+
}
|
|
180
|
+
finally {
|
|
181
|
+
// Clean up the one-shot handler
|
|
182
|
+
const list = this._listeners.get(eventType);
|
|
183
|
+
if (list) {
|
|
184
|
+
const idx = list.indexOf(handler);
|
|
185
|
+
if (idx !== -1)
|
|
186
|
+
list.splice(idx, 1);
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Wait for the call to reach the `ended` state.
|
|
192
|
+
*
|
|
193
|
+
* @param timeout - Optional timeout in milliseconds.
|
|
194
|
+
* @returns The terminating `calling.call.state` {@link RelayEvent}.
|
|
195
|
+
* @throws {Error} When the optional timeout elapses before the call ends.
|
|
196
|
+
*/
|
|
197
|
+
async waitForEnded(timeout) {
|
|
198
|
+
if (timeout != null) {
|
|
199
|
+
return new Promise((resolve, reject) => {
|
|
200
|
+
const timer = setTimeout(() => {
|
|
201
|
+
reject(new Error(`waitForEnded timed out after ${timeout}ms`));
|
|
202
|
+
}, timeout);
|
|
203
|
+
this._ended.promise.then((v) => { clearTimeout(timer); resolve(v); }, (e) => { clearTimeout(timer); reject(e); });
|
|
204
|
+
});
|
|
205
|
+
}
|
|
206
|
+
return this._ended.promise;
|
|
207
|
+
}
|
|
208
|
+
// ─── Action Helper ───────────────────────────────────────────────
|
|
209
|
+
/** @internal Register an action, execute the RPC, clean up on failure. */
|
|
210
|
+
async _startAction(action, method, params, onCompleted) {
|
|
211
|
+
if (this.state === CALL_STATE_ENDED) {
|
|
212
|
+
logger.warn(`Call ${this.callId} already ended, skipping ${method}`);
|
|
213
|
+
const goneEvent = new RelayEvent('', {});
|
|
214
|
+
action._resolve(goneEvent);
|
|
215
|
+
return action;
|
|
216
|
+
}
|
|
217
|
+
if (onCompleted)
|
|
218
|
+
action._onCompleted = onCompleted;
|
|
219
|
+
this._actions.set(action.controlId, action);
|
|
220
|
+
try {
|
|
221
|
+
const result = await this._execute(method, params);
|
|
222
|
+
// _execute returns {} when the call is gone (404/410) — resolve immediately
|
|
223
|
+
if (!result || Object.keys(result).length === 0) {
|
|
224
|
+
this._actions.delete(action.controlId);
|
|
225
|
+
if (!action._done.settled) {
|
|
226
|
+
const goneEvent = new RelayEvent('', {});
|
|
227
|
+
action._resolve(goneEvent);
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
}
|
|
231
|
+
catch (err) {
|
|
232
|
+
this._actions.delete(action.controlId);
|
|
233
|
+
if (!action._done.settled) {
|
|
234
|
+
action._done.reject(err);
|
|
235
|
+
// Suppress unhandled rejection — the caller gets the error via the rethrown exception
|
|
236
|
+
action._done.promise.catch(() => { });
|
|
237
|
+
}
|
|
238
|
+
throw err;
|
|
239
|
+
}
|
|
240
|
+
return action;
|
|
241
|
+
}
|
|
242
|
+
// ─── Call Lifecycle Methods ──────────────────────────────────────
|
|
243
|
+
/**
|
|
244
|
+
* Answer an inbound call.
|
|
245
|
+
*
|
|
246
|
+
* @param extra - Optional additional params merged into the answer request
|
|
247
|
+
* (e.g. SIP headers, codec hints).
|
|
248
|
+
* @returns The platform's answer response.
|
|
249
|
+
* @throws {RelayError} When the answer command is rejected.
|
|
250
|
+
*/
|
|
251
|
+
async answer(extra) {
|
|
252
|
+
return this._execute('answer', extra);
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* End / hang up the call.
|
|
256
|
+
*
|
|
257
|
+
* @param reason - Hangup reason delivered to the platform. Defaults to
|
|
258
|
+
* `"hangup"`.
|
|
259
|
+
* @returns The platform's end response.
|
|
260
|
+
* @throws {RelayError} When the end command is rejected.
|
|
261
|
+
*/
|
|
262
|
+
async hangup(reason = 'hangup') {
|
|
263
|
+
return this._execute('end', { reason });
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Decline control of an inbound call, returning it to routing.
|
|
267
|
+
*
|
|
268
|
+
* Use instead of {@link answer} when you want the call to fall through to
|
|
269
|
+
* the next matching route rather than be handled by this client.
|
|
270
|
+
*
|
|
271
|
+
* @returns The platform's pass response.
|
|
272
|
+
* @throws {RelayError} When the pass command is rejected.
|
|
273
|
+
*/
|
|
274
|
+
async pass() {
|
|
275
|
+
return this._execute('pass');
|
|
276
|
+
}
|
|
277
|
+
// ─── Audio Playback ──────────────────────────────────────────────
|
|
278
|
+
/**
|
|
279
|
+
* Play audio content on the call.
|
|
280
|
+
*
|
|
281
|
+
* Returns immediately with a {@link PlayAction} — `await action.wait()` to
|
|
282
|
+
* block until playback finishes, or call `stop()` / `pause()` / `resume()`
|
|
283
|
+
* / `volume()` on it to control playback.
|
|
284
|
+
*
|
|
285
|
+
* @param media - Platform-shaped play items (TTS, audio URLs, silence, etc.).
|
|
286
|
+
* @param options - Optional playback controls.
|
|
287
|
+
* @param options.volume - Volume adjustment in dB.
|
|
288
|
+
* @param options.direction - `"speak"`, `"hear"`, or `"both"`.
|
|
289
|
+
* @param options.loop - Number of times to loop the playback.
|
|
290
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
291
|
+
* @param options.onCompleted - Callback fired when playback reaches a
|
|
292
|
+
* terminal state.
|
|
293
|
+
* @returns A {@link PlayAction} for control and completion tracking.
|
|
294
|
+
* @throws {RelayError} When the play command is rejected.
|
|
295
|
+
*/
|
|
296
|
+
async play(media, options = {}) {
|
|
297
|
+
const cid = options.controlId ?? randomUUID();
|
|
298
|
+
const params = { control_id: cid, play: media };
|
|
299
|
+
if (options.volume != null)
|
|
300
|
+
params.volume = options.volume;
|
|
301
|
+
if (options.direction != null)
|
|
302
|
+
params.direction = options.direction;
|
|
303
|
+
if (options.loop != null)
|
|
304
|
+
params.loop = options.loop;
|
|
305
|
+
const action = new PlayAction(this, cid);
|
|
306
|
+
return this._startAction(action, 'play', params, options.onCompleted);
|
|
307
|
+
}
|
|
308
|
+
// ─── Recording ───────────────────────────────────────────────────
|
|
309
|
+
/**
|
|
310
|
+
* Record audio from the call.
|
|
311
|
+
*
|
|
312
|
+
* @param audio - Platform-shaped audio recording options (direction, codec,
|
|
313
|
+
* timeouts, etc.). Defaults to `{}`.
|
|
314
|
+
* @param options - Recording behaviour.
|
|
315
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
316
|
+
* @param options.onCompleted - Callback fired when the recording reaches a
|
|
317
|
+
* terminal state.
|
|
318
|
+
* @returns A {@link RecordAction} for control and completion tracking.
|
|
319
|
+
* @throws {RelayError} When the record command is rejected.
|
|
320
|
+
*/
|
|
321
|
+
async record(audio, options = {}) {
|
|
322
|
+
const cid = options.controlId ?? randomUUID();
|
|
323
|
+
const recordObj = { audio: audio ?? {} };
|
|
324
|
+
const params = { control_id: cid, record: recordObj };
|
|
325
|
+
const action = new RecordAction(this, cid);
|
|
326
|
+
return this._startAction(action, 'record', params, options.onCompleted);
|
|
327
|
+
}
|
|
328
|
+
// ─── Input Collection ────────────────────────────────────────────
|
|
329
|
+
/**
|
|
330
|
+
* Play audio and collect digit / speech input in a single operation.
|
|
331
|
+
*
|
|
332
|
+
* Convenient for IVR prompts — playback stops as soon as input is received.
|
|
333
|
+
*
|
|
334
|
+
* @param media - Audio items to play while collecting.
|
|
335
|
+
* @param collect - Platform-shaped collect config (`digits`, `speech`, etc.).
|
|
336
|
+
* @param options - Playback and collection behaviour.
|
|
337
|
+
* @param options.volume - Playback volume adjustment in dB.
|
|
338
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
339
|
+
* @param options.onCompleted - Callback fired when collect completes.
|
|
340
|
+
* @returns A {@link CollectAction} for the combined play-and-collect flow.
|
|
341
|
+
* @throws {RelayError} When the play_and_collect command is rejected.
|
|
342
|
+
*/
|
|
343
|
+
async playAndCollect(media, collect, options = {}) {
|
|
344
|
+
const cid = options.controlId ?? randomUUID();
|
|
345
|
+
const params = {
|
|
346
|
+
control_id: cid,
|
|
347
|
+
play: media,
|
|
348
|
+
collect,
|
|
349
|
+
};
|
|
350
|
+
if (options.volume != null)
|
|
351
|
+
params.volume = options.volume;
|
|
352
|
+
const action = new CollectAction(this, cid);
|
|
353
|
+
return this._startAction(action, 'play_and_collect', params, options.onCompleted);
|
|
354
|
+
}
|
|
355
|
+
/**
|
|
356
|
+
* Collect digit / speech input without playing media.
|
|
357
|
+
*
|
|
358
|
+
* @param options - Collect configuration.
|
|
359
|
+
* @param options.digits - DTMF digit-collection config.
|
|
360
|
+
* @param options.speech - Speech-recognition config.
|
|
361
|
+
* @param options.initialTimeout - Seconds to wait for the first input.
|
|
362
|
+
* @param options.partialResults - Emit partial (interim) results.
|
|
363
|
+
* @param options.continuous - Keep collecting until explicitly stopped.
|
|
364
|
+
* @param options.sendStartOfInput - Emit a start-of-input event when detected.
|
|
365
|
+
* @param options.startInputTimers - Start input timers immediately.
|
|
366
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
367
|
+
* @param options.onCompleted - Callback fired when collect completes.
|
|
368
|
+
* @returns A {@link StandaloneCollectAction} for control and completion tracking.
|
|
369
|
+
* @throws {RelayError} When the collect command is rejected.
|
|
370
|
+
*/
|
|
371
|
+
async collect(options = {}) {
|
|
372
|
+
const cid = options.controlId ?? randomUUID();
|
|
373
|
+
const params = { control_id: cid };
|
|
374
|
+
if (options.digits != null)
|
|
375
|
+
params.digits = options.digits;
|
|
376
|
+
if (options.speech != null)
|
|
377
|
+
params.speech = options.speech;
|
|
378
|
+
if (options.initialTimeout != null)
|
|
379
|
+
params.initial_timeout = options.initialTimeout;
|
|
380
|
+
if (options.partialResults != null)
|
|
381
|
+
params.partial_results = options.partialResults;
|
|
382
|
+
if (options.continuous != null)
|
|
383
|
+
params.continuous = options.continuous;
|
|
384
|
+
if (options.sendStartOfInput != null)
|
|
385
|
+
params.send_start_of_input = options.sendStartOfInput;
|
|
386
|
+
if (options.startInputTimers != null)
|
|
387
|
+
params.start_input_timers = options.startInputTimers;
|
|
388
|
+
const action = new StandaloneCollectAction(this, cid);
|
|
389
|
+
return this._startAction(action, 'collect', params, options.onCompleted);
|
|
390
|
+
}
|
|
391
|
+
// ─── Bridging & Connectivity ─────────────────────────────────────
|
|
392
|
+
/**
|
|
393
|
+
* Bridge the call to one or more destinations.
|
|
394
|
+
*
|
|
395
|
+
* @param devices - Serial/parallel dial plan — outer array of serial groups,
|
|
396
|
+
* inner arrays dialled in parallel.
|
|
397
|
+
* @param options - Connect behaviour.
|
|
398
|
+
* @param options.ringback - Ringback media played to the originating party.
|
|
399
|
+
* @param options.tag - Tag for event correlation.
|
|
400
|
+
* @param options.maxDuration - Maximum connect duration in seconds.
|
|
401
|
+
* @param options.maxPricePerMinute - Price cap per minute.
|
|
402
|
+
* @param options.statusUrl - Webhook URL for status events.
|
|
403
|
+
* @returns The platform's connect response.
|
|
404
|
+
* @throws {RelayError} When the connect command is rejected.
|
|
405
|
+
*/
|
|
406
|
+
async connect(devices, options = {}) {
|
|
407
|
+
const params = { devices };
|
|
408
|
+
if (options.ringback != null)
|
|
409
|
+
params.ringback = options.ringback;
|
|
410
|
+
if (options.tag != null)
|
|
411
|
+
params.tag = options.tag;
|
|
412
|
+
if (options.maxDuration != null)
|
|
413
|
+
params.max_duration = options.maxDuration;
|
|
414
|
+
if (options.maxPricePerMinute != null)
|
|
415
|
+
params.max_price_per_minute = options.maxPricePerMinute;
|
|
416
|
+
if (options.statusUrl != null)
|
|
417
|
+
params.status_url = options.statusUrl;
|
|
418
|
+
return this._execute('connect', params);
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* Disconnect (unbridge) a connected call.
|
|
422
|
+
*
|
|
423
|
+
* @returns The platform's disconnect response.
|
|
424
|
+
* @throws {RelayError} When the disconnect command is rejected.
|
|
425
|
+
*/
|
|
426
|
+
async disconnect() {
|
|
427
|
+
return this._execute('disconnect');
|
|
428
|
+
}
|
|
429
|
+
// ─── DTMF ────────────────────────────────────────────────────────
|
|
430
|
+
/**
|
|
431
|
+
* Send DTMF digits on the call.
|
|
432
|
+
*
|
|
433
|
+
* @param digits - The DTMF digit string to send (e.g. `"1234#"`, `"ww*9"`).
|
|
434
|
+
* @param controlId - Explicit control ID. Auto-generated when omitted.
|
|
435
|
+
* @returns The platform's send-digits response.
|
|
436
|
+
* @throws {RelayError} When the send_digits command is rejected.
|
|
437
|
+
*/
|
|
438
|
+
async sendDigits(digits, controlId) {
|
|
439
|
+
const cid = controlId ?? randomUUID();
|
|
440
|
+
return this._execute('send_digits', { control_id: cid, digits });
|
|
441
|
+
}
|
|
442
|
+
// ─── Detection ───────────────────────────────────────────────────
|
|
443
|
+
/**
|
|
444
|
+
* Start audio detection (answering machine, fax, DTMF).
|
|
445
|
+
*
|
|
446
|
+
* @param detect - Platform-shaped detect configuration.
|
|
447
|
+
* @param options - Detection behaviour.
|
|
448
|
+
* @param options.timeout - Detection timeout in seconds.
|
|
449
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
450
|
+
* @param options.onCompleted - Callback fired when detection completes.
|
|
451
|
+
* @returns A {@link DetectAction} for control and completion tracking.
|
|
452
|
+
* @throws {RelayError} When the detect command is rejected.
|
|
453
|
+
*/
|
|
454
|
+
async detect(detect, options = {}) {
|
|
455
|
+
const cid = options.controlId ?? randomUUID();
|
|
456
|
+
const params = { control_id: cid, detect };
|
|
457
|
+
if (options.timeout != null)
|
|
458
|
+
params.timeout = options.timeout;
|
|
459
|
+
const action = new DetectAction(this, cid);
|
|
460
|
+
return this._startAction(action, 'detect', params, options.onCompleted);
|
|
461
|
+
}
|
|
462
|
+
// ─── SIP Refer ───────────────────────────────────────────────────
|
|
463
|
+
/**
|
|
464
|
+
* Transfer a SIP call via REFER.
|
|
465
|
+
*
|
|
466
|
+
* @param device - Platform-shaped SIP target device descriptor.
|
|
467
|
+
* @param options - Optional REFER behaviour.
|
|
468
|
+
* @param options.statusUrl - Webhook URL for REFER status events.
|
|
469
|
+
* @returns The platform's refer response.
|
|
470
|
+
* @throws {RelayError} When the refer command is rejected.
|
|
471
|
+
*/
|
|
472
|
+
async refer(device, options = {}) {
|
|
473
|
+
const params = { device };
|
|
474
|
+
if (options.statusUrl != null)
|
|
475
|
+
params.status_url = options.statusUrl;
|
|
476
|
+
return this._execute('refer', params);
|
|
477
|
+
}
|
|
478
|
+
// ─── Payment ─────────────────────────────────────────────────────
|
|
479
|
+
/**
|
|
480
|
+
* Start a PCI-compliant payment collection flow.
|
|
481
|
+
*
|
|
482
|
+
* @param paymentConnectorUrl - URL of the configured payment connector to
|
|
483
|
+
* tokenise the card with.
|
|
484
|
+
* @param options - Payment configuration — card-type filters, prompts,
|
|
485
|
+
* charge amount, etc. See the SignalWire pay documentation for field details.
|
|
486
|
+
* @returns A {@link PayAction} tracking the payment-collection flow.
|
|
487
|
+
* @throws {RelayError} When the pay command is rejected.
|
|
488
|
+
*/
|
|
489
|
+
async pay(paymentConnectorUrl, options = {}) {
|
|
490
|
+
const cid = options.controlId ?? randomUUID();
|
|
491
|
+
const params = {
|
|
492
|
+
control_id: cid,
|
|
493
|
+
payment_connector_url: paymentConnectorUrl,
|
|
494
|
+
};
|
|
495
|
+
if (options.inputMethod != null)
|
|
496
|
+
params.input = options.inputMethod;
|
|
497
|
+
if (options.statusUrl != null)
|
|
498
|
+
params.status_url = options.statusUrl;
|
|
499
|
+
if (options.paymentMethod != null)
|
|
500
|
+
params.payment_method = options.paymentMethod;
|
|
501
|
+
if (options.timeout != null)
|
|
502
|
+
params.timeout = options.timeout;
|
|
503
|
+
if (options.maxAttempts != null)
|
|
504
|
+
params.max_attempts = options.maxAttempts;
|
|
505
|
+
if (options.securityCode != null)
|
|
506
|
+
params.security_code = options.securityCode;
|
|
507
|
+
if (options.postalCode != null)
|
|
508
|
+
params.postal_code = options.postalCode;
|
|
509
|
+
if (options.minPostalCodeLength != null)
|
|
510
|
+
params.min_postal_code_length = options.minPostalCodeLength;
|
|
511
|
+
if (options.tokenType != null)
|
|
512
|
+
params.token_type = options.tokenType;
|
|
513
|
+
if (options.chargeAmount != null)
|
|
514
|
+
params.charge_amount = options.chargeAmount;
|
|
515
|
+
if (options.currency != null)
|
|
516
|
+
params.currency = options.currency;
|
|
517
|
+
if (options.language != null)
|
|
518
|
+
params.language = options.language;
|
|
519
|
+
if (options.voice != null)
|
|
520
|
+
params.voice = options.voice;
|
|
521
|
+
if (options.description != null)
|
|
522
|
+
params.description = options.description;
|
|
523
|
+
if (options.validCardTypes != null)
|
|
524
|
+
params.valid_card_types = options.validCardTypes;
|
|
525
|
+
if (options.parameters != null)
|
|
526
|
+
params.parameters = options.parameters;
|
|
527
|
+
if (options.prompts != null)
|
|
528
|
+
params.prompts = options.prompts;
|
|
529
|
+
const action = new PayAction(this, cid);
|
|
530
|
+
return this._startAction(action, 'pay', params, options.onCompleted);
|
|
531
|
+
}
|
|
532
|
+
// ─── Faxing ──────────────────────────────────────────────────────
|
|
533
|
+
/**
|
|
534
|
+
* Send a fax document.
|
|
535
|
+
*
|
|
536
|
+
* @param document - URL of the document to fax (TIFF or PDF).
|
|
537
|
+
* @param options - Fax behaviour.
|
|
538
|
+
* @param options.identity - Caller identity string sent in the fax header.
|
|
539
|
+
* @param options.headerInfo - Additional fax header text.
|
|
540
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
541
|
+
* @param options.onCompleted - Callback fired when the fax completes.
|
|
542
|
+
* @returns A {@link FaxAction} for control and completion tracking.
|
|
543
|
+
* @throws {RelayError} When the send_fax command is rejected.
|
|
544
|
+
*/
|
|
545
|
+
async sendFax(document, options = {}) {
|
|
546
|
+
const cid = options.controlId ?? randomUUID();
|
|
547
|
+
const params = { control_id: cid, document };
|
|
548
|
+
if (options.identity != null)
|
|
549
|
+
params.identity = options.identity;
|
|
550
|
+
if (options.headerInfo != null)
|
|
551
|
+
params.header_info = options.headerInfo;
|
|
552
|
+
const action = new FaxAction(this, cid, 'send_fax');
|
|
553
|
+
return this._startAction(action, 'send_fax', params, options.onCompleted);
|
|
554
|
+
}
|
|
555
|
+
/**
|
|
556
|
+
* Receive a fax and save it server-side.
|
|
557
|
+
*
|
|
558
|
+
* @param options - Fax reception behaviour.
|
|
559
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
560
|
+
* @param options.onCompleted - Callback fired when the fax completes.
|
|
561
|
+
* @returns A {@link FaxAction} for control and completion tracking.
|
|
562
|
+
* @throws {RelayError} When the receive_fax command is rejected.
|
|
563
|
+
*/
|
|
564
|
+
async receiveFax(options = {}) {
|
|
565
|
+
const cid = options.controlId ?? randomUUID();
|
|
566
|
+
const params = { control_id: cid };
|
|
567
|
+
const action = new FaxAction(this, cid, 'receive_fax');
|
|
568
|
+
return this._startAction(action, 'receive_fax', params, options.onCompleted);
|
|
569
|
+
}
|
|
570
|
+
// ─── Tap (Media Interception) ────────────────────────────────────
|
|
571
|
+
/**
|
|
572
|
+
* Intercept call media and stream it to an external destination.
|
|
573
|
+
*
|
|
574
|
+
* @param tap - Platform-shaped tap configuration (direction, codec, etc.).
|
|
575
|
+
* @param device - Destination device descriptor (WebSocket URL, etc.).
|
|
576
|
+
* @param options - Tap behaviour.
|
|
577
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
578
|
+
* @param options.onCompleted - Callback fired when the tap completes.
|
|
579
|
+
* @returns A {@link TapAction} for control and completion tracking.
|
|
580
|
+
* @throws {RelayError} When the tap command is rejected.
|
|
581
|
+
*/
|
|
582
|
+
async tap(tap, device, options = {}) {
|
|
583
|
+
const cid = options.controlId ?? randomUUID();
|
|
584
|
+
const params = { control_id: cid, tap, device };
|
|
585
|
+
const action = new TapAction(this, cid);
|
|
586
|
+
return this._startAction(action, 'tap', params, options.onCompleted);
|
|
587
|
+
}
|
|
588
|
+
// ─── Streaming ───────────────────────────────────────────────────
|
|
589
|
+
/**
|
|
590
|
+
* Start streaming call audio to a WebSocket endpoint.
|
|
591
|
+
*
|
|
592
|
+
* @param url - WebSocket URL to stream audio to.
|
|
593
|
+
* @param options - Stream behaviour.
|
|
594
|
+
* @param options.name - Friendly name for the stream.
|
|
595
|
+
* @param options.codec - Audio codec (e.g. `"PCMU"`, `"PCMA"`).
|
|
596
|
+
* @param options.track - Which track to send: `"inbound"`, `"outbound"`, or
|
|
597
|
+
* `"both"`.
|
|
598
|
+
* @param options.statusUrl - Webhook URL for stream status events.
|
|
599
|
+
* @param options.statusUrlMethod - HTTP method for `statusUrl` requests.
|
|
600
|
+
* @param options.authorizationBearerToken - Bearer token sent to the stream endpoint.
|
|
601
|
+
* @param options.customParameters - Extra parameters forwarded to the stream endpoint.
|
|
602
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
603
|
+
* @param options.onCompleted - Callback fired when the stream completes.
|
|
604
|
+
* @returns A {@link StreamAction} for control and completion tracking.
|
|
605
|
+
* @throws {RelayError} When the stream command is rejected.
|
|
606
|
+
*/
|
|
607
|
+
async stream(url, options = {}) {
|
|
608
|
+
const cid = options.controlId ?? randomUUID();
|
|
609
|
+
const params = { control_id: cid, url };
|
|
610
|
+
if (options.name != null)
|
|
611
|
+
params.name = options.name;
|
|
612
|
+
if (options.codec != null)
|
|
613
|
+
params.codec = options.codec;
|
|
614
|
+
if (options.track != null)
|
|
615
|
+
params.track = options.track;
|
|
616
|
+
if (options.statusUrl != null)
|
|
617
|
+
params.status_url = options.statusUrl;
|
|
618
|
+
if (options.statusUrlMethod != null)
|
|
619
|
+
params.status_url_method = options.statusUrlMethod;
|
|
620
|
+
if (options.authorizationBearerToken != null)
|
|
621
|
+
params.authorization_bearer_token = options.authorizationBearerToken;
|
|
622
|
+
if (options.customParameters != null)
|
|
623
|
+
params.custom_parameters = options.customParameters;
|
|
624
|
+
const action = new StreamAction(this, cid);
|
|
625
|
+
return this._startAction(action, 'stream', params, options.onCompleted);
|
|
626
|
+
}
|
|
627
|
+
// ─── Transfer ────────────────────────────────────────────────────
|
|
628
|
+
/**
|
|
629
|
+
* Transfer call control to another RELAY app or SWML script.
|
|
630
|
+
*
|
|
631
|
+
* @param dest - Destination identifier (RELAY context, SWML URL, etc.).
|
|
632
|
+
* @param extra - Optional additional params merged into the transfer request.
|
|
633
|
+
* @returns The platform's transfer response.
|
|
634
|
+
* @throws {RelayError} When the transfer command is rejected.
|
|
635
|
+
*/
|
|
636
|
+
async transfer(dest, extra) {
|
|
637
|
+
const params = { dest, ...extra };
|
|
638
|
+
return this._execute('transfer', params);
|
|
639
|
+
}
|
|
640
|
+
// ─── Conference ──────────────────────────────────────────────────
|
|
641
|
+
/**
|
|
642
|
+
* Join an ad-hoc audio conference.
|
|
643
|
+
*
|
|
644
|
+
* @param name - Conference name. Participants on the same name hear each other.
|
|
645
|
+
* @param options - Conference behaviour (muting, recording, status callbacks, etc.).
|
|
646
|
+
* @returns The platform's join-conference response.
|
|
647
|
+
* @throws {RelayError} When the join_conference command is rejected.
|
|
648
|
+
*/
|
|
649
|
+
async joinConference(name, options = {}) {
|
|
650
|
+
const params = { name };
|
|
651
|
+
if (options.muted != null)
|
|
652
|
+
params.muted = options.muted;
|
|
653
|
+
if (options.beep != null)
|
|
654
|
+
params.beep = options.beep;
|
|
655
|
+
if (options.startOnEnter != null)
|
|
656
|
+
params.start_on_enter = options.startOnEnter;
|
|
657
|
+
if (options.endOnExit != null)
|
|
658
|
+
params.end_on_exit = options.endOnExit;
|
|
659
|
+
if (options.waitUrl != null)
|
|
660
|
+
params.wait_url = options.waitUrl;
|
|
661
|
+
if (options.maxParticipants != null)
|
|
662
|
+
params.max_participants = options.maxParticipants;
|
|
663
|
+
if (options.record != null)
|
|
664
|
+
params.record = options.record;
|
|
665
|
+
if (options.region != null)
|
|
666
|
+
params.region = options.region;
|
|
667
|
+
if (options.trim != null)
|
|
668
|
+
params.trim = options.trim;
|
|
669
|
+
if (options.coach != null)
|
|
670
|
+
params.coach = options.coach;
|
|
671
|
+
if (options.statusCallback != null)
|
|
672
|
+
params.status_callback = options.statusCallback;
|
|
673
|
+
if (options.statusCallbackEvent != null)
|
|
674
|
+
params.status_callback_event = options.statusCallbackEvent;
|
|
675
|
+
if (options.statusCallbackEventType != null)
|
|
676
|
+
params.status_callback_event_type = options.statusCallbackEventType;
|
|
677
|
+
if (options.statusCallbackMethod != null)
|
|
678
|
+
params.status_callback_method = options.statusCallbackMethod;
|
|
679
|
+
if (options.recordingStatusCallback != null)
|
|
680
|
+
params.recording_status_callback = options.recordingStatusCallback;
|
|
681
|
+
if (options.recordingStatusCallbackEvent != null)
|
|
682
|
+
params.recording_status_callback_event = options.recordingStatusCallbackEvent;
|
|
683
|
+
if (options.recordingStatusCallbackEventType != null)
|
|
684
|
+
params.recording_status_callback_event_type = options.recordingStatusCallbackEventType;
|
|
685
|
+
if (options.recordingStatusCallbackMethod != null)
|
|
686
|
+
params.recording_status_callback_method = options.recordingStatusCallbackMethod;
|
|
687
|
+
if (options.stream != null)
|
|
688
|
+
params.stream = options.stream;
|
|
689
|
+
return this._execute('join_conference', params);
|
|
690
|
+
}
|
|
691
|
+
/**
|
|
692
|
+
* Leave an audio conference.
|
|
693
|
+
*
|
|
694
|
+
* @param conferenceId - Identifier of the conference to leave.
|
|
695
|
+
* @param extra - Optional additional params merged into the request.
|
|
696
|
+
* @returns The platform's leave-conference response.
|
|
697
|
+
* @throws {RelayError} When the leave_conference command is rejected.
|
|
698
|
+
*/
|
|
699
|
+
async leaveConference(conferenceId, extra) {
|
|
700
|
+
return this._execute('leave_conference', { conference_id: conferenceId, ...extra });
|
|
701
|
+
}
|
|
702
|
+
// ─── Hold / Unhold ───────────────────────────────────────────────
|
|
703
|
+
/**
|
|
704
|
+
* Put the call on hold.
|
|
705
|
+
*
|
|
706
|
+
* @returns The platform's hold response.
|
|
707
|
+
* @throws {RelayError} When the hold command is rejected.
|
|
708
|
+
*/
|
|
709
|
+
async hold() {
|
|
710
|
+
return this._execute('hold');
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
* Release the call from hold.
|
|
714
|
+
*
|
|
715
|
+
* @returns The platform's unhold response.
|
|
716
|
+
* @throws {RelayError} When the unhold command is rejected.
|
|
717
|
+
*/
|
|
718
|
+
async unhold() {
|
|
719
|
+
return this._execute('unhold');
|
|
720
|
+
}
|
|
721
|
+
// ─── Denoise ─────────────────────────────────────────────────────
|
|
722
|
+
/**
|
|
723
|
+
* Start noise reduction on the call.
|
|
724
|
+
*
|
|
725
|
+
* @returns The platform's denoise response.
|
|
726
|
+
* @throws {RelayError} When the denoise command is rejected.
|
|
727
|
+
*/
|
|
728
|
+
async denoise() {
|
|
729
|
+
return this._execute('denoise');
|
|
730
|
+
}
|
|
731
|
+
/**
|
|
732
|
+
* Stop noise reduction on the call.
|
|
733
|
+
*
|
|
734
|
+
* @returns The platform's denoise-stop response.
|
|
735
|
+
* @throws {RelayError} When the denoise.stop command is rejected.
|
|
736
|
+
*/
|
|
737
|
+
async denoiseStop() {
|
|
738
|
+
return this._execute('denoise.stop');
|
|
739
|
+
}
|
|
740
|
+
// ─── Transcribe ──────────────────────────────────────────────────
|
|
741
|
+
/**
|
|
742
|
+
* Start transcribing the call.
|
|
743
|
+
*
|
|
744
|
+
* @param options - Transcription behaviour.
|
|
745
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
746
|
+
* @param options.statusUrl - Webhook URL for transcription status events.
|
|
747
|
+
* @param options.onCompleted - Callback fired when transcription completes.
|
|
748
|
+
* @returns A {@link TranscribeAction} for control and completion tracking.
|
|
749
|
+
* @throws {RelayError} When the transcribe command is rejected.
|
|
750
|
+
*/
|
|
751
|
+
async transcribe(options = {}) {
|
|
752
|
+
const cid = options.controlId ?? randomUUID();
|
|
753
|
+
const params = { control_id: cid };
|
|
754
|
+
if (options.statusUrl != null)
|
|
755
|
+
params.status_url = options.statusUrl;
|
|
756
|
+
const action = new TranscribeAction(this, cid);
|
|
757
|
+
return this._startAction(action, 'transcribe', params, options.onCompleted);
|
|
758
|
+
}
|
|
759
|
+
// ─── Echo ────────────────────────────────────────────────────────
|
|
760
|
+
/**
|
|
761
|
+
* Echo audio back to the caller (useful for testing network round-trip).
|
|
762
|
+
*
|
|
763
|
+
* @param options - Echo behaviour.
|
|
764
|
+
* @param options.timeout - How long to echo, in seconds.
|
|
765
|
+
* @param options.statusUrl - Webhook URL for echo status events.
|
|
766
|
+
* @returns The platform's echo response.
|
|
767
|
+
* @throws {RelayError} When the echo command is rejected.
|
|
768
|
+
*/
|
|
769
|
+
async echo(options = {}) {
|
|
770
|
+
const params = {};
|
|
771
|
+
if (options.timeout != null)
|
|
772
|
+
params.timeout = options.timeout;
|
|
773
|
+
if (options.statusUrl != null)
|
|
774
|
+
params.status_url = options.statusUrl;
|
|
775
|
+
return this._execute('echo', Object.keys(params).length ? params : undefined);
|
|
776
|
+
}
|
|
777
|
+
// ─── Digit Bindings ──────────────────────────────────────────────
|
|
778
|
+
/**
|
|
779
|
+
* Bind a DTMF digit sequence to trigger a RELAY method automatically when
|
|
780
|
+
* the caller presses it.
|
|
781
|
+
*
|
|
782
|
+
* @param digits - DTMF sequence that triggers the binding (e.g. `"*9"`).
|
|
783
|
+
* @param bindMethod - RELAY method to invoke when the sequence is detected.
|
|
784
|
+
* @param options - Binding behaviour.
|
|
785
|
+
* @param options.bindParams - Params forwarded to `bindMethod` on trigger.
|
|
786
|
+
* @param options.realm - Optional realm label so bindings can be cleared in groups.
|
|
787
|
+
* @param options.maxTriggers - Maximum number of times the binding can fire.
|
|
788
|
+
* @returns The platform's bind_digit response.
|
|
789
|
+
* @throws {RelayError} When the bind_digit command is rejected.
|
|
790
|
+
*/
|
|
791
|
+
async bindDigit(digits, bindMethod, options = {}) {
|
|
792
|
+
const params = {
|
|
793
|
+
digits,
|
|
794
|
+
bind_method: bindMethod,
|
|
795
|
+
};
|
|
796
|
+
if (options.bindParams != null)
|
|
797
|
+
params.params = options.bindParams;
|
|
798
|
+
if (options.realm != null)
|
|
799
|
+
params.realm = options.realm;
|
|
800
|
+
if (options.maxTriggers != null)
|
|
801
|
+
params.max_triggers = options.maxTriggers;
|
|
802
|
+
return this._execute('bind_digit', params);
|
|
803
|
+
}
|
|
804
|
+
/**
|
|
805
|
+
* Clear all digit bindings, optionally filtered by realm.
|
|
806
|
+
*
|
|
807
|
+
* @param realm - When provided, only bindings with this realm label are cleared.
|
|
808
|
+
* @returns The platform's clear_digit_bindings response.
|
|
809
|
+
* @throws {RelayError} When the clear_digit_bindings command is rejected.
|
|
810
|
+
*/
|
|
811
|
+
async clearDigitBindings(realm) {
|
|
812
|
+
const params = {};
|
|
813
|
+
if (realm != null)
|
|
814
|
+
params.realm = realm;
|
|
815
|
+
return this._execute('clear_digit_bindings', Object.keys(params).length ? params : undefined);
|
|
816
|
+
}
|
|
817
|
+
// ─── Live Transcribe / Translate ─────────────────────────────────
|
|
818
|
+
/**
|
|
819
|
+
* Start or stop live transcription on the call.
|
|
820
|
+
*
|
|
821
|
+
* @param action - Platform-shaped action block (`start` or `stop` plus
|
|
822
|
+
* configuration).
|
|
823
|
+
* @param extra - Optional additional params merged into the request.
|
|
824
|
+
* @returns The platform's live_transcribe response.
|
|
825
|
+
* @throws {RelayError} When the live_transcribe command is rejected.
|
|
826
|
+
*/
|
|
827
|
+
async liveTranscribe(action, extra) {
|
|
828
|
+
return this._execute('live_transcribe', { action, ...extra });
|
|
829
|
+
}
|
|
830
|
+
/**
|
|
831
|
+
* Start or stop live translation on the call.
|
|
832
|
+
*
|
|
833
|
+
* @param action - Platform-shaped action block (`start` or `stop` plus
|
|
834
|
+
* source/target languages).
|
|
835
|
+
* @param options - Live-translate behaviour.
|
|
836
|
+
* @param options.statusUrl - Webhook URL for translation status events.
|
|
837
|
+
* @returns The platform's live_translate response.
|
|
838
|
+
* @throws {RelayError} When the live_translate command is rejected.
|
|
839
|
+
*/
|
|
840
|
+
async liveTranslate(action, options = {}) {
|
|
841
|
+
const params = { action };
|
|
842
|
+
if (options.statusUrl != null)
|
|
843
|
+
params.status_url = options.statusUrl;
|
|
844
|
+
return this._execute('live_translate', params);
|
|
845
|
+
}
|
|
846
|
+
// ─── Room ────────────────────────────────────────────────────────
|
|
847
|
+
/**
|
|
848
|
+
* Join a video / audio room.
|
|
849
|
+
*
|
|
850
|
+
* @param name - Room name — callers on the same name share the same room.
|
|
851
|
+
* @param options - Room behaviour.
|
|
852
|
+
* @param options.statusUrl - Webhook URL for room status events.
|
|
853
|
+
* @returns The platform's join_room response.
|
|
854
|
+
* @throws {RelayError} When the join_room command is rejected.
|
|
855
|
+
*/
|
|
856
|
+
async joinRoom(name, options = {}) {
|
|
857
|
+
const params = { name };
|
|
858
|
+
if (options.statusUrl != null)
|
|
859
|
+
params.status_url = options.statusUrl;
|
|
860
|
+
return this._execute('join_room', params);
|
|
861
|
+
}
|
|
862
|
+
/**
|
|
863
|
+
* Leave the current room.
|
|
864
|
+
*
|
|
865
|
+
* @param extra - Optional additional params merged into the request.
|
|
866
|
+
* @returns The platform's leave_room response.
|
|
867
|
+
* @throws {RelayError} When the leave_room command is rejected.
|
|
868
|
+
*/
|
|
869
|
+
async leaveRoom(extra) {
|
|
870
|
+
return this._execute('leave_room', extra);
|
|
871
|
+
}
|
|
872
|
+
// ─── AI Agent ────────────────────────────────────────────────────
|
|
873
|
+
/**
|
|
874
|
+
* Start an AI agent session on the call.
|
|
875
|
+
*
|
|
876
|
+
* @param options - AI configuration — prompts, voices, tools, languages, etc.
|
|
877
|
+
* @returns An {@link AIAction} for control and completion tracking.
|
|
878
|
+
* @throws {RelayError} When the ai command is rejected.
|
|
879
|
+
*/
|
|
880
|
+
async ai(options = {}) {
|
|
881
|
+
const cid = options.controlId ?? randomUUID();
|
|
882
|
+
const params = { control_id: cid };
|
|
883
|
+
if (options.agent != null)
|
|
884
|
+
params.agent = options.agent;
|
|
885
|
+
if (options.prompt != null)
|
|
886
|
+
params.prompt = options.prompt;
|
|
887
|
+
if (options.postPrompt != null)
|
|
888
|
+
params.post_prompt = options.postPrompt;
|
|
889
|
+
if (options.postPromptUrl != null)
|
|
890
|
+
params.post_prompt_url = options.postPromptUrl;
|
|
891
|
+
if (options.postPromptAuthUser != null)
|
|
892
|
+
params.post_prompt_auth_user = options.postPromptAuthUser;
|
|
893
|
+
if (options.postPromptAuthPassword != null)
|
|
894
|
+
params.post_prompt_auth_password = options.postPromptAuthPassword;
|
|
895
|
+
if (options.globalData != null)
|
|
896
|
+
params.global_data = options.globalData;
|
|
897
|
+
if (options.pronounce != null)
|
|
898
|
+
params.pronounce = options.pronounce;
|
|
899
|
+
if (options.hints != null)
|
|
900
|
+
params.hints = options.hints;
|
|
901
|
+
if (options.languages != null)
|
|
902
|
+
params.languages = options.languages;
|
|
903
|
+
if (options.SWAIG != null)
|
|
904
|
+
params.SWAIG = options.SWAIG;
|
|
905
|
+
if (options.aiParams != null)
|
|
906
|
+
params.params = options.aiParams;
|
|
907
|
+
const action = new AIAction(this, cid);
|
|
908
|
+
return this._startAction(action, 'ai', params, options.onCompleted);
|
|
909
|
+
}
|
|
910
|
+
/**
|
|
911
|
+
* Connect the call to an Amazon Bedrock AI agent.
|
|
912
|
+
*
|
|
913
|
+
* @param options - Bedrock agent configuration.
|
|
914
|
+
* @param options.prompt - Prompt to send to the Bedrock agent.
|
|
915
|
+
* @param options.SWAIG - SWAIG configuration (functions, includes, etc.).
|
|
916
|
+
* @param options.aiParams - AI engine parameters.
|
|
917
|
+
* @param options.globalData - Global-data object available to SWAIG tools.
|
|
918
|
+
* @param options.postPrompt - Post-prompt configuration.
|
|
919
|
+
* @param options.postPromptUrl - URL to POST the final summary to.
|
|
920
|
+
* @returns The platform's amazon_bedrock response.
|
|
921
|
+
* @throws {RelayError} When the amazon_bedrock command is rejected.
|
|
922
|
+
*/
|
|
923
|
+
async amazonBedrock(options = {}) {
|
|
924
|
+
const params = {};
|
|
925
|
+
if (options.prompt != null)
|
|
926
|
+
params.prompt = options.prompt;
|
|
927
|
+
if (options.SWAIG != null)
|
|
928
|
+
params.SWAIG = options.SWAIG;
|
|
929
|
+
if (options.aiParams != null)
|
|
930
|
+
params.params = options.aiParams;
|
|
931
|
+
if (options.globalData != null)
|
|
932
|
+
params.global_data = options.globalData;
|
|
933
|
+
if (options.postPrompt != null)
|
|
934
|
+
params.post_prompt = options.postPrompt;
|
|
935
|
+
if (options.postPromptUrl != null)
|
|
936
|
+
params.post_prompt_url = options.postPromptUrl;
|
|
937
|
+
return this._execute('amazon_bedrock', params);
|
|
938
|
+
}
|
|
939
|
+
/**
|
|
940
|
+
* Send a message into an active AI agent session.
|
|
941
|
+
*
|
|
942
|
+
* @param options - Message parameters.
|
|
943
|
+
* @param options.messageText - Text content to inject into the conversation.
|
|
944
|
+
* @param options.role - Speaker role (`"system"`, `"user"`, or `"assistant"`).
|
|
945
|
+
* @param options.reset - Reset directives for the conversation state.
|
|
946
|
+
* @param options.globalData - Global-data updates to merge.
|
|
947
|
+
* @returns The platform's ai_message response.
|
|
948
|
+
* @throws {RelayError} When the ai_message command is rejected.
|
|
949
|
+
*/
|
|
950
|
+
async aiMessage(options = {}) {
|
|
951
|
+
const params = {};
|
|
952
|
+
if (options.messageText != null)
|
|
953
|
+
params.message_text = options.messageText;
|
|
954
|
+
if (options.role != null)
|
|
955
|
+
params.role = options.role;
|
|
956
|
+
if (options.reset != null)
|
|
957
|
+
params.reset = options.reset;
|
|
958
|
+
if (options.globalData != null)
|
|
959
|
+
params.global_data = options.globalData;
|
|
960
|
+
return this._execute('ai_message', params);
|
|
961
|
+
}
|
|
962
|
+
/**
|
|
963
|
+
* Put the AI agent session on hold (pause turn-taking).
|
|
964
|
+
*
|
|
965
|
+
* @param options - Hold behaviour.
|
|
966
|
+
* @param options.timeout - Maximum hold duration.
|
|
967
|
+
* @param options.prompt - Prompt played to the caller during the hold.
|
|
968
|
+
* @returns The platform's ai_hold response.
|
|
969
|
+
* @throws {RelayError} When the ai_hold command is rejected.
|
|
970
|
+
*/
|
|
971
|
+
async aiHold(options = {}) {
|
|
972
|
+
const params = {};
|
|
973
|
+
if (options.timeout != null)
|
|
974
|
+
params.timeout = options.timeout;
|
|
975
|
+
if (options.prompt != null)
|
|
976
|
+
params.prompt = options.prompt;
|
|
977
|
+
return this._execute('ai_hold', Object.keys(params).length ? params : undefined);
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* Resume an AI agent session from hold.
|
|
981
|
+
*
|
|
982
|
+
* @param options - Unhold behaviour.
|
|
983
|
+
* @param options.prompt - Prompt played to the caller on resume.
|
|
984
|
+
* @returns The platform's ai_unhold response.
|
|
985
|
+
* @throws {RelayError} When the ai_unhold command is rejected.
|
|
986
|
+
*/
|
|
987
|
+
async aiUnhold(options = {}) {
|
|
988
|
+
const params = {};
|
|
989
|
+
if (options.prompt != null)
|
|
990
|
+
params.prompt = options.prompt;
|
|
991
|
+
return this._execute('ai_unhold', Object.keys(params).length ? params : undefined);
|
|
992
|
+
}
|
|
993
|
+
// ─── User Events ─────────────────────────────────────────────────
|
|
994
|
+
/**
|
|
995
|
+
* Emit a custom user-defined event on the call for your webhooks.
|
|
996
|
+
*
|
|
997
|
+
* @param options - Freeform event payload. Set `options.event` for the
|
|
998
|
+
* event name and include any additional fields your webhook expects.
|
|
999
|
+
* @returns The platform's user_event response.
|
|
1000
|
+
* @throws {RelayError} When the user_event command is rejected.
|
|
1001
|
+
*/
|
|
1002
|
+
async userEvent(options = {}) {
|
|
1003
|
+
const params = {};
|
|
1004
|
+
if (options.event != null)
|
|
1005
|
+
params.event = options.event;
|
|
1006
|
+
return this._execute('user_event', params);
|
|
1007
|
+
}
|
|
1008
|
+
// ─── Queue ───────────────────────────────────────────────────────
|
|
1009
|
+
/**
|
|
1010
|
+
* Place the call into a named queue.
|
|
1011
|
+
*
|
|
1012
|
+
* @param queueName - Name of the queue to enter.
|
|
1013
|
+
* @param options - Queue-entry behaviour.
|
|
1014
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
1015
|
+
* @param options.statusUrl - Webhook URL for queue status events.
|
|
1016
|
+
* @returns The platform's queue.enter response.
|
|
1017
|
+
* @throws {RelayError} When the queue.enter command is rejected.
|
|
1018
|
+
*/
|
|
1019
|
+
async queueEnter(queueName, options = {}) {
|
|
1020
|
+
const cid = options.controlId ?? randomUUID();
|
|
1021
|
+
const params = {
|
|
1022
|
+
control_id: cid,
|
|
1023
|
+
queue_name: queueName,
|
|
1024
|
+
};
|
|
1025
|
+
if (options.statusUrl != null)
|
|
1026
|
+
params.status_url = options.statusUrl;
|
|
1027
|
+
return this._execute('queue.enter', params);
|
|
1028
|
+
}
|
|
1029
|
+
/**
|
|
1030
|
+
* Remove the call from a queue.
|
|
1031
|
+
*
|
|
1032
|
+
* @param queueName - Name of the queue to leave.
|
|
1033
|
+
* @param options - Queue-exit behaviour.
|
|
1034
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
1035
|
+
* @param options.queueId - Queue ID override (when multiple queues share a name).
|
|
1036
|
+
* @param options.statusUrl - Webhook URL for queue status events.
|
|
1037
|
+
* @returns The platform's queue.leave response.
|
|
1038
|
+
* @throws {RelayError} When the queue.leave command is rejected.
|
|
1039
|
+
*/
|
|
1040
|
+
async queueLeave(queueName, options = {}) {
|
|
1041
|
+
const cid = options.controlId ?? randomUUID();
|
|
1042
|
+
const params = {
|
|
1043
|
+
control_id: cid,
|
|
1044
|
+
queue_name: queueName,
|
|
1045
|
+
};
|
|
1046
|
+
if (options.queueId != null)
|
|
1047
|
+
params.queue_id = options.queueId;
|
|
1048
|
+
if (options.statusUrl != null)
|
|
1049
|
+
params.status_url = options.statusUrl;
|
|
1050
|
+
return this._execute('queue.leave', params);
|
|
1051
|
+
}
|
|
1052
|
+
// ─── Repr ────────────────────────────────────────────────────────
|
|
1053
|
+
/**
|
|
1054
|
+
* Return a human-readable diagnostic string.
|
|
1055
|
+
*
|
|
1056
|
+
* @returns `<Call id=... state=... direction=...>` — handy for log output.
|
|
1057
|
+
*/
|
|
1058
|
+
toString() {
|
|
1059
|
+
return `<Call id=${this.callId} state=${this.state} direction=${this.direction}>`;
|
|
1060
|
+
}
|
|
1061
|
+
}
|
|
1062
|
+
//# sourceMappingURL=Call.js.map
|