@signalwire/sdk 2.0.4 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
package/dist/relay/Call.d.ts
CHANGED
|
@@ -7,7 +7,10 @@
|
|
|
7
7
|
import { Action, PlayAction, RecordAction, DetectAction, CollectAction, StandaloneCollectAction, FaxAction, TapAction, StreamAction, PayAction, TranscribeAction, AIAction } from './Action.js';
|
|
8
8
|
import { type Deferred } from './Deferred.js';
|
|
9
9
|
import { RelayEvent } from './RelayEvent.js';
|
|
10
|
-
import type { CompletedCallback, EventHandler } from './types.js';
|
|
10
|
+
import type { CollectConfig, CompletedCallback, Device, DeviceInput, EventHandler, PlayItem } from './types.js';
|
|
11
|
+
import type { CallingAiHoldResult, CallingAiMessageResult, CallingAiUnholdResult, CallingAmazonBedrockResult, CallingAnswerResult, CallingBindDigitResult, CallingClearDigitBindingsResult, CallingConnectParams, CallingConnectResult, CallingDenoiseResult, CallingDenoiseStopResult, CallingDisconnectResult, CallingEchoResult, CallingEndResult, CallingJoinConferenceResult, CallingJoinRoomResult, CallingLeaveConferenceResult, CallingLeaveRoomResult, CallingLiveTranscribeResult, CallingLiveTranslateResult, CallingPassResult, CallingQueueEnterResult, CallingQueueLeaveResult, CallingReferResult, CallingSendDigitsResult, CallingTransferResult, CallingUserEventResult } from './protocol.types.generated.js';
|
|
12
|
+
import type { CallCollectRequest, CallDetectRequest, CallRecordRequest, CallTapRequest } from '../rest/namespaces/calling.types.generated.js';
|
|
13
|
+
import type { TtsGender, FaxTone, CallState } from './closedSets.js';
|
|
11
14
|
/** Interface the Call needs from RelayClient (avoids circular import). */
|
|
12
15
|
export interface RelayClientLike {
|
|
13
16
|
execute(method: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
@@ -24,9 +27,11 @@ export interface RelayClientLike {
|
|
|
24
27
|
*
|
|
25
28
|
* @example Inside an onCall handler
|
|
26
29
|
* ```ts
|
|
30
|
+
* import { RelayClient } from '@signalwire/sdk';
|
|
31
|
+
* const client = new RelayClient();
|
|
27
32
|
* client.onCall(async (call) => {
|
|
28
33
|
* await call.answer();
|
|
29
|
-
* const play = await call.
|
|
34
|
+
* const play = await call.play([{ type: 'tts', params: { text: 'Hello!' } }]);
|
|
30
35
|
* await play.wait();
|
|
31
36
|
* await call.hangup();
|
|
32
37
|
* });
|
|
@@ -50,9 +55,15 @@ export declare class Call {
|
|
|
50
55
|
/** `"inbound"` or `"outbound"`. */
|
|
51
56
|
direction: string;
|
|
52
57
|
/** Device descriptor the call is associated with (phone, SIP, etc.). */
|
|
53
|
-
device:
|
|
54
|
-
/**
|
|
55
|
-
|
|
58
|
+
device: Device;
|
|
59
|
+
/**
|
|
60
|
+
* Current call state. One of the {@link CallState} values
|
|
61
|
+
* (`"created"` | `"ringing"` | `"answered"` | `"ending"` | `"ended"`; closed
|
|
62
|
+
* literal union, autocompleted + typo-checked). A raw wire value is cast to
|
|
63
|
+
* the closed type at the hydration boundary. Use {@link Call.isTerminal} to
|
|
64
|
+
* test for the terminal (`ended`) state rather than comparing strings by hand.
|
|
65
|
+
*/
|
|
66
|
+
state: CallState;
|
|
56
67
|
/** Call segment ID used for event correlation. */
|
|
57
68
|
segmentId: string;
|
|
58
69
|
/** @internal */ readonly _listeners: Map<string, EventHandler[]>;
|
|
@@ -61,12 +72,28 @@ export declare class Call {
|
|
|
61
72
|
constructor(client: RelayClientLike, callId: string, nodeId: string, projectId: string, context: string, options?: {
|
|
62
73
|
tag?: string;
|
|
63
74
|
direction?: string;
|
|
64
|
-
device?:
|
|
65
|
-
state?:
|
|
75
|
+
device?: Device;
|
|
76
|
+
state?: CallState;
|
|
66
77
|
segmentId?: string;
|
|
67
78
|
});
|
|
68
|
-
/**
|
|
69
|
-
|
|
79
|
+
/**
|
|
80
|
+
* Whether this call has reached its terminal lifecycle state (`ended`) and
|
|
81
|
+
* will emit no further `calling.call.state` transitions.
|
|
82
|
+
*
|
|
83
|
+
* Idiomatic shortcut for `isCallStateTerminal(call.state)` — prefer it over
|
|
84
|
+
* a hand-written `call.state === 'ended'` comparison so the terminal-set
|
|
85
|
+
* definition lives in one place ({@link ../relay/closedSets.CallState}).
|
|
86
|
+
*/
|
|
87
|
+
get isTerminal(): boolean;
|
|
88
|
+
/**
|
|
89
|
+
* @internal Send a calling.<method> JSON-RPC request for this call.
|
|
90
|
+
*
|
|
91
|
+
* The result phase shape is the JSON-RPC ack for that method — pass the
|
|
92
|
+
* generated `Calling<Method>Result` as `R` so callers get the typed ack
|
|
93
|
+
* (`code`/`call_id`/`control_id`/`data`/…). Defaults to the open wire object
|
|
94
|
+
* for the few methods with no modeled result.
|
|
95
|
+
*/
|
|
96
|
+
_execute<R extends object = Record<string, unknown>>(method: string, extraParams?: Record<string, unknown>): Promise<R>;
|
|
70
97
|
/**
|
|
71
98
|
* Register an event listener for this call.
|
|
72
99
|
*
|
|
@@ -102,6 +129,52 @@ export declare class Call {
|
|
|
102
129
|
* @throws {Error} When the optional timeout elapses before the call ends.
|
|
103
130
|
*/
|
|
104
131
|
waitForEnded(timeout?: number): Promise<RelayEvent>;
|
|
132
|
+
/**
|
|
133
|
+
* Wait until the call reaches `target`, short-circuiting when it is already
|
|
134
|
+
* at or past it. The call lifecycle is ordered
|
|
135
|
+
* `created < ringing < answered < ending < ended`; if the current state's
|
|
136
|
+
* rank is `>=` the target's, this resolves immediately with a synthesized
|
|
137
|
+
* `calling.call.state` event (matching the legacy SDK / Python's
|
|
138
|
+
* `_wait_for_state`). Otherwise it blocks on the next matching state event.
|
|
139
|
+
*
|
|
140
|
+
* @internal
|
|
141
|
+
*/
|
|
142
|
+
private _waitForState;
|
|
143
|
+
/**
|
|
144
|
+
* Wait until the call is answered.
|
|
145
|
+
*
|
|
146
|
+
* Returns immediately if the call is already answered (or past it, e.g.
|
|
147
|
+
* ending/ended). Typed wait over {@link waitFor}, mirroring Python's
|
|
148
|
+
* `call.wait_for_answered(timeout)`.
|
|
149
|
+
*
|
|
150
|
+
* @param timeout - Optional timeout in milliseconds. Omit to wait forever.
|
|
151
|
+
* @returns The `calling.call.state` {@link RelayEvent} (synthesized on short-circuit).
|
|
152
|
+
* @throws {Error} When the optional timeout elapses before the call is answered.
|
|
153
|
+
*/
|
|
154
|
+
waitForAnswered(timeout?: number): Promise<RelayEvent>;
|
|
155
|
+
/**
|
|
156
|
+
* Wait until the call is ringing.
|
|
157
|
+
*
|
|
158
|
+
* Returns immediately if the call is already ringing (or past it, e.g.
|
|
159
|
+
* answered/ending/ended). Typed wait over {@link waitFor}, mirroring
|
|
160
|
+
* Python's `call.wait_for_ringing(timeout)`.
|
|
161
|
+
*
|
|
162
|
+
* @param timeout - Optional timeout in milliseconds. Omit to wait forever.
|
|
163
|
+
* @returns The `calling.call.state` {@link RelayEvent} (synthesized on short-circuit).
|
|
164
|
+
* @throws {Error} When the optional timeout elapses before the call is ringing.
|
|
165
|
+
*/
|
|
166
|
+
waitForRinging(timeout?: number): Promise<RelayEvent>;
|
|
167
|
+
/**
|
|
168
|
+
* Wait until the call is ending.
|
|
169
|
+
*
|
|
170
|
+
* Returns immediately if the call is already ending (or ended). Typed wait
|
|
171
|
+
* over {@link waitFor}, mirroring Python's `call.wait_for_ending(timeout)`.
|
|
172
|
+
*
|
|
173
|
+
* @param timeout - Optional timeout in milliseconds. Omit to wait forever.
|
|
174
|
+
* @returns The `calling.call.state` {@link RelayEvent} (synthesized on short-circuit).
|
|
175
|
+
* @throws {Error} When the optional timeout elapses before the call is ending.
|
|
176
|
+
*/
|
|
177
|
+
waitForEnding(timeout?: number): Promise<RelayEvent>;
|
|
105
178
|
/** @internal Register an action, execute the RPC, clean up on failure. */
|
|
106
179
|
_startAction<T extends Action>(action: T, method: string, params: Record<string, unknown>, onCompleted?: CompletedCallback | null): Promise<T>;
|
|
107
180
|
/**
|
|
@@ -112,7 +185,7 @@ export declare class Call {
|
|
|
112
185
|
* @returns The platform's answer response.
|
|
113
186
|
* @throws {RelayError} When the answer command is rejected.
|
|
114
187
|
*/
|
|
115
|
-
answer(extra?: Record<string, unknown>): Promise<
|
|
188
|
+
answer(extra?: Record<string, unknown>): Promise<CallingAnswerResult>;
|
|
116
189
|
/**
|
|
117
190
|
* End / hang up the call.
|
|
118
191
|
*
|
|
@@ -121,7 +194,7 @@ export declare class Call {
|
|
|
121
194
|
* @returns The platform's end response.
|
|
122
195
|
* @throws {RelayError} When the end command is rejected.
|
|
123
196
|
*/
|
|
124
|
-
hangup(reason?: string): Promise<
|
|
197
|
+
hangup(reason?: string): Promise<CallingEndResult>;
|
|
125
198
|
/**
|
|
126
199
|
* Decline control of an inbound call, returning it to routing.
|
|
127
200
|
*
|
|
@@ -131,7 +204,7 @@ export declare class Call {
|
|
|
131
204
|
* @returns The platform's pass response.
|
|
132
205
|
* @throws {RelayError} When the pass command is rejected.
|
|
133
206
|
*/
|
|
134
|
-
pass(): Promise<
|
|
207
|
+
pass(): Promise<CallingPassResult>;
|
|
135
208
|
/**
|
|
136
209
|
* Play audio content on the call.
|
|
137
210
|
*
|
|
@@ -150,13 +223,88 @@ export declare class Call {
|
|
|
150
223
|
* @returns A {@link PlayAction} for control and completion tracking.
|
|
151
224
|
* @throws {RelayError} When the play command is rejected.
|
|
152
225
|
*/
|
|
153
|
-
play(media:
|
|
226
|
+
play(media: PlayItem[], options?: {
|
|
154
227
|
volume?: number;
|
|
155
228
|
direction?: string;
|
|
156
229
|
loop?: number;
|
|
157
230
|
controlId?: string;
|
|
158
231
|
onCompleted?: CompletedCallback;
|
|
159
232
|
}): Promise<PlayAction>;
|
|
233
|
+
/**
|
|
234
|
+
* Play text-to-speech. Typed convenience over {@link play}.
|
|
235
|
+
*
|
|
236
|
+
* Builds the `{ type: 'tts', params: { text, language?, gender?, voice? } }`
|
|
237
|
+
* media entry so callers don't hand-assemble it. Mirrors Python's
|
|
238
|
+
* `call.play_tts(text, *, language, gender, voice, volume)`.
|
|
239
|
+
*
|
|
240
|
+
* @param text - Text to speak.
|
|
241
|
+
* @param options - TTS options.
|
|
242
|
+
* @param options.language - BCP-47 language tag (e.g. `"en-US"`).
|
|
243
|
+
* @param options.gender - Voice gender (`"male"` / `"female"`).
|
|
244
|
+
* @param options.voice - Explicit voice identifier (overrides language/gender).
|
|
245
|
+
* @param options.volume - Top-level playback volume in dB.
|
|
246
|
+
* @param options.onCompleted - Callback fired when playback reaches a terminal state.
|
|
247
|
+
* @returns A {@link PlayAction} for control and completion tracking.
|
|
248
|
+
* @throws {RelayError} When the play command is rejected.
|
|
249
|
+
*/
|
|
250
|
+
playTTS(text: string, options?: {
|
|
251
|
+
language?: string;
|
|
252
|
+
gender?: TtsGender;
|
|
253
|
+
voice?: string;
|
|
254
|
+
volume?: number;
|
|
255
|
+
onCompleted?: CompletedCallback;
|
|
256
|
+
}): Promise<PlayAction>;
|
|
257
|
+
/**
|
|
258
|
+
* Play an audio file from a URL. Typed convenience over {@link play}.
|
|
259
|
+
*
|
|
260
|
+
* Builds the `{ type: 'audio', params: { url } }` media entry. Mirrors
|
|
261
|
+
* Python's `call.play_audio(url, *, volume)`.
|
|
262
|
+
*
|
|
263
|
+
* @param url - URL of the audio file to play.
|
|
264
|
+
* @param options - Audio options.
|
|
265
|
+
* @param options.volume - Top-level playback volume in dB.
|
|
266
|
+
* @param options.onCompleted - Callback fired when playback reaches a terminal state.
|
|
267
|
+
* @returns A {@link PlayAction} for control and completion tracking.
|
|
268
|
+
* @throws {RelayError} When the play command is rejected.
|
|
269
|
+
*/
|
|
270
|
+
playAudio(url: string, options?: {
|
|
271
|
+
volume?: number;
|
|
272
|
+
onCompleted?: CompletedCallback;
|
|
273
|
+
}): Promise<PlayAction>;
|
|
274
|
+
/**
|
|
275
|
+
* Play silence for `duration` seconds. Typed convenience over {@link play}.
|
|
276
|
+
*
|
|
277
|
+
* Builds the `{ type: 'silence', params: { duration } }` media entry.
|
|
278
|
+
* Mirrors Python's `call.play_silence(duration)`.
|
|
279
|
+
*
|
|
280
|
+
* @param duration - Length of silence in seconds.
|
|
281
|
+
* @param options - Playback options.
|
|
282
|
+
* @param options.onCompleted - Callback fired when playback reaches a terminal state.
|
|
283
|
+
* @returns A {@link PlayAction} for control and completion tracking.
|
|
284
|
+
* @throws {RelayError} When the play command is rejected.
|
|
285
|
+
*/
|
|
286
|
+
playSilence(duration: number, options?: {
|
|
287
|
+
onCompleted?: CompletedCallback;
|
|
288
|
+
}): Promise<PlayAction>;
|
|
289
|
+
/**
|
|
290
|
+
* Play a named ringtone by country code. Typed convenience over {@link play}.
|
|
291
|
+
*
|
|
292
|
+
* Builds the `{ type: 'ringtone', params: { name, duration? } }` media entry.
|
|
293
|
+
* Mirrors Python's `call.play_ringtone(name, *, duration, volume)`.
|
|
294
|
+
*
|
|
295
|
+
* @param name - Ringtone name / country code (e.g. `"us"`, `"gb"`).
|
|
296
|
+
* @param options - Ringtone options.
|
|
297
|
+
* @param options.duration - How long to play the ringtone, in seconds (nested in media params).
|
|
298
|
+
* @param options.volume - Top-level playback volume in dB.
|
|
299
|
+
* @param options.onCompleted - Callback fired when playback reaches a terminal state.
|
|
300
|
+
* @returns A {@link PlayAction} for control and completion tracking.
|
|
301
|
+
* @throws {RelayError} When the play command is rejected.
|
|
302
|
+
*/
|
|
303
|
+
playRingtone(name: string, options?: {
|
|
304
|
+
duration?: number;
|
|
305
|
+
volume?: number;
|
|
306
|
+
onCompleted?: CompletedCallback;
|
|
307
|
+
}): Promise<PlayAction>;
|
|
160
308
|
/**
|
|
161
309
|
* Record audio from the call.
|
|
162
310
|
*
|
|
@@ -169,7 +317,7 @@ export declare class Call {
|
|
|
169
317
|
* @returns A {@link RecordAction} for control and completion tracking.
|
|
170
318
|
* @throws {RelayError} When the record command is rejected.
|
|
171
319
|
*/
|
|
172
|
-
record(audio?:
|
|
320
|
+
record(audio?: CallRecordRequest['params']['audio'], options?: {
|
|
173
321
|
controlId?: string;
|
|
174
322
|
onCompleted?: CompletedCallback;
|
|
175
323
|
}): Promise<RecordAction>;
|
|
@@ -187,11 +335,55 @@ export declare class Call {
|
|
|
187
335
|
* @returns A {@link CollectAction} for the combined play-and-collect flow.
|
|
188
336
|
* @throws {RelayError} When the play_and_collect command is rejected.
|
|
189
337
|
*/
|
|
190
|
-
playAndCollect(media:
|
|
338
|
+
playAndCollect(media: PlayItem[], collect: CollectConfig, options?: {
|
|
191
339
|
volume?: number;
|
|
192
340
|
controlId?: string;
|
|
193
341
|
onCompleted?: CompletedCallback;
|
|
194
342
|
}): Promise<CollectAction>;
|
|
343
|
+
/**
|
|
344
|
+
* Play TTS then collect input. Typed media over {@link playAndCollect}.
|
|
345
|
+
*
|
|
346
|
+
* Builds the `{ type: 'tts', params: { text, language?, gender?, voice? } }`
|
|
347
|
+
* play media and forwards the caller's `collect` config. Mirrors Python's
|
|
348
|
+
* `call.prompt_tts(text, collect, *, language, gender, voice, volume)`.
|
|
349
|
+
*
|
|
350
|
+
* @param text - Text to speak before collecting.
|
|
351
|
+
* @param collect - Platform-shaped collect config (`digits`, `speech`, etc.).
|
|
352
|
+
* @param options - Prompt options.
|
|
353
|
+
* @param options.language - BCP-47 language tag (e.g. `"en-US"`).
|
|
354
|
+
* @param options.gender - Voice gender (`"male"` / `"female"`).
|
|
355
|
+
* @param options.voice - Explicit voice identifier (overrides language/gender).
|
|
356
|
+
* @param options.volume - Top-level playback volume in dB.
|
|
357
|
+
* @param options.onCompleted - Callback fired when collect completes.
|
|
358
|
+
* @returns A {@link CollectAction} for the combined play-and-collect flow.
|
|
359
|
+
* @throws {RelayError} When the play_and_collect command is rejected.
|
|
360
|
+
*/
|
|
361
|
+
promptTTS(text: string, collect: CollectConfig, options?: {
|
|
362
|
+
language?: string;
|
|
363
|
+
gender?: TtsGender;
|
|
364
|
+
voice?: string;
|
|
365
|
+
volume?: number;
|
|
366
|
+
onCompleted?: CompletedCallback;
|
|
367
|
+
}): Promise<CollectAction>;
|
|
368
|
+
/**
|
|
369
|
+
* Play an audio file then collect input. Typed media over {@link playAndCollect}.
|
|
370
|
+
*
|
|
371
|
+
* Builds the `{ type: 'audio', params: { url } }` play media and forwards
|
|
372
|
+
* the caller's `collect` config. Mirrors Python's
|
|
373
|
+
* `call.prompt_audio(url, collect, *, volume)`.
|
|
374
|
+
*
|
|
375
|
+
* @param url - URL of the audio file to play before collecting.
|
|
376
|
+
* @param collect - Platform-shaped collect config (`digits`, `speech`, etc.).
|
|
377
|
+
* @param options - Prompt options.
|
|
378
|
+
* @param options.volume - Top-level playback volume in dB.
|
|
379
|
+
* @param options.onCompleted - Callback fired when collect completes.
|
|
380
|
+
* @returns A {@link CollectAction} for the combined play-and-collect flow.
|
|
381
|
+
* @throws {RelayError} When the play_and_collect command is rejected.
|
|
382
|
+
*/
|
|
383
|
+
promptAudio(url: string, collect: CollectConfig, options?: {
|
|
384
|
+
volume?: number;
|
|
385
|
+
onCompleted?: CompletedCallback;
|
|
386
|
+
}): Promise<CollectAction>;
|
|
195
387
|
/**
|
|
196
388
|
* Collect digit / speech input without playing media.
|
|
197
389
|
*
|
|
@@ -209,8 +401,8 @@ export declare class Call {
|
|
|
209
401
|
* @throws {RelayError} When the collect command is rejected.
|
|
210
402
|
*/
|
|
211
403
|
collect(options?: {
|
|
212
|
-
digits?:
|
|
213
|
-
speech?:
|
|
404
|
+
digits?: CallCollectRequest['params']['digits'];
|
|
405
|
+
speech?: CallCollectRequest['params']['speech'];
|
|
214
406
|
initialTimeout?: number;
|
|
215
407
|
partialResults?: boolean;
|
|
216
408
|
continuous?: boolean;
|
|
@@ -222,6 +414,11 @@ export declare class Call {
|
|
|
222
414
|
/**
|
|
223
415
|
* Bridge the call to one or more destinations.
|
|
224
416
|
*
|
|
417
|
+
* Each device is a {@link PhoneDevice}, {@link SipDevice}, or
|
|
418
|
+
* {@link FabricDevice} (dial a Fabric address directly — the platform resolves
|
|
419
|
+
* the address to whatever it points to: a Subscriber, a Relay/LaML app, a video
|
|
420
|
+
* room, …).
|
|
421
|
+
*
|
|
225
422
|
* @param devices - Serial/parallel dial plan — outer array of serial groups,
|
|
226
423
|
* inner arrays dialled in parallel.
|
|
227
424
|
* @param options - Connect behaviour.
|
|
@@ -233,20 +430,20 @@ export declare class Call {
|
|
|
233
430
|
* @returns The platform's connect response.
|
|
234
431
|
* @throws {RelayError} When the connect command is rejected.
|
|
235
432
|
*/
|
|
236
|
-
connect(devices:
|
|
237
|
-
ringback?:
|
|
433
|
+
connect(devices: DeviceInput[][], options?: {
|
|
434
|
+
ringback?: CallingConnectParams['ringback'];
|
|
238
435
|
tag?: string;
|
|
239
436
|
maxDuration?: number;
|
|
240
437
|
maxPricePerMinute?: number;
|
|
241
438
|
statusUrl?: string;
|
|
242
|
-
}): Promise<
|
|
439
|
+
}): Promise<CallingConnectResult>;
|
|
243
440
|
/**
|
|
244
441
|
* Disconnect (unbridge) a connected call.
|
|
245
442
|
*
|
|
246
443
|
* @returns The platform's disconnect response.
|
|
247
444
|
* @throws {RelayError} When the disconnect command is rejected.
|
|
248
445
|
*/
|
|
249
|
-
disconnect(): Promise<
|
|
446
|
+
disconnect(): Promise<CallingDisconnectResult>;
|
|
250
447
|
/**
|
|
251
448
|
* Send DTMF digits on the call.
|
|
252
449
|
*
|
|
@@ -255,7 +452,7 @@ export declare class Call {
|
|
|
255
452
|
* @returns The platform's send-digits response.
|
|
256
453
|
* @throws {RelayError} When the send_digits command is rejected.
|
|
257
454
|
*/
|
|
258
|
-
sendDigits(digits: string, controlId?: string): Promise<
|
|
455
|
+
sendDigits(digits: string, controlId?: string): Promise<CallingSendDigitsResult>;
|
|
259
456
|
/**
|
|
260
457
|
* Start audio detection (answering machine, fax, DTMF).
|
|
261
458
|
*
|
|
@@ -267,11 +464,79 @@ export declare class Call {
|
|
|
267
464
|
* @returns A {@link DetectAction} for control and completion tracking.
|
|
268
465
|
* @throws {RelayError} When the detect command is rejected.
|
|
269
466
|
*/
|
|
270
|
-
detect(detect:
|
|
467
|
+
detect(detect: CallDetectRequest['params']['detect'], options?: {
|
|
271
468
|
timeout?: number;
|
|
272
469
|
controlId?: string;
|
|
273
470
|
onCompleted?: CompletedCallback;
|
|
274
471
|
}): Promise<DetectAction>;
|
|
472
|
+
/**
|
|
473
|
+
* Detect DTMF digits. Typed convenience over {@link detect}.
|
|
474
|
+
*
|
|
475
|
+
* Builds the `{ type: 'digit', params: { digits? } }` detect object.
|
|
476
|
+
* Mirrors Python's `call.detect_digit(*, digits, timeout)`.
|
|
477
|
+
*
|
|
478
|
+
* @param options - Digit-detection options.
|
|
479
|
+
* @param options.digits - Restrict detection to this DTMF digit set (nested in detect params).
|
|
480
|
+
* @param options.timeout - Top-level detection timeout in seconds.
|
|
481
|
+
* @param options.onCompleted - Callback fired when detection completes.
|
|
482
|
+
* @returns A {@link DetectAction} for control and completion tracking.
|
|
483
|
+
* @throws {RelayError} When the detect command is rejected.
|
|
484
|
+
*/
|
|
485
|
+
detectDigit(options?: {
|
|
486
|
+
digits?: string;
|
|
487
|
+
timeout?: number;
|
|
488
|
+
onCompleted?: CompletedCallback;
|
|
489
|
+
}): Promise<DetectAction>;
|
|
490
|
+
/**
|
|
491
|
+
* Detect human vs answering machine (AMD). Typed convenience over {@link detect}.
|
|
492
|
+
*
|
|
493
|
+
* Builds the `{ type: 'machine', params: { ...only-provided... } }` detect
|
|
494
|
+
* object — only the options the caller supplies are emitted, matching
|
|
495
|
+
* Python's behaviour. Mirrors Python's `call.detect_answering_machine(*,
|
|
496
|
+
* initial_timeout, end_silence_timeout, machine_voice_threshold,
|
|
497
|
+
* machine_words_threshold, detect_interruptions, detect_message_end,
|
|
498
|
+
* timeout)`.
|
|
499
|
+
*
|
|
500
|
+
* @param options - AMD options.
|
|
501
|
+
* @param options.initialTimeout - Seconds to wait for initial voice.
|
|
502
|
+
* @param options.endSilenceTimeout - Trailing-silence cutoff in seconds.
|
|
503
|
+
* @param options.machineVoiceThreshold - Voice-duration threshold for a machine verdict.
|
|
504
|
+
* @param options.machineWordsThreshold - Word-count threshold for a machine verdict.
|
|
505
|
+
* @param options.detectInterruptions - Emit interruption events during detection.
|
|
506
|
+
* @param options.detectMessageEnd - Detect the end of a machine's greeting/message.
|
|
507
|
+
* @param options.timeout - Top-level detection timeout in seconds.
|
|
508
|
+
* @param options.onCompleted - Callback fired when detection completes.
|
|
509
|
+
* @returns A {@link DetectAction} for control and completion tracking.
|
|
510
|
+
* @throws {RelayError} When the detect command is rejected.
|
|
511
|
+
*/
|
|
512
|
+
detectAnsweringMachine(options?: {
|
|
513
|
+
initialTimeout?: number;
|
|
514
|
+
endSilenceTimeout?: number;
|
|
515
|
+
machineVoiceThreshold?: number;
|
|
516
|
+
machineWordsThreshold?: number;
|
|
517
|
+
detectInterruptions?: boolean;
|
|
518
|
+
detectMessageEnd?: boolean;
|
|
519
|
+
timeout?: number;
|
|
520
|
+
onCompleted?: CompletedCallback;
|
|
521
|
+
}): Promise<DetectAction>;
|
|
522
|
+
/**
|
|
523
|
+
* Detect a fax tone (CED/CNG). Typed convenience over {@link detect}.
|
|
524
|
+
*
|
|
525
|
+
* Builds the `{ type: 'fax', params: { tone? } }` detect object. Mirrors
|
|
526
|
+
* Python's `call.detect_fax(*, tone, timeout)`.
|
|
527
|
+
*
|
|
528
|
+
* @param options - Fax-detection options.
|
|
529
|
+
* @param options.tone - Restrict detection to a specific tone (`"CED"` / `"CNG"`), nested in detect params.
|
|
530
|
+
* @param options.timeout - Top-level detection timeout in seconds.
|
|
531
|
+
* @param options.onCompleted - Callback fired when detection completes.
|
|
532
|
+
* @returns A {@link DetectAction} for control and completion tracking.
|
|
533
|
+
* @throws {RelayError} When the detect command is rejected.
|
|
534
|
+
*/
|
|
535
|
+
detectFax(options?: {
|
|
536
|
+
tone?: FaxTone;
|
|
537
|
+
timeout?: number;
|
|
538
|
+
onCompleted?: CompletedCallback;
|
|
539
|
+
}): Promise<DetectAction>;
|
|
275
540
|
/**
|
|
276
541
|
* Transfer a SIP call via REFER.
|
|
277
542
|
*
|
|
@@ -281,9 +546,9 @@ export declare class Call {
|
|
|
281
546
|
* @returns The platform's refer response.
|
|
282
547
|
* @throws {RelayError} When the refer command is rejected.
|
|
283
548
|
*/
|
|
284
|
-
refer(device:
|
|
549
|
+
refer(device: DeviceInput, options?: {
|
|
285
550
|
statusUrl?: string;
|
|
286
|
-
}): Promise<
|
|
551
|
+
}): Promise<CallingReferResult>;
|
|
287
552
|
/**
|
|
288
553
|
* Start a PCI-compliant payment collection flow.
|
|
289
554
|
*
|
|
@@ -357,7 +622,7 @@ export declare class Call {
|
|
|
357
622
|
* @returns A {@link TapAction} for control and completion tracking.
|
|
358
623
|
* @throws {RelayError} When the tap command is rejected.
|
|
359
624
|
*/
|
|
360
|
-
tap(tap:
|
|
625
|
+
tap(tap: CallTapRequest['params']['tap'], device: DeviceInput, options?: {
|
|
361
626
|
controlId?: string;
|
|
362
627
|
onCompleted?: CompletedCallback;
|
|
363
628
|
}): Promise<TapAction>;
|
|
@@ -368,8 +633,8 @@ export declare class Call {
|
|
|
368
633
|
* @param options - Stream behaviour.
|
|
369
634
|
* @param options.name - Friendly name for the stream.
|
|
370
635
|
* @param options.codec - Audio codec (e.g. `"PCMU"`, `"PCMA"`).
|
|
371
|
-
* @param options.track - Which
|
|
372
|
-
* `"
|
|
636
|
+
* @param options.track - Which audio to stream: `"inbound_track"`,
|
|
637
|
+
* `"outbound_track"` or `"both_tracks"`. Sent as given.
|
|
373
638
|
* @param options.statusUrl - Webhook URL for stream status events.
|
|
374
639
|
* @param options.statusUrlMethod - HTTP method for `statusUrl` requests.
|
|
375
640
|
* @param options.authorizationBearerToken - Bearer token sent to the stream endpoint.
|
|
@@ -398,7 +663,7 @@ export declare class Call {
|
|
|
398
663
|
* @returns The platform's transfer response.
|
|
399
664
|
* @throws {RelayError} When the transfer command is rejected.
|
|
400
665
|
*/
|
|
401
|
-
transfer(dest: string, extra?: Record<string, unknown>): Promise<
|
|
666
|
+
transfer(dest: string, extra?: Record<string, unknown>): Promise<CallingTransferResult>;
|
|
402
667
|
/**
|
|
403
668
|
* Join an ad-hoc audio conference.
|
|
404
669
|
*
|
|
@@ -427,7 +692,7 @@ export declare class Call {
|
|
|
427
692
|
recordingStatusCallbackEventType?: string;
|
|
428
693
|
recordingStatusCallbackMethod?: string;
|
|
429
694
|
stream?: Record<string, unknown>;
|
|
430
|
-
}): Promise<
|
|
695
|
+
}): Promise<CallingJoinConferenceResult>;
|
|
431
696
|
/**
|
|
432
697
|
* Leave an audio conference.
|
|
433
698
|
*
|
|
@@ -436,7 +701,7 @@ export declare class Call {
|
|
|
436
701
|
* @returns The platform's leave-conference response.
|
|
437
702
|
* @throws {RelayError} When the leave_conference command is rejected.
|
|
438
703
|
*/
|
|
439
|
-
leaveConference(conferenceId: string, extra?: Record<string, unknown>): Promise<
|
|
704
|
+
leaveConference(conferenceId: string, extra?: Record<string, unknown>): Promise<CallingLeaveConferenceResult>;
|
|
440
705
|
/**
|
|
441
706
|
* Put the call on hold.
|
|
442
707
|
*
|
|
@@ -457,14 +722,14 @@ export declare class Call {
|
|
|
457
722
|
* @returns The platform's denoise response.
|
|
458
723
|
* @throws {RelayError} When the denoise command is rejected.
|
|
459
724
|
*/
|
|
460
|
-
denoise(): Promise<
|
|
725
|
+
denoise(): Promise<CallingDenoiseResult>;
|
|
461
726
|
/**
|
|
462
727
|
* Stop noise reduction on the call.
|
|
463
728
|
*
|
|
464
729
|
* @returns The platform's denoise-stop response.
|
|
465
730
|
* @throws {RelayError} When the denoise.stop command is rejected.
|
|
466
731
|
*/
|
|
467
|
-
denoiseStop(): Promise<
|
|
732
|
+
denoiseStop(): Promise<CallingDenoiseStopResult>;
|
|
468
733
|
/**
|
|
469
734
|
* Start transcribing the call.
|
|
470
735
|
*
|
|
@@ -492,7 +757,7 @@ export declare class Call {
|
|
|
492
757
|
echo(options?: {
|
|
493
758
|
timeout?: number;
|
|
494
759
|
statusUrl?: string;
|
|
495
|
-
}): Promise<
|
|
760
|
+
}): Promise<CallingEchoResult>;
|
|
496
761
|
/**
|
|
497
762
|
* Bind a DTMF digit sequence to trigger a RELAY method automatically when
|
|
498
763
|
* the caller presses it.
|
|
@@ -510,7 +775,7 @@ export declare class Call {
|
|
|
510
775
|
bindParams?: Record<string, unknown>;
|
|
511
776
|
realm?: string;
|
|
512
777
|
maxTriggers?: number;
|
|
513
|
-
}): Promise<
|
|
778
|
+
}): Promise<CallingBindDigitResult>;
|
|
514
779
|
/**
|
|
515
780
|
* Clear all digit bindings, optionally filtered by realm.
|
|
516
781
|
*
|
|
@@ -518,7 +783,7 @@ export declare class Call {
|
|
|
518
783
|
* @returns The platform's clear_digit_bindings response.
|
|
519
784
|
* @throws {RelayError} When the clear_digit_bindings command is rejected.
|
|
520
785
|
*/
|
|
521
|
-
clearDigitBindings(realm?: string): Promise<
|
|
786
|
+
clearDigitBindings(realm?: string): Promise<CallingClearDigitBindingsResult>;
|
|
522
787
|
/**
|
|
523
788
|
* Start or stop live transcription on the call.
|
|
524
789
|
*
|
|
@@ -528,7 +793,7 @@ export declare class Call {
|
|
|
528
793
|
* @returns The platform's live_transcribe response.
|
|
529
794
|
* @throws {RelayError} When the live_transcribe command is rejected.
|
|
530
795
|
*/
|
|
531
|
-
liveTranscribe(action: Record<string, unknown>, extra?: Record<string, unknown>): Promise<
|
|
796
|
+
liveTranscribe(action: Record<string, unknown>, extra?: Record<string, unknown>): Promise<CallingLiveTranscribeResult>;
|
|
532
797
|
/**
|
|
533
798
|
* Start or stop live translation on the call.
|
|
534
799
|
*
|
|
@@ -541,7 +806,7 @@ export declare class Call {
|
|
|
541
806
|
*/
|
|
542
807
|
liveTranslate(action: Record<string, unknown>, options?: {
|
|
543
808
|
statusUrl?: string;
|
|
544
|
-
}): Promise<
|
|
809
|
+
}): Promise<CallingLiveTranslateResult>;
|
|
545
810
|
/**
|
|
546
811
|
* Join a video / audio room.
|
|
547
812
|
*
|
|
@@ -553,7 +818,7 @@ export declare class Call {
|
|
|
553
818
|
*/
|
|
554
819
|
joinRoom(name: string, options?: {
|
|
555
820
|
statusUrl?: string;
|
|
556
|
-
}): Promise<
|
|
821
|
+
}): Promise<CallingJoinRoomResult>;
|
|
557
822
|
/**
|
|
558
823
|
* Leave the current room.
|
|
559
824
|
*
|
|
@@ -561,7 +826,7 @@ export declare class Call {
|
|
|
561
826
|
* @returns The platform's leave_room response.
|
|
562
827
|
* @throws {RelayError} When the leave_room command is rejected.
|
|
563
828
|
*/
|
|
564
|
-
leaveRoom(extra?: Record<string, unknown>): Promise<
|
|
829
|
+
leaveRoom(extra?: Record<string, unknown>): Promise<CallingLeaveRoomResult>;
|
|
565
830
|
/**
|
|
566
831
|
* Start an AI agent session on the call.
|
|
567
832
|
*
|
|
@@ -605,7 +870,7 @@ export declare class Call {
|
|
|
605
870
|
globalData?: Record<string, unknown>;
|
|
606
871
|
postPrompt?: Record<string, unknown>;
|
|
607
872
|
postPromptUrl?: string;
|
|
608
|
-
}): Promise<
|
|
873
|
+
}): Promise<CallingAmazonBedrockResult>;
|
|
609
874
|
/**
|
|
610
875
|
* Send a message into an active AI agent session.
|
|
611
876
|
*
|
|
@@ -622,7 +887,7 @@ export declare class Call {
|
|
|
622
887
|
role?: string;
|
|
623
888
|
reset?: Record<string, unknown>;
|
|
624
889
|
globalData?: Record<string, unknown>;
|
|
625
|
-
}): Promise<
|
|
890
|
+
}): Promise<CallingAiMessageResult>;
|
|
626
891
|
/**
|
|
627
892
|
* Put the AI agent session on hold (pause turn-taking).
|
|
628
893
|
*
|
|
@@ -635,7 +900,7 @@ export declare class Call {
|
|
|
635
900
|
aiHold(options?: {
|
|
636
901
|
timeout?: string;
|
|
637
902
|
prompt?: string;
|
|
638
|
-
}): Promise<
|
|
903
|
+
}): Promise<CallingAiHoldResult>;
|
|
639
904
|
/**
|
|
640
905
|
* Resume an AI agent session from hold.
|
|
641
906
|
*
|
|
@@ -646,7 +911,7 @@ export declare class Call {
|
|
|
646
911
|
*/
|
|
647
912
|
aiUnhold(options?: {
|
|
648
913
|
prompt?: string;
|
|
649
|
-
}): Promise<
|
|
914
|
+
}): Promise<CallingAiUnholdResult>;
|
|
650
915
|
/**
|
|
651
916
|
* Emit a custom user-defined event on the call for your webhooks.
|
|
652
917
|
*
|
|
@@ -657,7 +922,7 @@ export declare class Call {
|
|
|
657
922
|
*/
|
|
658
923
|
userEvent(options?: {
|
|
659
924
|
event?: string;
|
|
660
|
-
} & Record<string, unknown>): Promise<
|
|
925
|
+
} & Record<string, unknown>): Promise<CallingUserEventResult>;
|
|
661
926
|
/**
|
|
662
927
|
* Place the call into a named queue.
|
|
663
928
|
*
|
|
@@ -671,7 +936,7 @@ export declare class Call {
|
|
|
671
936
|
queueEnter(queueName: string, options?: {
|
|
672
937
|
controlId?: string;
|
|
673
938
|
statusUrl?: string;
|
|
674
|
-
}): Promise<
|
|
939
|
+
}): Promise<CallingQueueEnterResult>;
|
|
675
940
|
/**
|
|
676
941
|
* Remove the call from a queue.
|
|
677
942
|
*
|
|
@@ -687,7 +952,7 @@ export declare class Call {
|
|
|
687
952
|
controlId?: string;
|
|
688
953
|
queueId?: string;
|
|
689
954
|
statusUrl?: string;
|
|
690
|
-
}): Promise<
|
|
955
|
+
}): Promise<CallingQueueLeaveResult>;
|
|
691
956
|
/**
|
|
692
957
|
* Return a human-readable diagnostic string.
|
|
693
958
|
*
|