@signalwire/sdk 2.0.1 → 2.0.3
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/{src/index.ts → dist/index.d.ts} +13 -100
- 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 +1026 -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/dist/rest/index.d.ts +131 -0
- package/{src/rest/index.ts → dist/rest/index.js} +101 -136
- 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/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
- 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 -2598
- package/src/AgentServer.ts +0 -442
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1181
- package/src/DataMap.ts +0 -477
- package/src/FunctionResult.ts +0 -903
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -467
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -749
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -240
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -283
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -199
- package/src/WebService.ts +0 -641
- 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/livewire/index.ts +0 -1252
- package/src/prefabs/ConciergeAgent.ts +0 -309
- package/src/prefabs/FAQBotAgent.ts +0 -415
- package/src/prefabs/InfoGathererAgent.ts +0 -379
- package/src/prefabs/ReceptionistAgent.ts +0 -395
- package/src/prefabs/SurveyAgent.ts +0 -671
- package/src/relay/Action.ts +0 -482
- package/src/relay/Call.ts +0 -1270
- package/src/relay/Deferred.ts +0 -94
- package/src/relay/Message.ts +0 -199
- package/src/relay/RelayClient.ts +0 -1185
- package/src/relay/RelayError.ts +0 -20
- package/src/relay/RelayEvent.ts +0 -944
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -164
- package/src/rest/RestError.ts +0 -45
- package/src/rest/base/BaseResource.ts +0 -32
- package/src/rest/base/CrudResource.ts +0 -98
- package/src/rest/base/CrudWithAddresses.ts +0 -37
- package/src/rest/namespaces/addresses.ts +0 -64
- package/src/rest/namespaces/calling.ts +0 -534
- package/src/rest/namespaces/chat.ts +0 -31
- package/src/rest/namespaces/compat.ts +0 -812
- package/src/rest/namespaces/datasphere.ts +0 -88
- package/src/rest/namespaces/fabric.ts +0 -417
- package/src/rest/namespaces/imported-numbers.ts +0 -31
- package/src/rest/namespaces/logs.ts +0 -151
- package/src/rest/namespaces/lookup.ts +0 -38
- package/src/rest/namespaces/mfa.ts +0 -61
- package/src/rest/namespaces/number-groups.ts +0 -68
- package/src/rest/namespaces/phone-numbers.ts +0 -76
- package/src/rest/namespaces/project.ts +0 -65
- package/src/rest/namespaces/pubsub.ts +0 -31
- package/src/rest/namespaces/queues.ts +0 -58
- package/src/rest/namespaces/recordings.ts +0 -53
- package/src/rest/namespaces/registry.ts +0 -200
- package/src/rest/namespaces/short-codes.ts +0 -54
- package/src/rest/namespaces/sip-profile.ts +0 -40
- package/src/rest/namespaces/verified-callers.ts +0 -46
- package/src/rest/namespaces/video.ts +0 -332
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -582
- package/src/skills/SkillManager.ts +0 -419
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
- package/src/skills/builtin/ask_claude.ts +0 -246
- package/src/skills/builtin/claude_skills.ts +0 -983
- package/src/skills/builtin/custom_skills.ts +0 -327
- package/src/skills/builtin/datasphere.ts +0 -447
- package/src/skills/builtin/datasphere_serverless.ts +0 -347
- package/src/skills/builtin/datetime.ts +0 -137
- package/src/skills/builtin/google_maps.ts +0 -656
- package/src/skills/builtin/info_gatherer.ts +0 -415
- package/src/skills/builtin/joke.ts +0 -196
- package/src/skills/builtin/math.ts +0 -149
- package/src/skills/builtin/mcp_gateway.ts +0 -685
- package/src/skills/builtin/native_vector_search.ts +0 -910
- package/src/skills/builtin/play_background_file.ts +0 -367
- package/src/skills/builtin/spider.ts +0 -874
- package/src/skills/builtin/swml_transfer.ts +0 -645
- package/src/skills/builtin/weather_api.ts +0 -255
- package/src/skills/builtin/web_search.ts +0 -1083
- package/src/skills/builtin/wikipedia_search.ts +0 -304
- 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,697 @@
|
|
|
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
|
+
import { Action, PlayAction, RecordAction, DetectAction, CollectAction, StandaloneCollectAction, FaxAction, TapAction, StreamAction, PayAction, TranscribeAction, AIAction } from './Action.js';
|
|
8
|
+
import { type Deferred } from './Deferred.js';
|
|
9
|
+
import { RelayEvent } from './RelayEvent.js';
|
|
10
|
+
import type { CompletedCallback, EventHandler } from './types.js';
|
|
11
|
+
/** Interface the Call needs from RelayClient (avoids circular import). */
|
|
12
|
+
export interface RelayClientLike {
|
|
13
|
+
execute(method: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
14
|
+
}
|
|
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 declare class Call {
|
|
39
|
+
/** @internal */ readonly _client: RelayClientLike;
|
|
40
|
+
/** Unique call identifier assigned by the platform. */
|
|
41
|
+
callId: string;
|
|
42
|
+
/** RELAY node that owns this call. */
|
|
43
|
+
nodeId: string;
|
|
44
|
+
/** SignalWire project ID. */
|
|
45
|
+
projectId: string;
|
|
46
|
+
/** RELAY context this call was received on. */
|
|
47
|
+
context: string;
|
|
48
|
+
/** Opaque correlation tag attached at dial time. */
|
|
49
|
+
tag: string;
|
|
50
|
+
/** `"inbound"` or `"outbound"`. */
|
|
51
|
+
direction: string;
|
|
52
|
+
/** Device descriptor the call is associated with (phone, SIP, etc.). */
|
|
53
|
+
device: Record<string, any>;
|
|
54
|
+
/** Current call state (e.g. `"created"`, `"answered"`, `"ended"`). */
|
|
55
|
+
state: string;
|
|
56
|
+
/** Call segment ID used for event correlation. */
|
|
57
|
+
segmentId: string;
|
|
58
|
+
/** @internal */ readonly _listeners: Map<string, EventHandler[]>;
|
|
59
|
+
/** @internal */ readonly _actions: Map<string, Action>;
|
|
60
|
+
/** @internal */ readonly _ended: Deferred<RelayEvent>;
|
|
61
|
+
constructor(client: RelayClientLike, callId: string, nodeId: string, projectId: string, context: string, options?: {
|
|
62
|
+
tag?: string;
|
|
63
|
+
direction?: string;
|
|
64
|
+
device?: Record<string, any>;
|
|
65
|
+
state?: string;
|
|
66
|
+
segmentId?: string;
|
|
67
|
+
});
|
|
68
|
+
/** @internal Send a calling.<method> JSON-RPC request for this call. */
|
|
69
|
+
_execute(method: string, extraParams?: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
70
|
+
/**
|
|
71
|
+
* Register an event listener for this call.
|
|
72
|
+
*
|
|
73
|
+
* Multiple listeners for the same event type are supported. Listener errors
|
|
74
|
+
* are logged but do not disrupt dispatch to other listeners.
|
|
75
|
+
*
|
|
76
|
+
* @param eventType - Fully-qualified event type (e.g.
|
|
77
|
+
* `"calling.call.state"`, `"calling.call.play"`).
|
|
78
|
+
* @param handler - Callback invoked for each matching event.
|
|
79
|
+
*/
|
|
80
|
+
on(eventType: string, handler: EventHandler): void;
|
|
81
|
+
/** @internal Called by RelayClient when an event arrives for this call. */
|
|
82
|
+
_dispatchEvent(payload: Record<string, unknown>): Promise<void>;
|
|
83
|
+
/**
|
|
84
|
+
* Wait for a specific event, optionally filtered by predicate.
|
|
85
|
+
*
|
|
86
|
+
* Registers a one-shot listener that is removed after resolving (or after
|
|
87
|
+
* the timeout elapses). Useful for awaiting a specific state transition.
|
|
88
|
+
*
|
|
89
|
+
* @param eventType - Event type to wait for.
|
|
90
|
+
* @param predicate - Optional filter — only events for which this returns
|
|
91
|
+
* `true` resolve the wait.
|
|
92
|
+
* @param timeout - Optional timeout in milliseconds. Omit to wait forever.
|
|
93
|
+
* @returns The first matching {@link RelayEvent}.
|
|
94
|
+
* @throws {Error} When the optional timeout elapses before a match.
|
|
95
|
+
*/
|
|
96
|
+
waitFor(eventType: string, predicate?: (event: RelayEvent) => boolean, timeout?: number): Promise<RelayEvent>;
|
|
97
|
+
/**
|
|
98
|
+
* Wait for the call to reach the `ended` state.
|
|
99
|
+
*
|
|
100
|
+
* @param timeout - Optional timeout in milliseconds.
|
|
101
|
+
* @returns The terminating `calling.call.state` {@link RelayEvent}.
|
|
102
|
+
* @throws {Error} When the optional timeout elapses before the call ends.
|
|
103
|
+
*/
|
|
104
|
+
waitForEnded(timeout?: number): Promise<RelayEvent>;
|
|
105
|
+
/** @internal Register an action, execute the RPC, clean up on failure. */
|
|
106
|
+
_startAction<T extends Action>(action: T, method: string, params: Record<string, unknown>, onCompleted?: CompletedCallback | null): Promise<T>;
|
|
107
|
+
/**
|
|
108
|
+
* Answer an inbound call.
|
|
109
|
+
*
|
|
110
|
+
* @param extra - Optional additional params merged into the answer request
|
|
111
|
+
* (e.g. SIP headers, codec hints).
|
|
112
|
+
* @returns The platform's answer response.
|
|
113
|
+
* @throws {RelayError} When the answer command is rejected.
|
|
114
|
+
*/
|
|
115
|
+
answer(extra?: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
116
|
+
/**
|
|
117
|
+
* End / hang up the call.
|
|
118
|
+
*
|
|
119
|
+
* @param reason - Hangup reason delivered to the platform. Defaults to
|
|
120
|
+
* `"hangup"`.
|
|
121
|
+
* @returns The platform's end response.
|
|
122
|
+
* @throws {RelayError} When the end command is rejected.
|
|
123
|
+
*/
|
|
124
|
+
hangup(reason?: string): Promise<Record<string, unknown>>;
|
|
125
|
+
/**
|
|
126
|
+
* Decline control of an inbound call, returning it to routing.
|
|
127
|
+
*
|
|
128
|
+
* Use instead of {@link answer} when you want the call to fall through to
|
|
129
|
+
* the next matching route rather than be handled by this client.
|
|
130
|
+
*
|
|
131
|
+
* @returns The platform's pass response.
|
|
132
|
+
* @throws {RelayError} When the pass command is rejected.
|
|
133
|
+
*/
|
|
134
|
+
pass(): Promise<Record<string, unknown>>;
|
|
135
|
+
/**
|
|
136
|
+
* Play audio content on the call.
|
|
137
|
+
*
|
|
138
|
+
* Returns immediately with a {@link PlayAction} — `await action.wait()` to
|
|
139
|
+
* block until playback finishes, or call `stop()` / `pause()` / `resume()`
|
|
140
|
+
* / `volume()` on it to control playback.
|
|
141
|
+
*
|
|
142
|
+
* @param media - Platform-shaped play items (TTS, audio URLs, silence, etc.).
|
|
143
|
+
* @param options - Optional playback controls.
|
|
144
|
+
* @param options.volume - Volume adjustment in dB.
|
|
145
|
+
* @param options.direction - `"speak"`, `"hear"`, or `"both"`.
|
|
146
|
+
* @param options.loop - Number of times to loop the playback.
|
|
147
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
148
|
+
* @param options.onCompleted - Callback fired when playback reaches a
|
|
149
|
+
* terminal state.
|
|
150
|
+
* @returns A {@link PlayAction} for control and completion tracking.
|
|
151
|
+
* @throws {RelayError} When the play command is rejected.
|
|
152
|
+
*/
|
|
153
|
+
play(media: Record<string, unknown>[], options?: {
|
|
154
|
+
volume?: number;
|
|
155
|
+
direction?: string;
|
|
156
|
+
loop?: number;
|
|
157
|
+
controlId?: string;
|
|
158
|
+
onCompleted?: CompletedCallback;
|
|
159
|
+
}): Promise<PlayAction>;
|
|
160
|
+
/**
|
|
161
|
+
* Record audio from the call.
|
|
162
|
+
*
|
|
163
|
+
* @param audio - Platform-shaped audio recording options (direction, codec,
|
|
164
|
+
* timeouts, etc.). Defaults to `{}`.
|
|
165
|
+
* @param options - Recording behaviour.
|
|
166
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
167
|
+
* @param options.onCompleted - Callback fired when the recording reaches a
|
|
168
|
+
* terminal state.
|
|
169
|
+
* @returns A {@link RecordAction} for control and completion tracking.
|
|
170
|
+
* @throws {RelayError} When the record command is rejected.
|
|
171
|
+
*/
|
|
172
|
+
record(audio?: Record<string, unknown>, options?: {
|
|
173
|
+
controlId?: string;
|
|
174
|
+
onCompleted?: CompletedCallback;
|
|
175
|
+
}): Promise<RecordAction>;
|
|
176
|
+
/**
|
|
177
|
+
* Play audio and collect digit / speech input in a single operation.
|
|
178
|
+
*
|
|
179
|
+
* Convenient for IVR prompts — playback stops as soon as input is received.
|
|
180
|
+
*
|
|
181
|
+
* @param media - Audio items to play while collecting.
|
|
182
|
+
* @param collect - Platform-shaped collect config (`digits`, `speech`, etc.).
|
|
183
|
+
* @param options - Playback and collection behaviour.
|
|
184
|
+
* @param options.volume - Playback volume adjustment in dB.
|
|
185
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
186
|
+
* @param options.onCompleted - Callback fired when collect completes.
|
|
187
|
+
* @returns A {@link CollectAction} for the combined play-and-collect flow.
|
|
188
|
+
* @throws {RelayError} When the play_and_collect command is rejected.
|
|
189
|
+
*/
|
|
190
|
+
playAndCollect(media: Record<string, unknown>[], collect: Record<string, unknown>, options?: {
|
|
191
|
+
volume?: number;
|
|
192
|
+
controlId?: string;
|
|
193
|
+
onCompleted?: CompletedCallback;
|
|
194
|
+
}): Promise<CollectAction>;
|
|
195
|
+
/**
|
|
196
|
+
* Collect digit / speech input without playing media.
|
|
197
|
+
*
|
|
198
|
+
* @param options - Collect configuration.
|
|
199
|
+
* @param options.digits - DTMF digit-collection config.
|
|
200
|
+
* @param options.speech - Speech-recognition config.
|
|
201
|
+
* @param options.initialTimeout - Seconds to wait for the first input.
|
|
202
|
+
* @param options.partialResults - Emit partial (interim) results.
|
|
203
|
+
* @param options.continuous - Keep collecting until explicitly stopped.
|
|
204
|
+
* @param options.sendStartOfInput - Emit a start-of-input event when detected.
|
|
205
|
+
* @param options.startInputTimers - Start input timers immediately.
|
|
206
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
207
|
+
* @param options.onCompleted - Callback fired when collect completes.
|
|
208
|
+
* @returns A {@link StandaloneCollectAction} for control and completion tracking.
|
|
209
|
+
* @throws {RelayError} When the collect command is rejected.
|
|
210
|
+
*/
|
|
211
|
+
collect(options?: {
|
|
212
|
+
digits?: Record<string, unknown>;
|
|
213
|
+
speech?: Record<string, unknown>;
|
|
214
|
+
initialTimeout?: number;
|
|
215
|
+
partialResults?: boolean;
|
|
216
|
+
continuous?: boolean;
|
|
217
|
+
sendStartOfInput?: boolean;
|
|
218
|
+
startInputTimers?: boolean;
|
|
219
|
+
controlId?: string;
|
|
220
|
+
onCompleted?: CompletedCallback;
|
|
221
|
+
}): Promise<StandaloneCollectAction>;
|
|
222
|
+
/**
|
|
223
|
+
* Bridge the call to one or more destinations.
|
|
224
|
+
*
|
|
225
|
+
* @param devices - Serial/parallel dial plan — outer array of serial groups,
|
|
226
|
+
* inner arrays dialled in parallel.
|
|
227
|
+
* @param options - Connect behaviour.
|
|
228
|
+
* @param options.ringback - Ringback media played to the originating party.
|
|
229
|
+
* @param options.tag - Tag for event correlation.
|
|
230
|
+
* @param options.maxDuration - Maximum connect duration in seconds.
|
|
231
|
+
* @param options.maxPricePerMinute - Price cap per minute.
|
|
232
|
+
* @param options.statusUrl - Webhook URL for status events.
|
|
233
|
+
* @returns The platform's connect response.
|
|
234
|
+
* @throws {RelayError} When the connect command is rejected.
|
|
235
|
+
*/
|
|
236
|
+
connect(devices: Record<string, unknown>[][], options?: {
|
|
237
|
+
ringback?: Record<string, unknown>[];
|
|
238
|
+
tag?: string;
|
|
239
|
+
maxDuration?: number;
|
|
240
|
+
maxPricePerMinute?: number;
|
|
241
|
+
statusUrl?: string;
|
|
242
|
+
}): Promise<Record<string, unknown>>;
|
|
243
|
+
/**
|
|
244
|
+
* Disconnect (unbridge) a connected call.
|
|
245
|
+
*
|
|
246
|
+
* @returns The platform's disconnect response.
|
|
247
|
+
* @throws {RelayError} When the disconnect command is rejected.
|
|
248
|
+
*/
|
|
249
|
+
disconnect(): Promise<Record<string, unknown>>;
|
|
250
|
+
/**
|
|
251
|
+
* Send DTMF digits on the call.
|
|
252
|
+
*
|
|
253
|
+
* @param digits - The DTMF digit string to send (e.g. `"1234#"`, `"ww*9"`).
|
|
254
|
+
* @param controlId - Explicit control ID. Auto-generated when omitted.
|
|
255
|
+
* @returns The platform's send-digits response.
|
|
256
|
+
* @throws {RelayError} When the send_digits command is rejected.
|
|
257
|
+
*/
|
|
258
|
+
sendDigits(digits: string, controlId?: string): Promise<Record<string, unknown>>;
|
|
259
|
+
/**
|
|
260
|
+
* Start audio detection (answering machine, fax, DTMF).
|
|
261
|
+
*
|
|
262
|
+
* @param detect - Platform-shaped detect configuration.
|
|
263
|
+
* @param options - Detection behaviour.
|
|
264
|
+
* @param options.timeout - Detection timeout in seconds.
|
|
265
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
266
|
+
* @param options.onCompleted - Callback fired when detection completes.
|
|
267
|
+
* @returns A {@link DetectAction} for control and completion tracking.
|
|
268
|
+
* @throws {RelayError} When the detect command is rejected.
|
|
269
|
+
*/
|
|
270
|
+
detect(detect: Record<string, unknown>, options?: {
|
|
271
|
+
timeout?: number;
|
|
272
|
+
controlId?: string;
|
|
273
|
+
onCompleted?: CompletedCallback;
|
|
274
|
+
}): Promise<DetectAction>;
|
|
275
|
+
/**
|
|
276
|
+
* Transfer a SIP call via REFER.
|
|
277
|
+
*
|
|
278
|
+
* @param device - Platform-shaped SIP target device descriptor.
|
|
279
|
+
* @param options - Optional REFER behaviour.
|
|
280
|
+
* @param options.statusUrl - Webhook URL for REFER status events.
|
|
281
|
+
* @returns The platform's refer response.
|
|
282
|
+
* @throws {RelayError} When the refer command is rejected.
|
|
283
|
+
*/
|
|
284
|
+
refer(device: Record<string, unknown>, options?: {
|
|
285
|
+
statusUrl?: string;
|
|
286
|
+
}): Promise<Record<string, unknown>>;
|
|
287
|
+
/**
|
|
288
|
+
* Start a PCI-compliant payment collection flow.
|
|
289
|
+
*
|
|
290
|
+
* @param paymentConnectorUrl - URL of the configured payment connector to
|
|
291
|
+
* tokenise the card with.
|
|
292
|
+
* @param options - Payment configuration — card-type filters, prompts,
|
|
293
|
+
* charge amount, etc. See the SignalWire pay documentation for field details.
|
|
294
|
+
* @returns A {@link PayAction} tracking the payment-collection flow.
|
|
295
|
+
* @throws {RelayError} When the pay command is rejected.
|
|
296
|
+
*/
|
|
297
|
+
pay(paymentConnectorUrl: string, options?: {
|
|
298
|
+
controlId?: string;
|
|
299
|
+
inputMethod?: string;
|
|
300
|
+
statusUrl?: string;
|
|
301
|
+
paymentMethod?: string;
|
|
302
|
+
timeout?: string;
|
|
303
|
+
maxAttempts?: string;
|
|
304
|
+
securityCode?: string;
|
|
305
|
+
postalCode?: string;
|
|
306
|
+
minPostalCodeLength?: string;
|
|
307
|
+
tokenType?: string;
|
|
308
|
+
chargeAmount?: string;
|
|
309
|
+
currency?: string;
|
|
310
|
+
language?: string;
|
|
311
|
+
voice?: string;
|
|
312
|
+
description?: string;
|
|
313
|
+
validCardTypes?: string;
|
|
314
|
+
parameters?: Record<string, unknown>[];
|
|
315
|
+
prompts?: Record<string, unknown>[];
|
|
316
|
+
onCompleted?: CompletedCallback;
|
|
317
|
+
}): Promise<PayAction>;
|
|
318
|
+
/**
|
|
319
|
+
* Send a fax document.
|
|
320
|
+
*
|
|
321
|
+
* @param document - URL of the document to fax (TIFF or PDF).
|
|
322
|
+
* @param options - Fax behaviour.
|
|
323
|
+
* @param options.identity - Caller identity string sent in the fax header.
|
|
324
|
+
* @param options.headerInfo - Additional fax header text.
|
|
325
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
326
|
+
* @param options.onCompleted - Callback fired when the fax completes.
|
|
327
|
+
* @returns A {@link FaxAction} for control and completion tracking.
|
|
328
|
+
* @throws {RelayError} When the send_fax command is rejected.
|
|
329
|
+
*/
|
|
330
|
+
sendFax(document: string, options?: {
|
|
331
|
+
identity?: string;
|
|
332
|
+
headerInfo?: string;
|
|
333
|
+
controlId?: string;
|
|
334
|
+
onCompleted?: CompletedCallback;
|
|
335
|
+
}): Promise<FaxAction>;
|
|
336
|
+
/**
|
|
337
|
+
* Receive a fax and save it server-side.
|
|
338
|
+
*
|
|
339
|
+
* @param options - Fax reception behaviour.
|
|
340
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
341
|
+
* @param options.onCompleted - Callback fired when the fax completes.
|
|
342
|
+
* @returns A {@link FaxAction} for control and completion tracking.
|
|
343
|
+
* @throws {RelayError} When the receive_fax command is rejected.
|
|
344
|
+
*/
|
|
345
|
+
receiveFax(options?: {
|
|
346
|
+
controlId?: string;
|
|
347
|
+
onCompleted?: CompletedCallback;
|
|
348
|
+
}): Promise<FaxAction>;
|
|
349
|
+
/**
|
|
350
|
+
* Intercept call media and stream it to an external destination.
|
|
351
|
+
*
|
|
352
|
+
* @param tap - Platform-shaped tap configuration (direction, codec, etc.).
|
|
353
|
+
* @param device - Destination device descriptor (WebSocket URL, etc.).
|
|
354
|
+
* @param options - Tap behaviour.
|
|
355
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
356
|
+
* @param options.onCompleted - Callback fired when the tap completes.
|
|
357
|
+
* @returns A {@link TapAction} for control and completion tracking.
|
|
358
|
+
* @throws {RelayError} When the tap command is rejected.
|
|
359
|
+
*/
|
|
360
|
+
tap(tap: Record<string, unknown>, device: Record<string, unknown>, options?: {
|
|
361
|
+
controlId?: string;
|
|
362
|
+
onCompleted?: CompletedCallback;
|
|
363
|
+
}): Promise<TapAction>;
|
|
364
|
+
/**
|
|
365
|
+
* Start streaming call audio to a WebSocket endpoint.
|
|
366
|
+
*
|
|
367
|
+
* @param url - WebSocket URL to stream audio to.
|
|
368
|
+
* @param options - Stream behaviour.
|
|
369
|
+
* @param options.name - Friendly name for the stream.
|
|
370
|
+
* @param options.codec - Audio codec (e.g. `"PCMU"`, `"PCMA"`).
|
|
371
|
+
* @param options.track - Which track to send: `"inbound"`, `"outbound"`, or
|
|
372
|
+
* `"both"`.
|
|
373
|
+
* @param options.statusUrl - Webhook URL for stream status events.
|
|
374
|
+
* @param options.statusUrlMethod - HTTP method for `statusUrl` requests.
|
|
375
|
+
* @param options.authorizationBearerToken - Bearer token sent to the stream endpoint.
|
|
376
|
+
* @param options.customParameters - Extra parameters forwarded to the stream endpoint.
|
|
377
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
378
|
+
* @param options.onCompleted - Callback fired when the stream completes.
|
|
379
|
+
* @returns A {@link StreamAction} for control and completion tracking.
|
|
380
|
+
* @throws {RelayError} When the stream command is rejected.
|
|
381
|
+
*/
|
|
382
|
+
stream(url: string, options?: {
|
|
383
|
+
name?: string;
|
|
384
|
+
codec?: string;
|
|
385
|
+
track?: string;
|
|
386
|
+
statusUrl?: string;
|
|
387
|
+
statusUrlMethod?: string;
|
|
388
|
+
authorizationBearerToken?: string;
|
|
389
|
+
customParameters?: Record<string, unknown>;
|
|
390
|
+
controlId?: string;
|
|
391
|
+
onCompleted?: CompletedCallback;
|
|
392
|
+
}): Promise<StreamAction>;
|
|
393
|
+
/**
|
|
394
|
+
* Transfer call control to another RELAY app or SWML script.
|
|
395
|
+
*
|
|
396
|
+
* @param dest - Destination identifier (RELAY context, SWML URL, etc.).
|
|
397
|
+
* @param extra - Optional additional params merged into the transfer request.
|
|
398
|
+
* @returns The platform's transfer response.
|
|
399
|
+
* @throws {RelayError} When the transfer command is rejected.
|
|
400
|
+
*/
|
|
401
|
+
transfer(dest: string, extra?: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
402
|
+
/**
|
|
403
|
+
* Join an ad-hoc audio conference.
|
|
404
|
+
*
|
|
405
|
+
* @param name - Conference name. Participants on the same name hear each other.
|
|
406
|
+
* @param options - Conference behaviour (muting, recording, status callbacks, etc.).
|
|
407
|
+
* @returns The platform's join-conference response.
|
|
408
|
+
* @throws {RelayError} When the join_conference command is rejected.
|
|
409
|
+
*/
|
|
410
|
+
joinConference(name: string, options?: {
|
|
411
|
+
muted?: boolean;
|
|
412
|
+
beep?: string;
|
|
413
|
+
startOnEnter?: boolean;
|
|
414
|
+
endOnExit?: boolean;
|
|
415
|
+
waitUrl?: string;
|
|
416
|
+
maxParticipants?: number;
|
|
417
|
+
record?: string;
|
|
418
|
+
region?: string;
|
|
419
|
+
trim?: string;
|
|
420
|
+
coach?: string;
|
|
421
|
+
statusCallback?: string;
|
|
422
|
+
statusCallbackEvent?: string;
|
|
423
|
+
statusCallbackEventType?: string;
|
|
424
|
+
statusCallbackMethod?: string;
|
|
425
|
+
recordingStatusCallback?: string;
|
|
426
|
+
recordingStatusCallbackEvent?: string;
|
|
427
|
+
recordingStatusCallbackEventType?: string;
|
|
428
|
+
recordingStatusCallbackMethod?: string;
|
|
429
|
+
stream?: Record<string, unknown>;
|
|
430
|
+
}): Promise<Record<string, unknown>>;
|
|
431
|
+
/**
|
|
432
|
+
* Leave an audio conference.
|
|
433
|
+
*
|
|
434
|
+
* @param conferenceId - Identifier of the conference to leave.
|
|
435
|
+
* @param extra - Optional additional params merged into the request.
|
|
436
|
+
* @returns The platform's leave-conference response.
|
|
437
|
+
* @throws {RelayError} When the leave_conference command is rejected.
|
|
438
|
+
*/
|
|
439
|
+
leaveConference(conferenceId: string, extra?: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
440
|
+
/**
|
|
441
|
+
* Put the call on hold.
|
|
442
|
+
*
|
|
443
|
+
* @returns The platform's hold response.
|
|
444
|
+
* @throws {RelayError} When the hold command is rejected.
|
|
445
|
+
*/
|
|
446
|
+
hold(): Promise<Record<string, unknown>>;
|
|
447
|
+
/**
|
|
448
|
+
* Release the call from hold.
|
|
449
|
+
*
|
|
450
|
+
* @returns The platform's unhold response.
|
|
451
|
+
* @throws {RelayError} When the unhold command is rejected.
|
|
452
|
+
*/
|
|
453
|
+
unhold(): Promise<Record<string, unknown>>;
|
|
454
|
+
/**
|
|
455
|
+
* Start noise reduction on the call.
|
|
456
|
+
*
|
|
457
|
+
* @returns The platform's denoise response.
|
|
458
|
+
* @throws {RelayError} When the denoise command is rejected.
|
|
459
|
+
*/
|
|
460
|
+
denoise(): Promise<Record<string, unknown>>;
|
|
461
|
+
/**
|
|
462
|
+
* Stop noise reduction on the call.
|
|
463
|
+
*
|
|
464
|
+
* @returns The platform's denoise-stop response.
|
|
465
|
+
* @throws {RelayError} When the denoise.stop command is rejected.
|
|
466
|
+
*/
|
|
467
|
+
denoiseStop(): Promise<Record<string, unknown>>;
|
|
468
|
+
/**
|
|
469
|
+
* Start transcribing the call.
|
|
470
|
+
*
|
|
471
|
+
* @param options - Transcription behaviour.
|
|
472
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
473
|
+
* @param options.statusUrl - Webhook URL for transcription status events.
|
|
474
|
+
* @param options.onCompleted - Callback fired when transcription completes.
|
|
475
|
+
* @returns A {@link TranscribeAction} for control and completion tracking.
|
|
476
|
+
* @throws {RelayError} When the transcribe command is rejected.
|
|
477
|
+
*/
|
|
478
|
+
transcribe(options?: {
|
|
479
|
+
controlId?: string;
|
|
480
|
+
statusUrl?: string;
|
|
481
|
+
onCompleted?: CompletedCallback;
|
|
482
|
+
}): Promise<TranscribeAction>;
|
|
483
|
+
/**
|
|
484
|
+
* Echo audio back to the caller (useful for testing network round-trip).
|
|
485
|
+
*
|
|
486
|
+
* @param options - Echo behaviour.
|
|
487
|
+
* @param options.timeout - How long to echo, in seconds.
|
|
488
|
+
* @param options.statusUrl - Webhook URL for echo status events.
|
|
489
|
+
* @returns The platform's echo response.
|
|
490
|
+
* @throws {RelayError} When the echo command is rejected.
|
|
491
|
+
*/
|
|
492
|
+
echo(options?: {
|
|
493
|
+
timeout?: number;
|
|
494
|
+
statusUrl?: string;
|
|
495
|
+
}): Promise<Record<string, unknown>>;
|
|
496
|
+
/**
|
|
497
|
+
* Bind a DTMF digit sequence to trigger a RELAY method automatically when
|
|
498
|
+
* the caller presses it.
|
|
499
|
+
*
|
|
500
|
+
* @param digits - DTMF sequence that triggers the binding (e.g. `"*9"`).
|
|
501
|
+
* @param bindMethod - RELAY method to invoke when the sequence is detected.
|
|
502
|
+
* @param options - Binding behaviour.
|
|
503
|
+
* @param options.bindParams - Params forwarded to `bindMethod` on trigger.
|
|
504
|
+
* @param options.realm - Optional realm label so bindings can be cleared in groups.
|
|
505
|
+
* @param options.maxTriggers - Maximum number of times the binding can fire.
|
|
506
|
+
* @returns The platform's bind_digit response.
|
|
507
|
+
* @throws {RelayError} When the bind_digit command is rejected.
|
|
508
|
+
*/
|
|
509
|
+
bindDigit(digits: string, bindMethod: string, options?: {
|
|
510
|
+
bindParams?: Record<string, unknown>;
|
|
511
|
+
realm?: string;
|
|
512
|
+
maxTriggers?: number;
|
|
513
|
+
}): Promise<Record<string, unknown>>;
|
|
514
|
+
/**
|
|
515
|
+
* Clear all digit bindings, optionally filtered by realm.
|
|
516
|
+
*
|
|
517
|
+
* @param realm - When provided, only bindings with this realm label are cleared.
|
|
518
|
+
* @returns The platform's clear_digit_bindings response.
|
|
519
|
+
* @throws {RelayError} When the clear_digit_bindings command is rejected.
|
|
520
|
+
*/
|
|
521
|
+
clearDigitBindings(realm?: string): Promise<Record<string, unknown>>;
|
|
522
|
+
/**
|
|
523
|
+
* Start or stop live transcription on the call.
|
|
524
|
+
*
|
|
525
|
+
* @param action - Platform-shaped action block (`start` or `stop` plus
|
|
526
|
+
* configuration).
|
|
527
|
+
* @param extra - Optional additional params merged into the request.
|
|
528
|
+
* @returns The platform's live_transcribe response.
|
|
529
|
+
* @throws {RelayError} When the live_transcribe command is rejected.
|
|
530
|
+
*/
|
|
531
|
+
liveTranscribe(action: Record<string, unknown>, extra?: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
532
|
+
/**
|
|
533
|
+
* Start or stop live translation on the call.
|
|
534
|
+
*
|
|
535
|
+
* @param action - Platform-shaped action block (`start` or `stop` plus
|
|
536
|
+
* source/target languages).
|
|
537
|
+
* @param options - Live-translate behaviour.
|
|
538
|
+
* @param options.statusUrl - Webhook URL for translation status events.
|
|
539
|
+
* @returns The platform's live_translate response.
|
|
540
|
+
* @throws {RelayError} When the live_translate command is rejected.
|
|
541
|
+
*/
|
|
542
|
+
liveTranslate(action: Record<string, unknown>, options?: {
|
|
543
|
+
statusUrl?: string;
|
|
544
|
+
}): Promise<Record<string, unknown>>;
|
|
545
|
+
/**
|
|
546
|
+
* Join a video / audio room.
|
|
547
|
+
*
|
|
548
|
+
* @param name - Room name — callers on the same name share the same room.
|
|
549
|
+
* @param options - Room behaviour.
|
|
550
|
+
* @param options.statusUrl - Webhook URL for room status events.
|
|
551
|
+
* @returns The platform's join_room response.
|
|
552
|
+
* @throws {RelayError} When the join_room command is rejected.
|
|
553
|
+
*/
|
|
554
|
+
joinRoom(name: string, options?: {
|
|
555
|
+
statusUrl?: string;
|
|
556
|
+
}): Promise<Record<string, unknown>>;
|
|
557
|
+
/**
|
|
558
|
+
* Leave the current room.
|
|
559
|
+
*
|
|
560
|
+
* @param extra - Optional additional params merged into the request.
|
|
561
|
+
* @returns The platform's leave_room response.
|
|
562
|
+
* @throws {RelayError} When the leave_room command is rejected.
|
|
563
|
+
*/
|
|
564
|
+
leaveRoom(extra?: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
565
|
+
/**
|
|
566
|
+
* Start an AI agent session on the call.
|
|
567
|
+
*
|
|
568
|
+
* @param options - AI configuration — prompts, voices, tools, languages, etc.
|
|
569
|
+
* @returns An {@link AIAction} for control and completion tracking.
|
|
570
|
+
* @throws {RelayError} When the ai command is rejected.
|
|
571
|
+
*/
|
|
572
|
+
ai(options?: {
|
|
573
|
+
controlId?: string;
|
|
574
|
+
agent?: string;
|
|
575
|
+
prompt?: Record<string, unknown>;
|
|
576
|
+
postPrompt?: Record<string, unknown>;
|
|
577
|
+
postPromptUrl?: string;
|
|
578
|
+
postPromptAuthUser?: string;
|
|
579
|
+
postPromptAuthPassword?: string;
|
|
580
|
+
globalData?: Record<string, unknown>;
|
|
581
|
+
pronounce?: Record<string, unknown>[];
|
|
582
|
+
hints?: string[];
|
|
583
|
+
languages?: Record<string, unknown>[];
|
|
584
|
+
SWAIG?: Record<string, unknown>;
|
|
585
|
+
aiParams?: Record<string, unknown>;
|
|
586
|
+
onCompleted?: CompletedCallback;
|
|
587
|
+
}): Promise<AIAction>;
|
|
588
|
+
/**
|
|
589
|
+
* Connect the call to an Amazon Bedrock AI agent.
|
|
590
|
+
*
|
|
591
|
+
* @param options - Bedrock agent configuration.
|
|
592
|
+
* @param options.prompt - Prompt to send to the Bedrock agent.
|
|
593
|
+
* @param options.SWAIG - SWAIG configuration (functions, includes, etc.).
|
|
594
|
+
* @param options.aiParams - AI engine parameters.
|
|
595
|
+
* @param options.globalData - Global-data object available to SWAIG tools.
|
|
596
|
+
* @param options.postPrompt - Post-prompt configuration.
|
|
597
|
+
* @param options.postPromptUrl - URL to POST the final summary to.
|
|
598
|
+
* @returns The platform's amazon_bedrock response.
|
|
599
|
+
* @throws {RelayError} When the amazon_bedrock command is rejected.
|
|
600
|
+
*/
|
|
601
|
+
amazonBedrock(options?: {
|
|
602
|
+
prompt?: unknown;
|
|
603
|
+
SWAIG?: Record<string, unknown>;
|
|
604
|
+
aiParams?: Record<string, unknown>;
|
|
605
|
+
globalData?: Record<string, unknown>;
|
|
606
|
+
postPrompt?: Record<string, unknown>;
|
|
607
|
+
postPromptUrl?: string;
|
|
608
|
+
}): Promise<Record<string, unknown>>;
|
|
609
|
+
/**
|
|
610
|
+
* Send a message into an active AI agent session.
|
|
611
|
+
*
|
|
612
|
+
* @param options - Message parameters.
|
|
613
|
+
* @param options.messageText - Text content to inject into the conversation.
|
|
614
|
+
* @param options.role - Speaker role (`"system"`, `"user"`, or `"assistant"`).
|
|
615
|
+
* @param options.reset - Reset directives for the conversation state.
|
|
616
|
+
* @param options.globalData - Global-data updates to merge.
|
|
617
|
+
* @returns The platform's ai_message response.
|
|
618
|
+
* @throws {RelayError} When the ai_message command is rejected.
|
|
619
|
+
*/
|
|
620
|
+
aiMessage(options?: {
|
|
621
|
+
messageText?: string;
|
|
622
|
+
role?: string;
|
|
623
|
+
reset?: Record<string, unknown>;
|
|
624
|
+
globalData?: Record<string, unknown>;
|
|
625
|
+
}): Promise<Record<string, unknown>>;
|
|
626
|
+
/**
|
|
627
|
+
* Put the AI agent session on hold (pause turn-taking).
|
|
628
|
+
*
|
|
629
|
+
* @param options - Hold behaviour.
|
|
630
|
+
* @param options.timeout - Maximum hold duration.
|
|
631
|
+
* @param options.prompt - Prompt played to the caller during the hold.
|
|
632
|
+
* @returns The platform's ai_hold response.
|
|
633
|
+
* @throws {RelayError} When the ai_hold command is rejected.
|
|
634
|
+
*/
|
|
635
|
+
aiHold(options?: {
|
|
636
|
+
timeout?: string;
|
|
637
|
+
prompt?: string;
|
|
638
|
+
}): Promise<Record<string, unknown>>;
|
|
639
|
+
/**
|
|
640
|
+
* Resume an AI agent session from hold.
|
|
641
|
+
*
|
|
642
|
+
* @param options - Unhold behaviour.
|
|
643
|
+
* @param options.prompt - Prompt played to the caller on resume.
|
|
644
|
+
* @returns The platform's ai_unhold response.
|
|
645
|
+
* @throws {RelayError} When the ai_unhold command is rejected.
|
|
646
|
+
*/
|
|
647
|
+
aiUnhold(options?: {
|
|
648
|
+
prompt?: string;
|
|
649
|
+
}): Promise<Record<string, unknown>>;
|
|
650
|
+
/**
|
|
651
|
+
* Emit a custom user-defined event on the call for your webhooks.
|
|
652
|
+
*
|
|
653
|
+
* @param options - Freeform event payload. Set `options.event` for the
|
|
654
|
+
* event name and include any additional fields your webhook expects.
|
|
655
|
+
* @returns The platform's user_event response.
|
|
656
|
+
* @throws {RelayError} When the user_event command is rejected.
|
|
657
|
+
*/
|
|
658
|
+
userEvent(options?: {
|
|
659
|
+
event?: string;
|
|
660
|
+
} & Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
661
|
+
/**
|
|
662
|
+
* Place the call into a named queue.
|
|
663
|
+
*
|
|
664
|
+
* @param queueName - Name of the queue to enter.
|
|
665
|
+
* @param options - Queue-entry behaviour.
|
|
666
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
667
|
+
* @param options.statusUrl - Webhook URL for queue status events.
|
|
668
|
+
* @returns The platform's queue.enter response.
|
|
669
|
+
* @throws {RelayError} When the queue.enter command is rejected.
|
|
670
|
+
*/
|
|
671
|
+
queueEnter(queueName: string, options?: {
|
|
672
|
+
controlId?: string;
|
|
673
|
+
statusUrl?: string;
|
|
674
|
+
}): Promise<Record<string, unknown>>;
|
|
675
|
+
/**
|
|
676
|
+
* Remove the call from a queue.
|
|
677
|
+
*
|
|
678
|
+
* @param queueName - Name of the queue to leave.
|
|
679
|
+
* @param options - Queue-exit behaviour.
|
|
680
|
+
* @param options.controlId - Explicit control ID. Auto-generated when omitted.
|
|
681
|
+
* @param options.queueId - Queue ID override (when multiple queues share a name).
|
|
682
|
+
* @param options.statusUrl - Webhook URL for queue status events.
|
|
683
|
+
* @returns The platform's queue.leave response.
|
|
684
|
+
* @throws {RelayError} When the queue.leave command is rejected.
|
|
685
|
+
*/
|
|
686
|
+
queueLeave(queueName: string, options?: {
|
|
687
|
+
controlId?: string;
|
|
688
|
+
queueId?: string;
|
|
689
|
+
statusUrl?: string;
|
|
690
|
+
}): Promise<Record<string, unknown>>;
|
|
691
|
+
/**
|
|
692
|
+
* Return a human-readable diagnostic string.
|
|
693
|
+
*
|
|
694
|
+
* @returns `<Call id=... state=... direction=...>` — handy for log output.
|
|
695
|
+
*/
|
|
696
|
+
toString(): string;
|
|
697
|
+
}
|