@signalwire/sdk 2.0.5 → 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 +481 -126
- package/dist/AgentBase.js +1502 -438
- 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 +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- 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 +18 -0
- package/dist/PomBuilder.js +53 -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 +22 -1
- package/dist/PromptManager.js +28 -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 +158 -58
- package/dist/SWMLService.js +435 -127
- 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 +49 -9
- package/dist/SecurityUtils.js +153 -51
- 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 +92 -33
- 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 -371
- 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 +47 -68
- package/dist/index.js +44 -73
- 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 +44 -17
- package/dist/relay/RelayClient.js +175 -65
- 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 +73 -42
- 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 +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -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 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- 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 +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- 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 +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- 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 +18 -6
- 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 +21 -22
- 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 +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- 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 +38 -30
- 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 +294 -100
- 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 +14 -13
- 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 +59 -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 +85 -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/RelayError.js
CHANGED
|
@@ -7,6 +7,20 @@
|
|
|
7
7
|
export class RelayError extends Error {
|
|
8
8
|
/** Numeric RELAY result code returned by the server. */
|
|
9
9
|
code;
|
|
10
|
+
/**
|
|
11
|
+
* The RAW server message, undecorated — the reference's public `self.message`
|
|
12
|
+
* (`relay/client.py:1332`).
|
|
13
|
+
*
|
|
14
|
+
* Kept as its own property because JS `Error` owns `message` and `super(...)`
|
|
15
|
+
* fills it with the DECORATED text (`"RELAY error {code}: {message}"`, the
|
|
16
|
+
* reference's `super().__init__` on line 1333). A caller who wants the server's
|
|
17
|
+
* own wording — to match on it, surface it in a UI, or forward it — reads this;
|
|
18
|
+
* `message` gives the decorated form, matching Python's `str(exc)`.
|
|
19
|
+
*
|
|
20
|
+
* Same spelling and rationale as {@link AIChatError.serverMessage}. The surface
|
|
21
|
+
* enumerator folds it onto the reference's `message` attribute.
|
|
22
|
+
*/
|
|
23
|
+
serverMessage;
|
|
10
24
|
/**
|
|
11
25
|
* @param code - Numeric RELAY result code (e.g. `404`, `503`).
|
|
12
26
|
* @param message - Human-readable error message from the server.
|
|
@@ -15,6 +29,7 @@ export class RelayError extends Error {
|
|
|
15
29
|
super(`RELAY error ${code}: ${message}`);
|
|
16
30
|
this.name = 'RelayError';
|
|
17
31
|
this.code = code;
|
|
32
|
+
this.serverMessage = message;
|
|
18
33
|
}
|
|
19
34
|
}
|
|
20
35
|
//# sourceMappingURL=RelayError.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RelayError.js","sourceRoot":"","sources":["../../src/relay/RelayError.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,wDAAwD;IAC/C,IAAI,CAAS;
|
|
1
|
+
{"version":3,"file":"RelayError.js","sourceRoot":"","sources":["../../src/relay/RelayError.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,wDAAwD;IAC/C,IAAI,CAAS;IACtB;;;;;;;;;;;;OAYG;IACM,aAAa,CAAS;IAE/B;;;OAGG;IACH,YAAY,IAAY,EAAE,OAAe;QACvC,KAAK,CAAC,eAAe,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;IAC/B,CAAC;CACF"}
|
|
@@ -4,6 +4,15 @@
|
|
|
4
4
|
* These are convenience classes over raw event dicts. All Call event handlers
|
|
5
5
|
* also accept the raw dict, so these are optional.
|
|
6
6
|
*/
|
|
7
|
+
import type { CallState, DialState, MessageState } from './closedSets.js';
|
|
8
|
+
import type { Device } from './types.js';
|
|
9
|
+
/**
|
|
10
|
+
* Raw RELAY wire payload — a `signalwire.event` notification dict. Field
|
|
11
|
+
* names/types are server-defined; access goes through {@link pick}, which
|
|
12
|
+
* applies a boundary cast to the expected field type while preserving the
|
|
13
|
+
* exact `value ?? default` runtime semantics.
|
|
14
|
+
*/
|
|
15
|
+
type EventPayload = Record<string, unknown>;
|
|
7
16
|
/**
|
|
8
17
|
* Base class for all typed RELAY events.
|
|
9
18
|
*
|
|
@@ -16,7 +25,7 @@ export declare class RelayEvent {
|
|
|
16
25
|
/** Fully-qualified event type (e.g. `"calling.call.state"`). */
|
|
17
26
|
readonly eventType: string;
|
|
18
27
|
/** Raw params dict from the RELAY notification. */
|
|
19
|
-
readonly params:
|
|
28
|
+
readonly params: EventPayload;
|
|
20
29
|
/** Call ID associated with the event, or `""` for non-call events. */
|
|
21
30
|
readonly callId: string;
|
|
22
31
|
/** Server timestamp (epoch seconds) at which the event was emitted. */
|
|
@@ -27,43 +36,50 @@ export declare class RelayEvent {
|
|
|
27
36
|
* @param callId - Call ID (if applicable).
|
|
28
37
|
* @param timestamp - Server-side event timestamp.
|
|
29
38
|
*/
|
|
30
|
-
constructor(eventType: string, params:
|
|
39
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number);
|
|
31
40
|
/**
|
|
32
41
|
* Factory that builds a typed event from a raw `signalwire.event` payload.
|
|
33
42
|
* Subclasses override this to populate their specialised fields; the base
|
|
34
43
|
* implementation returns a minimal `RelayEvent` used as the fallback for
|
|
35
44
|
* unrecognised event types.
|
|
36
45
|
*/
|
|
37
|
-
static fromPayload(payload:
|
|
46
|
+
static fromPayload(payload: EventPayload): RelayEvent;
|
|
38
47
|
}
|
|
39
48
|
/** `calling.call.state` — fires on every lifecycle transition (created, ringing, answered, ending, ended). */
|
|
40
49
|
export declare class CallStateEvent extends RelayEvent {
|
|
41
|
-
|
|
50
|
+
/**
|
|
51
|
+
* The new call state — a {@link CallState} (`created` | `ringing` |
|
|
52
|
+
* `answered` | `ending` | `ended`; closed literal union, autocompleted +
|
|
53
|
+
* typo-checked). Pass to {@link ../relay/closedSets.isCallStateTerminal} to
|
|
54
|
+
* test for the terminal state.
|
|
55
|
+
*/
|
|
56
|
+
readonly callState: CallState;
|
|
42
57
|
readonly endReason: string;
|
|
43
58
|
readonly direction: string;
|
|
44
|
-
readonly device:
|
|
45
|
-
constructor(eventType: string, params:
|
|
46
|
-
static fromPayload(payload:
|
|
59
|
+
readonly device: Device;
|
|
60
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, callState?: CallState, endReason?: string, direction?: string, device?: Device);
|
|
61
|
+
static fromPayload(payload: EventPayload): CallStateEvent;
|
|
47
62
|
}
|
|
48
63
|
/** `calling.call.receive` — fires when an inbound call arrives on a subscribed context. */
|
|
49
64
|
export declare class CallReceiveEvent extends RelayEvent {
|
|
50
|
-
|
|
65
|
+
/** Initial call state ({@link CallState}; typically `created`). */
|
|
66
|
+
readonly callState: CallState;
|
|
51
67
|
readonly direction: string;
|
|
52
|
-
readonly device:
|
|
68
|
+
readonly device: Device;
|
|
53
69
|
readonly nodeId: string;
|
|
54
70
|
readonly projectId: string;
|
|
55
71
|
readonly context: string;
|
|
56
72
|
readonly segmentId: string;
|
|
57
73
|
readonly tag: string;
|
|
58
|
-
constructor(eventType: string, params:
|
|
59
|
-
static fromPayload(payload:
|
|
74
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, callState?: CallState, direction?: string, device?: Device, nodeId?: string, projectId?: string, context?: string, segmentId?: string, tag?: string);
|
|
75
|
+
static fromPayload(payload: EventPayload): CallReceiveEvent;
|
|
60
76
|
}
|
|
61
77
|
/** `calling.call.play` — play-media action state change (`playing`, `paused`, `finished`, `error`). */
|
|
62
78
|
export declare class PlayEvent extends RelayEvent {
|
|
63
79
|
readonly controlId: string;
|
|
64
80
|
readonly state: string;
|
|
65
|
-
constructor(eventType: string, params:
|
|
66
|
-
static fromPayload(payload:
|
|
81
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string);
|
|
82
|
+
static fromPayload(payload: EventPayload): PlayEvent;
|
|
67
83
|
}
|
|
68
84
|
/** `calling.call.record` — recording state change with final URL, duration, and size when finished. */
|
|
69
85
|
export declare class RecordEvent extends RelayEvent {
|
|
@@ -72,48 +88,48 @@ export declare class RecordEvent extends RelayEvent {
|
|
|
72
88
|
readonly url: string;
|
|
73
89
|
readonly duration: number;
|
|
74
90
|
readonly size: number;
|
|
75
|
-
readonly record:
|
|
76
|
-
constructor(eventType: string, params:
|
|
77
|
-
static fromPayload(payload:
|
|
91
|
+
readonly record: EventPayload;
|
|
92
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, url?: string, duration?: number, size?: number, record?: EventPayload);
|
|
93
|
+
static fromPayload(payload: EventPayload): RecordEvent;
|
|
78
94
|
}
|
|
79
95
|
/** `calling.call.collect` — caller input (DTMF or speech) collected by a collect action. */
|
|
80
96
|
export declare class CollectEvent extends RelayEvent {
|
|
81
97
|
readonly controlId: string;
|
|
82
98
|
readonly state: string;
|
|
83
|
-
readonly result:
|
|
99
|
+
readonly result: EventPayload;
|
|
84
100
|
readonly final: boolean | undefined;
|
|
85
|
-
constructor(eventType: string, params:
|
|
86
|
-
static fromPayload(payload:
|
|
101
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, result?: EventPayload, final_?: boolean | undefined);
|
|
102
|
+
static fromPayload(payload: EventPayload): CollectEvent;
|
|
87
103
|
}
|
|
88
104
|
/** `calling.call.connect` — state transition when one call connects to another (dialplan/bridge). */
|
|
89
105
|
export declare class ConnectEvent extends RelayEvent {
|
|
90
106
|
readonly connectState: string;
|
|
91
|
-
readonly peer:
|
|
92
|
-
constructor(eventType: string, params:
|
|
93
|
-
static fromPayload(payload:
|
|
107
|
+
readonly peer: EventPayload;
|
|
108
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, connectState?: string, peer?: EventPayload);
|
|
109
|
+
static fromPayload(payload: EventPayload): ConnectEvent;
|
|
94
110
|
}
|
|
95
111
|
/** `calling.call.detect` — answering-machine / fax / DTMF detection result. */
|
|
96
112
|
export declare class DetectEvent extends RelayEvent {
|
|
97
113
|
readonly controlId: string;
|
|
98
|
-
readonly detect:
|
|
99
|
-
constructor(eventType: string, params:
|
|
100
|
-
static fromPayload(payload:
|
|
114
|
+
readonly detect: EventPayload;
|
|
115
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, detect?: EventPayload);
|
|
116
|
+
static fromPayload(payload: EventPayload): DetectEvent;
|
|
101
117
|
}
|
|
102
118
|
/** `calling.call.fax` — fax send/receive progress update. */
|
|
103
119
|
export declare class FaxEvent extends RelayEvent {
|
|
104
120
|
readonly controlId: string;
|
|
105
|
-
readonly fax:
|
|
106
|
-
constructor(eventType: string, params:
|
|
107
|
-
static fromPayload(payload:
|
|
121
|
+
readonly fax: EventPayload;
|
|
122
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, fax?: EventPayload);
|
|
123
|
+
static fromPayload(payload: EventPayload): FaxEvent;
|
|
108
124
|
}
|
|
109
125
|
/** `calling.call.tap` — media tap state change (audio mirror to an external endpoint). */
|
|
110
126
|
export declare class TapEvent extends RelayEvent {
|
|
111
127
|
readonly controlId: string;
|
|
112
128
|
readonly state: string;
|
|
113
|
-
readonly tap:
|
|
114
|
-
readonly device:
|
|
115
|
-
constructor(eventType: string, params:
|
|
116
|
-
static fromPayload(payload:
|
|
129
|
+
readonly tap: EventPayload;
|
|
130
|
+
readonly device: Device;
|
|
131
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, tap?: EventPayload, device?: Device);
|
|
132
|
+
static fromPayload(payload: EventPayload): TapEvent;
|
|
117
133
|
}
|
|
118
134
|
/** `calling.call.stream` — outbound media stream state change (e.g. RTMP/WebSocket streaming). */
|
|
119
135
|
export declare class StreamEvent extends RelayEvent {
|
|
@@ -121,23 +137,29 @@ export declare class StreamEvent extends RelayEvent {
|
|
|
121
137
|
readonly state: string;
|
|
122
138
|
readonly url: string;
|
|
123
139
|
readonly name: string;
|
|
124
|
-
constructor(eventType: string, params:
|
|
125
|
-
static fromPayload(payload:
|
|
140
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, url?: string, name?: string);
|
|
141
|
+
static fromPayload(payload: EventPayload): StreamEvent;
|
|
126
142
|
}
|
|
127
143
|
/** `calling.call.send_digits` — progress update for DTMF digits sent out on a call. */
|
|
128
144
|
export declare class SendDigitsEvent extends RelayEvent {
|
|
129
145
|
readonly controlId: string;
|
|
130
146
|
readonly state: string;
|
|
131
|
-
constructor(eventType: string, params:
|
|
132
|
-
static fromPayload(payload:
|
|
147
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string);
|
|
148
|
+
static fromPayload(payload: EventPayload): SendDigitsEvent;
|
|
133
149
|
}
|
|
134
150
|
/** `calling.call.dial` — outbound dial progress (answered, failed, no-answer, etc.). */
|
|
135
151
|
export declare class DialEvent extends RelayEvent {
|
|
136
152
|
readonly tag: string;
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
153
|
+
/**
|
|
154
|
+
* Outbound-dial state — a {@link DialState} (`dialing` | `answered` |
|
|
155
|
+
* `failed`; closed literal union, autocompleted + typo-checked). Pass to
|
|
156
|
+
* {@link ../relay/closedSets.isDialStateTerminal} to test for resolution.
|
|
157
|
+
* Distinct from a {@link CallState}.
|
|
158
|
+
*/
|
|
159
|
+
readonly dialState: DialState;
|
|
160
|
+
readonly call: EventPayload;
|
|
161
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, tag?: string, dialState?: DialState, call?: EventPayload);
|
|
162
|
+
static fromPayload(payload: EventPayload): DialEvent;
|
|
141
163
|
}
|
|
142
164
|
/** `calling.call.refer` — SIP REFER result (off-platform transfer response codes). */
|
|
143
165
|
export declare class ReferEvent extends RelayEvent {
|
|
@@ -145,21 +167,21 @@ export declare class ReferEvent extends RelayEvent {
|
|
|
145
167
|
readonly sipReferTo: string;
|
|
146
168
|
readonly sipReferResponseCode: string;
|
|
147
169
|
readonly sipNotifyResponseCode: string;
|
|
148
|
-
constructor(eventType: string, params:
|
|
149
|
-
static fromPayload(payload:
|
|
170
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, state?: string, sipReferTo?: string, sipReferResponseCode?: string, sipNotifyResponseCode?: string);
|
|
171
|
+
static fromPayload(payload: EventPayload): ReferEvent;
|
|
150
172
|
}
|
|
151
173
|
/** `calling.call.denoise` — noise-reduction on/off confirmation. */
|
|
152
174
|
export declare class DenoiseEvent extends RelayEvent {
|
|
153
175
|
readonly denoised: boolean;
|
|
154
|
-
constructor(eventType: string, params:
|
|
155
|
-
static fromPayload(payload:
|
|
176
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, denoised?: boolean);
|
|
177
|
+
static fromPayload(payload: EventPayload): DenoiseEvent;
|
|
156
178
|
}
|
|
157
179
|
/** `calling.call.pay` — PCI-compliant payment collection progress update. */
|
|
158
180
|
export declare class PayEvent extends RelayEvent {
|
|
159
181
|
readonly controlId: string;
|
|
160
182
|
readonly state: string;
|
|
161
|
-
constructor(eventType: string, params:
|
|
162
|
-
static fromPayload(payload:
|
|
183
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string);
|
|
184
|
+
static fromPayload(payload: EventPayload): PayEvent;
|
|
163
185
|
}
|
|
164
186
|
/** `calling.call.queue` — call-queue position update (queued, waiting, member answered, timed out). */
|
|
165
187
|
export declare class QueueEvent extends RelayEvent {
|
|
@@ -169,14 +191,14 @@ export declare class QueueEvent extends RelayEvent {
|
|
|
169
191
|
readonly queueName: string;
|
|
170
192
|
readonly position: number;
|
|
171
193
|
readonly size: number;
|
|
172
|
-
constructor(eventType: string, params:
|
|
173
|
-
static fromPayload(payload:
|
|
194
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, status?: string, queueId?: string, queueName?: string, position?: number, size?: number);
|
|
195
|
+
static fromPayload(payload: EventPayload): QueueEvent;
|
|
174
196
|
}
|
|
175
197
|
/** `calling.call.echo` — test/diagnostic echo reflection from the server. */
|
|
176
198
|
export declare class EchoEvent extends RelayEvent {
|
|
177
199
|
readonly state: string;
|
|
178
|
-
constructor(eventType: string, params:
|
|
179
|
-
static fromPayload(payload:
|
|
200
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, state?: string);
|
|
201
|
+
static fromPayload(payload: EventPayload): EchoEvent;
|
|
180
202
|
}
|
|
181
203
|
/** `calling.call.transcribe` — transcription state change and final URL/duration when finished. */
|
|
182
204
|
export declare class TranscribeEvent extends RelayEvent {
|
|
@@ -186,29 +208,29 @@ export declare class TranscribeEvent extends RelayEvent {
|
|
|
186
208
|
readonly recordingId: string;
|
|
187
209
|
readonly duration: number;
|
|
188
210
|
readonly size: number;
|
|
189
|
-
constructor(eventType: string, params:
|
|
190
|
-
static fromPayload(payload:
|
|
211
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, url?: string, recordingId?: string, duration?: number, size?: number);
|
|
212
|
+
static fromPayload(payload: EventPayload): TranscribeEvent;
|
|
191
213
|
}
|
|
192
214
|
/** `calling.call.hold` — hold/unhold state change on the call. */
|
|
193
215
|
export declare class HoldEvent extends RelayEvent {
|
|
194
216
|
readonly state: string;
|
|
195
|
-
constructor(eventType: string, params:
|
|
196
|
-
static fromPayload(payload:
|
|
217
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, state?: string);
|
|
218
|
+
static fromPayload(payload: EventPayload): HoldEvent;
|
|
197
219
|
}
|
|
198
220
|
/** `calling.conference` — conference lifecycle change (created, active, ended). */
|
|
199
221
|
export declare class ConferenceEvent extends RelayEvent {
|
|
200
222
|
readonly conferenceId: string;
|
|
201
223
|
readonly name: string;
|
|
202
224
|
readonly status: string;
|
|
203
|
-
constructor(eventType: string, params:
|
|
204
|
-
static fromPayload(payload:
|
|
225
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, conferenceId?: string, name?: string, status?: string);
|
|
226
|
+
static fromPayload(payload: EventPayload): ConferenceEvent;
|
|
205
227
|
}
|
|
206
228
|
/** `calling.error` — platform-emitted error against the calling namespace. */
|
|
207
229
|
export declare class CallingErrorEvent extends RelayEvent {
|
|
208
230
|
readonly code: string;
|
|
209
231
|
readonly message: string;
|
|
210
|
-
constructor(eventType: string, params:
|
|
211
|
-
static fromPayload(payload:
|
|
232
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, code?: string, message?: string);
|
|
233
|
+
static fromPayload(payload: EventPayload): CallingErrorEvent;
|
|
212
234
|
}
|
|
213
235
|
/** `messaging.receive` — inbound SMS/MMS received on a subscribed context. */
|
|
214
236
|
export declare class MessageReceiveEvent extends RelayEvent {
|
|
@@ -222,8 +244,8 @@ export declare class MessageReceiveEvent extends RelayEvent {
|
|
|
222
244
|
readonly segments: number;
|
|
223
245
|
readonly messageState: string;
|
|
224
246
|
readonly tags: string[];
|
|
225
|
-
constructor(eventType: string, params:
|
|
226
|
-
static fromPayload(payload:
|
|
247
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, messageId?: string, context?: string, direction?: string, fromNumber?: string, toNumber?: string, body?: string, media?: string[], segments?: number, messageState?: string, tags?: string[]);
|
|
248
|
+
static fromPayload(payload: EventPayload): MessageReceiveEvent;
|
|
227
249
|
}
|
|
228
250
|
/** `messaging.state` — state change for an outbound message (queued → sent → delivered/failed). */
|
|
229
251
|
export declare class MessageStateEvent extends RelayEvent {
|
|
@@ -235,15 +257,23 @@ export declare class MessageStateEvent extends RelayEvent {
|
|
|
235
257
|
readonly body: string;
|
|
236
258
|
readonly media: string[];
|
|
237
259
|
readonly segments: number;
|
|
238
|
-
|
|
260
|
+
/**
|
|
261
|
+
* Message lifecycle state — a {@link MessageState} (`queued` |
|
|
262
|
+
* `initiated` | `sent` | `delivered` | `undelivered` | `failed` | `received`;
|
|
263
|
+
* closed literal union, autocompleted + typo-checked). Pass to
|
|
264
|
+
* {@link ../relay/closedSets.isMessageStateTerminal} to test for a final
|
|
265
|
+
* delivery outcome. Distinct from a {@link CallState} /
|
|
266
|
+
* {@link DialState}.
|
|
267
|
+
*/
|
|
268
|
+
readonly messageState: MessageState;
|
|
239
269
|
readonly reason: string;
|
|
240
270
|
readonly tags: string[];
|
|
241
|
-
constructor(eventType: string, params:
|
|
242
|
-
static fromPayload(payload:
|
|
271
|
+
constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, messageId?: string, context?: string, direction?: string, fromNumber?: string, toNumber?: string, body?: string, media?: string[], segments?: number, messageState?: MessageState, reason?: string, tags?: string[]);
|
|
272
|
+
static fromPayload(payload: EventPayload): MessageStateEvent;
|
|
243
273
|
}
|
|
244
274
|
/** Structural type for an event class that exposes a `fromPayload` factory. */
|
|
245
275
|
export type EventClass = {
|
|
246
|
-
fromPayload(payload:
|
|
276
|
+
fromPayload(payload: EventPayload): RelayEvent;
|
|
247
277
|
};
|
|
248
278
|
/**
|
|
249
279
|
* Maps RELAY `event_type` strings to the typed event subclass that builds
|
|
@@ -251,4 +281,5 @@ export type EventClass = {
|
|
|
251
281
|
*/
|
|
252
282
|
export declare const EVENT_CLASS_MAP: Record<string, EventClass>;
|
|
253
283
|
/** Parse a raw signalwire.event params dict into a typed event object. */
|
|
254
|
-
export declare function parseEvent(payload:
|
|
284
|
+
export declare function parseEvent(payload: EventPayload): RelayEvent;
|
|
285
|
+
export {};
|