@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
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":"3.5.0","exports":["AIAction","AIChatClient","AIChatClientOptions","AIChatError","AIVerbBuildOptions","AIVerbHandler","Action","AddressesResource","AgentBase","AgentOptions","AgentServer","AiAgents","ApiNinjasTriviaSkill","AskClaudeSkill","AuthConfig","AuthHandler","AuthenticationError","BaseResource","BedrockAgent","BedrockAgentConfig","CALL_STATE_ANSWERED","CALL_STATE_CREATED","CALL_STATE_ENDED","CALL_STATE_ENDING","CALL_STATE_RINGING","CALL_STATE_TERMINAL","CONNECT_STATE_CONNECTED","CONNECT_STATE_CONNECTING","CONNECT_STATE_DISCONNECTED","CONNECT_STATE_FAILED","Call","CallFlowsResource","CallHandler","CallLike","CallReceiveEvent","CallState","CallStateEvent","CallingErrorEvent","CallingNamespace","CaptureLeg","ChatGateway","ChatGatewayOptions","ChatInProgressError","ChatLog","ChatOptions","ChatResource","ChatResponse","ClaudeSkillsSkill","ClientOptions","CollectAction","CollectConfig","CollectEvent","CompletedCallback","ConciergeAgent","ConciergeConfig","ConferenceEvent","ConferenceLogs","ConferenceRoomsResource","ConfigLoader","ConnectEvent","Context","ContextBuilder","ConversationInfo","ConversationNotFoundError","ConversationTurnOptions","CreateConversationOptions","CrudResource","CrudWithAddresses","CustomSkillsSkill","CxmlApplicationsResource","CxmlScripts","CxmlWebhooks","DIALOGUE_ROLES","DIAL_STATE_TERMINAL","DataMap","DataSphereServerlessSkill","DataSphereSkill","DatasphereDocuments","DatasphereNamespace","DateTimeSkill","DebugTokenResult","Deferred","DenoiseEvent","DetectAction","DetectEvent","Device","DialEvent","DialOptions","DialState","DialogueTurn","DynamicConfigCallback","EVENT_CALLING_ERROR","EVENT_CALL_COLLECT","EVENT_CALL_CONNECT","EVENT_CALL_DENOISE","EVENT_CALL_DETECT","EVENT_CALL_DIAL","EVENT_CALL_ECHO","EVENT_CALL_FAX","EVENT_CALL_HOLD","EVENT_CALL_PAY","EVENT_CALL_PLAY","EVENT_CALL_QUEUE","EVENT_CALL_RECEIVE","EVENT_CALL_RECORD","EVENT_CALL_REFER","EVENT_CALL_SEND_DIGITS","EVENT_CALL_STATE","EVENT_CALL_STREAM","EVENT_CALL_TAP","EVENT_CALL_TRANSCRIBE","EVENT_CLASS_MAP","EVENT_CONFERENCE","EVENT_MESSAGING_RECEIVE","EVENT_MESSAGING_STATE","EchoEvent","EndCall","EventClass","EventHandler","FAQBotAgent","FAQBotConfig","FAQEntry","FabricAddresses","FabricDevice","FabricNamespace","FabricResource","FabricResourcePUT","FabricTokens","FaxAction","FaxEvent","FaxLogs","FaxTone","FormParamValue","FormParams","FreeswitchConnectors","FunctionInclude","FunctionResult","GatewayRejection","GatherInfo","GatherQuestion","GenericResources","GoogleMapsSkill","HISTORY_MODES","HandoffRouter","HandoffRouterOptions","HistoryMode","HoldEvent","HostAppRouter","HttpClient","HttpClientOptions","ImportedNumbersResource","InferredSchema","InfoGathererAgent","InfoGathererConfig","InfoGathererQuestion","InfoGathererQuestionCallback","InfoGathererSkill","JokeSkill","LamlPaginatedResponse","LanguageConfig","LogLevel","Logger","LogsNamespace","LookupResource","MAX_MESSAGE_BYTES","MAX_REQUEST_BODY_BYTES","MAX_SKILL_INPUT_LENGTH","MAX_USER_METADATA_BYTES","MESSAGE_STATE_DELIVERED","MESSAGE_STATE_FAILED","MESSAGE_STATE_INITIATED","MESSAGE_STATE_QUEUED","MESSAGE_STATE_RECEIVED","MESSAGE_STATE_SENT","MESSAGE_STATE_TERMINAL","MESSAGE_STATE_UNDELIVERED","MathSkill","McpGatewaySkill","Message","MessageHandler","MessageLogs","MessageReceiveEvent","MessageState","MessageStateEvent","MfaResource","NativeVectorSearchSkill","NonceEntry","NormalizedPostPrompt","NumberGroupsResource","OnRequestCallback","PaginatedResponse","ParameterProperty","ParameterSchema","ParameterSchemaEntry","ParameterSchemaObject","ParameterType","ParsedParam","PayAction","PayEvent","PaymentAction","PaymentParameter","PaymentPrompt","PhoneCallHandler","PhoneDevice","PhoneNumbersResource","PlayAction","PlayBackgroundFileSkill","PlayEvent","PlayItem","PomBuilder","PomSection","PomSectionData","PostPrompt","PostPromptData","ProjectNamespace","ProjectTokens","PromptManager","PromptObjectModel","PronunciationRule","PubSubResource","QueryParams","QueueEvent","QueuesResource","RECORD_DIRECTIONS","RECORD_FORMATS","RateLimitError","ReceptionistAgent","ReceptionistConfig","ReceptionistDepartment","RecordAction","RecordDirection","RecordEvent","RecordFormat","RecordingsResource","ReferEvent","RegistryBrands","RegistryCampaigns","RegistryNamespace","RegistryNumbers","RegistryOrders","RelayApplications","RelayClient","RelayClientLike","RelayClientOptions","RelayError","RelayEvent","RequestOptions","RequestOptionsInit","RestClient","RestError","RestTransportError","RoutingCallback","SIGNALWIRE_SHA256_SIGNATURE_HEADER","SIGNALWIRE_SIGNATURE_HEADER","SWMLService","SWMLServiceOptions","SWMLVerbHandler","SchemaUtils","SchemaValidationError","Section","SectionData","SecurityConfig","SendDigitsEvent","SendMessage","SendMessageOptions","ServerlessAdapter","ServerlessEvent","ServerlessPlatform","ServerlessResponse","SessionManager","ShortCodesResource","SignalWireErrorBody","SipDevice","SipEndpoints","SipGateways","SipProfileResource","SkillBase","SkillConfig","SkillManager","SkillName","SkillNameOrString","SkillPromptSection","SkillRegistry","SkillSchemaInfo","SkillToolDefinition","SpiderSkill","SslConfig","SslOptions","StandaloneCollectAction","Step","StreamAction","StreamEvent","SubscribersResource","SummarizeOptions","SummaryCallback","SummaryError","SurveyAgent","SurveyConfig","SurveyQuestion","SwaigArgument","SwaigFunction","SwaigFunctionOptions","SwaigHandler","SwaigRequest","SwmlBuilder","SwmlBuilderOptions","SwmlRequestCall","SwmlRequestData","SwmlScripts","SwmlTransferSkill","SwmlWebhooks","TAP_CODECS","TAP_DIRECTIONS","TWILIO_COMPAT_SIGNATURE_HEADER","TapAction","TapCodec","TapDirection","TapEvent","TranscribeAction","TranscribeEvent","TtsGender","TypedToolHandler","ValidationResult","VerbHandlerRegistry","VerifiedCallersResource","VideoConferenceTokens","VideoConferences","VideoNamespace","VideoRoomRecordings","VideoRoomSessions","VideoRoomTokens","VideoRooms","VideoStreams","VoiceLogs","WeatherApiSkill","WebSearchSkill","WebService","WebServiceOptions","WebhookRejection","WebhookValidationOptions","WikipediaSearchSkill","addSkillDirectory","createBedrockAgent","createDeferred","createExpressionTool","createSimpleApiTool","createSimpleContext","createTypedHandlerWrapper","declaredCapabilities","defineSkillTool","dialogueTurns","filterSensitiveHeaders","getAllowedEnvPrefixes","getExecutionMode","getLogger","hasCapability","inferSchema","isCallStateTerminal","isDialStateTerminal","isMessageStateTerminal","isServerlessMode","listSkills","listSkillsWithParams","livewire","normalizePostPrompt","paginate","paginateAll","paramSchema","parseEvent","parseFunctionParams","parsePostPromptData","redactUrl","registerBuiltinSkills","registerSkill","resetLoggingConfiguration","restClient","safeAssign","setAllowedEnvPrefixes","setGlobalLogColor","setGlobalLogFormat","setGlobalLogLevel","setGlobalLogStream","stripControlChars","stripJsonFence","suppressAllLogs","userVariables","validate","validateRequest","validateUrl","validateWebhookSignature","validateWebhookSignatureSha256","webhookValidationMiddleware","withTimeout"],"entries":{"AIAction":{"name":"AIAction","kind":"class","exported":true,"signature":["class AIAction extends Action"],"doc":"Async handle for a `calling.call.ai` action (on-call AI agent session).","file":"dist/relay/Action.d.ts","line":272,"members":[{"name":"constructor","kind":"constructor","owner":"AIAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":273},{"name":"stop","kind":"method","owner":"AIAction","signature":["stop(): Promise<Record<string, unknown>>"],"doc":"Stop the AI agent session.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":280}],"bases":["Action"]},"AIChatClient":{"name":"AIChatClient","kind":"class","exported":true,"signature":["class AIChatClient"],"doc":"Async client for the SignalWire AI Chat service.","file":"dist/ai-chat/AIChatClient.d.ts","line":168,"members":[{"name":"url","kind":"property","owner":"AIChatClient","readonly":true,"signature":["readonly url: string"],"doc":"Fully-qualified endpoint URL requests are POSTed to.","file":"dist/ai-chat/AIChatClient.d.ts","line":170},{"name":"constructor","kind":"constructor","owner":"AIChatClient","signature":["constructor(options?: AIChatClientOptions)"],"doc":"@param options - Connection + credential options. Either `url` or `space`\n (or `SIGNALWIRE_SPACE`) must resolve a target; `project` is required (arg\n or `SIGNALWIRE_PROJECT_ID`).\n@throws {Error} When no project is available, or no URL can be resolved.","file":"dist/ai-chat/AIChatClient.d.ts","line":181},{"name":"rawPost","kind":"method","owner":"AIChatClient","signature":["rawPost(method: string, params: JsonRpcParams): Promise<Response>"],"doc":"POST one JSON-RPC call and return the response with its body unread.\n\nFor a proxy that has to stream the body through rather than buffer it.\nThe service pads a slow response with keepalive whitespace so that\nintermediaries don't close the connection mid-turn; a proxy that waits for\nthe whole body holds back that padding and brings back the timeout it's\nthere to prevent. Pass `response.body` on as it arrives.\n\nThe caller interprets the result, including that a JSON-RPC error arrives\nunder HTTP 200 (see the typed methods). Read the body to the end or cancel\nit, so the connection is released. The idle timeout applies to each read.\nPrefer the typed methods unless you are relaying bytes.\n\n@param method - JSON-RPC method, e.g. `chat`.\n@param params - JSON-RPC params, sent as they are.\n@returns The response, body unread.\n\n@example\n```ts\nimport { Hono } from 'hono';\nimport { AIChatClient } from '@signalwire/sdk';\n\nconst client = new AIChatClient({ space: 'myspace' });\nconst app = new Hono();\n\napp.post('/chat', async (c) => {\n const { id, message } = await c.req.json<{ id: string; message: string }>();\n const upstream = await client.rawPost('chat', { id, message });\n return new Response(upstream.body, {\n status: upstream.status,\n headers: { 'Content-Type': 'application/json' },\n });\n});\n```","file":"dist/ai-chat/AIChatClient.d.ts","line":241},{"name":"createConversation","kind":"method","owner":"AIChatClient","signature":["createConversation(conversationId: string, options: CreateConversationOptions): Promise<ConversationInfo>"],"doc":"Create a conversation (or, with `reinit`, reinitialize an existing one) and\noptionally send its opening user message.\n\n@param conversationId - The conversation id to create.\n@param options - Must include `configUrl`; other fields are optional.\n@returns The created conversation's status + optional opening message.","file":"dist/ai-chat/AIChatClient.d.ts","line":250},{"name":"chat","kind":"method","owner":"AIChatClient","signature":["chat(conversationId: string, message: string, options?: ChatOptions): Promise<ChatResponse>"],"doc":"Send a message and await a full LLM round trip.\n\nPassing `configUrl` auto-creates the conversation if it doesn't exist yet;\n`timeout` and `reinit` apply to that auto-create, with the same meaning as on\n{@link createConversation}. Expect seconds — the turn awaits the model.\n\n@param conversationId - The conversation to send into.\n@param message - The user (or system) message text.\n@param options - Optional role / auto-create / metadata fields.\n@returns The assistant reply text plus any structured user event.","file":"dist/ai-chat/AIChatClient.d.ts","line":263},{"name":"end","kind":"method","owner":"AIChatClient","signature":["end(conversationId: string): Promise<boolean>"],"doc":"End a conversation (triggers server-side post-processing / archival).\n\n@param conversationId - The conversation to end.\n@returns `true` when the service reported the conversation ended.","file":"dist/ai-chat/AIChatClient.d.ts","line":270},{"name":"delete","kind":"method","owner":"AIChatClient","signature":["delete(conversationId: string): Promise<boolean>"],"doc":"Permanently delete a conversation and its data. Idempotent.\n\n@param conversationId - The conversation to delete.\n@returns `true` when the service reported the conversation deleted.","file":"dist/ai-chat/AIChatClient.d.ts","line":277},{"name":"log","kind":"method","owner":"AIChatClient","signature":["log(conversationId: string): Promise<ChatLog>"],"doc":"Return the full message history plus the call timeline.\n\n@param conversationId - The conversation to read.\n@returns The message list and call timeline.","file":"dist/ai-chat/AIChatClient.d.ts","line":284},{"name":"summarize","kind":"method","owner":"AIChatClient","signature":["summarize(conversationId: string, options?: SummarizeOptions): Promise<string>"],"doc":"Return an AI summary of the conversation (rate limited server-side).\n\nThe service returns EXACTLY ONE of `{summary}` or `{error}` — BOTH on the\nsuccess envelope — so a failed generation must surface as a thrown\n{@link SummaryError}, never as an empty string.\n\n@param conversationId - The conversation to summarize.\n@param options - Optional custom prompt + sampling parameters.\n@returns The summary text.\n@throws {SummaryError} When the service reports summary generation failed.","file":"dist/ai-chat/AIChatClient.d.ts","line":297},{"name":"close","kind":"method","owner":"AIChatClient","signature":["close(): Promise<void>"],"doc":"Release any resources the client holds and complete its lifecycle.\n\nThe client is stateless per request — it injects/uses `fetch` and holds no\npooled socket or session of its own (unlike the python reference's owned\n`aiohttp.ClientSession`), so there is nothing to tear down; this is a no-op\nthat fulfills the reference's `close()` lifecycle contract. Safe to call more\nthan once. Prefer `await using` (below) where the runtime supports it.","file":"dist/ai-chat/AIChatClient.d.ts","line":307}]},"AIChatClientOptions":{"name":"AIChatClientOptions","kind":"interface","exported":true,"signature":["interface AIChatClientOptions"],"doc":"Constructor options for {@link AIChatClient}.","file":"dist/ai-chat/AIChatClient.d.ts","line":110,"members":[{"name":"project","kind":"property","owner":"AIChatClientOptions","signature":["project?: string"],"doc":"Project id (Basic-auth username). Falls back to `SIGNALWIRE_PROJECT_ID`.","file":"dist/ai-chat/AIChatClient.d.ts","line":112},{"name":"token","kind":"property","owner":"AIChatClientOptions","signature":["token?: string"],"doc":"API token (Basic-auth password). Falls back to `SIGNALWIRE_API_TOKEN`.","file":"dist/ai-chat/AIChatClient.d.ts","line":114},{"name":"space","kind":"property","owner":"AIChatClientOptions","signature":["space?: string"],"doc":"Space name; builds `https://{space}.signalwire.com/api/ai/chat`. Falls back to `SIGNALWIRE_SPACE`.","file":"dist/ai-chat/AIChatClient.d.ts","line":116},{"name":"url","kind":"property","owner":"AIChatClientOptions","signature":["url?: string"],"doc":"Fully-qualified endpoint URL, used verbatim (highest precedence).","file":"dist/ai-chat/AIChatClient.d.ts","line":118},{"name":"fetchImpl","kind":"property","owner":"AIChatClientOptions","signature":["fetchImpl?: typeof globalThis.fetch"],"doc":"Override the `fetch` implementation (dependency injection for tests).","file":"dist/ai-chat/AIChatClient.d.ts","line":120},{"name":"readIdleTimeoutSeconds","kind":"property","owner":"AIChatClientOptions","signature":["readIdleTimeoutSeconds?: number"],"doc":"Seconds without receiving any data (headers or body) before a request is\nabandoned. Not a limit on the whole turn: every chunk restarts it. Default\n60. `0` disables.","file":"dist/ai-chat/AIChatClient.d.ts","line":126}]},"AIChatError":{"name":"AIChatError","kind":"class","exported":true,"signature":["class AIChatError extends Error"],"doc":"Base error for AI Chat service failures. Every typed subclass carries the\nJSON-RPC error `code` (or `null` when the failure rode the success envelope,\nas with {@link SummaryError}) and the server `message`.\n\nCallers catch this one family (`instanceof AIChatError`) for every AI-Chat\nfailure and can branch on `code` or the subclass type.","file":"dist/ai-chat/AIChatClient.d.ts","line":47,"members":[{"name":"code","kind":"property","owner":"AIChatError","readonly":true,"signature":["readonly code: number | null"],"doc":"JSON-RPC error code, or `null` when the failure rode the success envelope.","file":"dist/ai-chat/AIChatClient.d.ts","line":49},{"name":"serverMessage","kind":"property","owner":"AIChatError","readonly":true,"signature":["readonly serverMessage: string"],"doc":"The server-provided error message (without the `[code]` prefix).","file":"dist/ai-chat/AIChatClient.d.ts","line":51},{"name":"constructor","kind":"constructor","owner":"AIChatError","signature":["constructor(code: number | null, message: string)"],"doc":"@param code - JSON-RPC error code, or `null` (a success-envelope failure).\n@param message - The server-provided error message.","file":"dist/ai-chat/AIChatClient.d.ts","line":56}],"bases":["Error"]},"AIVerbBuildOptions":{"name":"AIVerbBuildOptions","kind":"interface","exported":true,"signature":["interface AIVerbBuildOptions"],"doc":"Options accepted by {@link AIVerbHandler.buildConfig}.","file":"dist/SWMLHandler.d.ts","line":63,"members":[{"name":"promptText","kind":"property","owner":"AIVerbBuildOptions","signature":["promptText?: string"],"doc":"Text prompt for the AI (mutually exclusive with promptPom).","file":"dist/SWMLHandler.d.ts","line":65},{"name":"promptPom","kind":"property","owner":"AIVerbBuildOptions","signature":["promptPom?: Record<string, unknown>[]"],"doc":"POM structure for the AI prompt (mutually exclusive with promptText).","file":"dist/SWMLHandler.d.ts","line":67},{"name":"contexts","kind":"property","owner":"AIVerbBuildOptions","signature":["contexts?: Record<string, unknown>"],"doc":"Optional contexts and steps configuration (can be combined with text or pom).","file":"dist/SWMLHandler.d.ts","line":69},{"name":"postPrompt","kind":"property","owner":"AIVerbBuildOptions","signature":["postPrompt?: string"],"doc":"Optional post-prompt text.","file":"dist/SWMLHandler.d.ts","line":71},{"name":"postPromptUrl","kind":"property","owner":"AIVerbBuildOptions","signature":["postPromptUrl?: string"],"doc":"Optional URL for post-prompt processing.","file":"dist/SWMLHandler.d.ts","line":73},{"name":"swaig","kind":"property","owner":"AIVerbBuildOptions","signature":["swaig?: Record<string, unknown>"],"doc":"Optional SWAIG configuration.","file":"dist/SWMLHandler.d.ts","line":75}]},"AIVerbHandler":{"name":"AIVerbHandler","kind":"class","exported":true,"signature":["class AIVerbHandler extends SWMLVerbHandler"],"doc":"Handler for the SWML 'ai' verb.","file":"dist/SWMLHandler.d.ts","line":80,"members":[{"name":"getVerbName","kind":"method","owner":"AIVerbHandler","signature":["getVerbName(): string"],"doc":"Get the name of the verb this handler handles.\n@returns \"ai\" as the verb name.","file":"dist/SWMLHandler.d.ts","line":85},{"name":"validateConfig","kind":"method","owner":"AIVerbHandler","signature":["validateConfig(config: Record<string, unknown>): [boolean, string[]]"],"doc":"Validate the configuration for the AI verb.\n\nChecks that:\n- `prompt` is present and is an object\n- `prompt` contains exactly one of `text` or `pom` (mutually exclusive)\n- `prompt.contexts`, if present, is an object\n- `SWAIG`, if present, is an object\n\n@param config - The configuration dictionary for the AI verb.\n@returns A [isValid, errorMessages] tuple.","file":"dist/SWMLHandler.d.ts","line":98},{"name":"buildConfig","kind":"method","owner":"AIVerbHandler","signature":["buildConfig(opts?: AIVerbBuildOptions): Record<string, unknown>"],"doc":"Build a configuration for the AI verb.\n\nRequires exactly one of `promptText` or `promptPom` (mutually exclusive).\nThrows an `Error` if both or neither are provided.\n\nExtra keys in `opts` are routed as follows:\n- `languages`, `hints`, `pronounce`, `globalData` / `global_data` are placed at the top level of the config.\n- All other extra keys are placed into `config.params`.\n\n@param opts - Build options for the AI verb configuration.\n@returns AI verb configuration dictionary.","file":"dist/SWMLHandler.d.ts","line":112}],"bases":["SWMLVerbHandler"]},"Action":{"name":"Action","kind":"class","exported":true,"signature":["class Action"],"doc":"Async handle for a controllable call operation (play, record, tap, detect, etc.).\n\nAn Action is returned from the async variants on {@link Call} (e.g. `call.playAsync`).\nIt resolves when the server emits a terminal event for its `controlId`. Use\n{@link Action.wait} to await completion, or register an `onCompleted` callback.\n\n@example\n```ts\nimport { RelayClient } from '@signalwire/sdk';\nconst client = new RelayClient();\nclient.onCall(async (call) => {\n const play = await call.play([{ type: 'tts', params: { text: 'Hello!' } }]);\n // do other work while the greeting plays...\n const result = await play.wait(10); // seconds\n console.log('Playback finished with state', result.params.state);\n});\n```","file":"dist/relay/Action.d.ts","line":37,"members":[{"name":"call","kind":"property","owner":"Action","readonly":true,"signature":["readonly call: CallLike"],"doc":"Reference to the owning call.","file":"dist/relay/Action.d.ts","line":39},{"name":"controlId","kind":"property","owner":"Action","readonly":true,"signature":["readonly controlId: string"],"doc":"Unique control ID used by the server to route events back to this action.","file":"dist/relay/Action.d.ts","line":41},{"name":"result","kind":"property","owner":"Action","signature":["result: RelayEvent | null"],"doc":"Final event once the action terminates, or `null` while still running.","file":"dist/relay/Action.d.ts","line":46},{"name":"completed","kind":"property","owner":"Action","signature":["completed: boolean"],"doc":"Whether the action has reached a terminal state.","file":"dist/relay/Action.d.ts","line":48},{"name":"constructor","kind":"constructor","owner":"Action","signature":["constructor(call: CallLike, controlId: string, terminalEvent: string, terminalStates: readonly string[])"],"doc":"@param call - Owning call (via the structural {@link CallLike} interface).\n@param controlId - Unique control ID the server will echo on events.\n@param terminalEvent - Event type that carries terminal state transitions.\n@param terminalStates - State values that mark this action as completed.","file":"dist/relay/Action.d.ts","line":56},{"name":"wait","kind":"method","owner":"Action","signature":["wait(timeout?: number): Promise<RelayEvent>"],"doc":"Wait for the action to complete.\n\n@param timeout - Maximum time to wait in **seconds** (matches the Python\n SDK convention — not milliseconds).\n@returns The terminal {@link RelayEvent} for this action.\n@throws {Error} When the optional timeout elapses before the action ends.","file":"dist/relay/Action.d.ts","line":69},{"name":"isDone","kind":"accessor","owner":"Action","signature":["get isDone(): boolean"],"doc":"True once the action has reached a terminal state.","file":"dist/relay/Action.d.ts","line":71}]},"AddressesResource":{"name":"AddressesResource","kind":"class","exported":true,"signature":["class Addresses extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":7,"members":[{"name":"constructor","kind":"constructor","owner":"AddressesResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":8},{"name":"list","kind":"method","owner":"AddressesResource","signature":["list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<AddressListResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":9},{"name":"create","kind":"method","owner":"AddressesResource","signature":["create(label: string, country: string, first_name: string, last_name: string, street_number: string, street_name: string, city: string, state: string, postal_code: string, options?: {\n address_type?: AddressType;\n address_number?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<AddressResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":10},{"name":"get","kind":"method","owner":"AddressesResource","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<AddressResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":15},{"name":"delete","kind":"method","owner":"AddressesResource","signature":["delete(id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":16}],"bases":["BaseResource"]},"AgentBase":{"name":"AgentBase","kind":"class","exported":true,"signature":["class AgentBase extends SWMLService"],"doc":"Core agent class that composes an HTTP server, prompt management, session handling,\nSWAIG tool registry, and 5-phase SWML rendering into a single deployable unit.\n\nA single `AgentBase` is one HTTP-servable voice agent:\n\n- `GET /` returns the SWML call-flow document\n- `POST /swaig` dispatches SWAIG function calls to registered tool handlers\n- `POST /post_prompt` receives the end-of-call summary and invokes {@link onSummary}\n\nMost user agents either (a) subclass `AgentBase` and override `defineTools()` / `onSummary()`\nor (b) use one of the {@link ./prefabs/index.js | prefab agents} (e.g. `ReceptionistAgent`).\n\n@example Subclass with a custom tool\n```ts\nimport { AgentBase, FunctionResult } from '@signalwire/sdk';\n\nclass WeatherAgent extends AgentBase {\n static override PROMPT_SECTIONS = [\n { title: 'Role', body: 'You are a weather assistant.' },\n ];\n\n protected override defineTools(): void {\n this.defineTool({\n name: 'get_forecast',\n description: 'Return the forecast for a city.',\n parameters: {\n type: 'object',\n properties: { city: { type: 'string' } },\n required: ['city'],\n },\n handler: async ({ city }) => {\n const forecast = await fetchForecast(city as string);\n return new FunctionResult(forecast);\n },\n });\n }\n}\n\nconst agent = new WeatherAgent({ name: 'weather', route: '/' });\nawait agent.serve({ port: 3000 });\n```\n\n@example Imperative usage (no subclass)\n```ts\nconst agent = new AgentBase({ name: 'hello', route: '/' });\nagent.setPromptText('You are a friendly greeter.');\nagent.defineTool({\n name: 'say_hi',\n description: 'Respond with a greeting.',\n parameters: { type: 'object', properties: {} },\n handler: () => new FunctionResult('Hello from SignalWire!'),\n});\nawait agent.serve();\n```\n\n@see {@link FunctionResult} — builder for tool handler responses\n@see {@link ContextBuilder} — multi-step conversation state machines\n@see {@link DataMap} — server-side tools without webhooks\n@see {@link AgentServer} — host multiple agents on one HTTP server","file":"dist/AgentBase.d.ts","line":96,"members":[{"name":"agentId","kind":"property","owner":"AgentBase","signature":["agentId: string"],"doc":"Unique identifier for this agent instance.","file":"dist/AgentBase.d.ts","line":98},{"name":"log","kind":"property","owner":"AgentBase","signature":["log: Logger"],"doc":"Structured logger instance for this agent. Override the inherited\nSWMLService logger with an AgentBase-tagged one.","file":"dist/AgentBase.d.ts","line":150},{"name":"signingKey","kind":"accessor","owner":"AgentBase","signature":["get signingKey(): string | null"],"doc":"The resolved SignalWire Signing Key, or `null` when signature validation is\ndisabled — the reference's public `self.signing_key`.\n\nRead-only: the resolution order (explicit option → `SIGNALWIRE_SIGNING_KEY` →\n`null`) runs once at construction and the middleware is mounted against it, so a\npost-construction write would not take effect.","file":"dist/AgentBase.d.ts","line":184},{"name":"constructor","kind":"constructor","owner":"AgentBase","signature":["constructor(opts: AgentOptions)"],"doc":"Create a new AgentBase instance.\n@param opts - Agent configuration options including name, route, auth, and call settings.","file":"dist/AgentBase.d.ts","line":192},{"name":"PROMPT_SECTIONS","kind":"property","owner":"AgentBase","static":true,"signature":["static PROMPT_SECTIONS?: {\n title: string;\n body?: string;\n bullets?: string[];\n numbered?: boolean;\n}[]"],"doc":"Static prompt sections: subclasses can define these declaratively.\nEach entry is applied via promptAddSection() in the constructor.","file":"dist/AgentBase.d.ts","line":197},{"name":"defineTools","kind":"method","owner":"AgentBase","protected":true,"signature":["protected defineTools(): void"],"doc":"Lifecycle hook for subclasses to register their SWAIG tools. Override it\nand call `this.defineTool(...)` inside.\n\nYou do **not** need to call this yourself — the base class invokes it\nautomatically (exactly once) the first time tools are needed: on\n{@link renderSwml}, {@link getTools}, {@link serve}/{@link run}, or SWAIG\ndispatch. It runs lazily rather than from the base constructor because in\nJS/TS `super()` runs *before* a subclass's field initializers, so a\nbase-constructor call would see `undefined` fields. Deferring to first use\nguarantees all subclass fields are initialized.\n\nCalling `this.defineTools()` manually (the old convention) still works and\nis safe — the call is idempotent, so it will not double-register tools.","file":"dist/AgentBase.d.ts","line":220},{"name":"ensureToolsDefined","kind":"method","owner":"AgentBase","protected":true,"signature":["protected ensureToolsDefined(): void"],"doc":"Run {@link defineTools} exactly once. Idempotent: safe to call from any\ntool-consumption entry point and from a subclass constructor. This is how\n`defineTools()` gets auto-invoked without falling into the JS field-init\nordering trap (see {@link defineTools}).","file":"dist/AgentBase.d.ts","line":227},{"name":"onError","kind":"method","owner":"AgentBase","signature":["onError(handler: SwaigErrorHandler | undefined): this"],"doc":"Register an agent-level error hook invoked when any SWAIG tool handler\nthrows. It runs after a tool's own `onError` (if any) and lets you report\nfailures (Sentry/Datadog/logging) and optionally control the user-facing\nresponse — return a {@link FunctionResult} to override it, or nothing to\nfall back to the default message. The error is always contained, so a\nthrown handler never breaks the live call.\n\n@param handler - The error hook, or `undefined` to clear it.\n@returns `this`, for chaining.","file":"dist/AgentBase.d.ts","line":241},{"name":"getTools","kind":"method","owner":"AgentBase","signature":["getTools(): SwaigFunction[]"],"doc":"Public access to the list of registered tools.\n\nIn Python, `define_tools()` is public and returns `List[SWAIGFunction]`.\nIn TypeScript, `defineTools()` is a protected setup hook (void). This\nmethod provides the equivalent public \"get all tools\" capability.\n@returns Array of all registered SwaigFunction instances.","file":"dist/AgentBase.d.ts","line":250},{"name":"promptManager","kind":"accessor","owner":"AgentBase","signature":["get promptManager(): PromptManager"],"doc":"Public accessor for the PromptManager (POM).\n\nPython exposes `self.pom` as a public attribute. This getter\nprovides equivalent access for direct POM manipulation.","file":"dist/AgentBase.d.ts","line":257},{"name":"pom","kind":"accessor","owner":"AgentBase","signature":["get pom(): PromptObjectModel | null"],"doc":"Public accessor for the agent's POM as a {@link PromptObjectModel} instance.\n\nPython equivalent: ``agent.pom`` instance attribute (agent_base.py line 209)\nis a ``signalwire.pom.pom.PromptObjectModel`` when ``use_pom=True``,\nor ``None`` otherwise. This getter returns the equivalent TypeScript\n``PromptObjectModel`` instance — callers can use ``addSection``,\n``findSection``, ``renderMarkdown``, ``renderXml``, ``toJson``, ``toYaml``\nexactly as in Python.\n\nThe instance returned is a fresh snapshot built from the current\n``PomBuilder`` state, so mutating it does not feed back into the agent's\ninternal builder. To mutate the agent's prompt, use\n``promptAddSection`` / ``promptAddToSection`` / ``promptAddSubsection``.\n\n@returns A `PromptObjectModel` populated with the agent's sections, or `null` when POM mode is off.","file":"dist/AgentBase.d.ts","line":275},{"name":"nativeFunctions","kind":"accessor","owner":"AgentBase","signature":["get nativeFunctions(): string[]","set nativeFunctions(fns: string[])"],"doc":"Public accessor for the native functions list.\n\nPython exposes `self.native_functions` as a public read/write attribute.\n@returns A copy of the native functions list.","file":"dist/AgentBase.d.ts","line":282},{"name":"skillManager","kind":"accessor","owner":"AgentBase","signature":["get skillManager(): SkillManager"],"doc":"Public read-only accessor for the SkillManager.\n\nPython exposes `self.skill_manager` as a public attribute. This getter\nprovides equivalent read access.","file":"dist/AgentBase.d.ts","line":291},{"name":"setPromptText","kind":"method","owner":"AgentBase","signature":["setPromptText(text: string): this"],"doc":"Set the main system prompt text for the AI.\n@param text - The prompt text to use.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":297},{"name":"setPostPrompt","kind":"method","owner":"AgentBase","signature":["setPostPrompt(text: string): this"],"doc":"Set the post-prompt text evaluated after the call ends.\n@param text - The post-prompt text to use.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":303},{"name":"promptAddSection","kind":"method","owner":"AgentBase","signature":["promptAddSection(title: string, opts?: {\n body?: string;\n bullets?: string[];\n numbered?: boolean;\n numberedBullets?: boolean;\n subsections?: {\n title: string;\n body?: string;\n bullets?: string[];\n }[];\n}): this"],"doc":"Add a new section to the prompt with optional body, bullets, and subsections.\n@param title - Section heading.\n@param opts - Optional section content including body text, bullet points, and subsections.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":310},{"name":"promptAddToSection","kind":"method","owner":"AgentBase","signature":["promptAddToSection(title: string, opts?: {\n body?: string;\n bullet?: string;\n bullets?: string[];\n}): this"],"doc":"Append content to an existing prompt section.\n@param title - Title of the section to append to.\n@param opts - Content to add: body text, a single bullet, or multiple bullets.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":327},{"name":"promptAddSubsection","kind":"method","owner":"AgentBase","signature":["promptAddSubsection(parentTitle: string, title: string, opts?: {\n body?: string;\n bullets?: string[];\n}): this"],"doc":"Add a subsection under an existing prompt section.\n@param parentTitle - Title of the parent section.\n@param title - Title of the new subsection.\n@param opts - Optional body text and bullet points for the subsection.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":339},{"name":"promptHasSection","kind":"method","owner":"AgentBase","signature":["promptHasSection(title: string): boolean"],"doc":"Check whether a prompt section with the given title exists.\n@param title - Section title to look for.\n@returns True if the section exists.","file":"dist/AgentBase.d.ts","line":348},{"name":"getPrompt","kind":"method","owner":"AgentBase","signature":["getPrompt(): string"],"doc":"Get the fully rendered main prompt text.\n@returns The assembled prompt string.","file":"dist/AgentBase.d.ts","line":353},{"name":"getPromptPom","kind":"method","owner":"AgentBase","signature":["getPromptPom(): Record<string, unknown>[] | null"],"doc":"Get the raw POM (Prompt Object Model) structure as an array of section data objects,\nwhen the agent is in POM mode and has at least one section.\n\nMatches Python `get_prompt()` which returns `Union[str, List[Dict]]` — a raw list when\nin POM mode (via `pom.to_list()` / `pom.render_dict()`), or a string otherwise.\nThe TS `getPrompt()` always returns a string (rendered Markdown), so this companion\nmethod exposes the raw POM structure for callers that need it for serialisation or\ninspection (e.g. skills that inspect prompt sections).\n\n@returns An array of POM section data objects, or null if not in POM mode or POM is empty.","file":"dist/AgentBase.d.ts","line":366},{"name":"getPostPrompt","kind":"method","owner":"AgentBase","signature":["getPostPrompt(): string | null"],"doc":"Get the post-prompt text, if one has been set.\n@returns The post-prompt string, or null if not configured.","file":"dist/AgentBase.d.ts","line":371},{"name":"getRawPrompt","kind":"method","owner":"AgentBase","signature":["getRawPrompt(): string | null"],"doc":"Get the raw prompt text whatever `setPromptText` stored, or null when\nno raw prompt has been set.\n\nMatches Python `PromptManager.get_raw_prompt()` which returns the raw\nstored string or `None`. Use this instead of `getPrompt()` when you\nneed the unrendered text rather than the POM-rendered Markdown.\n\n@returns The raw prompt string, or null if not set.","file":"dist/AgentBase.d.ts","line":382},{"name":"setPromptPom","kind":"method","owner":"AgentBase","signature":["setPromptPom(pom: Record<string, unknown>[]): this"],"doc":"Set the prompt as a POM (Prompt Object Model) dictionary.\n\nReplaces the current POM sections with the provided structured data.\nEach entry should have `title`, and optionally `body`, `bullets`,\n`numbered`, `numberedBullets`, and `subsections`.\n\n@param pom - Array of POM section dictionaries.\n@returns This agent instance for chaining.\n@throws Error if POM mode is not enabled (`usePom: false`).","file":"dist/AgentBase.d.ts","line":394},{"name":"defineContexts","kind":"method","owner":"AgentBase","signature":["defineContexts(contexts?: ContextBuilder): ContextBuilder","defineContexts(contexts: Record<string, unknown>): this"],"doc":"Get the agent's contexts builder, creating it on first use, or replace it.\n\nCalled with no argument, it returns the builder the agent already has, so\ncalling it again adds to the same workflow, as in the Python SDK.\n\nGiven a plain object, it uses that object as the contexts, rendered as it\nis, and returns the agent, as the Python SDK does with a dict.\n\n@param contexts - A ContextBuilder to use in place of the current one, or\n the contexts as a plain object.\n@returns The active ContextBuilder, or the agent when given an object.","file":"dist/AgentBase.d.ts","line":408},{"name":"resetContexts","kind":"method","owner":"AgentBase","signature":["resetContexts(): this"],"doc":"Remove all contexts, returning the agent to a no-contexts state.\n\nThis is a convenience wrapper around `defineContexts().reset()`.\nUse it in a dynamic config callback when you need to rebuild\ncontexts from scratch for a specific request.\n\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":419},{"name":"getContexts","kind":"method","owner":"AgentBase","signature":["getContexts(): Record<string, unknown> | null"],"doc":"Get the contexts dictionary as serialised SWML, or null when no\ncontexts have been defined yet.\n\nMatches Python `PromptManager.get_contexts()` which returns the\ncontexts dict or `None`.\n\n@returns Contexts dict, or null when no contexts are defined.","file":"dist/AgentBase.d.ts","line":429},{"name":"addHint","kind":"method","owner":"AgentBase","signature":["addHint(hint: string): this"],"doc":"Add a single speech-recognition hint.\n@param hint - Word or phrase to boost in speech recognition.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":435},{"name":"addHints","kind":"method","owner":"AgentBase","signature":["addHints(hints: string[]): this"],"doc":"Add multiple speech-recognition hints at once.\n@param hints - Array of words or phrases to boost.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":441},{"name":"addPatternHint","kind":"method","owner":"AgentBase","signature":["addPatternHint(opts: {\n hint: string;\n pattern: string;\n replace: string;\n ignoreCase?: boolean;\n}): this"],"doc":"Add a pattern-based speech-recognition hint with find-and-replace behavior.\n@param opts - Pattern hint configuration with a descriptive hint label,\n regex pattern, replacement string, and optional case-insensitive flag.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":448},{"name":"addLanguage","kind":"method","owner":"AgentBase","signature":["addLanguage(config: LanguageConfig): this"],"doc":"Add a supported language to the AI configuration.\n@param config - Language configuration including name, code, voice, and optional fillers.\n `params` may be set to attach engine-specific tuning (voice stability,\n similarity boost, model knobs, etc.); only emitted into SWML when\n non-empty so existing entries stay byte-identical when no params are\n passed (Python ai_config_mixin.py `add_language`).\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":463},{"name":"setLanguages","kind":"method","owner":"AgentBase","signature":["setLanguages(languages: LanguageConfig[]): this"],"doc":"Replace all configured languages with a new list.\n@param languages - Array of language configurations.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":469},{"name":"setMultilingual","kind":"method","owner":"AgentBase","signature":["setMultilingual(config: Record<string, unknown>): this"],"doc":"Configure ASR-driven multilingual mode (Mode B).\n\nEmits a top-level `multilingual` object on the AI verb. The recognizer runs\nin code-switching mode and the agent answers in whatever language the caller\nactually spoke — the model does not pick the language. Mutually exclusive\nwith {@link setLanguages}; if both are set the server uses `multilingual` and\nignores `languages`.\n\n@param config - The multilingual config object (languages, allowed,\n start_language, min_switch_words, fillers, etc.).\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":483},{"name":"setLanguageParams","kind":"method","owner":"AgentBase","signature":["setLanguageParams(code: string, params: Record<string, unknown>): this"],"doc":"Set (or replace) the per-language `params` dict on an already-added\nlanguage. Useful when language entries are built up via {@link addLanguage}\nfirst and engine-specific tuning is added later (e.g., from a config\nloader).\n\nPython equivalent: `set_language_params(code, params)`. Passing an empty\nobject removes the `params` key entirely. Unknown codes are a no-op.\n\n@param code - Language code as previously passed to {@link addLanguage} (e.g. `\"en-US\"`).\n@param params - Engine-specific params dict to attach. Empty object removes the key.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":497},{"name":"getLanguageParams","kind":"method","owner":"AgentBase","signature":["getLanguageParams(code: string): Record<string, unknown> | undefined"],"doc":"Read the per-language `params` dict for a previously-added language.\n\nPython equivalent: `get_language_params(code)`. Returns `undefined` if the\ncode is unknown or the language has no params set — no exception path.\n\n@param code - Language code as previously passed to {@link addLanguage}.\n@returns The params dict if set, `undefined` otherwise (including when the code is unknown).","file":"dist/AgentBase.d.ts","line":507},{"name":"addPronunciation","kind":"method","owner":"AgentBase","signature":["addPronunciation(rule: PronunciationRule): this"],"doc":"Add a pronunciation override rule for the TTS engine.\n@param rule - Pronunciation rule specifying the text to replace and its substitute.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":513},{"name":"setPronunciations","kind":"method","owner":"AgentBase","signature":["setPronunciations(rules: PronunciationRule[]): this"],"doc":"Replace all pronunciation rules with a new list.\n@param rules - Array of pronunciation rule objects.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":519},{"name":"setParam","kind":"method","owner":"AgentBase","signature":["setParam(key: string, value: unknown): this"],"doc":"Set a single AI parameter (e.g. \"temperature\", \"top_p\").\n@param key - Parameter name.\n@param value - Parameter value.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":526},{"name":"setParams","kind":"method","owner":"AgentBase","signature":["setParams(params: Record<string, unknown>): this"],"doc":"Merge multiple AI parameters into the existing params object.\n@param params - Key-value pairs to merge.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":532},{"name":"setGlobalData","kind":"method","owner":"AgentBase","signature":["setGlobalData(data: Record<string, unknown>): this"],"doc":"**MERGES** `data` into the global_data object passed into the AI\nconfiguration. **Despite the name, this does NOT replace** the existing\nobject — existing keys are preserved and incoming keys overwrite only on\ncollision (it calls `.update()`-style merge, matching Python\n`set_global_data`). This is intentional: skills and other callers each\ncontribute keys via {@link updateGlobalData}, and a replacing\n`setGlobalData` would silently clobber their contributions.\n\n- To **add/override** keys while keeping the rest: this method or the\n identical {@link updateGlobalData}.\n- To **fully replace** global_data (clearing every prior key, including\n skill-contributed ones): use {@link replaceGlobalData}.\n\n@param data - Key-value pairs to merge into global data.\n@returns This agent instance for chaining.\n@see updateGlobalData - explicit merge alias.\n@see replaceGlobalData - true replace semantics.","file":"dist/AgentBase.d.ts","line":552},{"name":"updateGlobalData","kind":"method","owner":"AgentBase","signature":["updateGlobalData(data: Record<string, unknown>): this"],"doc":"Merge additional entries into the existing global_data object. Identical in\nbehavior to {@link setGlobalData} (both merge); use this name when the\nintent is explicitly \"add to\" rather than \"set\". Skills register their\nglobal data through this path.\n\n@param data - Key-value pairs to merge into global data.\n@returns This agent instance for chaining.\n@see replaceGlobalData - to clear prior keys instead of merging.","file":"dist/AgentBase.d.ts","line":563},{"name":"replaceGlobalData","kind":"method","owner":"AgentBase","signature":["replaceGlobalData(data: Record<string, unknown>): this"],"doc":"**REPLACES** the entire global_data object: every previously-set key\n(including skill-contributed keys) is cleared, and `data` becomes the new\nglobal_data. Use this when you genuinely want a fresh object — the\nunambiguous counterpart to the merging {@link setGlobalData} /\n{@link updateGlobalData}.\n\nA shallow copy of `data` is stored, so later mutations of the caller's\nobject do not leak into the agent.\n\nTS-native addition: Python's reference SDK has no replace path (its\n`set_global_data` only merges), so this has no Python counterpart — see\n`PORT_ADDITIONS.md`.\n\n@param data - The new global_data object (replaces all prior keys).\n@returns This agent instance for chaining.\n@see setGlobalData - the merging counterpart (does NOT clear prior keys).","file":"dist/AgentBase.d.ts","line":582},{"name":"setNativeFunctions","kind":"method","owner":"AgentBase","signature":["setNativeFunctions(funcs: string[]): this"],"doc":"Set the list of native SWAIG function names (built-in platform functions).\n@param funcs - Array of native function names.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":588},{"name":"SUPPORTED_INTERNAL_FILLER_NAMES","kind":"property","owner":"AgentBase","static":true,"readonly":true,"signature":["static readonly SUPPORTED_INTERNAL_FILLER_NAMES: ReadonlySet<string>"],"doc":"The complete set of internal SWAIG function names that accept fillers,\nmatching the SWAIGInternalFiller schema definition. Any name outside\nthis set is silently ignored by the runtime — addInternalFiller /\nsetInternalFillers warn if you pass an unknown name.","file":"dist/AgentBase.d.ts","line":595},{"name":"setInternalFillers","kind":"method","owner":"AgentBase","signature":["setInternalFillers(internalFillers: Record<string, Record<string, string[]>>): this"],"doc":"Set internal fillers for native SWAIG functions.\n\nInternal fillers are short phrases the AI agent speaks (via TTS) while\nan internal/native function is running, so the caller doesn't hear\ndead air during transitions or background work.\n\nSupported function names (matches the SWAIGInternalFiller schema):\n\n hangup — when the agent is hanging up\n check_time — when checking the time\n wait_for_user — when waiting for user input\n wait_seconds — during deliberate pauses\n adjust_response_latency — when adjusting response timing\n next_step — transitioning between steps in prompt.contexts\n change_context — switching between contexts in prompt.contexts\n get_visual_input — processing visual input (enable_vision=true)\n get_ideal_strategy — thinking (enable_thinking=true)\n\nNotably NOT supported: change_step, gather_submit, or arbitrary\nuser-defined SWAIG function names. The runtime only honors fillers\nfor the names listed above; everything else is silently ignored at\nthe SWML level. This method warns at registration time if you pass\nan unknown name so you catch the typo early.\n\n@param internalFillers - Map of function name to language-keyed filler phrases.\n@returns This agent instance for chaining.\n\n@example\nagent.setInternalFillers({\n next_step: {\n 'en-US': ['Moving to the next step...', 'Great, let us continue...'],\n 'es': ['Pasando al siguiente paso...']\n },\n check_time: {\n 'en-US': ['Let me check the time...']\n }\n});","file":"dist/AgentBase.d.ts","line":635},{"name":"addInternalFiller","kind":"method","owner":"AgentBase","signature":["addInternalFiller(functionName: string, languageCode: string, fillers: string[]): this"],"doc":"Add internal filler phrases for a single internal function and language.\n\nSee {@link setInternalFillers} for the complete list of supported\nfunctionName values and an explanation of what fillers do.\n\n@param functionName - One of the supported internal function names\n (see SUPPORTED_INTERNAL_FILLER_NAMES). Names outside the supported\n set log a warning and are ignored by the runtime.\n@param languageCode - BCP-47 language code for the fillers (e.g. 'en-US').\n@param fillers - Array of filler phrases.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":649},{"name":"addFunctionInclude","kind":"method","owner":"AgentBase","signature":["addFunctionInclude(url: string, functions: string[], metaData?: Record<string, unknown>): this"],"doc":"Add a remote SWAIG function include reference.\n@param url - URL of the remote SWAIG endpoint.\n@param functions - Function names available at that endpoint.\n@param metaData - Optional metadata to attach to the include.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":657},{"name":"setFunctionIncludes","kind":"method","owner":"AgentBase","signature":["setFunctionIncludes(includes: FunctionInclude[]): this"],"doc":"Replace the entire list of function includes.\nEach include must have a `url` and `functions` array.\n@param includes - Array of function include objects.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":664},{"name":"setPromptLlmParams","kind":"method","owner":"AgentBase","signature":["setPromptLlmParams(params: Record<string, unknown>): this"],"doc":"Merge LLM-specific parameters into the main prompt configuration (e.g. model, temperature).\n@param params - Key-value LLM parameters to merge.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":670},{"name":"setPostPromptLlmParams","kind":"method","owner":"AgentBase","signature":["setPostPromptLlmParams(params: Record<string, unknown>): this"],"doc":"Merge LLM-specific parameters into the post-prompt configuration.\n@param params - Key-value LLM parameters to merge.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":676},{"name":"enableDebugEvents","kind":"method","owner":"AgentBase","signature":["enableDebugEvents(level?: number): this"],"doc":"Enable debug event webhooks for this agent.\n@param level - Debug verbosity level (defaults to 1).\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":682},{"name":"enableSipRouting","kind":"method","owner":"AgentBase","signature":["enableSipRouting(autoMap?: boolean, path?: string): this"],"doc":"Enable SIP routing for this agent.\n@param autoMap - When true, automatically map SIP usernames to the agent route (defaults to true).\n@param path - HTTP path for the SIP routing endpoint (defaults to '/sip').\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":689},{"name":"registerSipUsername","kind":"method","owner":"AgentBase","signature":["registerSipUsername(username: string): this"],"doc":"Register a SIP username to route to this agent.\n@param username - The SIP username to register.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":695},{"name":"autoMapSipUsernames","kind":"method","owner":"AgentBase","signature":["autoMapSipUsernames(): this"],"doc":"Automatically register common SIP usernames based on this agent's\nname and route. Derives cleaned variants (alphanumeric + underscore)\nand registers each via `registerSipUsername()`.\n\nPort of Python's `auto_map_sip_usernames()`:\n- Registers a cleaned version of the agent name\n- Registers a cleaned version of the route (if different from name)\n- For names longer than 3 characters, also registers a vowel-stripped variant\n\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":708},{"name":"registerRoutingCallback","kind":"method","owner":"AgentBase","signature":["registerRoutingCallback(callback: RoutingCallback, path?: string): this"],"doc":"Register a callback at a specific HTTP path that decides how to route an\nincoming request.\n\nWhen called, the endpoint at `path` will invoke `callback` with the parsed\nrequest body. If `callback` returns a non-empty route string the server\nresponds with a `307` redirect to it (`Location: <route>`), so the\nrequest goes to the right agent. If `callback` returns `null` / `undefined` the\nagent's own SWML is returned instead (normal processing).\n\nMirrors Python `swml_service.register_routing_callback` /\n`web_mixin.register_routing_callback`.\n\n@param callback - Function receiving the parsed request body and returning a\n route string to redirect, or null/undefined for normal processing.\n@param path - HTTP path where this callback endpoint is registered\n (default: '/sip').\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":728},{"name":"extractSipUsername","kind":"method","owner":"AgentBase","static":true,"signature":["static extractSipUsername(requestBody: SwmlRequestData): string | null"],"doc":"Extract the SIP username from a request body's call.to field.\n@param requestBody - The parsed request body containing call information.\n@returns The extracted SIP username, or null if not found.","file":"dist/AgentBase.d.ts","line":734},{"name":"addMcpServer","kind":"method","owner":"AgentBase","signature":["addMcpServer(url: string, opts?: {\n headers?: Record<string, string>;\n resources?: boolean;\n resourceVars?: Record<string, string>;\n}): this"],"doc":"Add an external MCP server for tool discovery and invocation.\nTools are discovered via MCP protocol at session start and added to the AI's tool list.\n@param url - MCP server HTTP endpoint URL\n@param opts - Optional configuration: headers, resources, resourceVars\n@returns This agent instance for chaining","file":"dist/AgentBase.d.ts","line":742},{"name":"enableMcpServer","kind":"method","owner":"AgentBase","signature":["enableMcpServer(): this"],"doc":"Expose this agent's tools as an MCP server endpoint at /mcp.\nAdds a JSON-RPC 2.0 endpoint that MCP clients (Claude Desktop, other agents) can connect to.\nThe endpoint requires the agent's basic auth credentials, and lists and\ncalls only the tools the agent runs itself (not DataMap or external webhook tools).\n@returns This agent instance for chaining","file":"dist/AgentBase.d.ts","line":754},{"name":"isMcpServerEnabled","kind":"method","owner":"AgentBase","signature":["isMcpServerEnabled(): boolean"],"doc":"Check if MCP server endpoint is enabled.","file":"dist/AgentBase.d.ts","line":756},{"name":"getMcpServers","kind":"method","owner":"AgentBase","signature":["getMcpServers(): Record<string, unknown>[]"],"doc":"Get configured MCP servers (read-only copy).","file":"dist/AgentBase.d.ts","line":758},{"name":"handleMcpRequest","kind":"method","owner":"AgentBase","signature":["handleMcpRequest(body: Record<string, unknown>): Promise<Record<string, unknown>>"],"doc":"Handle an MCP JSON-RPC 2.0 request. Returns the response object.","file":"dist/AgentBase.d.ts","line":768},{"name":"defineTypedTool","kind":"method","owner":"AgentBase","signature":["defineTypedTool(opts: {\n name: string;\n description: string;\n parameters?: Record<string, unknown>;\n /**\n * The typed handler. Receives the AI-extracted arguments as named\n * positional parameters (in declaration order), optionally with a trailing\n * `rawData` record, and returns a SWAIG result. Precisely typed as\n * {@link TypedToolHandler} rather than the bare `Function` so a non-callable\n * — or a callable that returns nothing usable — is a compile-time error.\n */\n handler: TypedToolHandler;\n secure?: boolean;\n fillers?: Record<string, string[]>;\n waitFile?: string;\n waitFileLoops?: number;\n required?: string[];\n}): this"],"doc":"Register a SWAIG tool with a typed handler that receives named parameters\ninstead of the standard `(args, rawData)` convention.\n\nThe SDK wraps the handler to unpack the args dict into positional params.\nIf no `parameters` schema is provided, one is inferred from the handler's\nsource code (parameter names and default values).\n\n@param opts - Tool definition with a typed handler function.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":780},{"name":"validateToolToken","kind":"method","owner":"AgentBase","signature":["validateToolToken(functionName: string, token: string, callId: string): boolean"],"doc":"Validate a tool-call token for the given function.\n\nMirrors Python reference `core/mixins/state_mixin.py validate_tool_token`:\n1. Unknown function → `false`.\n2. Registered but non-secure → `true` without consulting SessionManager\n (non-secure tools never require a token).\n3. Raw-dict descriptors (e.g. DataMap) are treated as secure, matching\n Python's `isinstance(func, dict) → is_secure = True` branch.\n4. Missing token on a secure tool → `false`.\n5. Otherwise delegate to `SessionManager.validateToolToken`.\n\nDivergences from the Python reference:\n- No debug-logging branch: `AgentBase` does not expose an agent-level\n debug-mode flag, so the per-call debug telemetry Python emits is\n omitted. `SessionManager` still logs its own validation outcomes.\n- No token-derived call-id fallback: `SessionManager.debugToken`\n truncates the embedded call-id for log safety, so an extracted value\n cannot be round-tripped back through `validateToolToken`. The caller\n is expected to supply a non-empty `callId`; an empty one is forwarded\n unchanged and the underlying validator will reject it.","file":"dist/AgentBase.d.ts","line":820},{"name":"createToolToken","kind":"method","owner":"AgentBase","signature":["createToolToken(toolName: string, callId: string): string"],"doc":"Mint a per-call SWAIG-function token via the agent's SessionManager.\n\nMirrors Python reference `core/mixins/state_mixin.py _create_tool_token`:\ndelegates to `SessionManager.createToolToken` and returns an empty\nstring on any failure (Python catches all exceptions and returns \"\").","file":"dist/AgentBase.d.ts","line":828},{"name":"addPreAnswerVerb","kind":"method","owner":"AgentBase","signature":["addPreAnswerVerb(verbName: string, config: Record<string, unknown> | number): this"],"doc":"Add a SWML verb to execute before the answer phase (phase 1).\n@param verbName - Name of the SWML verb (e.g. \"play\", \"record\").\n@param config - Verb configuration object.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":835},{"name":"addAnswerVerb","kind":"method","owner":"AgentBase","signature":["addAnswerVerb(config?: Record<string, unknown>): this"],"doc":"Configure the answer verb (phase 2) with optional settings.\n@param config - Optional answer verb configuration.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":841},{"name":"addPostAnswerVerb","kind":"method","owner":"AgentBase","signature":["addPostAnswerVerb(verbName: string, config: Record<string, unknown> | number): this"],"doc":"Add a SWML verb to execute after the answer phase but before the AI verb (phase 3).\n@param verbName - Name of the SWML verb.\n@param config - Verb configuration object.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":848},{"name":"addPostAiVerb","kind":"method","owner":"AgentBase","signature":["addPostAiVerb(verbName: string, config: Record<string, unknown>): this"],"doc":"Add a SWML verb to execute after the AI verb (phase 5).\n@param verbName - Name of the SWML verb.\n@param config - Verb configuration object.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":855},{"name":"clearPreAnswerVerbs","kind":"method","owner":"AgentBase","signature":["clearPreAnswerVerbs(): this"],"doc":"Remove all pre-answer verbs.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":860},{"name":"clearPostAnswerVerbs","kind":"method","owner":"AgentBase","signature":["clearPostAnswerVerbs(): this"],"doc":"Remove all post-answer verbs.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":865},{"name":"clearPostAiVerbs","kind":"method","owner":"AgentBase","signature":["clearPostAiVerbs(): this"],"doc":"Remove all post-AI verbs.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":870},{"name":"getName","kind":"method","owner":"AgentBase","signature":["getName(): string"],"doc":"Get the agent's display name.\n@returns The agent name string.","file":"dist/AgentBase.d.ts","line":875},{"name":"addSkill","kind":"method","owner":"AgentBase","signature":["addSkill(skill: SkillBase): Promise<this>"],"doc":"Add a skill to this agent, registering its tools, prompt sections, hints, and global data.\n@param skill - The skill instance to add.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":881},{"name":"addSkillByName","kind":"method","owner":"AgentBase","signature":["addSkillByName(skillName: SkillNameOrString, params?: SkillConfig): Promise<this>"],"doc":"Add a skill by its registered name, looking it up in the global SkillRegistry.\n\nMatches Python's `add_skill(skill_name, params)` which loads skills by string\nname via the SkillManager registry. Throws a `ValueError`-equivalent if the\nskill name is not found in the registry.\n\nAccepts a typed {@link SkillNameOrString}: one of the built-in\n{@link SkillName} values (autocompleted) or any other string for custom\nand third-party skills. Because any string is accepted, a misspelled name\ncompiles, and this rejects at runtime because it isn't registered. The value is\nforwarded to the registry unchanged — the typing is erased at runtime, so\nthis matches Python's bare-`str` `add_skill(skill_name, params)`.\n\n@param skillName - The name the skill was registered under in the SkillRegistry.\n@param params - Optional configuration parameters forwarded to the skill factory.\n@returns This agent instance for chaining.\n@throws Error if no skill with the given name is registered.","file":"dist/AgentBase.d.ts","line":901},{"name":"removeSkill","kind":"method","owner":"AgentBase","signature":["removeSkill(instanceId: string): Promise<boolean>"],"doc":"Remove a previously added skill by its instance ID.\n@param instanceId - The unique instance ID of the skill to remove.\n@returns True if the skill was found and removed.","file":"dist/AgentBase.d.ts","line":907},{"name":"listSkills","kind":"method","owner":"AgentBase","signature":["listSkills(): {\n name: string;\n instanceId: string;\n initialized: boolean;\n}[]"],"doc":"List all registered skills with their names, instance IDs, and initialization status.\n@returns Array of skill descriptors.","file":"dist/AgentBase.d.ts","line":912},{"name":"hasSkill","kind":"method","owner":"AgentBase","signature":["hasSkill(skillName: SkillNameOrString): boolean"],"doc":"Check whether a skill with the given name is registered.\n\nAccepts a typed {@link SkillNameOrString} so built-in names autocomplete;\nany other string is accepted too (custom skills, matching Python's\nbare-`str` `has_skill`), so a misspelled name compiles and returns false.\n\n@param skillName - The skill name to check.\n@returns True if a skill with that name exists.","file":"dist/AgentBase.d.ts","line":927},{"name":"removeSkillByName","kind":"method","owner":"AgentBase","signature":["removeSkillByName(skillName: string): Promise<boolean>"],"doc":"Remove a skill by its name (matches the Python SDK).\n\nPython's `remove_skill(skill_name)` removes by skill name.\nThe existing `removeSkill(instanceId)` removes by instance ID.\nThis method provides name-based removal to match the Python SDK.\n\n@param skillName - The skill name to remove.\n@returns True if a skill with that name was found and removed.","file":"dist/AgentBase.d.ts","line":938},{"name":"setDynamicConfigCallback","kind":"method","owner":"AgentBase","signature":["setDynamicConfigCallback(cb: DynamicConfigCallback): this"],"doc":"Set a callback that configures a per-request copy of this agent.\n\nOn each request that renders SWML, runs a SWAIG function or delivers a\nsummary, the SDK makes a copy of this agent, calls the callback with the\nrequest's query parameters, body and headers (credential-bearing headers\nremoved) and the copy, and handles the request with the copy. Tool\nhandlers get the copy as their third argument, and `onSummary` runs on it.\n\nThe copy has its own prompt, tools, skills list, hints, languages,\npronunciations, params, global data, function includes, LLM params,\nfillers, call-flow verbs, SWAIG query params, native functions, MCP\nservers, SIP usernames, routing callbacks and contexts, so changing any of\nthem with the agent's methods affects only this request. Anything else is\nshared with this agent and every request in flight: a field a subclass\nadds, a skill instance, or an object inside the configuration that isn't\nplain data (a `URL`, a class instance). Assigning a new value to such a\nfield on the copy is safe; mutating a shared object in place is not.\n\nA handler that captured this agent (an arrow function, or a method passed\nwith `.bind(this)`) still sees this agent, not the copy: read per-call\nconfiguration from the handler's third argument. A subclass's JavaScript\n`#private` fields aren't on the copy, so its methods that read them\nthrow there; use TypeScript `private` fields.\n\n@param cb - Callback receiving `(queryParams, bodyParams, headers, agent)` where\n `agent` is the ephemeral `AgentBase` copy to mutate. May be async.\n@returns This agent instance for chaining.\n\n@example\n```ts\nagent.setDynamicConfigCallback((query, body, headers, agent) => {\n const lang = query.lang ?? 'en';\n if (lang === 'es') {\n (agent as AgentBase).setPromptText('Eres un asistente útil.');\n }\n});\n```","file":"dist/AgentBase.d.ts","line":987},{"name":"addPerCallConfig","kind":"method","owner":"AgentBase","signature":["addPerCallConfig(cb: DynamicConfigCallback): this"],"doc":"Register a per-request configuration callback, keeping any already set.\n\nSame signature and contract as {@link setDynamicConfigCallback}, except\nthat callbacks accumulate instead of replacing each other. They run in\nregistration order on the same per-request copy, so a later one sees what\nan earlier one configured. This is the composable form: a base class and a\nsubclass, or an agent and a helper, can each register what they own\nwithout knowing about each other. `setDynamicConfigCallback` replaces\nevery callback registered so far.\n\n@param cb - Callback receiving `(queryParams, bodyParams, headers, agent)`,\n where `agent` is the per-request copy. Configure that, never the agent\n itself, or the configuration leaks across callers. May be async.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":1004},{"name":"onCallEnd","kind":"method","owner":"AgentBase","signature":["onCallEnd(handler: (callLog: Record<string, unknown>[], rawData: SwaigRequest) => void | Promise<void>): (callLog: Record<string, unknown>[], rawData: SwaigRequest) => void | Promise<void>"],"doc":"Register a handler that runs when the call ends, with the transcript.\n\nHandlers run in registration order with `(callLog, rawData)`: the\nconversation as the platform recorded it, and the whole SWAIG request\n(with `global_data` and `call_id`). This wraps the platform's reserved\n`hangup_hook` function, which fires on hangup and is never offered to the\nmodel, so it can't be called early or skipped.\n\nRegistering a handler also turns on the `swaig_post_conversation`\nparameter: without it the hook still fires, but carries no transcript,\nand the handler gets an empty list with nothing to say why. If that\nparameter is explicitly `false`, it's left alone and a warning is logged.\n\nA handler's return value is ignored (the call is over), and an exception\nis logged, not raised, so a failing handler doesn't stop the others.\n\n@param handler - Called with `(callLog, rawData)`; may be async.\n@returns The handler.\n\n@example\n```ts\nagent.onCallEnd((callLog, rawData) => {\n archive(rawData.global_data?.['conversation_id'], callLog);\n});\n```","file":"dist/AgentBase.d.ts","line":1032},{"name":"mount","kind":"method","owner":"AgentBase","signature":["mount(appOrRouter: Hono | ((req: Request) => Response | Promise<Response>), opts?: {\n prefix?: string;\n name?: string;\n}): this"],"doc":"Mount an extra Hono app, or a fetch handler, alongside this agent's routes.\n\nUse this instead of adding routes to {@link getApp}'s app by hand: the\nagent rebuilds its app when its routes change (a routing callback, say),\nand a mount is replayed on every build. A mounted app answers its own\nCORS preflights (the agent's CORS and CSRF middleware don't apply to it),\nsets its own security headers, and isn't behind the agent's basic auth.\nMount before calling `serve()`.\n\n@param appOrRouter - A Hono app (its routes are added under `prefix`) or a\n fetch handler `(request) => Response` (mounted at `prefix`, which it\n doesn't see).\n@param opts - `prefix`: the path to mount at, from the host root (a\n trailing slash is dropped; default the root). `name`: accepted so\n code written for the Python SDK works; it has no effect here.\n@returns This agent instance for chaining.\n\n@example\n```ts\nagent.mount(gateway.router(), { prefix: '/chat' });\n```","file":"dist/AgentBase.d.ts","line":1058},{"name":"addSwaigQueryParams","kind":"method","owner":"AgentBase","signature":["addSwaigQueryParams(params: Record<string, string>): this"],"doc":"Add extra query parameters appended to all SWAIG webhook URLs.\n@param params - Key-value pairs to append as query parameters.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":1067},{"name":"clearSwaigQueryParams","kind":"method","owner":"AgentBase","signature":["clearSwaigQueryParams(): this"],"doc":"Clear all SWAIG query parameters.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":1072},{"name":"manualSetProxyUrl","kind":"method","owner":"AgentBase","signature":["manualSetProxyUrl(url: string): this"],"doc":"Manually set the proxy base URL used for webhook URL generation.\n@param url - The external-facing base URL (trailing slashes are stripped).\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":1078},{"name":"enableDebugRoutes","kind":"method","owner":"AgentBase","signature":["enableDebugRoutes(): this"],"doc":"Register a callback function that determines routing based on POST data.\n\nWhen a routing callback is registered, an endpoint at the specified path\nis created in `getApp()`. The callback receives the request body and returns\nEnable debug routes for testing and development.\n\nThis is a backward-compatibility stub matching the Python SDK.\nIn the TypeScript SDK, debug routes (health, ready, debug_events)\nare automatically registered in `getApp()`.\n\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":1092},{"name":"setWebHookUrl","kind":"method","owner":"AgentBase","signature":["setWebHookUrl(url: string): this"],"doc":"Override the default SWAIG webhook URL with a custom one.\n@param url - The custom webhook URL.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":1099},{"name":"setPostPromptUrl","kind":"method","owner":"AgentBase","signature":["setPostPromptUrl(url: string): this"],"doc":"Override the default post-prompt webhook URL with a custom one.\n@param url - The custom post-prompt URL.\n@returns This agent instance for chaining.","file":"dist/AgentBase.d.ts","line":1105},{"name":"getFullUrl","kind":"method","owner":"AgentBase","signature":["getFullUrl(includeAuth?: boolean): string"],"doc":"Get the full external URL of this agent, using the proxy base URL if available.\n@param includeAuth - Whether to embed basic-auth credentials in the URL (defaults to false).\n@returns The fully-qualified URL string.","file":"dist/AgentBase.d.ts","line":1111},{"name":"onSummary","kind":"method","owner":"AgentBase","signature":["onSummary(_summary: PostPromptData | null, _rawData: PostPrompt): void | Record<string, unknown> | Promise<void | Record<string, unknown>>"],"doc":"Lifecycle hook called when a post-prompt summary is received. Override in subclasses.\n\nInvoked once at the end of a call when the AI has produced a structured summary\n(configured via `setPostPrompt()`). Use this hook to persist\ncall data, notify other systems, or trigger follow-up workflows.\n\n@param _summary - Parsed summary object (JSON when the post-prompt requests\n structured output), or `null` if extraction/parsing failed.\n@param _rawData - Full raw post-prompt payload received from the platform,\n including call metadata, conversation history, and the summary text.\n\nWith a dynamic config callback set, this runs on the request's configured\ncopy of the agent. For a request whose `action` is `fetch_conversation`,\nan override may return the conversation (for example\n`{ conversation_summary: '...' }`); the post-prompt endpoint sends that\nback instead of `{ success: true }`.\n\n@example\n```ts\nclass MyAgent extends AgentBase {\n async onSummary(summary, rawData) {\n if (!summary) return;\n await db.calls.insert({\n callSid: rawData.call_id,\n summary,\n endedAt: new Date(),\n });\n }\n}\n```","file":"dist/AgentBase.d.ts","line":1151},{"name":"onRequest","kind":"method","owner":"AgentBase","signature":["onRequest(requestData?: SwmlRequestData | null, callbackPath?: string | null): Record<string, unknown> | void | Promise<Record<string, unknown> | void>"],"doc":"Lifecycle hook called when SWML is requested. Default delegates to\n{@link onSwmlRequest} and returns its result. Subclasses typically\noverride `onSwmlRequest` rather than this method.\n\nMatches Python `WebMixin.on_request(request_data, callback_path)`. The\ncross-language API is the two-arg form; the Hono `context` argument is\na TypeScript-side extra preserved for callers that already have it but\nis not part of the audited surface.\n\n@param requestData - The parsed request body.\n@param callbackPath - Optional callback path from the request.\n@returns Optionally a dict of SWML modifications, or undefined for\n default rendering.","file":"dist/AgentBase.d.ts","line":1167},{"name":"onSwmlRequest","kind":"method","owner":"AgentBase","signature":["onSwmlRequest(_rawData: SwmlRequestData, _callbackPath?: string, _context?: Context): Record<string, unknown> | void | Promise<Record<string, unknown> | void>"],"doc":"Lifecycle hook called on every SWML request before rendering. Override in subclasses.\n\nMay optionally return a modification dict that will be merged into the\nrendered SWML document (matching Python's `Optional[dict]` return type).\n\nMatches Python `on_swml_request(request_data, callback_path, request)` — the third\nparameter is the FastAPI `Request` in Python; here it is the raw Hono context object\nso that subclasses can access query parameters (`context.req.query()`), raw request\nheaders (`context.req.raw.headers`), etc.\n\n@param _rawData - The parsed request body.\n@param _callbackPath - Optional callback path from the request.\n@param _context - The raw Hono context object (c), providing access to headers and query params.\n@returns Optionally a dict of SWML modifications, or void.","file":"dist/AgentBase.d.ts","line":1184},{"name":"handleRequest","kind":"method","owner":"AgentBase","signature":["handleRequest(method: string, url: string, headers: Record<string, string>, body?: Record<string, unknown> | null): Promise<[number, Record<string, string>, string]>"],"doc":"Framework-free request-dispatch core for AgentBase.\n\nOverrides {@link SWMLService.handleRequest} so the primitive dispatch surface\nrenders SWML via AgentBase's {@link renderSwml} (mirroring the Hono root path)\ninstead of the base `renderDocument`. Performs basic-auth, the routing-callback\ncheck `(body, headers)`, and `onSwmlRequest` modification over plain\nprimitives, returning a `[status, headers, bodyString]` triple with the\n401-auth and 307-redirect behavior preserved. Mirrors Python's\n`AgentBase.handle_request(method, url, headers, body)`.\n\n@param method HTTP method, e.g. `\"GET\"` or `\"POST\"`.\n@param url The full request URL.\n@param headers Request headers as a plain dict.\n@param body The already-parsed JSON body for POST requests, or `undefined`.\n@returns A `[statusCode, responseHeaders, bodyString]` triple.","file":"dist/AgentBase.d.ts","line":1202},{"name":"onDebugEvent","kind":"method","owner":"AgentBase","signature":["onDebugEvent(_event: Record<string, unknown>): void | Promise<void>"],"doc":"Lifecycle hook called when a debug event webhook is received. Override in subclasses.\n@param _event - The debug event payload.","file":"dist/AgentBase.d.ts","line":1220},{"name":"validateBasicAuth","kind":"method","owner":"AgentBase","signature":["validateBasicAuth(username: string, password: string): boolean | Promise<boolean>"],"doc":"Check a request's basic-auth credentials. Every route that requires\nbasic auth calls it. The default compares them with the agent's\ncredentials in constant time; override it to check credentials another\nway, as the Python SDK's `validate_basic_auth` allows. An override\nreplaces the comparison, so call `super.validateBasicAuth()` to keep it.\n@param username - The username from the request.\n@param password - The password from the request.\n@returns True if the credentials are valid; false to reject the request.","file":"dist/AgentBase.d.ts","line":1231},{"name":"onFunctionCall","kind":"method","owner":"AgentBase","signature":["onFunctionCall(_name: string, _args: Record<string, unknown>, _rawData: Record<string, unknown>): Record<string, unknown> | void | Promise<Record<string, unknown> | void>"],"doc":"Hook called before each SWAIG function execution. Override in subclasses.\n\n**Behavioral note:** In the Python SDK, `on_function_call` IS the dispatcher\n— it retrieves and executes the function, returning the result. In TypeScript,\n`fn.execute()` is called separately after this hook. However, if this method\nreturns a non-void value, it is used as the result and the default execution\nis skipped, enabling dispatch interception matching the Python SDK.\n\n@param _name - Name of the function about to execute.\n@param _args - Parsed arguments for the function.\n@param _rawData - The full raw SWAIG request payload.\n@returns Optionally a result dict to short-circuit default execution,\n or void/undefined to proceed normally.","file":"dist/AgentBase.d.ts","line":1247},{"name":"renderSwml","kind":"method","owner":"AgentBase","signature":["renderSwml(callId?: string, modifications?: Record<string, unknown>): string"],"doc":"Render the complete SWML document by assembling all 5 phases: pre-answer, answer,\npost-answer, AI, and post-AI verbs.\n\n@param callId - Optional call ID to use for session tokens; auto-generated if omitted.\n@param modifications - Optional dict returned from `onSwmlRequest` to merge into the AI\n verb config before rendering. Matches Python's `_render_swml(modifications)` semantics:\n `global_data` is deep-merged; all other keys override the AI config directly.\n@returns The rendered SWML document as a JSON string.","file":"dist/AgentBase.d.ts","line":1288},{"name":"getApp","kind":"method","owner":"AgentBase","signature":["getApp(): Hono"],"doc":"Get or lazily create the Hono HTTP application with all routes, middleware, auth, and CORS.\n@returns The configured Hono application instance.","file":"dist/AgentBase.d.ts","line":1308},{"name":"asRouter","kind":"method","owner":"AgentBase","signature":["asRouter(): HostAppRouter"],"doc":"Get a router to embed this agent's routes in a host web app.\n\nReturns a Hono sub-app with this agent's routes relative to its root\n(`/`, `/swaig`, `/post_prompt`, plus any routing callbacks), for the host\nto mount under the agent's route: `hostApp.route(agent.route,\nagent.asRouter())`. This is the TypeScript realization of Python's\n`as_router()`, which is route-relative the same way; the named\n{@link HostAppRouter} type is the cross-port \"embed my routes in a host\napp\" contract. {@link getApp} serves the same routes under the agent's\nroute.\n\n@returns A mountable Hono sub-app carrying this agent's routes.","file":"dist/AgentBase.d.ts","line":1335},{"name":"serve","kind":"method","owner":"AgentBase","signature":["serve(opts?: {\n host?: string;\n port?: number;\n}): Promise<void>"],"doc":"Start the HTTP server and begin listening for requests.\n\nUses `@hono/node-server` under the hood. When run in CLI mode\n(`SWAIG_CLI_MODE=true`, set automatically by `npx swaig-test`), this is a\nno-op so agent config can be inspected without starting a server.\n\n@param opts - Optional host/port overrides. Defaults to the values provided\n in the constructor options or the `PORT` environment variable.\n@returns A promise that resolves once the server has begun listening.\n\n@example\n```ts\nconst agent = new AgentBase({ name: 'demo', port: 3000 });\nawait agent.serve();\n// Or override at runtime:\nawait agent.serve({ port: 8080, host: '127.0.0.1' });\n```","file":"dist/AgentBase.d.ts","line":1365},{"name":"run","kind":"method","owner":"AgentBase","signature":["run(opts?: {\n host?: string;\n port?: number;\n event?: ServerlessEvent;\n context?: unknown;\n platform?: 'lambda' | 'gcf' | 'azure' | 'cgi' | 'auto';\n}): Promise<void | ServerlessResponse>"],"doc":"Smart entry point matching Python's `WebMixin.run()`: auto-detects the\nexecution environment and dispatches accordingly. When a serverless event\nis supplied, or a serverless platform is detected from the environment\n(`AWS_LAMBDA_FUNCTION_NAME`/`_HANDLER`, `FUNCTION_TARGET`,\n`FUNCTIONS_WORKER_RUNTIME`, `GATEWAY_INTERFACE`), it dispatches to\n{@link runServerless}; otherwise it starts the HTTP server via {@link serve}.\nCloud Run sets `K_SERVICE` but not `FUNCTION_TARGET`, so there it serves.\n\nFor deterministic behavior, call {@link serve} (server) or\n{@link runServerless} (serverless) directly.\n\n@param opts - Either server host/port overrides, or a serverless\n `{ event, context, platform }` payload.\n@returns `void` for server mode, or the serverless response object.","file":"dist/AgentBase.d.ts","line":1385},{"name":"runServerless","kind":"method","owner":"AgentBase","signature":["runServerless(event: ServerlessEvent, context?: unknown, platform?: 'lambda' | 'gcf' | 'azure' | 'cgi' | 'auto'): Promise<ServerlessResponse>"],"doc":"Handle a single serverless invocation (AWS Lambda, Google Cloud Functions, Azure Functions, or CGI).\n\nMatches Python `run(event, context)` when executed in a serverless environment. Python's\n`run()` auto-detects the platform via `get_execution_mode()` and dispatches accordingly;\n`runServerless` is the **explicit** serverless path so callers can opt in deliberately\n(the polymorphic {@link run} dispatches here when a serverless env/event is detected).\n\nPlatform detection follows the same environment-variable heuristics as Python's\n`ServerlessMixin`: `AWS_LAMBDA_FUNCTION_NAME` → Lambda, `K_SERVICE` → GCF,\n`FUNCTIONS_WORKER_RUNTIME` → Azure, `GATEWAY_INTERFACE` → CGI.\n\nUsage in a Lambda handler file:\n```ts\nexport const handler = (event: any, context: any) => agent.runServerless(event, context);\n```\n\n@param event - The serverless event payload (Lambda event, GCF request body, etc.).\n@param context - The serverless context object (Lambda context, Azure context, etc.).\n@param platform - Optional platform override; defaults to 'auto' (environment detection).\n@returns The normalized serverless response object.","file":"dist/AgentBase.d.ts","line":1414},{"name":"setupGracefulShutdown","kind":"method","owner":"AgentBase","static":true,"signature":["static setupGracefulShutdown(opts?: {\n timeout?: number;\n}): void"],"doc":"Register process signal handlers for clean Kubernetes/Docker shutdown.\nHandles SIGTERM and SIGINT, waits for a timeout, then exits.\n@param opts - Optional timeout in milliseconds (default 5000).","file":"dist/AgentBase.d.ts","line":1421},{"name":"getBasicAuthCredentials","kind":"method","owner":"AgentBase","signature":["getBasicAuthCredentials(includeSource?: false): [string, string]","getBasicAuthCredentials(includeSource: true): [string, string, 'provided' | 'environment' | 'config file' | 'generated']"],"doc":"Get the basic-auth credentials used by this agent.\n@param includeSource - When true, a third element indicating the credential source is appended.\n@returns A tuple of [username, password] or [username, password, source].","file":"dist/AgentBase.d.ts","line":1430}],"bases":["SWMLService"]},"AgentOptions":{"name":"AgentOptions","kind":"interface","exported":true,"signature":["interface AgentOptions"],"doc":"Configuration options for constructing an AgentBase instance.","file":"dist/types.d.ts","line":7,"members":[{"name":"name","kind":"property","owner":"AgentOptions","signature":["name: string"],"doc":"Display name of the agent, also used as default basic-auth username when credentials are auto-generated.","file":"dist/types.d.ts","line":9},{"name":"route","kind":"property","owner":"AgentOptions","signature":["route?: string"],"doc":"HTTP route path the agent listens on (defaults to \"/\").","file":"dist/types.d.ts","line":11},{"name":"host","kind":"property","owner":"AgentOptions","signature":["host?: string"],"doc":"Hostname to bind the HTTP server to (defaults to \"0.0.0.0\").","file":"dist/types.d.ts","line":13},{"name":"port","kind":"property","owner":"AgentOptions","signature":["port?: number"],"doc":"Port number for the HTTP server (defaults to env PORT or 3000).","file":"dist/types.d.ts","line":15},{"name":"basicAuth","kind":"property","owner":"AgentOptions","signature":["basicAuth?: [string, string]"],"doc":"Explicit basic-auth credentials as [username, password]; auto-generated if omitted.","file":"dist/types.d.ts","line":17},{"name":"usePom","kind":"property","owner":"AgentOptions","signature":["usePom?: boolean"],"doc":"Whether to use POM-based prompt rendering (defaults to true).","file":"dist/types.d.ts","line":19},{"name":"tokenExpirySecs","kind":"property","owner":"AgentOptions","signature":["tokenExpirySecs?: number"],"doc":"Session token expiry in seconds (defaults to 3600).","file":"dist/types.d.ts","line":21},{"name":"swaigSecret","kind":"property","owner":"AgentOptions","signature":["swaigSecret?: string"],"doc":"Secret that signs this agent's per-call SWAIG function tokens. Falls back\nto `SIGNALWIRE_SWAIG_SECRET`. Set the same secret on every replica, and\nkeep it across restarts, so a token minted by one process validates on\nanother; when neither is set, each process generates its own.","file":"dist/types.d.ts","line":28},{"name":"autoAnswer","kind":"property","owner":"AgentOptions","signature":["autoAnswer?: boolean"],"doc":"Whether to automatically insert an \"answer\" verb in the SWML call flow (defaults to true).","file":"dist/types.d.ts","line":30},{"name":"recordCall","kind":"property","owner":"AgentOptions","signature":["recordCall?: boolean"],"doc":"Whether to record the call (defaults to false).","file":"dist/types.d.ts","line":32},{"name":"recordFormat","kind":"property","owner":"AgentOptions","signature":["recordFormat?: string"],"doc":"Recording format, e.g. \"mp4\" (defaults to \"mp4\").","file":"dist/types.d.ts","line":34},{"name":"recordStereo","kind":"property","owner":"AgentOptions","signature":["recordStereo?: boolean"],"doc":"Whether to record in stereo (defaults to true).","file":"dist/types.d.ts","line":36},{"name":"defaultWebhookUrl","kind":"property","owner":"AgentOptions","signature":["defaultWebhookUrl?: string"],"doc":"Default webhook URL for SWAIG function callbacks.","file":"dist/types.d.ts","line":38},{"name":"nativeFunctions","kind":"property","owner":"AgentOptions","signature":["nativeFunctions?: string[]"],"doc":"List of native function names to include in the SWAIG configuration.","file":"dist/types.d.ts","line":40},{"name":"agentId","kind":"property","owner":"AgentOptions","signature":["agentId?: string"],"doc":"Unique identifier for this agent instance; auto-generated if omitted.","file":"dist/types.d.ts","line":42},{"name":"suppressLogs","kind":"property","owner":"AgentOptions","signature":["suppressLogs?: boolean"],"doc":"When true, suppresses all log output.","file":"dist/types.d.ts","line":44},{"name":"schemaPath","kind":"property","owner":"AgentOptions","signature":["schemaPath?: string"],"doc":"Path to a JSON Schema file for SWML validation.\nWhen provided, rendered SWML documents are validated against this schema.\nFalls back to the built-in schema if omitted.","file":"dist/types.d.ts","line":50},{"name":"enablePostPromptOverride","kind":"property","owner":"AgentOptions","signature":["enablePostPromptOverride?: boolean"],"doc":"Whether to enable the post-prompt override endpoint.\nWhen true, a `/post_prompt_override` route is registered that allows\nexternal callers to replace the post-prompt text at runtime.\nDefaults to false.","file":"dist/types.d.ts","line":57},{"name":"checkForInputOverride","kind":"property","owner":"AgentOptions","signature":["checkForInputOverride?: boolean"],"doc":"Whether to enable the check-for-input override endpoint.\nWhen true, a `/check_for_input` route is registered that allows\nexternal callers to inject input checks at runtime.\nDefaults to false.","file":"dist/types.d.ts","line":64},{"name":"configFile","kind":"property","owner":"AgentOptions","signature":["configFile?: string"],"doc":"Path to a JSON configuration file.\nWhen provided, the file is loaded at construction time and its\n`service` section can override name, route, host, and port\n(constructor arguments still take precedence over file values).","file":"dist/types.d.ts","line":71},{"name":"schemaValidation","kind":"property","owner":"AgentOptions","signature":["schemaValidation?: boolean"],"doc":"Whether to validate rendered SWML against the schema.\nCan also be disabled via the `SWML_SKIP_SCHEMA_VALIDATION` env var.\nDefaults to true.","file":"dist/types.d.ts","line":77},{"name":"signingKey","kind":"property","owner":"AgentOptions","signature":["signingKey?: string"],"doc":"SignalWire Signing Key for verifying inbound webhook signatures.\nWhen set, AgentBase auto-mounts the webhook signature validation\nmiddleware on POST /, /swaig, and /post_prompt; unsigned or\nmis-signed requests are rejected with 403.\n\nFalls back to the `SIGNALWIRE_SIGNING_KEY` environment variable when\nomitted. When both are unset, signature validation is disabled and\nthe agent emits a one-time warning on startup so operators notice.\n\nPer SignalWire's webhook signing rules: this MUST be treated as secret —\nnever logged, never echoed to clients, never included in error\nmessages.","file":"dist/types.d.ts","line":92},{"name":"webhookTrustProxy","kind":"property","owner":"AgentOptions","signature":["webhookTrustProxy?: boolean"],"doc":"When true, the webhook validation middleware honors\n`X-Forwarded-Proto` / `X-Forwarded-Host` headers when reconstructing\nthe public URL the platform POSTed to. Default false because proxy\nheaders are spoofable; opt in only when you control the proxy.\n\nThe `SWML_PROXY_URL_BASE` env var always takes precedence over both\nforwarded headers and the raw request URL.","file":"dist/types.d.ts","line":102}]},"AgentServer":{"name":"AgentServer","kind":"class","exported":true,"signature":["class AgentServer"],"doc":"Multi-agent HTTP server that hosts multiple AgentBase instances on distinct route prefixes.\n\nUse `AgentServer` when one process should serve more than one agent — each with its own\nprompt, tools, and route. Internally, each agent's Hono router is mounted under its own\npath. Static assets can also be served from a configured directory.\n\n@example Host two agents on one port\n```ts\nimport { AgentServer, AgentBase } from '@signalwire/sdk';\n\nconst salesAgent = new AgentBase({ name: 'sales', route: '/sales' });\nconst supportAgent = new AgentBase({ name: 'support', route: '/support' });\n\nconst server = new AgentServer({ host: '0.0.0.0', port: 3000 });\nserver.register(salesAgent);\nserver.register(supportAgent);\n\nawait server.run();\n```\n\n@see {@link AgentBase}","file":"dist/AgentServer.d.ts","line":33,"members":[{"name":"host","kind":"property","owner":"AgentServer","signature":["host: string"],"doc":"Hostname the server binds to.","file":"dist/AgentServer.d.ts","line":35},{"name":"port","kind":"property","owner":"AgentServer","signature":["port: number"],"doc":"Port the server listens on.","file":"dist/AgentServer.d.ts","line":37},{"name":"logLevel","kind":"property","owner":"AgentServer","readonly":true,"signature":["readonly logLevel: string"],"doc":"Logging level (debug, info, warn, error).","file":"dist/AgentServer.d.ts","line":39},{"name":"log","kind":"property","owner":"AgentServer","readonly":true,"signature":["readonly log: import(\"./Logger.js\").Logger"],"doc":"Public logger for this server instance.","file":"dist/AgentServer.d.ts","line":41},{"name":"constructor","kind":"constructor","owner":"AgentServer","signature":["constructor(opts?: {\n host?: string;\n port?: number;\n logLevel?: string;\n})"],"doc":"Create an AgentServer.\n@param opts - Optional host, port, and logLevel overrides; defaults to 0.0.0.0:3000, logLevel 'info'.","file":"dist/AgentServer.d.ts","line":60},{"name":"register","kind":"method","owner":"AgentServer","signature":["register(agent: AgentBase, route?: string): void"],"doc":"Register an agent at the given route prefix.\n@param agent - The AgentBase instance to mount.\n@param route - Route prefix; defaults to the agent's own route or '/'.\n@throws If the route is already occupied by another agent.","file":"dist/AgentServer.d.ts","line":83},{"name":"unregister","kind":"method","owner":"AgentServer","signature":["unregister(route: string): boolean"],"doc":"Remove an agent registration by route.\n@param route - The route prefix to unregister.\n@returns True if the agent was found and removed, false if not found.","file":"dist/AgentServer.d.ts","line":89},{"name":"getAgents","kind":"method","owner":"AgentServer","signature":["getAgents(): Map<string, AgentBase>"],"doc":"Get all registered agents keyed by their route prefix.\n@returns A map of route prefixes to AgentBase instances.","file":"dist/AgentServer.d.ts","line":94},{"name":"getAgent","kind":"method","owner":"AgentServer","signature":["getAgent(route: string): AgentBase | undefined"],"doc":"Look up a registered agent by its route prefix.\n@param route - The route prefix to look up.\n@returns The agent at that route, or undefined if none is registered.","file":"dist/AgentServer.d.ts","line":100},{"name":"serveStaticFiles","kind":"method","owner":"AgentServer","signature":["serveStaticFiles(directory: string, route?: string): void"],"doc":"Serve static files from a local directory under a given route prefix.\nIncludes path traversal protection (rejects `..`), MIME type detection,\nand security headers (Cache-Control, X-Content-Type-Options).\n@param directory - Absolute or relative path to the directory to serve.\n@param route - Route prefix for static files (defaults to '/').","file":"dist/AgentServer.d.ts","line":108},{"name":"setupSipRouting","kind":"method","owner":"AgentServer","signature":["setupSipRouting(route?: string, autoMap?: boolean): void"],"doc":"Set up central SIP-based routing for the server.\n\nThis configures all agents to handle SIP requests at the specified path,\nusing a coordinated routing system where each agent checks if it can\nhandle SIP requests for specific usernames.\n\n@param route - The path for SIP routing (default: '/sip').\n@param autoMap - Whether to automatically map SIP usernames to agent routes (default: true).","file":"dist/AgentServer.d.ts","line":121},{"name":"registerSipUsername","kind":"method","owner":"AgentServer","signature":["registerSipUsername(username: string, route: string): void"],"doc":"Register a mapping from a SIP username to an agent route at the server level.\n\nAllows callers to manually route an arbitrary SIP username to any already-registered\nagent route, independent of the automatic mapping performed by `setupSipRouting`.\n\n@param username - The SIP username to map (stored lowercase).\n@param route - The agent route to map the username to (leading `/` added if missing; trailing slashes stripped).","file":"dist/AgentServer.d.ts","line":131},{"name":"registerGlobalRoutingCallback","kind":"method","owner":"AgentServer","signature":["registerGlobalRoutingCallback(callbackFn: RoutingCallback, path: string): void"],"doc":"Register a routing callback across all agents at the given path.\n\nThis allows unified routing logic to be applied to all agents from\na central server-level coordinator.\n\n@param callbackFn - The callback function that receives a request and body, returning a route string or undefined.\n@param path - The path to register the callback at.","file":"dist/AgentServer.d.ts","line":141},{"name":"getApp","kind":"method","owner":"AgentServer","signature":["getApp(): Hono"],"doc":"Build and return the Hono application with all registered agents and a root listing endpoint.\n@returns The fully configured Hono app.","file":"dist/AgentServer.d.ts","line":150},{"name":"run","kind":"method","owner":"AgentServer","signature":["run(host?: string, port?: number): Promise<void>"],"doc":"Start the HTTP server and begin listening for requests.\n\nThis method handles server mode only. For serverless deployments\n(AWS Lambda, Google Cloud Functions, Azure Functions), use\n{@link ServerlessAdapter} instead. When `SWAIG_CLI_MODE=true` is set in\nthe environment, the call is a no-op so agent config can be inspected\nwithout starting a server.\n\n@param host - Override the configured hostname. Defaults to the\n constructor value.\n@param port - Override the configured port. Defaults to the constructor\n value.\n@returns Resolves once the underlying Hono server has begun listening.","file":"dist/AgentServer.d.ts","line":166}]},"AiAgents":{"name":"AiAgents","kind":"class","exported":true,"signature":["class AiAgents extends FabricResource<AIAgentListResponse, AIAgentResponse, AIAgentCreateRequest, AIAgentUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":24,"members":[{"name":"constructor","kind":"constructor","owner":"AiAgents","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":25},{"name":"create","kind":"method","owner":"AiAgents","signature":["create(body: AIAgentCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<AIAgentResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":27},{"name":"update","kind":"method","owner":"AiAgents","signature":["update(id: string, body: AIAgentUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<AIAgentResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":29}],"bases":["FabricResource"]},"ApiNinjasTriviaSkill":{"name":"ApiNinjasTriviaSkill","kind":"class","exported":true,"signature":["class ApiNinjasTriviaSkill extends SkillBase"],"doc":"Fetches trivia questions from the API Ninjas service.\n\nTier 2 built-in skill. Requires the `API_NINJAS_KEY` environment variable.\nSupports optional `default_category` and `reveal_answer` config options.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('api_ninjas_trivia', { default_category: 'sciencenature' });\n```","file":"dist/skills/builtin/api_ninjas_trivia.d.ts","line":23,"members":[{"name":"SKILL_NAME","kind":"property","owner":"ApiNinjasTriviaSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/api_ninjas_trivia.d.ts","line":24},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"ApiNinjasTriviaSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/api_ninjas_trivia.d.ts","line":25},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"ApiNinjasTriviaSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/api_ninjas_trivia.d.ts","line":26},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"ApiNinjasTriviaSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/api_ninjas_trivia.d.ts","line":27},{"name":"getParameterSchema","kind":"method","owner":"ApiNinjasTriviaSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/api_ninjas_trivia.d.ts","line":28},{"name":"getInstanceKey","kind":"method","owner":"ApiNinjasTriviaSkill","signature":["getInstanceKey(): string"],"doc":"Produce a compound instance key matching Python `get_instance_key`\n(skill.py:139-146): `f\"{SKILL_NAME}_{self.tool_name}\"` with\n`tool_name` defaulting to `'get_trivia'` (skill.py:95). The base\n`SkillBase.getInstanceKey` uses `this.skillName` as the fallback,\nso we override to match Python's `'get_trivia'` default.","file":"dist/skills/builtin/api_ninjas_trivia.d.ts","line":36},{"name":"getTools","kind":"method","owner":"ApiNinjasTriviaSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A single trivia tool (configurable name) that fetches a random trivia question with optional category.","file":"dist/skills/builtin/api_ninjas_trivia.d.ts","line":38},{"name":"getHints","kind":"method","owner":"ApiNinjasTriviaSkill","signature":["getHints(): string[]"],"doc":"@returns Speech recognition hints for trivia-related keywords.","file":"dist/skills/builtin/api_ninjas_trivia.d.ts","line":42}],"bases":["SkillBase"]},"AskClaudeSkill":{"name":"AskClaudeSkill","kind":"class","exported":true,"signature":["class AskClaudeSkill extends SkillBase"],"doc":"Provides access to Anthropic's Claude AI for sub-queries and complex reasoning.\n\nNeeds an Anthropic API key, passed as `api_key` or set in the\n`ANTHROPIC_API_KEY` environment variable; setup fails without one. Supports `model` and `max_tokens` config options to control which Claude model\nis used and the maximum response length.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('ask_claude', { model: 'claude-sonnet-4-6', max_tokens: 512 });\n```","file":"dist/skills/builtin/ask_claude.d.ts","line":25,"members":[{"name":"SKILL_NAME","kind":"property","owner":"AskClaudeSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/ask_claude.d.ts","line":26},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"AskClaudeSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/ask_claude.d.ts","line":27},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"AskClaudeSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/ask_claude.d.ts","line":28},{"name":"setup","kind":"method","owner":"AskClaudeSkill","signature":["setup(): Promise<boolean>"],"doc":"Fails when neither `api_key` nor `ANTHROPIC_API_KEY` is set.\n@returns `true` if an API key is present, `false` otherwise.","file":"dist/skills/builtin/ask_claude.d.ts","line":35},{"name":"getParameterSchema","kind":"method","owner":"AskClaudeSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/ask_claude.d.ts","line":36},{"name":"getTools","kind":"method","owner":"AskClaudeSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A single `ask_claude` tool that sends prompts to the Claude API.","file":"dist/skills/builtin/ask_claude.d.ts","line":38}],"bases":["SkillBase"]},"AuthConfig":{"name":"AuthConfig","kind":"interface","exported":true,"signature":["interface AuthConfig"],"doc":"Configuration for one or more authentication methods checked by {@link AuthHandler}.","file":"dist/AuthHandler.d.ts","line":19,"members":[{"name":"bearerToken","kind":"property","owner":"AuthConfig","signature":["bearerToken?: string"],"doc":"Bearer token matched against the Authorization header.","file":"dist/AuthHandler.d.ts","line":21},{"name":"apiKey","kind":"property","owner":"AuthConfig","signature":["apiKey?: string"],"doc":"API key matched against the X-Api-Key header.","file":"dist/AuthHandler.d.ts","line":23},{"name":"apiKeyHeader","kind":"property","owner":"AuthConfig","signature":["apiKeyHeader?: string"],"doc":"Custom header name for API key lookup (default: 'X-Api-Key').","file":"dist/AuthHandler.d.ts","line":25},{"name":"basicAuth","kind":"property","owner":"AuthConfig","signature":["basicAuth?: [string, string]"],"doc":"Basic auth credentials as a [username, password] tuple.","file":"dist/AuthHandler.d.ts","line":27},{"name":"customValidator","kind":"property","owner":"AuthConfig","signature":["customValidator?: (request: {\n headers: Record<string, string>;\n method: string;\n url: string;\n}) => boolean | Promise<boolean>"],"doc":"Custom validator function; return true to allow the request.","file":"dist/AuthHandler.d.ts","line":29},{"name":"allowUnauthenticated","kind":"property","owner":"AuthConfig","signature":["allowUnauthenticated?: boolean"],"doc":"When explicitly set to false, deny requests if no auth methods are configured.","file":"dist/AuthHandler.d.ts","line":35}]},"AuthHandler":{"name":"AuthHandler","kind":"class","exported":true,"signature":["class AuthHandler"],"doc":"Multi-method authentication handler with timing-safe credential comparison.","file":"dist/AuthHandler.d.ts","line":38,"members":[{"name":"config","kind":"property","owner":"AuthHandler","readonly":true,"signature":["readonly config: AuthConfig"],"doc":"The authentication configuration for this handler.","file":"dist/AuthHandler.d.ts","line":40},{"name":"constructor","kind":"constructor","owner":"AuthHandler","signature":["constructor(config: AuthConfig)"],"doc":"Create a new AuthHandler.\n@param config - Authentication configuration specifying one or more auth methods.","file":"dist/AuthHandler.d.ts","line":45},{"name":"validate","kind":"method","owner":"AuthHandler","signature":["validate(headers: Record<string, string>): Promise<boolean>"],"doc":"Validate request headers against configured auth methods (Bearer, API Key, Basic, Custom) in order.\n@param headers - The request headers as a string-keyed record.\n@returns True if any configured method accepts the request, or if no methods are configured.","file":"dist/AuthHandler.d.ts","line":51},{"name":"verifyBasicAuth","kind":"method","owner":"AuthHandler","signature":["verifyBasicAuth(username: string, password: string): boolean"],"doc":"Verify a Basic Auth username/password pair against the configured credentials.\n\nReturns false immediately if Basic Auth is not configured.\nUses constant-time comparison to prevent timing attacks.\n\n@param username - The username to verify.\n@param password - The password to verify.\n@returns True if the credentials match the configured Basic Auth credentials.","file":"dist/AuthHandler.d.ts","line":62},{"name":"verifyBearerToken","kind":"method","owner":"AuthHandler","signature":["verifyBearerToken(token: string): boolean"],"doc":"Verify a Bearer token against the configured token.\n\nReturns false immediately if Bearer token auth is not configured.\nUses constant-time comparison to prevent timing attacks.\n\n@param token - The Bearer token string to verify (without the \"Bearer \" prefix).\n@returns True if the token matches the configured Bearer token.","file":"dist/AuthHandler.d.ts","line":72},{"name":"verifyApiKey","kind":"method","owner":"AuthHandler","signature":["verifyApiKey(key: string): boolean"],"doc":"Verify an API key against the configured key.\n\nReturns false immediately if API key auth is not configured.\nUses constant-time comparison to prevent timing attacks.\n\n@param key - The API key string to verify.\n@returns True if the key matches the configured API key.","file":"dist/AuthHandler.d.ts","line":82},{"name":"middleware","kind":"method","owner":"AuthHandler","signature":["middleware(optional?: boolean): (c: Context, next: () => Promise<void>) => Promise<Response | void>"],"doc":"Create a Hono-compatible middleware that rejects unauthorized requests with a 401 response.\n@param optional - When true, unauthenticated requests are allowed through instead of being rejected (default: false).\n@returns A middleware function suitable for use with Hono's `app.use()`.","file":"dist/AuthHandler.d.ts","line":88},{"name":"expressMiddleware","kind":"method","owner":"AuthHandler","signature":["expressMiddleware(optional?: boolean): (req: ExpressLikeRequest, res: ExpressLikeResponse, next: () => void) => Promise<void>"],"doc":"Create an Express/Connect-compatible middleware adapter.\n\nThis serves as the framework-agnostic equivalent of Python's\n`get_fastapi_dependency`. For standalone validation without a\nframework, use {@link validate} directly.\n\n@param optional - When true, unauthenticated requests are allowed through (default: false).\n@returns An Express-compatible middleware function.","file":"dist/AuthHandler.d.ts","line":99},{"name":"getAuthInfo","kind":"method","owner":"AuthHandler","signature":["getAuthInfo(): {\n basic?: {\n enabled: true;\n username: string;\n };\n bearer?: {\n enabled: true;\n hint: string;\n };\n apiKey?: {\n enabled: true;\n header: string;\n hint: string;\n };\n}"],"doc":"Get information about configured authentication methods.\n\nReturns structured metadata describing each enabled auth method,\nincluding usernames, header names, and usage hints.\n\n@returns An object describing the enabled auth methods and their configuration.","file":"dist/AuthHandler.d.ts","line":108},{"name":"hasBearerAuth","kind":"method","owner":"AuthHandler","signature":["hasBearerAuth(): boolean"],"doc":"Check whether Bearer token authentication is configured.\n@returns True if a bearer token has been set.","file":"dist/AuthHandler.d.ts","line":127},{"name":"hasApiKeyAuth","kind":"method","owner":"AuthHandler","signature":["hasApiKeyAuth(): boolean"],"doc":"Check whether API key authentication is configured.\n@returns True if an API key has been set.","file":"dist/AuthHandler.d.ts","line":132},{"name":"hasBasicAuth","kind":"method","owner":"AuthHandler","signature":["hasBasicAuth(): boolean"],"doc":"Check whether Basic authentication is configured.\n@returns True if basic auth credentials have been set.","file":"dist/AuthHandler.d.ts","line":137}]},"AuthenticationError":{"name":"AuthenticationError","kind":"class","exported":true,"signature":["class AuthenticationError extends AIChatError"],"doc":"Missing/rejected identity (HTTP 401 / JSON-RPC -32009).","file":"dist/ai-chat/AIChatClient.d.ts","line":59,"members":[{"name":"constructor","kind":"constructor","owner":"AuthenticationError","signature":["constructor(code: number | null, message: string)"],"doc":"","file":"dist/ai-chat/AIChatClient.d.ts","line":60}],"bases":["AIChatError"]},"BaseResource":{"name":"BaseResource","kind":"class","exported":true,"signature":["abstract class BaseResource"],"doc":"Abstract base class for all REST resources.\n\nEvery namespace resource (e.g. {@link PhoneNumbersResource}, {@link VideoRooms})\nextends this class to get a typed reference to the shared {@link HttpClient}\nand a small path-building helper. Not exported for direct use — subclass it.","file":"dist/rest/base/BaseResource.d.ts","line":9,"members":[{"name":"constructor","kind":"constructor","owner":"BaseResource","signature":["constructor(http: HttpClient, basePath: string)"],"doc":"@param http - Shared HTTP client to issue requests through.\n@param basePath - Absolute path prefix (e.g. `'/api/relay/rest/phone_numbers'`).","file":"dist/rest/base/BaseResource.d.ts","line":16}]},"BedrockAgent":{"name":"BedrockAgent","kind":"class","exported":true,"signature":["class BedrockAgent extends AgentBase"],"doc":"Agent implementation for the Amazon Bedrock voice-to-voice model.\n\nSupports all standard agent features (prompt building with text and POM,\nskills and SWAIG functions, post-prompt, dynamic configuration) but renders\nSWML with the `amazon_bedrock` verb rather than `ai`.\n\n@example\n```ts\nimport { BedrockAgent } from '@signalwire/sdk';\n\nconst agent = new BedrockAgent({\n systemPrompt: 'You are a helpful voice assistant.',\n voiceId: 'tiffany',\n});\n\nagent.setInferenceParams(0.5, 0.95, 2048);\nawait agent.serve({ port: 3000 });\n```","file":"dist/agents/BedrockAgent.d.ts","line":66,"members":[{"name":"constructor","kind":"constructor","owner":"BedrockAgent","signature":["constructor(config?: BedrockAgentConfig)"],"doc":"Create a BedrockAgent.\n@param config - Configuration including voice, inference params, and optional system prompt.\n@throws Error if `temperature` or `topP` isn't a number, or `maxTokens` isn't an integer.","file":"dist/agents/BedrockAgent.d.ts","line":81},{"name":"renderSwml","kind":"method","owner":"BedrockAgent","signature":["renderSwml(callId?: string, modifications?: Record<string, unknown>): string"],"doc":"Render the SWML document, transforming the base `ai` verb into an\n`amazon_bedrock` verb with the same structure. Mirrors Python\n`BedrockAgent._render_swml`.\n\nOnly `prompt`, `SWAIG`, `params`, `global_data`, `post_prompt` and\n`post_prompt_url` are carried over. Anything else on the `ai` verb, such\nas `hints`, `languages`, `pronounce`, `multilingual` or the debug webhook\nkeys, is left out, as is anything in the prompt that the Bedrock prompt\ndoesn't define, such as `contexts`. The agent logs one warning for each\nfeature it leaves out, the first time it leaves it out.","file":"dist/agents/BedrockAgent.d.ts","line":94},{"name":"setVoice","kind":"method","owner":"BedrockAgent","signature":["setVoice(voiceId: string): this"],"doc":"Set the Bedrock voice: `tiffany`, `matthew`, `amy`, `lupe` or `carlos`.\nMirrors Python `set_voice`.","file":"dist/agents/BedrockAgent.d.ts","line":107},{"name":"setInferenceParams","kind":"method","owner":"BedrockAgent","signature":["setInferenceParams(temperature?: number | string | null, topP?: number | string | null, maxTokens?: number | string | null): this"],"doc":"Update Bedrock inference parameters. Any argument left undefined (or\nnull) is unchanged. Each value may be a number or a numeric string, which\nis converted. `temperature` and `topP` may also be a SWML variable\nreference such as `${temperature}`. The platform's Bedrock session applies\n`temperature` (0 to 2) and `topP` (0 to 1), and doesn't read `maxTokens`: it\nuses 1024. Mirrors Python `set_inference_params`.\n\n@throws Error if `temperature` or `topP` isn't a number, or `maxTokens`\n isn't an integer. Nothing is changed when a value is refused.","file":"dist/agents/BedrockAgent.d.ts","line":119},{"name":"setLlmModel","kind":"method","owner":"BedrockAgent","signature":["setLlmModel(model: string): this"],"doc":"Set the LLM model — not applicable for Bedrock, which uses a fixed\nvoice-to-voice model. Logs a warning and does nothing.\nMirrors Python `set_llm_model`.","file":"dist/agents/BedrockAgent.d.ts","line":125},{"name":"setLlmTemperature","kind":"method","owner":"BedrockAgent","signature":["setLlmTemperature(temperature: number | string): this"],"doc":"Set the LLM temperature — redirects to {@link setInferenceParams}.\nMirrors Python `set_llm_temperature`.\n\n@throws Error if `temperature` isn't a number or a SWML variable reference.","file":"dist/agents/BedrockAgent.d.ts","line":132},{"name":"setPostPromptLlmParams","kind":"method","owner":"BedrockAgent","signature":["setPostPromptLlmParams(_params: Record<string, unknown>): this"],"doc":"Set post-prompt LLM parameters — not applicable for Bedrock (its\npost-prompt uses OpenAI configured in the engine). Logs a warning.\nMirrors Python `set_post_prompt_llm_params`.","file":"dist/agents/BedrockAgent.d.ts","line":138},{"name":"setPromptLlmParams","kind":"method","owner":"BedrockAgent","signature":["setPromptLlmParams(params: Record<string, unknown>): this"],"doc":"Set the prompt's inference settings.\n\n`temperature`, `top_p` and `max_tokens` update the inference settings, as\n{@link setInferenceParams} does, which converts numeric strings and\nthrows for other values. The platform's Bedrock session reads no other\nprompt setting, so anything else, such as `confidence`,\n`presence_penalty` or `barge_confidence`, is ignored with a warning.\nMirrors Python `set_prompt_llm_params`.\n\n@param params - Prompt settings, with their SWML names.\n@returns This agent, for chaining.\n@throws Error if `temperature` or `top_p` isn't a number, or `max_tokens`\n isn't an integer. Nothing is changed when a value is refused.","file":"dist/agents/BedrockAgent.d.ts","line":154}],"bases":["AgentBase"]},"BedrockAgentConfig":{"name":"BedrockAgentConfig","kind":"interface","exported":true,"signature":["interface BedrockAgentConfig"],"doc":"Configuration for the {@link BedrockAgent}.","file":"dist/agents/BedrockAgent.d.ts","line":17,"members":[{"name":"name","kind":"property","owner":"BedrockAgentConfig","signature":["name?: string"],"doc":"Agent display name (defaults to `\"bedrock_agent\"`).","file":"dist/agents/BedrockAgent.d.ts","line":19},{"name":"route","kind":"property","owner":"BedrockAgentConfig","signature":["route?: string"],"doc":"HTTP route for this agent (defaults to `\"/bedrock\"`).","file":"dist/agents/BedrockAgent.d.ts","line":21},{"name":"systemPrompt","kind":"property","owner":"BedrockAgentConfig","signature":["systemPrompt?: string"],"doc":"Initial system prompt (can be overridden later with `setPromptText`).","file":"dist/agents/BedrockAgent.d.ts","line":23},{"name":"voiceId","kind":"property","owner":"BedrockAgentConfig","signature":["voiceId?: string"],"doc":"Bedrock voice: `tiffany`, `matthew`, `amy`, `lupe` or `carlos` (defaults to `\"matthew\"`).","file":"dist/agents/BedrockAgent.d.ts","line":25},{"name":"temperature","kind":"property","owner":"BedrockAgentConfig","signature":["temperature?: number | string"],"doc":"Generation temperature (0-2). Defaults to 0.7. A numeric string is\nconverted, and a SWML variable reference such as `${temperature}` is\npassed through.","file":"dist/agents/BedrockAgent.d.ts","line":31},{"name":"topP","kind":"property","owner":"BedrockAgentConfig","signature":["topP?: number | string"],"doc":"Nucleus sampling parameter (0-1). Defaults to 0.9. A numeric string is\nconverted, and a SWML variable reference such as `${top_p}` is passed\nthrough.","file":"dist/agents/BedrockAgent.d.ts","line":37},{"name":"maxTokens","kind":"property","owner":"BedrockAgentConfig","signature":["maxTokens?: number | string"],"doc":"Maximum tokens to generate. Defaults to 1024. A numeric string is\nconverted. The platform's Bedrock session doesn't read it; it uses 1024.","file":"dist/agents/BedrockAgent.d.ts","line":42},{"name":"agentOptions","kind":"property","owner":"BedrockAgentConfig","signature":["agentOptions?: Partial<AgentOptions>"],"doc":"Additional AgentBase options forwarded to `super()`.","file":"dist/agents/BedrockAgent.d.ts","line":44}]},"CALL_STATE_ANSWERED":{"name":"CALL_STATE_ANSWERED","kind":"variable","exported":true,"signature":["const CALL_STATE_ANSWERED"],"doc":"","file":"dist/relay/constants.d.ts","line":19},"CALL_STATE_CREATED":{"name":"CALL_STATE_CREATED","kind":"variable","exported":true,"signature":["const CALL_STATE_CREATED"],"doc":"","file":"dist/relay/constants.d.ts","line":17},"CALL_STATE_ENDED":{"name":"CALL_STATE_ENDED","kind":"variable","exported":true,"signature":["const CALL_STATE_ENDED"],"doc":"","file":"dist/relay/constants.d.ts","line":21},"CALL_STATE_ENDING":{"name":"CALL_STATE_ENDING","kind":"variable","exported":true,"signature":["const CALL_STATE_ENDING"],"doc":"","file":"dist/relay/constants.d.ts","line":20},"CALL_STATE_RINGING":{"name":"CALL_STATE_RINGING","kind":"variable","exported":true,"signature":["const CALL_STATE_RINGING"],"doc":"","file":"dist/relay/constants.d.ts","line":18},"CALL_STATE_TERMINAL":{"name":"CALL_STATE_TERMINAL","kind":"variable","exported":true,"signature":["const CALL_STATE_TERMINAL: readonly [\"ended\"]"],"doc":"The single terminal {@link CallState} (`'ended'`).","file":"dist/relay/closedSets.d.ts","line":73},"CONNECT_STATE_CONNECTED":{"name":"CONNECT_STATE_CONNECTED","kind":"variable","exported":true,"signature":["const CONNECT_STATE_CONNECTED"],"doc":"","file":"dist/relay/constants.d.ts","line":33},"CONNECT_STATE_CONNECTING":{"name":"CONNECT_STATE_CONNECTING","kind":"variable","exported":true,"signature":["const CONNECT_STATE_CONNECTING"],"doc":"","file":"dist/relay/constants.d.ts","line":32},"CONNECT_STATE_DISCONNECTED":{"name":"CONNECT_STATE_DISCONNECTED","kind":"variable","exported":true,"signature":["const CONNECT_STATE_DISCONNECTED"],"doc":"","file":"dist/relay/constants.d.ts","line":34},"CONNECT_STATE_FAILED":{"name":"CONNECT_STATE_FAILED","kind":"variable","exported":true,"signature":["const CONNECT_STATE_FAILED"],"doc":"","file":"dist/relay/constants.d.ts","line":35},"Call":{"name":"Call","kind":"class","exported":true,"signature":["class Call"],"doc":"Live RELAY call with command methods.\n\nDon't construct directly — `Call` instances are created by {@link RelayClient}\nfor inbound calls (delivered to your `onCall` handler) and for outbound dials.\n\nEach command method (`answer()`, `play()`, `record()`, etc.) returns when the\nplatform acknowledges the command; event-driven completion is exposed via\n{@link Action} objects returned from the async \"play/record/...\" variants.\n\n@example Inside an onCall handler\n```ts\nimport { RelayClient } from '@signalwire/sdk';\nconst client = new RelayClient();\nclient.onCall(async (call) => {\n await call.answer();\n const play = await call.play([{ type: 'tts', params: { text: 'Hello!' } }]);\n await play.wait();\n await call.hangup();\n});\n```\n\n@see {@link RelayClient}\n@see {@link Action}","file":"dist/relay/Call.d.ts","line":43,"members":[{"name":"callId","kind":"property","owner":"Call","signature":["callId: string"],"doc":"Unique call identifier assigned by the platform.","file":"dist/relay/Call.d.ts","line":46},{"name":"nodeId","kind":"property","owner":"Call","signature":["nodeId: string"],"doc":"RELAY node that owns this call.","file":"dist/relay/Call.d.ts","line":48},{"name":"projectId","kind":"property","owner":"Call","signature":["projectId: string"],"doc":"SignalWire project ID.","file":"dist/relay/Call.d.ts","line":50},{"name":"context","kind":"property","owner":"Call","signature":["context: string"],"doc":"RELAY context this call was received on.","file":"dist/relay/Call.d.ts","line":52},{"name":"tag","kind":"property","owner":"Call","signature":["tag: string"],"doc":"Opaque correlation tag attached at dial time.","file":"dist/relay/Call.d.ts","line":54},{"name":"direction","kind":"property","owner":"Call","signature":["direction: string"],"doc":"`\"inbound\"` or `\"outbound\"`.","file":"dist/relay/Call.d.ts","line":56},{"name":"device","kind":"property","owner":"Call","signature":["device: Device"],"doc":"Device descriptor the call is associated with (phone, SIP, etc.).","file":"dist/relay/Call.d.ts","line":58},{"name":"state","kind":"property","owner":"Call","signature":["state: CallState"],"doc":"Current call state. One of the {@link CallState} values\n(`\"created\"` | `\"ringing\"` | `\"answered\"` | `\"ending\"` | `\"ended\"`; closed\nliteral union, autocompleted + typo-checked). A raw wire value is cast to\nthe closed type at the hydration boundary. Use {@link Call.isTerminal} to\ntest for the terminal (`ended`) state rather than comparing strings by hand.","file":"dist/relay/Call.d.ts","line":66},{"name":"segmentId","kind":"property","owner":"Call","signature":["segmentId: string"],"doc":"Call segment ID used for event correlation.","file":"dist/relay/Call.d.ts","line":68},{"name":"constructor","kind":"constructor","owner":"Call","signature":["constructor(client: RelayClientLike, callId: string, nodeId: string, projectId: string, context: string, options?: {\n tag?: string;\n direction?: string;\n device?: Device;\n state?: CallState;\n segmentId?: string;\n})"],"doc":"","file":"dist/relay/Call.d.ts","line":72},{"name":"isTerminal","kind":"accessor","owner":"Call","signature":["get isTerminal(): boolean"],"doc":"Whether this call has reached its terminal lifecycle state (`ended`) and\nwill emit no further `calling.call.state` transitions.\n\nIdiomatic shortcut for `isCallStateTerminal(call.state)` — prefer it over\na hand-written `call.state === 'ended'` comparison so the terminal-set\ndefinition lives in one place ({@link ../relay/closedSets.CallState}).","file":"dist/relay/Call.d.ts","line":87},{"name":"on","kind":"method","owner":"Call","signature":["on(eventType: string, handler: EventHandler): void"],"doc":"Register an event listener for this call.\n\nMultiple listeners for the same event type are supported. Listener errors\nare logged but do not disrupt dispatch to other listeners.\n\n@param eventType - Fully-qualified event type (e.g.\n `\"calling.call.state\"`, `\"calling.call.play\"`).\n@param handler - Callback invoked for each matching event.","file":"dist/relay/Call.d.ts","line":107},{"name":"waitFor","kind":"method","owner":"Call","signature":["waitFor(eventType: string, predicate?: (event: RelayEvent) => boolean, timeout?: number): Promise<RelayEvent>"],"doc":"Wait for a specific event, optionally filtered by predicate.\n\nRegisters a one-shot listener that is removed after resolving (or after\nthe timeout elapses). Useful for awaiting a specific state transition.\n\n@param eventType - Event type to wait for.\n@param predicate - Optional filter — only events for which this returns\n `true` resolve the wait.\n@param timeout - Optional timeout in milliseconds. Omit to wait forever.\n@returns The first matching {@link RelayEvent}.\n@throws {Error} When the optional timeout elapses before a match.","file":"dist/relay/Call.d.ts","line":123},{"name":"waitForEnded","kind":"method","owner":"Call","signature":["waitForEnded(timeout?: number): Promise<RelayEvent>"],"doc":"Wait for the call to reach the `ended` state.\n\n@param timeout - Optional timeout in milliseconds.\n@returns The terminating `calling.call.state` {@link RelayEvent}.\n@throws {Error} When the optional timeout elapses before the call ends.","file":"dist/relay/Call.d.ts","line":131},{"name":"waitForAnswered","kind":"method","owner":"Call","signature":["waitForAnswered(timeout?: number): Promise<RelayEvent>"],"doc":"Wait until the call is answered.\n\nReturns immediately if the call is already answered (or past it, e.g.\nending/ended). Typed wait over {@link waitFor}, mirroring Python's\n`call.wait_for_answered(timeout)`.\n\n@param timeout - Optional timeout in milliseconds. Omit to wait forever.\n@returns The `calling.call.state` {@link RelayEvent} (synthesized on short-circuit).\n@throws {Error} When the optional timeout elapses before the call is answered.","file":"dist/relay/Call.d.ts","line":154},{"name":"waitForRinging","kind":"method","owner":"Call","signature":["waitForRinging(timeout?: number): Promise<RelayEvent>"],"doc":"Wait until the call is ringing.\n\nReturns immediately if the call is already ringing (or past it, e.g.\nanswered/ending/ended). Typed wait over {@link waitFor}, mirroring\nPython's `call.wait_for_ringing(timeout)`.\n\n@param timeout - Optional timeout in milliseconds. Omit to wait forever.\n@returns The `calling.call.state` {@link RelayEvent} (synthesized on short-circuit).\n@throws {Error} When the optional timeout elapses before the call is ringing.","file":"dist/relay/Call.d.ts","line":166},{"name":"waitForEnding","kind":"method","owner":"Call","signature":["waitForEnding(timeout?: number): Promise<RelayEvent>"],"doc":"Wait until the call is ending.\n\nReturns immediately if the call is already ending (or ended). Typed wait\nover {@link waitFor}, mirroring Python's `call.wait_for_ending(timeout)`.\n\n@param timeout - Optional timeout in milliseconds. Omit to wait forever.\n@returns The `calling.call.state` {@link RelayEvent} (synthesized on short-circuit).\n@throws {Error} When the optional timeout elapses before the call is ending.","file":"dist/relay/Call.d.ts","line":177},{"name":"answer","kind":"method","owner":"Call","signature":["answer(extra?: Record<string, unknown>): Promise<CallingAnswerResult>"],"doc":"Answer an inbound call.\n\n@param extra - Optional additional params merged into the answer request\n (e.g. SIP headers, codec hints).\n@returns The platform's answer response.\n@throws {RelayError} When the answer command is rejected.","file":"dist/relay/Call.d.ts","line":188},{"name":"hangup","kind":"method","owner":"Call","signature":["hangup(reason?: string): Promise<CallingEndResult>"],"doc":"End / hang up the call.\n\n@param reason - Hangup reason delivered to the platform. Defaults to\n `\"hangup\"`.\n@returns The platform's end response.\n@throws {RelayError} When the end command is rejected.","file":"dist/relay/Call.d.ts","line":197},{"name":"pass","kind":"method","owner":"Call","signature":["pass(): Promise<CallingPassResult>"],"doc":"Decline control of an inbound call, returning it to routing.\n\nUse instead of {@link answer} when you want the call to fall through to\nthe next matching route rather than be handled by this client.\n\n@returns The platform's pass response.\n@throws {RelayError} When the pass command is rejected.","file":"dist/relay/Call.d.ts","line":207},{"name":"play","kind":"method","owner":"Call","signature":["play(media: PlayItem[], options?: {\n volume?: number;\n direction?: string;\n loop?: number;\n controlId?: string;\n onCompleted?: CompletedCallback;\n}): Promise<PlayAction>"],"doc":"Play audio content on the call.\n\nReturns immediately with a {@link PlayAction} — `await action.wait()` to\nblock until playback finishes, or call `stop()` / `pause()` / `resume()`\n/ `volume()` on it to control playback.\n\n@param media - Platform-shaped play items (TTS, audio URLs, silence, etc.).\n@param options - Optional playback controls.\n@param options.volume - Volume adjustment in dB.\n@param options.direction - `\"speak\"`, `\"hear\"`, or `\"both\"`.\n@param options.loop - Number of times to loop the playback.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.onCompleted - Callback fired when playback reaches a\n terminal state.\n@returns A {@link PlayAction} for control and completion tracking.\n@throws {RelayError} When the play command is rejected.","file":"dist/relay/Call.d.ts","line":226},{"name":"playTTS","kind":"method","owner":"Call","signature":["playTTS(text: string, options?: {\n language?: string;\n gender?: TtsGender;\n voice?: string;\n volume?: number;\n onCompleted?: CompletedCallback;\n}): Promise<PlayAction>"],"doc":"Play text-to-speech. Typed convenience over {@link play}.\n\nBuilds the `{ type: 'tts', params: { text, language?, gender?, voice? } }`\nmedia entry so callers don't hand-assemble it. Mirrors Python's\n`call.play_tts(text, *, language, gender, voice, volume)`.\n\n@param text - Text to speak.\n@param options - TTS options.\n@param options.language - BCP-47 language tag (e.g. `\"en-US\"`).\n@param options.gender - Voice gender (`\"male\"` / `\"female\"`).\n@param options.voice - Explicit voice identifier (overrides language/gender).\n@param options.volume - Top-level playback volume in dB.\n@param options.onCompleted - Callback fired when playback reaches a terminal state.\n@returns A {@link PlayAction} for control and completion tracking.\n@throws {RelayError} When the play command is rejected.","file":"dist/relay/Call.d.ts","line":250},{"name":"playAudio","kind":"method","owner":"Call","signature":["playAudio(url: string, options?: {\n volume?: number;\n onCompleted?: CompletedCallback;\n}): Promise<PlayAction>"],"doc":"Play an audio file from a URL. Typed convenience over {@link play}.\n\nBuilds the `{ type: 'audio', params: { url } }` media entry. Mirrors\nPython's `call.play_audio(url, *, volume)`.\n\n@param url - URL of the audio file to play.\n@param options - Audio options.\n@param options.volume - Top-level playback volume in dB.\n@param options.onCompleted - Callback fired when playback reaches a terminal state.\n@returns A {@link PlayAction} for control and completion tracking.\n@throws {RelayError} When the play command is rejected.","file":"dist/relay/Call.d.ts","line":270},{"name":"playSilence","kind":"method","owner":"Call","signature":["playSilence(duration: number, options?: {\n onCompleted?: CompletedCallback;\n}): Promise<PlayAction>"],"doc":"Play silence for `duration` seconds. Typed convenience over {@link play}.\n\nBuilds the `{ type: 'silence', params: { duration } }` media entry.\nMirrors Python's `call.play_silence(duration)`.\n\n@param duration - Length of silence in seconds.\n@param options - Playback options.\n@param options.onCompleted - Callback fired when playback reaches a terminal state.\n@returns A {@link PlayAction} for control and completion tracking.\n@throws {RelayError} When the play command is rejected.","file":"dist/relay/Call.d.ts","line":286},{"name":"playRingtone","kind":"method","owner":"Call","signature":["playRingtone(name: string, options?: {\n duration?: number;\n volume?: number;\n onCompleted?: CompletedCallback;\n}): Promise<PlayAction>"],"doc":"Play a named ringtone by country code. Typed convenience over {@link play}.\n\nBuilds the `{ type: 'ringtone', params: { name, duration? } }` media entry.\nMirrors Python's `call.play_ringtone(name, *, duration, volume)`.\n\n@param name - Ringtone name / country code (e.g. `\"us\"`, `\"gb\"`).\n@param options - Ringtone options.\n@param options.duration - How long to play the ringtone, in seconds (nested in media params).\n@param options.volume - Top-level playback volume in dB.\n@param options.onCompleted - Callback fired when playback reaches a terminal state.\n@returns A {@link PlayAction} for control and completion tracking.\n@throws {RelayError} When the play command is rejected.","file":"dist/relay/Call.d.ts","line":303},{"name":"record","kind":"method","owner":"Call","signature":["record(audio?: CallRecordRequest['params']['audio'], options?: {\n controlId?: string;\n onCompleted?: CompletedCallback;\n}): Promise<RecordAction>"],"doc":"Record audio from the call.\n\n@param audio - Platform-shaped audio recording options (direction, codec,\n timeouts, etc.). Defaults to `{}`.\n@param options - Recording behaviour.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.onCompleted - Callback fired when the recording reaches a\n terminal state.\n@returns A {@link RecordAction} for control and completion tracking.\n@throws {RelayError} When the record command is rejected.","file":"dist/relay/Call.d.ts","line":320},{"name":"playAndCollect","kind":"method","owner":"Call","signature":["playAndCollect(media: PlayItem[], collect: CollectConfig, options?: {\n volume?: number;\n controlId?: string;\n onCompleted?: CompletedCallback;\n}): Promise<CollectAction>"],"doc":"Play audio and collect digit / speech input in a single operation.\n\nConvenient for IVR prompts — playback stops as soon as input is received.\n\n@param media - Audio items to play while collecting.\n@param collect - Platform-shaped collect config (`digits`, `speech`, etc.).\n@param options - Playback and collection behaviour.\n@param options.volume - Playback volume adjustment in dB.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.onCompleted - Callback fired when collect completes.\n@returns A {@link CollectAction} for the combined play-and-collect flow.\n@throws {RelayError} When the play_and_collect command is rejected.","file":"dist/relay/Call.d.ts","line":338},{"name":"promptTTS","kind":"method","owner":"Call","signature":["promptTTS(text: string, collect: CollectConfig, options?: {\n language?: string;\n gender?: TtsGender;\n voice?: string;\n volume?: number;\n onCompleted?: CompletedCallback;\n}): Promise<CollectAction>"],"doc":"Play TTS then collect input. Typed media over {@link playAndCollect}.\n\nBuilds the `{ type: 'tts', params: { text, language?, gender?, voice? } }`\nplay media and forwards the caller's `collect` config. Mirrors Python's\n`call.prompt_tts(text, collect, *, language, gender, voice, volume)`.\n\n@param text - Text to speak before collecting.\n@param collect - Platform-shaped collect config (`digits`, `speech`, etc.).\n@param options - Prompt options.\n@param options.language - BCP-47 language tag (e.g. `\"en-US\"`).\n@param options.gender - Voice gender (`\"male\"` / `\"female\"`).\n@param options.voice - Explicit voice identifier (overrides language/gender).\n@param options.volume - Top-level playback volume in dB.\n@param options.onCompleted - Callback fired when collect completes.\n@returns A {@link CollectAction} for the combined play-and-collect flow.\n@throws {RelayError} When the play_and_collect command is rejected.","file":"dist/relay/Call.d.ts","line":361},{"name":"promptAudio","kind":"method","owner":"Call","signature":["promptAudio(url: string, collect: CollectConfig, options?: {\n volume?: number;\n onCompleted?: CompletedCallback;\n}): Promise<CollectAction>"],"doc":"Play an audio file then collect input. Typed media over {@link playAndCollect}.\n\nBuilds the `{ type: 'audio', params: { url } }` play media and forwards\nthe caller's `collect` config. Mirrors Python's\n`call.prompt_audio(url, collect, *, volume)`.\n\n@param url - URL of the audio file to play before collecting.\n@param collect - Platform-shaped collect config (`digits`, `speech`, etc.).\n@param options - Prompt options.\n@param options.volume - Top-level playback volume in dB.\n@param options.onCompleted - Callback fired when collect completes.\n@returns A {@link CollectAction} for the combined play-and-collect flow.\n@throws {RelayError} When the play_and_collect command is rejected.","file":"dist/relay/Call.d.ts","line":383},{"name":"collect","kind":"method","owner":"Call","signature":["collect(options?: {\n digits?: CallCollectRequest['params']['digits'];\n speech?: CallCollectRequest['params']['speech'];\n initialTimeout?: number;\n partialResults?: boolean;\n continuous?: boolean;\n sendStartOfInput?: boolean;\n startInputTimers?: boolean;\n controlId?: string;\n onCompleted?: CompletedCallback;\n}): Promise<StandaloneCollectAction>"],"doc":"Collect digit / speech input without playing media.\n\n@param options - Collect configuration.\n@param options.digits - DTMF digit-collection config.\n@param options.speech - Speech-recognition config.\n@param options.initialTimeout - Seconds to wait for the first input.\n@param options.partialResults - Emit partial (interim) results.\n@param options.continuous - Keep collecting until explicitly stopped.\n@param options.sendStartOfInput - Emit a start-of-input event when detected.\n@param options.startInputTimers - Start input timers immediately.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.onCompleted - Callback fired when collect completes.\n@returns A {@link StandaloneCollectAction} for control and completion tracking.\n@throws {RelayError} When the collect command is rejected.","file":"dist/relay/Call.d.ts","line":403},{"name":"connect","kind":"method","owner":"Call","signature":["connect(devices: DeviceInput[][], options?: {\n ringback?: CallingConnectParams['ringback'];\n tag?: string;\n maxDuration?: number;\n maxPricePerMinute?: number;\n statusUrl?: string;\n}): Promise<CallingConnectResult>"],"doc":"Bridge the call to one or more destinations.\n\nEach device is a {@link PhoneDevice}, {@link SipDevice}, or\n{@link FabricDevice} (dial a Fabric address directly — the platform resolves\nthe address to whatever it points to: a Subscriber, a Relay/LaML app, a video\nroom, …).\n\n@param devices - Serial/parallel dial plan — outer array of serial groups,\n inner arrays dialled in parallel.\n@param options - Connect behaviour.\n@param options.ringback - Ringback media played to the originating party.\n@param options.tag - Tag for event correlation.\n@param options.maxDuration - Maximum connect duration in seconds.\n@param options.maxPricePerMinute - Price cap per minute.\n@param options.statusUrl - Webhook URL for status events.\n@returns The platform's connect response.\n@throws {RelayError} When the connect command is rejected.","file":"dist/relay/Call.d.ts","line":433},{"name":"disconnect","kind":"method","owner":"Call","signature":["disconnect(): Promise<CallingDisconnectResult>"],"doc":"Disconnect (unbridge) a connected call.\n\n@returns The platform's disconnect response.\n@throws {RelayError} When the disconnect command is rejected.","file":"dist/relay/Call.d.ts","line":446},{"name":"sendDigits","kind":"method","owner":"Call","signature":["sendDigits(digits: string, controlId?: string): Promise<CallingSendDigitsResult>"],"doc":"Send DTMF digits on the call.\n\n@param digits - The DTMF digit string to send (e.g. `\"1234#\"`, `\"ww*9\"`).\n@param controlId - Explicit control ID. Auto-generated when omitted.\n@returns The platform's send-digits response.\n@throws {RelayError} When the send_digits command is rejected.","file":"dist/relay/Call.d.ts","line":455},{"name":"detect","kind":"method","owner":"Call","signature":["detect(detect: CallDetectRequest['params']['detect'], options?: {\n timeout?: number;\n controlId?: string;\n onCompleted?: CompletedCallback;\n}): Promise<DetectAction>"],"doc":"Start audio detection (answering machine, fax, DTMF).\n\n@param detect - Platform-shaped detect configuration.\n@param options - Detection behaviour.\n@param options.timeout - Detection timeout in seconds.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.onCompleted - Callback fired when detection completes.\n@returns A {@link DetectAction} for control and completion tracking.\n@throws {RelayError} When the detect command is rejected.","file":"dist/relay/Call.d.ts","line":467},{"name":"detectDigit","kind":"method","owner":"Call","signature":["detectDigit(options?: {\n digits?: string;\n timeout?: number;\n onCompleted?: CompletedCallback;\n}): Promise<DetectAction>"],"doc":"Detect DTMF digits. Typed convenience over {@link detect}.\n\nBuilds the `{ type: 'digit', params: { digits? } }` detect object.\nMirrors Python's `call.detect_digit(*, digits, timeout)`.\n\n@param options - Digit-detection options.\n@param options.digits - Restrict detection to this DTMF digit set (nested in detect params).\n@param options.timeout - Top-level detection timeout in seconds.\n@param options.onCompleted - Callback fired when detection completes.\n@returns A {@link DetectAction} for control and completion tracking.\n@throws {RelayError} When the detect command is rejected.","file":"dist/relay/Call.d.ts","line":485},{"name":"detectAnsweringMachine","kind":"method","owner":"Call","signature":["detectAnsweringMachine(options?: {\n initialTimeout?: number;\n endSilenceTimeout?: number;\n machineVoiceThreshold?: number;\n machineWordsThreshold?: number;\n detectInterruptions?: boolean;\n detectMessageEnd?: boolean;\n timeout?: number;\n onCompleted?: CompletedCallback;\n}): Promise<DetectAction>"],"doc":"Detect human vs answering machine (AMD). Typed convenience over {@link detect}.\n\nBuilds the `{ type: 'machine', params: { ...only-provided... } }` detect\nobject — only the options the caller supplies are emitted, matching\nPython's behaviour. Mirrors Python's `call.detect_answering_machine(*,\ninitial_timeout, end_silence_timeout, machine_voice_threshold,\nmachine_words_threshold, detect_interruptions, detect_message_end,\ntimeout)`.\n\n@param options - AMD options.\n@param options.initialTimeout - Seconds to wait for initial voice.\n@param options.endSilenceTimeout - Trailing-silence cutoff in seconds.\n@param options.machineVoiceThreshold - Voice-duration threshold for a machine verdict.\n@param options.machineWordsThreshold - Word-count threshold for a machine verdict.\n@param options.detectInterruptions - Emit interruption events during detection.\n@param options.detectMessageEnd - Detect the end of a machine's greeting/message.\n@param options.timeout - Top-level detection timeout in seconds.\n@param options.onCompleted - Callback fired when detection completes.\n@returns A {@link DetectAction} for control and completion tracking.\n@throws {RelayError} When the detect command is rejected.","file":"dist/relay/Call.d.ts","line":512},{"name":"detectFax","kind":"method","owner":"Call","signature":["detectFax(options?: {\n tone?: FaxTone;\n timeout?: number;\n onCompleted?: CompletedCallback;\n}): Promise<DetectAction>"],"doc":"Detect a fax tone (CED/CNG). Typed convenience over {@link detect}.\n\nBuilds the `{ type: 'fax', params: { tone? } }` detect object. Mirrors\nPython's `call.detect_fax(*, tone, timeout)`.\n\n@param options - Fax-detection options.\n@param options.tone - Restrict detection to a specific tone (`\"CED\"` / `\"CNG\"`), nested in detect params.\n@param options.timeout - Top-level detection timeout in seconds.\n@param options.onCompleted - Callback fired when detection completes.\n@returns A {@link DetectAction} for control and completion tracking.\n@throws {RelayError} When the detect command is rejected.","file":"dist/relay/Call.d.ts","line":535},{"name":"refer","kind":"method","owner":"Call","signature":["refer(device: DeviceInput, options?: {\n statusUrl?: string;\n}): Promise<CallingReferResult>"],"doc":"Transfer a SIP call via REFER.\n\n@param device - Platform-shaped SIP target device descriptor.\n@param options - Optional REFER behaviour.\n@param options.statusUrl - Webhook URL for REFER status events.\n@returns The platform's refer response.\n@throws {RelayError} When the refer command is rejected.","file":"dist/relay/Call.d.ts","line":549},{"name":"pay","kind":"method","owner":"Call","signature":["pay(paymentConnectorUrl: string, options?: {\n controlId?: string;\n inputMethod?: string;\n statusUrl?: string;\n paymentMethod?: string;\n timeout?: string;\n maxAttempts?: string;\n securityCode?: string;\n postalCode?: string;\n minPostalCodeLength?: string;\n tokenType?: string;\n chargeAmount?: string;\n currency?: string;\n language?: string;\n voice?: string;\n description?: string;\n validCardTypes?: string;\n parameters?: Record<string, unknown>[];\n prompts?: Record<string, unknown>[];\n onCompleted?: CompletedCallback;\n}): Promise<PayAction>"],"doc":"Start a PCI-compliant payment collection flow.\n\n@param paymentConnectorUrl - URL of the configured payment connector to\n tokenise the card with.\n@param options - Payment configuration — card-type filters, prompts,\n charge amount, etc. See the SignalWire pay documentation for field details.\n@returns A {@link PayAction} tracking the payment-collection flow.\n@throws {RelayError} When the pay command is rejected.","file":"dist/relay/Call.d.ts","line":562},{"name":"sendFax","kind":"method","owner":"Call","signature":["sendFax(document: string, options?: {\n identity?: string;\n headerInfo?: string;\n controlId?: string;\n onCompleted?: CompletedCallback;\n}): Promise<FaxAction>"],"doc":"Send a fax document.\n\n@param document - URL of the document to fax (TIFF or PDF).\n@param options - Fax behaviour.\n@param options.identity - Caller identity string sent in the fax header.\n@param options.headerInfo - Additional fax header text.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.onCompleted - Callback fired when the fax completes.\n@returns A {@link FaxAction} for control and completion tracking.\n@throws {RelayError} When the send_fax command is rejected.","file":"dist/relay/Call.d.ts","line":595},{"name":"receiveFax","kind":"method","owner":"Call","signature":["receiveFax(options?: {\n controlId?: string;\n onCompleted?: CompletedCallback;\n}): Promise<FaxAction>"],"doc":"Receive a fax and save it server-side.\n\n@param options - Fax reception behaviour.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.onCompleted - Callback fired when the fax completes.\n@returns A {@link FaxAction} for control and completion tracking.\n@throws {RelayError} When the receive_fax command is rejected.","file":"dist/relay/Call.d.ts","line":610},{"name":"tap","kind":"method","owner":"Call","signature":["tap(tap: CallTapRequest['params']['tap'], device: DeviceInput, options?: {\n controlId?: string;\n onCompleted?: CompletedCallback;\n}): Promise<TapAction>"],"doc":"Intercept call media and stream it to an external destination.\n\n@param tap - Platform-shaped tap configuration (direction, codec, etc.).\n@param device - Destination device descriptor (WebSocket URL, etc.).\n@param options - Tap behaviour.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.onCompleted - Callback fired when the tap completes.\n@returns A {@link TapAction} for control and completion tracking.\n@throws {RelayError} When the tap command is rejected.","file":"dist/relay/Call.d.ts","line":625},{"name":"stream","kind":"method","owner":"Call","signature":["stream(url: string, options?: {\n name?: string;\n codec?: string;\n track?: string;\n statusUrl?: string;\n statusUrlMethod?: string;\n authorizationBearerToken?: string;\n customParameters?: Record<string, unknown>;\n controlId?: string;\n onCompleted?: CompletedCallback;\n}): Promise<StreamAction>"],"doc":"Start streaming call audio to a WebSocket endpoint.\n\n@param url - WebSocket URL to stream audio to.\n@param options - Stream behaviour.\n@param options.name - Friendly name for the stream.\n@param options.codec - Audio codec (e.g. `\"PCMU\"`, `\"PCMA\"`).\n@param options.track - Which audio to stream: `\"inbound_track\"`,\n `\"outbound_track\"` or `\"both_tracks\"`. Sent as given.\n@param options.statusUrl - Webhook URL for stream status events.\n@param options.statusUrlMethod - HTTP method for `statusUrl` requests.\n@param options.authorizationBearerToken - Bearer token sent to the stream endpoint.\n@param options.customParameters - Extra parameters forwarded to the stream endpoint.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.onCompleted - Callback fired when the stream completes.\n@returns A {@link StreamAction} for control and completion tracking.\n@throws {RelayError} When the stream command is rejected.","file":"dist/relay/Call.d.ts","line":647},{"name":"transfer","kind":"method","owner":"Call","signature":["transfer(dest: string, extra?: Record<string, unknown>): Promise<CallingTransferResult>"],"doc":"Transfer call control to another RELAY app or SWML script.\n\n@param dest - Destination identifier (RELAY context, SWML URL, etc.).\n@param extra - Optional additional params merged into the transfer request.\n@returns The platform's transfer response.\n@throws {RelayError} When the transfer command is rejected.","file":"dist/relay/Call.d.ts","line":666},{"name":"joinConference","kind":"method","owner":"Call","signature":["joinConference(name: string, options?: {\n muted?: boolean;\n beep?: string;\n startOnEnter?: boolean;\n endOnExit?: boolean;\n waitUrl?: string;\n maxParticipants?: number;\n record?: string;\n region?: string;\n trim?: string;\n coach?: string;\n statusCallback?: string;\n statusCallbackEvent?: string;\n statusCallbackEventType?: string;\n statusCallbackMethod?: string;\n recordingStatusCallback?: string;\n recordingStatusCallbackEvent?: string;\n recordingStatusCallbackEventType?: string;\n recordingStatusCallbackMethod?: string;\n stream?: Record<string, unknown>;\n}): Promise<CallingJoinConferenceResult>"],"doc":"Join an ad-hoc audio conference.\n\n@param name - Conference name. Participants on the same name hear each other.\n@param options - Conference behaviour (muting, recording, status callbacks, etc.).\n@returns The platform's join-conference response.\n@throws {RelayError} When the join_conference command is rejected.","file":"dist/relay/Call.d.ts","line":675},{"name":"leaveConference","kind":"method","owner":"Call","signature":["leaveConference(conferenceId: string, extra?: Record<string, unknown>): Promise<CallingLeaveConferenceResult>"],"doc":"Leave an audio conference.\n\n@param conferenceId - Identifier of the conference to leave.\n@param extra - Optional additional params merged into the request.\n@returns The platform's leave-conference response.\n@throws {RelayError} When the leave_conference command is rejected.","file":"dist/relay/Call.d.ts","line":704},{"name":"hold","kind":"method","owner":"Call","signature":["hold(): Promise<Record<string, unknown>>"],"doc":"Put the call on hold.\n\n@returns The platform's hold response.\n@throws {RelayError} When the hold command is rejected.","file":"dist/relay/Call.d.ts","line":711},{"name":"unhold","kind":"method","owner":"Call","signature":["unhold(): Promise<Record<string, unknown>>"],"doc":"Release the call from hold.\n\n@returns The platform's unhold response.\n@throws {RelayError} When the unhold command is rejected.","file":"dist/relay/Call.d.ts","line":718},{"name":"denoise","kind":"method","owner":"Call","signature":["denoise(): Promise<CallingDenoiseResult>"],"doc":"Start noise reduction on the call.\n\n@returns The platform's denoise response.\n@throws {RelayError} When the denoise command is rejected.","file":"dist/relay/Call.d.ts","line":725},{"name":"denoiseStop","kind":"method","owner":"Call","signature":["denoiseStop(): Promise<CallingDenoiseStopResult>"],"doc":"Stop noise reduction on the call.\n\n@returns The platform's denoise-stop response.\n@throws {RelayError} When the denoise.stop command is rejected.","file":"dist/relay/Call.d.ts","line":732},{"name":"transcribe","kind":"method","owner":"Call","signature":["transcribe(options?: {\n controlId?: string;\n statusUrl?: string;\n onCompleted?: CompletedCallback;\n}): Promise<TranscribeAction>"],"doc":"Start transcribing the call.\n\n@param options - Transcription behaviour.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.statusUrl - Webhook URL for transcription status events.\n@param options.onCompleted - Callback fired when transcription completes.\n@returns A {@link TranscribeAction} for control and completion tracking.\n@throws {RelayError} When the transcribe command is rejected.","file":"dist/relay/Call.d.ts","line":743},{"name":"echo","kind":"method","owner":"Call","signature":["echo(options?: {\n timeout?: number;\n statusUrl?: string;\n}): Promise<CallingEchoResult>"],"doc":"Echo audio back to the caller (useful for testing network round-trip).\n\n@param options - Echo behaviour.\n@param options.timeout - How long to echo, in seconds.\n@param options.statusUrl - Webhook URL for echo status events.\n@returns The platform's echo response.\n@throws {RelayError} When the echo command is rejected.","file":"dist/relay/Call.d.ts","line":757},{"name":"bindDigit","kind":"method","owner":"Call","signature":["bindDigit(digits: string, bindMethod: string, options?: {\n bindParams?: Record<string, unknown>;\n realm?: string;\n maxTriggers?: number;\n}): Promise<CallingBindDigitResult>"],"doc":"Bind a DTMF digit sequence to trigger a RELAY method automatically when\nthe caller presses it.\n\n@param digits - DTMF sequence that triggers the binding (e.g. `\"*9\"`).\n@param bindMethod - RELAY method to invoke when the sequence is detected.\n@param options - Binding behaviour.\n@param options.bindParams - Params forwarded to `bindMethod` on trigger.\n@param options.realm - Optional realm label so bindings can be cleared in groups.\n@param options.maxTriggers - Maximum number of times the binding can fire.\n@returns The platform's bind_digit response.\n@throws {RelayError} When the bind_digit command is rejected.","file":"dist/relay/Call.d.ts","line":774},{"name":"clearDigitBindings","kind":"method","owner":"Call","signature":["clearDigitBindings(realm?: string): Promise<CallingClearDigitBindingsResult>"],"doc":"Clear all digit bindings, optionally filtered by realm.\n\n@param realm - When provided, only bindings with this realm label are cleared.\n@returns The platform's clear_digit_bindings response.\n@throws {RelayError} When the clear_digit_bindings command is rejected.","file":"dist/relay/Call.d.ts","line":786},{"name":"liveTranscribe","kind":"method","owner":"Call","signature":["liveTranscribe(action: Record<string, unknown>, extra?: Record<string, unknown>): Promise<CallingLiveTranscribeResult>"],"doc":"Start or stop live transcription on the call.\n\n@param action - Platform-shaped action block (`start` or `stop` plus\n configuration).\n@param extra - Optional additional params merged into the request.\n@returns The platform's live_transcribe response.\n@throws {RelayError} When the live_transcribe command is rejected.","file":"dist/relay/Call.d.ts","line":796},{"name":"liveTranslate","kind":"method","owner":"Call","signature":["liveTranslate(action: Record<string, unknown>, options?: {\n statusUrl?: string;\n}): Promise<CallingLiveTranslateResult>"],"doc":"Start or stop live translation on the call.\n\n@param action - Platform-shaped action block (`start` or `stop` plus\n source/target languages).\n@param options - Live-translate behaviour.\n@param options.statusUrl - Webhook URL for translation status events.\n@returns The platform's live_translate response.\n@throws {RelayError} When the live_translate command is rejected.","file":"dist/relay/Call.d.ts","line":807},{"name":"joinRoom","kind":"method","owner":"Call","signature":["joinRoom(name: string, options?: {\n statusUrl?: string;\n}): Promise<CallingJoinRoomResult>"],"doc":"Join a video / audio room.\n\n@param name - Room name — callers on the same name share the same room.\n@param options - Room behaviour.\n@param options.statusUrl - Webhook URL for room status events.\n@returns The platform's join_room response.\n@throws {RelayError} When the join_room command is rejected.","file":"dist/relay/Call.d.ts","line":819},{"name":"leaveRoom","kind":"method","owner":"Call","signature":["leaveRoom(extra?: Record<string, unknown>): Promise<CallingLeaveRoomResult>"],"doc":"Leave the current room.\n\n@param extra - Optional additional params merged into the request.\n@returns The platform's leave_room response.\n@throws {RelayError} When the leave_room command is rejected.","file":"dist/relay/Call.d.ts","line":829},{"name":"ai","kind":"method","owner":"Call","signature":["ai(options?: {\n controlId?: string;\n agent?: string;\n prompt?: Record<string, unknown>;\n postPrompt?: Record<string, unknown>;\n postPromptUrl?: string;\n postPromptAuthUser?: string;\n postPromptAuthPassword?: string;\n globalData?: Record<string, unknown>;\n pronounce?: Record<string, unknown>[];\n hints?: string[];\n languages?: Record<string, unknown>[];\n SWAIG?: Record<string, unknown>;\n aiParams?: Record<string, unknown>;\n onCompleted?: CompletedCallback;\n}): Promise<AIAction>"],"doc":"Start an AI agent session on the call.\n\n@param options - AI configuration — prompts, voices, tools, languages, etc.\n@returns An {@link AIAction} for control and completion tracking.\n@throws {RelayError} When the ai command is rejected.","file":"dist/relay/Call.d.ts","line":837},{"name":"amazonBedrock","kind":"method","owner":"Call","signature":["amazonBedrock(options?: {\n prompt?: unknown;\n SWAIG?: Record<string, unknown>;\n aiParams?: Record<string, unknown>;\n globalData?: Record<string, unknown>;\n postPrompt?: Record<string, unknown>;\n postPromptUrl?: string;\n}): Promise<CallingAmazonBedrockResult>"],"doc":"Connect the call to an Amazon Bedrock AI agent.\n\n@param options - Bedrock agent configuration.\n@param options.prompt - Prompt to send to the Bedrock agent.\n@param options.SWAIG - SWAIG configuration (functions, includes, etc.).\n@param options.aiParams - AI engine parameters.\n@param options.globalData - Global-data object available to SWAIG tools.\n@param options.postPrompt - Post-prompt configuration.\n@param options.postPromptUrl - URL to POST the final summary to.\n@returns The platform's amazon_bedrock response.\n@throws {RelayError} When the amazon_bedrock command is rejected.","file":"dist/relay/Call.d.ts","line":866},{"name":"aiMessage","kind":"method","owner":"Call","signature":["aiMessage(options?: {\n messageText?: string;\n role?: string;\n reset?: Record<string, unknown>;\n globalData?: Record<string, unknown>;\n}): Promise<CallingAiMessageResult>"],"doc":"Send a message into an active AI agent session.\n\n@param options - Message parameters.\n@param options.messageText - Text content to inject into the conversation.\n@param options.role - Speaker role (`\"system\"`, `\"user\"`, or `\"assistant\"`).\n@param options.reset - Reset directives for the conversation state.\n@param options.globalData - Global-data updates to merge.\n@returns The platform's ai_message response.\n@throws {RelayError} When the ai_message command is rejected.","file":"dist/relay/Call.d.ts","line":885},{"name":"aiHold","kind":"method","owner":"Call","signature":["aiHold(options?: {\n timeout?: string;\n prompt?: string;\n}): Promise<CallingAiHoldResult>"],"doc":"Put the AI agent session on hold (pause turn-taking).\n\n@param options - Hold behaviour.\n@param options.timeout - Maximum hold duration.\n@param options.prompt - Prompt played to the caller during the hold.\n@returns The platform's ai_hold response.\n@throws {RelayError} When the ai_hold command is rejected.","file":"dist/relay/Call.d.ts","line":900},{"name":"aiUnhold","kind":"method","owner":"Call","signature":["aiUnhold(options?: {\n prompt?: string;\n}): Promise<CallingAiUnholdResult>"],"doc":"Resume an AI agent session from hold.\n\n@param options - Unhold behaviour.\n@param options.prompt - Prompt played to the caller on resume.\n@returns The platform's ai_unhold response.\n@throws {RelayError} When the ai_unhold command is rejected.","file":"dist/relay/Call.d.ts","line":912},{"name":"userEvent","kind":"method","owner":"Call","signature":["userEvent(options?: {\n event?: string;\n} & Record<string, unknown>): Promise<CallingUserEventResult>"],"doc":"Emit a custom user-defined event on the call for your webhooks.\n\n@param options - Freeform event payload. Set `options.event` for the\n event name and include any additional fields your webhook expects.\n@returns The platform's user_event response.\n@throws {RelayError} When the user_event command is rejected.","file":"dist/relay/Call.d.ts","line":923},{"name":"queueEnter","kind":"method","owner":"Call","signature":["queueEnter(queueName: string, options?: {\n controlId?: string;\n statusUrl?: string;\n}): Promise<CallingQueueEnterResult>"],"doc":"Place the call into a named queue.\n\n@param queueName - Name of the queue to enter.\n@param options - Queue-entry behaviour.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.statusUrl - Webhook URL for queue status events.\n@returns The platform's queue.enter response.\n@throws {RelayError} When the queue.enter command is rejected.","file":"dist/relay/Call.d.ts","line":936},{"name":"queueLeave","kind":"method","owner":"Call","signature":["queueLeave(queueName: string, options?: {\n controlId?: string;\n queueId?: string;\n statusUrl?: string;\n}): Promise<CallingQueueLeaveResult>"],"doc":"Remove the call from a queue.\n\n@param queueName - Name of the queue to leave.\n@param options - Queue-exit behaviour.\n@param options.controlId - Explicit control ID. Auto-generated when omitted.\n@param options.queueId - Queue ID override (when multiple queues share a name).\n@param options.statusUrl - Webhook URL for queue status events.\n@returns The platform's queue.leave response.\n@throws {RelayError} When the queue.leave command is rejected.","file":"dist/relay/Call.d.ts","line":951},{"name":"toString","kind":"method","owner":"Call","signature":["toString(): string"],"doc":"Return a human-readable diagnostic string.\n\n@returns `<Call id=... state=... direction=...>` — handy for log output.","file":"dist/relay/Call.d.ts","line":961}]},"CallFlowsResource":{"name":"CallFlowsResource","kind":"class","exported":true,"signature":["class CallFlows extends FabricResource<CallFlowListResponse, CallFlowResponse, CallFlowCreateRequest, CallFlowUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":31,"members":[{"name":"constructor","kind":"constructor","owner":"CallFlowsResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":33},{"name":"create","kind":"method","owner":"CallFlowsResource","signature":["create(body: CallFlowCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<CallFlowResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":35},{"name":"update","kind":"method","owner":"CallFlowsResource","signature":["update(id: string, body: CallFlowUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<CallFlowResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":37},{"name":"listAddresses","kind":"method","owner":"CallFlowsResource","signature":["listAddresses(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<CallFlowAddressListResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":38},{"name":"listVersions","kind":"method","owner":"CallFlowsResource","signature":["listVersions(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<CallFlowVersionListResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":39},{"name":"deployVersion","kind":"method","owner":"CallFlowsResource","signature":["deployVersion(id: string, body: CallFlowVersionDeployRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<CallFlowVersionDeployResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":40}],"bases":["FabricResource"]},"CallHandler":{"name":"CallHandler","kind":"type","exported":true,"signature":["type CallHandler = (call: Call) => void | Promise<void>"],"doc":"Handler for inbound calls.","file":"dist/relay/types.d.ts","line":54},"CallLike":{"name":"CallLike","kind":"interface","exported":true,"signature":["interface CallLike"],"doc":"Structural subset of {@link Call} that an Action needs — avoids a circular\nimport between `Call.ts` and `Action.ts`.","file":"dist/relay/Action.d.ts","line":15,"members":[]},"CallReceiveEvent":{"name":"CallReceiveEvent","kind":"class","exported":true,"signature":["class CallReceiveEvent extends RelayEvent"],"doc":"`calling.call.receive` — fires when an inbound call arrives on a subscribed context.","file":"dist/relay/RelayEvent.d.ts","line":64,"members":[{"name":"callState","kind":"property","owner":"CallReceiveEvent","readonly":true,"signature":["readonly callState: CallState"],"doc":"Initial call state ({@link CallState}; typically `created`).","file":"dist/relay/RelayEvent.d.ts","line":66},{"name":"direction","kind":"property","owner":"CallReceiveEvent","readonly":true,"signature":["readonly direction: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":67},{"name":"device","kind":"property","owner":"CallReceiveEvent","readonly":true,"signature":["readonly device: Device"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":68},{"name":"nodeId","kind":"property","owner":"CallReceiveEvent","readonly":true,"signature":["readonly nodeId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":69},{"name":"projectId","kind":"property","owner":"CallReceiveEvent","readonly":true,"signature":["readonly projectId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":70},{"name":"context","kind":"property","owner":"CallReceiveEvent","readonly":true,"signature":["readonly context: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":71},{"name":"segmentId","kind":"property","owner":"CallReceiveEvent","readonly":true,"signature":["readonly segmentId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":72},{"name":"tag","kind":"property","owner":"CallReceiveEvent","readonly":true,"signature":["readonly tag: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":73},{"name":"constructor","kind":"constructor","owner":"CallReceiveEvent","signature":["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)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":74},{"name":"fromPayload","kind":"method","owner":"CallReceiveEvent","static":true,"signature":["static fromPayload(payload: EventPayload): CallReceiveEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":75}],"bases":["RelayEvent"]},"CallState":{"name":"CallState","kind":"type","exported":true,"signature":["type CallState = 'created' | 'ringing' | 'answered' | 'ending' | 'ended'"],"doc":"Call lifecycle state for {@link ../relay/Call.Call.state} and the\n`call_state` field of a `calling.call.state` event\n({@link ../relay/RelayEvent.CallStateEvent.callState}). The platform walks a\ncall through `created → ringing → answered → ending → ended`; `ended` is the\nsole terminal state (see {@link isCallStateTerminal}).","file":"dist/relay/closedSets.d.ts","line":48},"CallStateEvent":{"name":"CallStateEvent","kind":"class","exported":true,"signature":["class CallStateEvent extends RelayEvent"],"doc":"`calling.call.state` — fires on every lifecycle transition (created, ringing, answered, ending, ended).","file":"dist/relay/RelayEvent.d.ts","line":49,"members":[{"name":"callState","kind":"property","owner":"CallStateEvent","readonly":true,"signature":["readonly callState: CallState"],"doc":"The new call state — a {@link CallState} (`created` | `ringing` |\n`answered` | `ending` | `ended`; closed literal union, autocompleted +\ntypo-checked). Pass to {@link ../relay/closedSets.isCallStateTerminal} to\ntest for the terminal state.","file":"dist/relay/RelayEvent.d.ts","line":56},{"name":"endReason","kind":"property","owner":"CallStateEvent","readonly":true,"signature":["readonly endReason: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":57},{"name":"direction","kind":"property","owner":"CallStateEvent","readonly":true,"signature":["readonly direction: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":58},{"name":"device","kind":"property","owner":"CallStateEvent","readonly":true,"signature":["readonly device: Device"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":59},{"name":"constructor","kind":"constructor","owner":"CallStateEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, callState?: CallState, endReason?: string, direction?: string, device?: Device)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":60},{"name":"fromPayload","kind":"method","owner":"CallStateEvent","static":true,"signature":["static fromPayload(payload: EventPayload): CallStateEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":61}],"bases":["RelayEvent"]},"CallingErrorEvent":{"name":"CallingErrorEvent","kind":"class","exported":true,"signature":["class CallingErrorEvent extends RelayEvent"],"doc":"`calling.error` — platform-emitted error against the calling namespace.","file":"dist/relay/RelayEvent.d.ts","line":229,"members":[{"name":"code","kind":"property","owner":"CallingErrorEvent","readonly":true,"signature":["readonly code: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":230},{"name":"message","kind":"property","owner":"CallingErrorEvent","readonly":true,"signature":["readonly message: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":231},{"name":"constructor","kind":"constructor","owner":"CallingErrorEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, code?: string, message?: string)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":232},{"name":"fromPayload","kind":"method","owner":"CallingErrorEvent","static":true,"signature":["static fromPayload(payload: EventPayload): CallingErrorEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":233}],"bases":["RelayEvent"]},"CallingNamespace":{"name":"CallingNamespace","kind":"class","exported":true,"signature":["class Calling extends BaseResource"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":5,"members":[{"name":"constructor","kind":"constructor","owner":"CallingNamespace","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":6},{"name":"dial","kind":"method","owner":"CallingNamespace","signature":["dial(from: string, to: string, options?: {\n caller_id?: string;\n fallback_url?: string;\n status_url?: string;\n status_events?: ('answered' | 'queued' | 'initiated' | 'ringing' | 'ending' | 'ended')[];\n url_method?: string;\n url?: string;\n codecs?: string[] | string;\n swml?: SWMLObject;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":7},{"name":"update","kind":"method","owner":"CallingNamespace","signature":["update(id: uuid, options?: {\n fallback_url?: string;\n status?: 'canceled' | 'completed';\n status_url?: string;\n url?: string;\n swml?: SWMLObject;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":18},{"name":"end","kind":"method","owner":"CallingNamespace","signature":["end(callId: string, options?: {\n reason?: HangupReason;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":26},{"name":"aiHold","kind":"method","owner":"CallingNamespace","signature":["aiHold(callId: string, options?: {\n timeout?: number;\n prompt?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":30},{"name":"aiUnhold","kind":"method","owner":"CallingNamespace","signature":["aiUnhold(callId: string, options?: {\n prompt?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":35},{"name":"aiMessage","kind":"method","owner":"CallingNamespace","signature":["aiMessage(callId: string, options?: {\n role?: 'system' | 'user' | 'assistant';\n message_text?: string;\n reset?: CallAIMessageResetParams;\n global_data?: Record<string, Record<string, unknown>>;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":39},{"name":"liveTranscribe","kind":"method","owner":"CallingNamespace","signature":["liveTranscribe(callId: string, action: LiveTranscribeStartAction | LiveTranscribeSummarizeAction | LiveTranscribeStopAction, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":46},{"name":"liveTranslate","kind":"method","owner":"CallingNamespace","signature":["liveTranslate(callId: string, action: LiveTranslateStartAction | LiveTranslateSummarizeAction | LiveTranslateInjectAction | LiveTranslateStopAction, options?: {\n status_url?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":49},{"name":"transfer","kind":"method","owner":"CallingNamespace","signature":["transfer(callId: string, dest: string | SWMLObject, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":53},{"name":"userEvent","kind":"method","owner":"CallingNamespace","signature":["userEvent(callId: string, event: Record<string, Record<string, unknown>>, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":56},{"name":"disconnect","kind":"method","owner":"CallingNamespace","signature":["disconnect(callId: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":59},{"name":"play","kind":"method","owner":"CallingNamespace","signature":["play(callId: string, play: Record<string, unknown>[], options?: {\n control_id?: string;\n volume?: number;\n direction?: 'listen' | 'speak' | 'both';\n loop?: number;\n status_url?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":62},{"name":"playPause","kind":"method","owner":"CallingNamespace","signature":["playPause(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":70},{"name":"playResume","kind":"method","owner":"CallingNamespace","signature":["playResume(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":73},{"name":"playStop","kind":"method","owner":"CallingNamespace","signature":["playStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":76},{"name":"playVolume","kind":"method","owner":"CallingNamespace","signature":["playVolume(callId: string, control_id: string, volume: number, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":79},{"name":"record","kind":"method","owner":"CallingNamespace","signature":["record(callId: string, options?: {\n control_id?: string;\n audio?: Record<string, unknown>;\n status_url?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":82},{"name":"recordPause","kind":"method","owner":"CallingNamespace","signature":["recordPause(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":88},{"name":"recordResume","kind":"method","owner":"CallingNamespace","signature":["recordResume(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":91},{"name":"recordStop","kind":"method","owner":"CallingNamespace","signature":["recordStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":94},{"name":"collect","kind":"method","owner":"CallingNamespace","signature":["collect(callId: string, options?: {\n control_id?: string;\n initial_timeout?: number;\n digits?: Record<string, unknown>;\n speech?: Record<string, unknown>;\n continuous?: boolean;\n partial_results?: boolean;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":97},{"name":"collectStop","kind":"method","owner":"CallingNamespace","signature":["collectStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":106},{"name":"collectStartInputTimers","kind":"method","owner":"CallingNamespace","signature":["collectStartInputTimers(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":109},{"name":"detect","kind":"method","owner":"CallingNamespace","signature":["detect(callId: string, detect: Record<string, unknown>, options?: {\n control_id?: string;\n timeout?: number;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":112},{"name":"detectStop","kind":"method","owner":"CallingNamespace","signature":["detectStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":117},{"name":"tap","kind":"method","owner":"CallingNamespace","signature":["tap(callId: string, tap: Record<string, unknown>, device: Record<string, unknown>, options?: {\n control_id?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":120},{"name":"tapStop","kind":"method","owner":"CallingNamespace","signature":["tapStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":124},{"name":"stream","kind":"method","owner":"CallingNamespace","signature":["stream(callId: string, url: string, options?: {\n control_id?: string;\n codec?: string;\n track?: 'inbound_track' | 'outbound_track' | 'both_tracks';\n authorization_bearer_token?: string;\n custom_parameters?: Record<string, unknown>;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":127},{"name":"streamStop","kind":"method","owner":"CallingNamespace","signature":["streamStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":135},{"name":"denoise","kind":"method","owner":"CallingNamespace","signature":["denoise(callId: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":138},{"name":"denoiseStop","kind":"method","owner":"CallingNamespace","signature":["denoiseStop(callId: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":141},{"name":"transcribe","kind":"method","owner":"CallingNamespace","signature":["transcribe(callId: string, options?: {\n control_id?: string;\n status_url?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":144},{"name":"transcribeStop","kind":"method","owner":"CallingNamespace","signature":["transcribeStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":149},{"name":"aiStop","kind":"method","owner":"CallingNamespace","signature":["aiStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":152},{"name":"sendFaxStop","kind":"method","owner":"CallingNamespace","signature":["sendFaxStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":155},{"name":"receiveFaxStop","kind":"method","owner":"CallingNamespace","signature":["receiveFaxStop(callId: string, control_id: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":158},{"name":"refer","kind":"method","owner":"CallingNamespace","signature":["refer(callId: string, device: Record<string, unknown>, options?: {\n status_url?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CallResponse>"],"doc":"","file":"dist/rest/namespaces/calling.resources.generated.d.ts","line":161}],"bases":["BaseResource"]},"CaptureLeg":{"name":"CaptureLeg","kind":"type","exported":true,"signature":["type CaptureLeg = (conversationId: string, medium: string) => boolean | Promise<boolean>"],"doc":"Ends a leg and writes its record: `captureLeg(conversationId, medium)`,\nwhere `medium` is `voice` or `chat`. Return true once the record is written.","file":"dist/ai-chat/HandoffRouter.d.ts","line":101},"ChatGateway":{"name":"ChatGateway","kind":"class","exported":true,"signature":["class ChatGateway"],"doc":"Server-side proxy that lets a browser chat without holding a token.\n\nThe caps are counted in this process. Behind several replicas each keeps its\nown counts, so the effective cap is multiplied by the replica count; set\nthem with that in mind, or put a shared limiter in front.","file":"dist/ai-chat/ChatGateway.d.ts","line":235,"members":[{"name":"configUrl","kind":"property","owner":"ChatGateway","readonly":true,"signature":["readonly configUrl: string"],"doc":"The agent config sent on every call.","file":"dist/ai-chat/ChatGateway.d.ts","line":237},{"name":"key","kind":"property","owner":"ChatGateway","readonly":true,"signature":["readonly key: string"],"doc":"The publishable key the browser presents.","file":"dist/ai-chat/ChatGateway.d.ts","line":239},{"name":"allowedOrigins","kind":"property","owner":"ChatGateway","readonly":true,"signature":["readonly allowedOrigins: ReadonlySet<string>"],"doc":"Listed origins, without trailing slashes.","file":"dist/ai-chat/ChatGateway.d.ts","line":241},{"name":"handleTtl","kind":"property","owner":"ChatGateway","signature":["handleTtl: number"],"doc":"Seconds a handle stays valid.","file":"dist/ai-chat/ChatGateway.d.ts","line":243},{"name":"conversationTimeout","kind":"property","owner":"ChatGateway","signature":["conversationTimeout: number | null"],"doc":"Idle seconds before the service ends a conversation, or null for its default.","file":"dist/ai-chat/ChatGateway.d.ts","line":245},{"name":"maxNewConversations","kind":"property","owner":"ChatGateway","signature":["maxNewConversations: number"],"doc":"New conversations allowed per window.","file":"dist/ai-chat/ChatGateway.d.ts","line":247},{"name":"maxTurns","kind":"property","owner":"ChatGateway","signature":["maxTurns: number"],"doc":"Turns allowed per conversation.","file":"dist/ai-chat/ChatGateway.d.ts","line":249},{"name":"windowSeconds","kind":"property","owner":"ChatGateway","signature":["windowSeconds: number"],"doc":"Window for `maxNewConversations`, in seconds.","file":"dist/ai-chat/ChatGateway.d.ts","line":251},{"name":"constructor","kind":"constructor","owner":"ChatGateway","signature":["constructor(options: ChatGatewayOptions)"],"doc":"@param options - The agent config, the key, and the limits.\n@throws {Error} When `configUrl` is empty.","file":"dist/ai-chat/ChatGateway.d.ts","line":261},{"name":"lastActivity","kind":"method","owner":"ChatGateway","static":true,"signature":["static lastActivity(messages: readonly unknown[] | null | undefined): number | null"],"doc":"Epoch seconds of the newest message, or null when none is dated.\n\nLets a browser restore its idle clock after a reload. Without it a widget\nrestarts the clock at zero, so a tab closed for 55 minutes of a 60-minute\ntimeout waits another hour before warning while the conversation ends in\nfive.\n\nThe service stamps messages in microseconds; this converts to seconds.\nEvery role counts, not only the visible ones, because the service's idle\nclock moves on any write.\n\n@param messages - Messages as `chat_log` returns them.\n@returns Epoch seconds, or null.","file":"dist/ai-chat/ChatGateway.d.ts","line":277},{"name":"effectiveTimeout","kind":"accessor","owner":"ChatGateway","signature":["get effectiveTimeout(): number"],"doc":"The idle seconds a conversation actually gets: `conversationTimeout`, or\nthe service default when unset, so the number given to a browser is never\nnull.","file":"dist/ai-chat/ChatGateway.d.ts","line":283},{"name":"close","kind":"method","owner":"ChatGateway","signature":["close(): Promise<void>"],"doc":"Close the client, if the gateway built it. A client passed in the options\nbelongs to the caller and is left open.","file":"dist/ai-chat/ChatGateway.d.ts","line":288},{"name":"mintHandle","kind":"method","owner":"ChatGateway","signature":["mintHandle(conversationId?: string): string"],"doc":"Issue a signed handle for a conversation.\n\nThe browser never names a conversation. If it could, a publishable key\nand a guessed id would be enough to continue someone else's chat; with\nsigning, a caller can only present handles this gateway issued.\n\n@param conversationId - The conversation to name; a new random id when omitted.\n@returns The handle.","file":"dist/ai-chat/ChatGateway.d.ts","line":299},{"name":"readHandle","kind":"method","owner":"ChatGateway","signature":["readHandle(handle: string): string"],"doc":"The conversation id inside a handle. The signature is checked first and\nthe expiry second, both before the id is used.\n\n@param handle - A handle from {@link mintHandle}.\n@returns The conversation id.\n@throws {GatewayRejection} 400 for a malformed handle, 403 for a bad\n signature or an expired handle.","file":"dist/ai-chat/ChatGateway.d.ts","line":309},{"name":"checkOrigin","kind":"method","owner":"ChatGateway","signature":["checkOrigin(origin: string | null | undefined): void"],"doc":"Allow localhost and listed origins; refuse any other.\n\nA missing `Origin` is allowed: browsers send one on the cross-origin POSTs\nthis serves, so its absence means a caller that isn't a browser. Refusing\nthose would break server-side use without stopping an attacker, who can\nleave the header out.\n\n@param origin - The request's `Origin` header, or null/undefined when absent.\n@throws {GatewayRejection} 403 for an origin that isn't allowed.","file":"dist/ai-chat/ChatGateway.d.ts","line":321},{"name":"checkKey","kind":"method","owner":"ChatGateway","signature":["checkKey(presented: string | null | undefined): void"],"doc":"Verify the publishable key the browser sent, in constant time.\n\n@param presented - The key from the request, or null/undefined when absent.\n@throws {GatewayRejection} 401 when the key is missing or wrong.","file":"dist/ai-chat/ChatGateway.d.ts","line":328},{"name":"visibleMessages","kind":"method","owner":"ChatGateway","static":true,"signature":["static visibleMessages(messages: readonly unknown[] | null | undefined): Array<Record<string, unknown>>"],"doc":"The transcript a browser may redraw, and nothing else.\n\n`chat_log` returns the conversation as the service holds it: the\nsubstituted system prompt, then tool calls and results alongside the\ndialogue. Relaying that would publish the developer's prompt to anyone\nwith a handle. Only user and assistant turns with text are kept, reduced\nto role, content and, when dated, the time in epoch seconds, so a\nrestored transcript isn't shown as sent now.\n\n@param messages - Messages as `chat_log` returns them.\n@returns The visible turns.","file":"dist/ai-chat/ChatGateway.d.ts","line":342},{"name":"readUserMetadata","kind":"method","owner":"ChatGateway","signature":["readUserMetadata(body: Record<string, unknown>): Record<string, unknown> | null"],"doc":"Validate the page context a browser sent (`user_meta_data`).\n\nThe only field forwarded instead of replaced, so the only one that needs\na shape and a size limit. Absent, null and empty all yield null.\n\n@param body - The browser's request body.\n@returns The metadata, or null.\n@throws {GatewayRejection} 400 when it isn't a JSON object, 413 when it's\n larger than {@link MAX_USER_METADATA_BYTES} serialized.","file":"dist/ai-chat/ChatGateway.d.ts","line":356},{"name":"prepare","kind":"method","owner":"ChatGateway","signature":["prepare(body: Record<string, unknown>, opts: {\n origin?: string | null;\n key?: string | null;\n}): [string, Record<string, unknown>, string | null]"],"doc":"Validate a browser request and build the call to the chat service.\n\nEverything the browser could use to widen its own access is refused or\nreplaced here: the method must be one of four, the conversation comes\nfrom a signed handle, and `config_url` is the gateway's. The one\nexception is `user_meta_data`, which is forwarded (see\n{@link readUserMetadata}).\n\nA chat message over {@link MAX_MESSAGE_BYTES} (UTF-8) is refused with\n413 before a conversation is created or a turn counted.\n\n@param body - The browser's request body:\n `{ method?, handle?, message?, user_meta_data? }`.\n@param opts - `origin`: the `Origin` header; `key`: the presented key.\n@returns `[method, params, mintedHandle]`, the service method and params\n to send, and the new handle when this call created the conversation\n (null otherwise), for the caller to return to the browser.\n@throws {GatewayRejection} When the request is refused.","file":"dist/ai-chat/ChatGateway.d.ts","line":377},{"name":"router","kind":"method","owner":"ChatGateway","signature":["router(): Hono"],"doc":"A Hono app serving this gateway at `/`. Mount it with\n`agent.mount(gateway.router(), { prefix: '/chat' })`, or `app.route()`.\n\n`POST /` takes `{ method: 'start'|'chat'|'log'|'end', handle?, message?,\nuser_meta_data? }` with the key in `Authorization: Bearer`. A chat\nstreams the service's JSON-RPC response through without buffering it:\nthe service pads slow turns with keepalive whitespace so proxies don't\nclose the connection, and collecting the body here would hold that\npadding back and bring the timeout into your own stack. A new handle is\nreturned in the `X-Chat-Handle` header, which is why it can be sent\nbefore the body.\n\n`start` returns `{ greeting, status, timeout }`, `log` returns\n`{ messages, timeout, last_activity }` with only the visible dialogue,\nand `end` returns `{ status: 'ended' }`. A refusal returns\n`{ error: reason }` with the rejection's status, and a failure reaching\nthe chat service before any reply is sent returns 502\n`{ error: 'chat service error' }`, with CORS headers either way. A\nrequest body over {@link MAX_REQUEST_BODY_BYTES} is answered with 413\n`{ error: 'request too large' }` without being parsed.\n\n@returns The Hono app.","file":"dist/ai-chat/ChatGateway.d.ts","line":405}]},"ChatGatewayOptions":{"name":"ChatGatewayOptions","kind":"interface","exported":true,"signature":["interface ChatGatewayOptions"],"doc":"Constructor options for {@link ChatGateway}.","file":"dist/ai-chat/ChatGateway.d.ts","line":149,"members":[{"name":"configUrl","kind":"property","owner":"ChatGatewayOptions","signature":["configUrl: string"],"doc":"The agent config this key may reach. Sent on every call and never taken\nfrom the request, or whoever holds a key would choose which agent runs.","file":"dist/ai-chat/ChatGateway.d.ts","line":154},{"name":"key","kind":"property","owner":"ChatGatewayOptions","signature":["key?: string"],"doc":"The publishable key the widget carries. Falls back to\n`SIGNALWIRE_CHAT_GATEWAY_KEY`, then to a generated key, which is only\nuseful to a process that also serves the page and can embed it.","file":"dist/ai-chat/ChatGateway.d.ts","line":160},{"name":"allowedOrigins","kind":"property","owner":"ChatGatewayOptions","signature":["allowedOrigins?: readonly string[]"],"doc":"Origins allowed to use this key. Localhost is always allowed so local\ndevelopment works unconfigured; any other origin must be listed.","file":"dist/ai-chat/ChatGateway.d.ts","line":165},{"name":"client","kind":"property","owner":"ChatGatewayOptions","signature":["client?: AIChatClient"],"doc":"The client to forward with. Built from the environment when omitted, and then closed by {@link ChatGateway.close}.","file":"dist/ai-chat/ChatGateway.d.ts","line":167},{"name":"secret","kind":"property","owner":"ChatGatewayOptions","signature":["secret?: string | Uint8Array"],"doc":"HMAC key for signing handles. Falls back to\n`SIGNALWIRE_CHAT_GATEWAY_SECRET`, then to a random per-process value,\nwhich invalidates outstanding handles on restart and across replicas.\nSet it when you run more than one replica or restart often.","file":"dist/ai-chat/ChatGateway.d.ts","line":174},{"name":"handleTtl","kind":"property","owner":"ChatGatewayOptions","signature":["handleTtl?: number"],"doc":"Seconds a handle stays valid. Default {@link DEFAULT_HANDLE_TTL}.","file":"dist/ai-chat/ChatGateway.d.ts","line":176},{"name":"conversationTimeout","kind":"property","owner":"ChatGatewayOptions","signature":["conversationTimeout?: number | null"],"doc":"Idle seconds before the service ends a conversation, sent on every\ncreate. Set here rather than in the page: the service's responses don't\nexpose the deadline, so the gateway reports it back on `start` and `log`\nfor a widget to warn that the next message opens a new conversation.\nOmit for the service default ({@link SERVICE_DEFAULT_CONVERSATION_TIMEOUT}).","file":"dist/ai-chat/ChatGateway.d.ts","line":184},{"name":"maxNewConversations","kind":"property","owner":"ChatGatewayOptions","signature":["maxNewConversations?: number"],"doc":"New conversations per `windowSeconds`. The cap that matters most: a\nleaked key is used to open many one-turn conversations, each billed for\nits opening turn. Default {@link DEFAULT_MAX_NEW_CONVERSATIONS}.","file":"dist/ai-chat/ChatGateway.d.ts","line":190},{"name":"maxTurns","kind":"property","owner":"ChatGatewayOptions","signature":["maxTurns?: number"],"doc":"Turns one conversation may run. Default {@link DEFAULT_MAX_TURNS}.","file":"dist/ai-chat/ChatGateway.d.ts","line":192},{"name":"windowSeconds","kind":"property","owner":"ChatGatewayOptions","signature":["windowSeconds?: number"],"doc":"Window for `maxNewConversations`, in seconds. Default {@link DEFAULT_WINDOW_SECONDS}.","file":"dist/ai-chat/ChatGateway.d.ts","line":194}]},"ChatInProgressError":{"name":"ChatInProgressError","kind":"class","exported":true,"signature":["class ChatInProgressError extends AIChatError"],"doc":"Another message is being processed for this conversation (-32007).","file":"dist/ai-chat/AIChatClient.d.ts","line":71,"members":[{"name":"constructor","kind":"constructor","owner":"ChatInProgressError","signature":["constructor(code: number | null, message: string)"],"doc":"","file":"dist/ai-chat/AIChatClient.d.ts","line":72}],"bases":["AIChatError"]},"ChatLog":{"name":"ChatLog","kind":"interface","exported":true,"signature":["interface ChatLog"],"doc":"Result of {@link AIChatClient.log}.","file":"dist/ai-chat/AIChatClient.d.ts","line":103,"members":[{"name":"messages","kind":"property","owner":"ChatLog","signature":["messages: Array<Record<string, unknown>>"],"doc":"Full message history (the wire `chat_log` field).","file":"dist/ai-chat/AIChatClient.d.ts","line":105},{"name":"callTimeline","kind":"property","owner":"ChatLog","signature":["callTimeline: Array<Record<string, unknown>>"],"doc":"The call timeline (the wire `call_timeline` field).","file":"dist/ai-chat/AIChatClient.d.ts","line":107}]},"ChatOptions":{"name":"ChatOptions","kind":"interface","exported":true,"signature":["interface ChatOptions extends ConversationTurnOptions"],"doc":"Options for {@link AIChatClient.chat}.","file":"dist/ai-chat/AIChatClient.d.ts","line":147,"members":[{"name":"role","kind":"property","owner":"ChatOptions","signature":["role?: string"],"doc":"Message role (`\"user\"` or `\"system\"`). Default `\"user\"`.","file":"dist/ai-chat/AIChatClient.d.ts","line":149}],"bases":["ConversationTurnOptions"]},"ChatResource":{"name":"ChatResource","kind":"class","exported":true,"signature":["class Chat extends BaseResource"],"doc":"","file":"dist/rest/namespaces/chat.resources.generated.d.ts","line":5,"members":[{"name":"constructor","kind":"constructor","owner":"ChatResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/chat.resources.generated.d.ts","line":6},{"name":"createToken","kind":"method","owner":"ChatResource","signature":["createToken(ttl: number, channels: ChatChannel, options?: {\n member_id?: string;\n state?: ChatState;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<ChatToken>"],"doc":"","file":"dist/rest/namespaces/chat.resources.generated.d.ts","line":7}],"bases":["BaseResource"]},"ChatResponse":{"name":"ChatResponse","kind":"interface","exported":true,"signature":["interface ChatResponse"],"doc":"Result of {@link AIChatClient.chat}.","file":"dist/ai-chat/AIChatClient.d.ts","line":94,"members":[{"name":"text","kind":"property","owner":"ChatResponse","signature":["text: string"],"doc":"The assistant's reply text (the wire `response` field).","file":"dist/ai-chat/AIChatClient.d.ts","line":96},{"name":"conversationId","kind":"property","owner":"ChatResponse","signature":["conversationId: string"],"doc":"The conversation id this reply belongs to.","file":"dist/ai-chat/AIChatClient.d.ts","line":98},{"name":"userEvent","kind":"property","owner":"ChatResponse","signature":["userEvent: Record<string, unknown> | null"],"doc":"An optional structured event the turn emitted, else `null`.","file":"dist/ai-chat/AIChatClient.d.ts","line":100}]},"ClaudeSkillsSkill":{"name":"ClaudeSkillsSkill","kind":"class","exported":true,"signature":["class ClaudeSkillsSkill extends SkillBase"],"doc":"Load Claude-style SKILL.md files as SignalWire agent tools.\n\nThis skill parses Claude Code skill directories and makes them available\nas SWAIG tools that the AI can call. Each Claude skill becomes a tool\nthat returns the skill's instructions when invoked.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('claude_skills', { skills_path: './claude-skills' });\n```","file":"dist/skills/builtin/claude_skills.d.ts","line":26,"members":[{"name":"SKILL_NAME","kind":"property","owner":"ClaudeSkillsSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/claude_skills.d.ts","line":27},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"ClaudeSkillsSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/claude_skills.d.ts","line":28},{"name":"SKILL_VERSION","kind":"property","owner":"ClaudeSkillsSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/claude_skills.d.ts","line":29},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"ClaudeSkillsSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/claude_skills.d.ts","line":30},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"ClaudeSkillsSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/claude_skills.d.ts","line":31},{"name":"getParameterSchema","kind":"method","owner":"ClaudeSkillsSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/claude_skills.d.ts","line":40},{"name":"setup","kind":"method","owner":"ClaudeSkillsSkill","signature":["setup(): Promise<boolean>"],"doc":"Setup the Claude skills loader — discovers and parses all SKILL.md files.\n\nReturns `true` on success and `false` on any failure (missing path,\ninvalid path, stat failure, or non-directory), mirroring the Python\nskill's `setup() -> bool` contract.","file":"dist/skills/builtin/claude_skills.d.ts","line":48},{"name":"getTools","kind":"method","owner":"ClaudeSkillsSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"","file":"dist/skills/builtin/claude_skills.d.ts","line":66},{"name":"getHints","kind":"method","owner":"ClaudeSkillsSkill","signature":["getHints(): string[]"],"doc":"","file":"dist/skills/builtin/claude_skills.d.ts","line":68},{"name":"getInstanceKey","kind":"method","owner":"ClaudeSkillsSkill","signature":["getInstanceKey(): string"],"doc":"","file":"dist/skills/builtin/claude_skills.d.ts","line":70}],"bases":["SkillBase"]},"ClientOptions":{"name":"ClientOptions","kind":"interface","exported":true,"signature":["interface ClientOptions"],"doc":"Options for constructing a RestClient.","file":"dist/rest/types.d.ts","line":6,"members":[{"name":"project","kind":"property","owner":"ClientOptions","signature":["project?: string"],"doc":"SignalWire project ID. Falls back to SIGNALWIRE_PROJECT_ID env var.","file":"dist/rest/types.d.ts","line":8},{"name":"token","kind":"property","owner":"ClientOptions","signature":["token?: string"],"doc":"SignalWire API token. Falls back to SIGNALWIRE_API_TOKEN env var.","file":"dist/rest/types.d.ts","line":10},{"name":"host","kind":"property","owner":"ClientOptions","signature":["host?: string"],"doc":"SignalWire space host (e.g. \"example.signalwire.com\"). Falls back to SIGNALWIRE_SPACE env var.","file":"dist/rest/types.d.ts","line":12},{"name":"fetchImpl","kind":"property","owner":"ClientOptions","signature":["fetchImpl?: typeof globalThis.fetch"],"doc":"Custom fetch implementation for testing.","file":"dist/rest/types.d.ts","line":14},{"name":"requestOptions","kind":"property","owner":"ClientOptions","signature":["requestOptions?: RequestOptionsInit"],"doc":"Client-default transport envelope (timeout / retries / abort) applied to\nevery request; a per-request `requestOptions` shallow-overrides it. See\n{@link RequestOptions}.","file":"dist/rest/types.d.ts","line":20}]},"CollectAction":{"name":"CollectAction","kind":"class","exported":true,"signature":["class CollectAction extends Action"],"doc":"Async handle for a `play_and_collect` action (combined playback + input collection).","file":"dist/relay/Action.d.ts","line":149,"members":[{"name":"constructor","kind":"constructor","owner":"CollectAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":150},{"name":"stop","kind":"method","owner":"CollectAction","signature":["stop(): Promise<CallingPlayAndCollectStopResult>"],"doc":"Stop the play_and_collect operation.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":162},{"name":"pause","kind":"method","owner":"CollectAction","signature":["pause(behavior?: string): Promise<CallingPlayAndCollectResult>"],"doc":"Pause the prompt playback mid-collect (resumable with {@link resume}).\n\n@param behavior - Optional behaviour hint controlling what plays in place\n of the paused prompt audio.\n@returns The platform's pause response.\n@throws {RelayError} When the pause command is rejected.","file":"dist/relay/Action.d.ts","line":171},{"name":"resume","kind":"method","owner":"CollectAction","signature":["resume(): Promise<CallingPlayAndCollectResult>"],"doc":"Resume prompt playback paused by {@link pause}.\n\n@returns The platform's resume response.\n@throws {RelayError} When the resume command is rejected.","file":"dist/relay/Action.d.ts","line":178},{"name":"volume","kind":"method","owner":"CollectAction","signature":["volume(volume: number): Promise<CallingPlayAndCollectVolumeResult>"],"doc":"Adjust playback volume of the prompt audio mid-collect.\n\n@param volume - Volume adjustment in dB.\n@returns The platform's volume response.\n@throws {RelayError} When the volume command is rejected.","file":"dist/relay/Action.d.ts","line":186},{"name":"startInputTimers","kind":"method","owner":"CollectAction","signature":["startInputTimers(): Promise<CallingCollectStartInputTimersResult>"],"doc":"Start the collect input timers (useful when `initial_timeout` should be\nreset after an async side effect completes).\n\n@returns The platform's start_input_timers response.\n@throws {RelayError} When the command is rejected.","file":"dist/relay/Action.d.ts","line":194}],"bases":["Action"]},"CollectConfig":{"name":"CollectConfig","kind":"type","exported":true,"signature":["type CollectConfig = Omit<CallingCollectParams, 'node_id' | 'call_id' | 'control_id'>"],"doc":"Collect-input configuration — the canonical `calling.collect` params minus the\ntransport keys (`node_id`/`call_id`/`control_id`) the SDK fills internally.\nThe `digits`/`speech`/timer field types come straight from the RELAY schema.","file":"dist/relay/types.d.ts","line":168},"CollectEvent":{"name":"CollectEvent","kind":"class","exported":true,"signature":["class CollectEvent extends RelayEvent"],"doc":"`calling.call.collect` — caller input (DTMF or speech) collected by a collect action.","file":"dist/relay/RelayEvent.d.ts","line":96,"members":[{"name":"controlId","kind":"property","owner":"CollectEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":97},{"name":"state","kind":"property","owner":"CollectEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":98},{"name":"result","kind":"property","owner":"CollectEvent","readonly":true,"signature":["readonly result: EventPayload"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":99},{"name":"final","kind":"property","owner":"CollectEvent","readonly":true,"signature":["readonly final: boolean | undefined"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":100},{"name":"constructor","kind":"constructor","owner":"CollectEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, result?: EventPayload, final_?: boolean | undefined)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":101},{"name":"fromPayload","kind":"method","owner":"CollectEvent","static":true,"signature":["static fromPayload(payload: EventPayload): CollectEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":102}],"bases":["RelayEvent"]},"CompletedCallback":{"name":"CompletedCallback","kind":"type","exported":true,"signature":["type CompletedCallback = (event: RelayEvent) => void | Promise<void>"],"doc":"Callback when an action or message completes.","file":"dist/relay/types.d.ts","line":60},"ConciergeAgent":{"name":"ConciergeAgent","kind":"class","exported":true,"signature":["class ConciergeAgent extends AgentBase"],"doc":"Prefab agent that acts as a virtual concierge for a venue, providing information\nabout services, amenities, hours of operation, availability, and directions.\n\n@example Hotel concierge\n```ts\nimport { ConciergeAgent } from '@signalwire/sdk';\n\nconst agent = new ConciergeAgent({\n venueName: 'The Park Hotel',\n services: ['Room service', 'Valet parking', 'Spa', 'Restaurant'],\n hoursOfOperation: {\n restaurant: '7 AM - 10 PM daily',\n spa: '9 AM - 9 PM daily',\n default: '24 hours',\n },\n amenities: {\n pool: { location: 'Rooftop', hours: '6 AM - 10 PM' },\n gym: { location: 'Floor 2', hours: '24 hours' },\n },\n});\n\nawait agent.serve({ port: 3000 });\n```","file":"dist/prefabs/ConciergeAgent.d.ts","line":58,"members":[{"name":"venueName","kind":"property","owner":"ConciergeAgent","signature":["venueName: string"],"doc":"Name of the venue or business.","file":"dist/prefabs/ConciergeAgent.d.ts","line":60},{"name":"services","kind":"property","owner":"ConciergeAgent","signature":["services: string[]"],"doc":"List of services offered by the venue.","file":"dist/prefabs/ConciergeAgent.d.ts","line":62},{"name":"amenities","kind":"property","owner":"ConciergeAgent","signature":["amenities: Record<string, Record<string, string>>"],"doc":"Dictionary of amenities, each mapping to a dict of detail keys/values.","file":"dist/prefabs/ConciergeAgent.d.ts","line":64},{"name":"hoursOfOperation","kind":"property","owner":"ConciergeAgent","signature":["hoursOfOperation: Record<string, string>"],"doc":"Hours of operation by category. Defaults to `{ default: \"9 AM - 5 PM\" }`.","file":"dist/prefabs/ConciergeAgent.d.ts","line":66},{"name":"specialInstructions","kind":"property","owner":"ConciergeAgent","signature":["specialInstructions: string[]"],"doc":"Special instructions appended to the agent's instruction bullets.","file":"dist/prefabs/ConciergeAgent.d.ts","line":68},{"name":"constructor","kind":"constructor","owner":"ConciergeAgent","signature":["constructor(config: ConciergeConfig)"],"doc":"Create a ConciergeAgent for a venue with the given services, amenities, and hours.\n@param config - Configuration including venue name, services, amenities, and optional hours/instructions/welcome.","file":"dist/prefabs/ConciergeAgent.d.ts","line":73},{"name":"defineTools","kind":"method","owner":"ConciergeAgent","protected":true,"signature":["protected defineTools(): void"],"doc":"Register the `check_availability` and `get_directions` SWAIG tools.","file":"dist/prefabs/ConciergeAgent.d.ts","line":78},{"name":"checkAvailability","kind":"method","owner":"ConciergeAgent","signature":["checkAvailability(args: Record<string, unknown>, _rawData: Record<string, unknown>): FunctionResult"],"doc":"SWAIG handler for `check_availability`: check whether a service is available\non a given date/time. Mirrors Python `ConciergeAgent.check_availability`.","file":"dist/prefabs/ConciergeAgent.d.ts","line":83},{"name":"getDirections","kind":"method","owner":"ConciergeAgent","signature":["getDirections(args: Record<string, unknown>, _rawData: Record<string, unknown>): FunctionResult"],"doc":"SWAIG handler for `get_directions`: provide directions to a location or\namenity. Mirrors Python `ConciergeAgent.get_directions`.","file":"dist/prefabs/ConciergeAgent.d.ts","line":88},{"name":"onSummary","kind":"method","owner":"ConciergeAgent","signature":["onSummary(summary: Record<string, unknown> | null, _rawData: PostPrompt): void | Promise<void>"],"doc":"Process the interaction summary returned at the end of a call.\nLogs structured summaries as JSON. Subclasses may override to persist or process.","file":"dist/prefabs/ConciergeAgent.d.ts","line":93}],"bases":["AgentBase"]},"ConciergeConfig":{"name":"ConciergeConfig","kind":"interface","exported":true,"signature":["interface ConciergeConfig"],"doc":"Configuration for the {@link ConciergeAgent}.","file":"dist/prefabs/ConciergeAgent.d.ts","line":13,"members":[{"name":"venueName","kind":"property","owner":"ConciergeConfig","signature":["venueName: string"],"doc":"Name of the venue or business (required).","file":"dist/prefabs/ConciergeAgent.d.ts","line":15},{"name":"services","kind":"property","owner":"ConciergeConfig","signature":["services: string[]"],"doc":"List of services offered by the venue (required).","file":"dist/prefabs/ConciergeAgent.d.ts","line":17},{"name":"amenities","kind":"property","owner":"ConciergeConfig","signature":["amenities: Record<string, Record<string, string>>"],"doc":"Dictionary of amenities, each mapping to a dict of detail keys/values.","file":"dist/prefabs/ConciergeAgent.d.ts","line":19},{"name":"hoursOfOperation","kind":"property","owner":"ConciergeConfig","signature":["hoursOfOperation?: Record<string, string>"],"doc":"Optional hours of operation by category (e.g. `{ default: \"9 AM - 5 PM\" }`).","file":"dist/prefabs/ConciergeAgent.d.ts","line":21},{"name":"specialInstructions","kind":"property","owner":"ConciergeConfig","signature":["specialInstructions?: string[]"],"doc":"Optional special instructions appended to the agent's instruction bullets.","file":"dist/prefabs/ConciergeAgent.d.ts","line":23},{"name":"welcomeMessage","kind":"property","owner":"ConciergeConfig","signature":["welcomeMessage?: string"],"doc":"Optional custom welcome message spoken as a non-bargeable static greeting.","file":"dist/prefabs/ConciergeAgent.d.ts","line":25},{"name":"name","kind":"property","owner":"ConciergeConfig","signature":["name?: string"],"doc":"Agent display name (defaults to `\"concierge\"`).","file":"dist/prefabs/ConciergeAgent.d.ts","line":27},{"name":"route","kind":"property","owner":"ConciergeConfig","signature":["route?: string"],"doc":"HTTP route for this agent (defaults to `\"/concierge\"`).","file":"dist/prefabs/ConciergeAgent.d.ts","line":29},{"name":"agentOptions","kind":"property","owner":"ConciergeConfig","signature":["agentOptions?: Partial<AgentOptions>"],"doc":"Additional AgentBase options forwarded to `super()`.","file":"dist/prefabs/ConciergeAgent.d.ts","line":31}]},"ConferenceEvent":{"name":"ConferenceEvent","kind":"class","exported":true,"signature":["class ConferenceEvent extends RelayEvent"],"doc":"`calling.conference` — conference lifecycle change (created, active, ended).","file":"dist/relay/RelayEvent.d.ts","line":221,"members":[{"name":"conferenceId","kind":"property","owner":"ConferenceEvent","readonly":true,"signature":["readonly conferenceId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":222},{"name":"name","kind":"property","owner":"ConferenceEvent","readonly":true,"signature":["readonly name: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":223},{"name":"status","kind":"property","owner":"ConferenceEvent","readonly":true,"signature":["readonly status: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":224},{"name":"constructor","kind":"constructor","owner":"ConferenceEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, conferenceId?: string, name?: string, status?: string)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":225},{"name":"fromPayload","kind":"method","owner":"ConferenceEvent","static":true,"signature":["static fromPayload(payload: EventPayload): ConferenceEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":226}],"bases":["RelayEvent"]},"ConferenceLogs":{"name":"ConferenceLogs","kind":"class","exported":true,"signature":["class ConferenceLogs extends BaseResource"],"doc":"","file":"dist/rest/namespaces/logs.resources.generated.d.ts","line":6,"members":[{"name":"constructor","kind":"constructor","owner":"ConferenceLogs","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/logs.resources.generated.d.ts","line":7},{"name":"list","kind":"method","owner":"ConferenceLogs","signature":["list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ConferencesResponse>"],"doc":"","file":"dist/rest/namespaces/logs.resources.generated.d.ts","line":8}],"bases":["BaseResource"]},"ConferenceRoomsResource":{"name":"ConferenceRoomsResource","kind":"class","exported":true,"signature":["class ConferenceRooms extends FabricResource<ConferenceRoomListResponse, ConferenceRoomResponse, ConferenceRoomCreateRequest, ConferenceRoomUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":42,"members":[{"name":"constructor","kind":"constructor","owner":"ConferenceRoomsResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":44},{"name":"create","kind":"method","owner":"ConferenceRoomsResource","signature":["create(body: ConferenceRoomCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<ConferenceRoomResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":46},{"name":"update","kind":"method","owner":"ConferenceRoomsResource","signature":["update(id: string, body: ConferenceRoomUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<ConferenceRoomResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":48},{"name":"listAddresses","kind":"method","owner":"ConferenceRoomsResource","signature":["listAddresses(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ConferenceRoomAddressListResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":49}],"bases":["FabricResource"]},"ConfigLoader":{"name":"ConfigLoader","kind":"class","exported":true,"signature":["class ConfigLoader"],"doc":"JSON configuration file loader with environment variable interpolation and dot-notation access.","file":"dist/ConfigLoader.d.ts","line":8,"members":[{"name":"constructor","kind":"constructor","owner":"ConfigLoader","signature":["constructor(filePaths?: string | string[])"],"doc":"Create a new ConfigLoader, optionally loading a JSON file immediately.\n\nAccepts a single file path or an array of paths. When given an array,\nthe loader iterates in order and loads the first file that exists\n(mirroring Python's ordered-search behaviour).\n\n@param filePaths - Path(s) to a JSON config file to load on construction.","file":"dist/ConfigLoader.d.ts","line":23},{"name":"configPaths","kind":"accessor","owner":"ConfigLoader","signature":["get configPaths(): string[]"],"doc":"Get the ordered list of config file paths that were passed/searched.\n@returns The array of config paths.","file":"dist/ConfigLoader.d.ts","line":28},{"name":"load","kind":"method","owner":"ConfigLoader","signature":["load(filePath: string): this"],"doc":"Load configuration from a JSON file, performing `${VAR|default}` env var interpolation on the raw text.\n@param filePath - Path to the JSON config file.\n@returns This instance for chaining.","file":"dist/ConfigLoader.d.ts","line":34},{"name":"search","kind":"method","owner":"ConfigLoader","static":true,"signature":["static search(filename: string, additionalPaths?: string[], serviceName?: string): ConfigLoader | null"],"doc":"Search for a config file in standard locations.\n\nDefault search paths: CWD, `./config`, `$HOME/.signalwire`,\n`.swml/`, `$HOME/.swml/`, `/etc/swml/`.\n\n@param filename - The config file name to search for.\n@param additionalPaths - Extra directories to search before the defaults.\n@param serviceName - Optional service name; prepends service-specific filenames to the search.\n@returns A loaded ConfigLoader if found, or null if the file does not exist in any search path.","file":"dist/ConfigLoader.d.ts","line":46},{"name":"findConfigFile","kind":"method","owner":"ConfigLoader","static":true,"signature":["static findConfigFile(serviceName?: string, additionalPaths?: string[]): string | null"],"doc":"Find a config file path without loading it.\n\nSearches service-specific filenames, additional paths, and default paths.\nReturns the first found path string or null.\n\n@param serviceName - Optional service name for service-specific config filenames.\n@param additionalPaths - Additional file paths to check.\n@returns Path to the first config file found, or null.","file":"dist/ConfigLoader.d.ts","line":57},{"name":"get","kind":"method","owner":"ConfigLoader","signature":["get<T = unknown>(path: string, defaultValue?: T): T"],"doc":"Retrieve a configuration value using a dot-notation path (e.g. `'server.port'`).\n@param path - Dot-separated key path into the config object.\n@param defaultValue - Value returned when the path does not exist.\n@returns The resolved value, or defaultValue if not found.","file":"dist/ConfigLoader.d.ts","line":68},{"name":"set","kind":"method","owner":"ConfigLoader","signature":["set(path: string, value: unknown): this"],"doc":"Set a configuration value at the given dot-notation path, creating intermediate objects as needed.\n@param path - Dot-separated key path into the config object.\n@param value - The value to store.\n@returns This instance for chaining.","file":"dist/ConfigLoader.d.ts","line":75},{"name":"has","kind":"method","owner":"ConfigLoader","signature":["has(path: string): boolean"],"doc":"Check whether a dot-notation path exists in the loaded configuration.\n@param path - Dot-separated key path to check.\n@returns True if the path resolves to a defined value.","file":"dist/ConfigLoader.d.ts","line":81},{"name":"getConfig","kind":"method","owner":"ConfigLoader","signature":["getConfig(): Record<string, unknown>"],"doc":"Return a shallow copy of the entire configuration object. Canonical name,\nmatching Python's `ConfigLoader.get_config()`.\n@returns A copy of the top-level config data.","file":"dist/ConfigLoader.d.ts","line":87},{"name":"getConfigFile","kind":"method","owner":"ConfigLoader","signature":["getConfigFile(): string | null"],"doc":"Return the absolute path of the loaded config file, if any. Canonical name,\nmatching Python's `ConfigLoader.get_config_file()`.\n@returns The file path, or null if config was loaded from an object.","file":"dist/ConfigLoader.d.ts","line":93},{"name":"hasConfig","kind":"method","owner":"ConfigLoader","signature":["hasConfig(): boolean"],"doc":"Check if a configuration was loaded.\n\n**Deliberate deviation from Python `has_config()`:** Python returns `True`\nonly when a file was loaded (`self._config is not None`). This TypeScript\nimplementation also returns `true` when data was loaded via\n{@link loadFromObject}, because `loadFromObject` is an extra TS-only method\nwith no Python equivalent. Treating object-loaded data as \"configured\" is\nthe correct semantic for the TS API surface.\n\nIf you need file-load-only detection, check `this.getConfigFile() !== null`.\n\n@returns True if configuration data exists (from file or object).","file":"dist/ConfigLoader.d.ts","line":108},{"name":"getSection","kind":"method","owner":"ConfigLoader","signature":["getSection(section: string): Record<string, unknown>"],"doc":"Get an entire configuration section with all environment variables substituted.\n@param section - The top-level section name (e.g. 'security', 'server').\n@returns The configuration section as an object, or an empty object if not found.","file":"dist/ConfigLoader.d.ts","line":114},{"name":"substituteVars","kind":"method","owner":"ConfigLoader","signature":["substituteVars(value: unknown, maxDepth?: number): unknown"],"doc":"Recursively substitute `${VAR|default}` environment variables in any value.\n\nWalks strings, objects, and arrays. Coerces result strings to boolean\n(`\"true\"` / `\"false\"`) or number when appropriate.\n\n@param value - The value to process (string, object, array, or primitive).\n@param maxDepth - Maximum recursion depth to prevent infinite loops (default: 10).\n@returns The value with all environment variables substituted.","file":"dist/ConfigLoader.d.ts","line":125},{"name":"mergeWithEnv","kind":"method","owner":"ConfigLoader","signature":["mergeWithEnv(envPrefix?: string): Record<string, unknown>"],"doc":"Merge configuration with environment variables that match a prefix.\n\nConfig file values take precedence over environment variables. Matching\nenv var keys are stripped of the prefix, lowercased, split on `_`, and\nwritten into a nested object (e.g. `SWML_FOO_BAR` → `{ foo: { bar: v } }`).\nMirrors Python's `merge_with_env` in\n`signalwire/signalwire/core/config_loader.py`.\n\n@param envPrefix - Prefix for environment variables to consider (default: `'SWML_'`).\n@returns Merged configuration dictionary.","file":"dist/ConfigLoader.d.ts","line":138},{"name":"loadFromObject","kind":"method","owner":"ConfigLoader","signature":["loadFromObject(obj: Record<string, unknown>): this"],"doc":"Load configuration from a plain object instead of a file, useful for testing or programmatic setup.\n@param obj - The configuration object to use.\n@returns This instance for chaining.","file":"dist/ConfigLoader.d.ts","line":155},{"name":"interpolateEnvVars","kind":"method","owner":"ConfigLoader","signature":["interpolateEnvVars(input: string): string"],"doc":"Interpolate ${VAR|default} patterns in a raw string.\n@param input - The string containing env var references.\n@returns The string with all env var references resolved.","file":"dist/ConfigLoader.d.ts","line":161}]},"ConnectEvent":{"name":"ConnectEvent","kind":"class","exported":true,"signature":["class ConnectEvent extends RelayEvent"],"doc":"`calling.call.connect` — state transition when one call connects to another (dialplan/bridge).","file":"dist/relay/RelayEvent.d.ts","line":105,"members":[{"name":"connectState","kind":"property","owner":"ConnectEvent","readonly":true,"signature":["readonly connectState: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":106},{"name":"peer","kind":"property","owner":"ConnectEvent","readonly":true,"signature":["readonly peer: EventPayload"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":107},{"name":"constructor","kind":"constructor","owner":"ConnectEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, connectState?: string, peer?: EventPayload)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":108},{"name":"fromPayload","kind":"method","owner":"ConnectEvent","static":true,"signature":["static fromPayload(payload: EventPayload): ConnectEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":109}],"bases":["RelayEvent"]},"Context":{"name":"Context","kind":"class","exported":true,"signature":["class Context"],"doc":"A named context containing ordered steps, prompt configuration, and navigation rules.","file":"dist/ContextBuilder.d.ts","line":487,"members":[{"name":"name","kind":"property","owner":"Context","signature":["name: string"],"doc":"The unique name identifying this context.","file":"dist/ContextBuilder.d.ts","line":489},{"name":"constructor","kind":"constructor","owner":"Context","signature":["constructor(name: string)"],"doc":"Creates a new Context.\n@param name - The unique context name.","file":"dist/ContextBuilder.d.ts","line":511},{"name":"addStep","kind":"method","owner":"Context","signature":["addStep(name: string, opts?: {\n task?: string;\n bullets?: string[];\n criteria?: string;\n functions?: string | string[];\n validSteps?: string[];\n}): Step"],"doc":"Adds a new step to this context.\n@param name - The unique step name within this context.\n@param opts - Optional shorthand for task text, bullets, criteria, functions, and valid steps.\n@returns The newly created Step for further configuration.","file":"dist/ContextBuilder.d.ts","line":518},{"name":"getStep","kind":"method","owner":"Context","signature":["getStep(name: string): Step | undefined"],"doc":"Returns a step by name.\n@param name - The step name to retrieve.\n@returns The matching Step, or undefined if not found.","file":"dist/ContextBuilder.d.ts","line":530},{"name":"removeStep","kind":"method","owner":"Context","signature":["removeStep(name: string): this"],"doc":"Removes a step from this context by name.\n@param name - The step name to remove.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":536},{"name":"moveStep","kind":"method","owner":"Context","signature":["moveStep(name: string, position: number): this"],"doc":"Moves a step to a new position in the step order.\n@param name - The step name to move.\n@param position - The zero-based index to insert at.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":543},{"name":"setValidContexts","kind":"method","owner":"Context","signature":["setValidContexts(contexts: string[]): this"],"doc":"Sets which contexts the AI may navigate to from this context.\n@param contexts - List of allowed context names.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":549},{"name":"setValidSteps","kind":"method","owner":"Context","signature":["setValidSteps(steps: string[]): this"],"doc":"Sets which steps the AI may navigate to from this context.\n@param steps - List of allowed step names.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":555},{"name":"setPostPrompt","kind":"method","owner":"Context","signature":["setPostPrompt(postPrompt: string): this"],"doc":"Sets the post-prompt text for this context.\n@param postPrompt - The post-prompt string.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":561},{"name":"setSystemPrompt","kind":"method","owner":"Context","signature":["setSystemPrompt(systemPrompt: string): this"],"doc":"Sets raw system prompt text, mutually exclusive with system POM sections.\n@param systemPrompt - The system prompt string.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":567},{"name":"setConsolidate","kind":"method","owner":"Context","signature":["setConsolidate(consolidate: boolean): this"],"doc":"Sets whether to consolidate conversation history when entering this context.\n@param consolidate - Whether to consolidate.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":573},{"name":"setFullReset","kind":"method","owner":"Context","signature":["setFullReset(fullReset: boolean): this"],"doc":"Sets whether to fully reset conversation history when entering this context.\n@param fullReset - Whether to fully reset.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":579},{"name":"setUserPrompt","kind":"method","owner":"Context","signature":["setUserPrompt(userPrompt: string): this"],"doc":"Sets the user prompt text for this context.\n@param userPrompt - The user prompt string.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":585},{"name":"setInitialStep","kind":"method","owner":"Context","signature":["setInitialStep(stepName: string): this"],"doc":"Set which step the context starts on when entered.\n\nBy default, a context starts on its first step (index 0). Use this to\nskip a preamble step on re-entry via `change_context`.\n\n@param stepName - Name of the step to start on. Must exist in this context (validated by ContextBuilder.validate()).\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":595},{"name":"setIsolated","kind":"method","owner":"Context","signature":["setIsolated(isolated: boolean): this"],"doc":"Mark this context as isolated — entering it wipes conversation history.\n\nWhen `isolated=true` and the context is entered via change_context, the\nruntime wipes the conversation array. The model starts fresh with only\nthe new context's systemPrompt + step instructions, with no memory of\nprior turns.\n\nEXCEPTION — `reset` overrides the wipe:\n If the context also has a `reset` configuration (via consolidate or\n full_reset), the wipe is skipped in favor of the reset behavior. Use\n reset with consolidate=true to summarize prior history into a single\n message instead of dropping it entirely.\n\nUse cases:\n - Switching to a sensitive billing flow that should not see prior\n small-talk\n - Handing off to a different agent persona\n - Resetting after a long off-topic detour\n\n@param isolated - True to wipe conversation history on context entry\n (subject to the reset exception above).\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":620},{"name":"addSystemSection","kind":"method","owner":"Context","signature":["addSystemSection(title: string, body: string): this"],"doc":"Adds a POM section to the system prompt, mutually exclusive with raw system prompt text.\n@param title - The section heading.\n@param body - The section body text.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":627},{"name":"addSystemBullets","kind":"method","owner":"Context","signature":["addSystemBullets(title: string, bullets: string[]): this"],"doc":"Adds a POM section with bullets to the system prompt, mutually exclusive with raw system prompt text.\n@param title - The section heading.\n@param bullets - The list of bullet point strings.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":634},{"name":"setPrompt","kind":"method","owner":"Context","signature":["setPrompt(prompt: string): this"],"doc":"Sets raw prompt text for this context, mutually exclusive with POM prompt sections.\n@param prompt - The prompt string.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":640},{"name":"addSection","kind":"method","owner":"Context","signature":["addSection(title: string, body: string): this"],"doc":"Adds a POM section with a body to the context prompt, mutually exclusive with raw prompt text.\n@param title - The section heading.\n@param body - The section body text.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":647},{"name":"addBullets","kind":"method","owner":"Context","signature":["addBullets(title: string, bullets: string[]): this"],"doc":"Adds a POM section with bullets to the context prompt, mutually exclusive with raw prompt text.\n@param title - The section heading.\n@param bullets - The list of bullet point strings.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":654},{"name":"setEnterFillers","kind":"method","owner":"Context","signature":["setEnterFillers(fillers: Record<string, string[]>): this"],"doc":"Sets filler phrases spoken when entering this context, keyed by language code.\n@param fillers - Map of language codes to arrays of filler phrases.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":660},{"name":"setExitFillers","kind":"method","owner":"Context","signature":["setExitFillers(fillers: Record<string, string[]>): this"],"doc":"Sets filler phrases spoken when exiting this context, keyed by language code.\n@param fillers - Map of language codes to arrays of filler phrases.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":666},{"name":"addEnterFiller","kind":"method","owner":"Context","signature":["addEnterFiller(languageCode: string, fillers: string[]): this"],"doc":"Adds enter filler phrases for a specific language.\n@param languageCode - The language code (e.g., \"en-US\").\n@param fillers - Array of filler phrases.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":673},{"name":"addExitFiller","kind":"method","owner":"Context","signature":["addExitFiller(languageCode: string, fillers: string[]): this"],"doc":"Adds exit filler phrases for a specific language.\n@param languageCode - The language code (e.g., \"en-US\").\n@param fillers - Array of filler phrases.\n@returns This context for chaining.","file":"dist/ContextBuilder.d.ts","line":680},{"name":"setHistory","kind":"method","owner":"Context","signature":["setHistory(history: string): this"],"doc":"Set the default history visibility mode for every step in this context.\n\nA step's own `setHistory()` overrides this. See {@link Step.setHistory}\nfor what each mode does.\n\n@param history - One of `\"keep\"`, `\"default\"`, or `\"hide\"`.\n@returns This context for chaining.\n@throws {Error} If `history` is not one of the three modes.","file":"dist/ContextBuilder.d.ts","line":691},{"name":"getSteps","kind":"method","owner":"Context","signature":["getSteps(): Map<string, Step>"],"doc":"@internal","file":"dist/ContextBuilder.d.ts","line":693},{"name":"getStepOrder","kind":"method","owner":"Context","signature":["getStepOrder(): readonly string[]"],"doc":"@internal","file":"dist/ContextBuilder.d.ts","line":695},{"name":"getInitialStep","kind":"method","owner":"Context","signature":["getInitialStep(): string | null"],"doc":"@internal","file":"dist/ContextBuilder.d.ts","line":697},{"name":"getValidContexts","kind":"method","owner":"Context","signature":["getValidContexts(): string[] | null"],"doc":"@internal","file":"dist/ContextBuilder.d.ts","line":699},{"name":"toDict","kind":"method","owner":"Context","signature":["toDict(): ContextDict"],"doc":"Serializes this context and all its steps to a plain object for SWML output.\n@returns A dictionary representation of this context.","file":"dist/ContextBuilder.d.ts","line":707},{"name":"toJSON","kind":"method","owner":"Context","signature":["toJSON(): ContextDict"],"doc":"TS-native serialization hook so `JSON.stringify` emits the wire shape via\n{@link Context.toDict}. No Python counterpart.","file":"dist/ContextBuilder.d.ts","line":712}]},"ContextBuilder":{"name":"ContextBuilder","kind":"class","exported":true,"signature":["class ContextBuilder"],"doc":"Builder for multi-step, multi-context AI agent workflows.\n\nA ContextBuilder owns one or more Contexts; each Context owns an ordered\nlist of Steps. Only one context and one step is active at a time. Per\nchat turn, the runtime injects the current step's instructions as a\nsystem message, then asks the LLM for a response.\n\n## Native tools auto-injected by the runtime\n\nWhen a step (or its enclosing context) declares `validSteps` or\n`validContexts`, the runtime auto-injects two native tools so the model\ncan navigate the flow:\n\n - `next_step(step: enum)` — present when validSteps is set\n - `change_context(context: enum)` — present when validContexts is set\n\nTheir `enum` schemas are rewritten on every turn to match whatever\nvalidSteps / validContexts apply to the current step. You do NOT need\nto define these tools yourself; they appear automatically.\n\nA third native tool — `gather_submit` — is injected during gather_info\nquestioning (see Step.setGatherInfo / addGatherQuestion).\n\nThese three names — `next_step`, `change_context`, `gather_submit` —\nare reserved. ContextBuilder.validate() will reject any agent that\ndefines a SWAIG tool with one of these names.\n\n## Function whitelisting (Step.setFunctions)\n\nEach step may declare a `functions` whitelist. The whitelist is applied\nin-memory at the start of each LLM turn. CRITICALLY: if a step does NOT\ndeclare a `functions` field, it INHERITS the previous step's active set.\nSee Step.setFunctions() for details and examples.\n\n## Validation\n\nCall validate() (or toDict(), which calls it) to check that:\n\n - At least one context is defined\n - A single context must be named \"default\"\n - Every context has at least one step\n - validSteps references resolve to real step names (or \"next\")\n - validContexts references resolve to real context names\n - gather_info questions are non-empty and have unique keys\n - gather_info completion_action targets a reachable step\n - No user-defined SWAIG tool collides with a reserved native name\n\n@example Two-step support bot\n```ts\nimport { AgentBase, ContextBuilder } from '@signalwire/sdk';\n\nconst agent = new AgentBase({ name: 'support', route: '/' });\n\nconst contexts = new ContextBuilder();\nconst flow = contexts.addContext('default');\n\nflow.addStep('greeting')\n .setText(\"Greet the caller and ask if they're an existing customer.\")\n .setValidSteps(['existing', 'new']);\n\nflow.addStep('existing')\n .setText('Ask for the account number and read it back to confirm.');\n\nflow.addStep('new')\n .setText('Collect name, email, and reason for calling.');\n\nagent.defineContexts(contexts);\n```\n\n@see {@link Context}\n@see {@link Step}\n@see {@link GatherInfo}\n@see {@link AgentBase.defineContexts}","file":"dist/ContextBuilder.d.ts","line":789,"members":[{"name":"attachAgent","kind":"method","owner":"ContextBuilder","signature":["attachAgent(agent: unknown): this"],"doc":"Attach an agent reference so validate() can check user tool names\nagainst reserved native tool names. Called internally by\nAgentBase.defineContexts().\n@internal","file":"dist/ContextBuilder.d.ts","line":799},{"name":"reset","kind":"method","owner":"ContextBuilder","signature":["reset(): this"],"doc":"Removes all contexts, returning the builder to its initial state.\nUse this in a dynamic config callback when you need to rebuild\ncontexts from scratch for a specific request.\n@returns This builder for chaining.","file":"dist/ContextBuilder.d.ts","line":806},{"name":"addContext","kind":"method","owner":"ContextBuilder","signature":["addContext(name: string): Context"],"doc":"Adds a new named context to the builder.\n\n@param name - The unique context name. A single-context flow must name\n its only context `\"default\"`.\n@returns The newly created {@link Context} for further configuration.\n@throws {Error} When the max-context limit is exceeded or a context with\n the same name already exists.","file":"dist/ContextBuilder.d.ts","line":816},{"name":"getContext","kind":"method","owner":"ContextBuilder","signature":["getContext(name: string): Context | undefined"],"doc":"Returns a context by name.\n@param name - The context name to retrieve.\n@returns The matching Context, or undefined if not found.","file":"dist/ContextBuilder.d.ts","line":822},{"name":"validate","kind":"method","owner":"ContextBuilder","signature":["validate(): void"],"doc":"Validates that all contexts have steps, naming constraints are met, and cross-context references are valid.\n@throws Error if validation fails.","file":"dist/ContextBuilder.d.ts","line":827},{"name":"toDict","kind":"method","owner":"ContextBuilder","signature":["toDict(): Record<string, ContextDict>"],"doc":"Validates and serializes all contexts to a plain object for SWML output.\n@returns A dictionary mapping context names to their serialized representations.","file":"dist/ContextBuilder.d.ts","line":832},{"name":"toJSON","kind":"method","owner":"ContextBuilder","signature":["toJSON(): Record<string, ContextDict>"],"doc":"TS-native serialization hook so `JSON.stringify` emits the wire shape via\n{@link ContextBuilder.toDict}. No Python counterpart.","file":"dist/ContextBuilder.d.ts","line":837}]},"ConversationInfo":{"name":"ConversationInfo","kind":"interface","exported":true,"signature":["interface ConversationInfo"],"doc":"Result of {@link AIChatClient.createConversation}.","file":"dist/ai-chat/AIChatClient.d.ts","line":85,"members":[{"name":"id","kind":"property","owner":"ConversationInfo","signature":["id: string"],"doc":"The conversation id (echoed back — the caller's own input).","file":"dist/ai-chat/AIChatClient.d.ts","line":87},{"name":"status","kind":"property","owner":"ConversationInfo","signature":["status: string"],"doc":"Lifecycle status the service reported (e.g. `\"created\"`).","file":"dist/ai-chat/AIChatClient.d.ts","line":89},{"name":"initialMessage","kind":"property","owner":"ConversationInfo","signature":["initialMessage: string | null"],"doc":"The opening assistant message, if the config produced one.","file":"dist/ai-chat/AIChatClient.d.ts","line":91}]},"ConversationNotFoundError":{"name":"ConversationNotFoundError","kind":"class","exported":true,"signature":["class ConversationNotFoundError extends AIChatError"],"doc":"The conversation does not exist in this project (-32001).","file":"dist/ai-chat/AIChatClient.d.ts","line":63,"members":[{"name":"constructor","kind":"constructor","owner":"ConversationNotFoundError","signature":["constructor(code: number | null, message: string)"],"doc":"","file":"dist/ai-chat/AIChatClient.d.ts","line":64}],"bases":["AIChatError"]},"ConversationTurnOptions":{"name":"ConversationTurnOptions","kind":"interface","exported":true,"signature":["interface ConversationTurnOptions"],"doc":"Per-turn options common to {@link AIChatClient.createConversation} and {@link AIChatClient.chat}.","file":"dist/ai-chat/AIChatClient.d.ts","line":129,"members":[{"name":"configUrl","kind":"property","owner":"ConversationTurnOptions","signature":["configUrl?: string"],"doc":"Config URL locating the agent config (required on create; auto-creates on chat).","file":"dist/ai-chat/AIChatClient.d.ts","line":131},{"name":"timeout","kind":"property","owner":"ConversationTurnOptions","signature":["timeout?: number"],"doc":"Conversation inactivity timeout in seconds (wire `conversation_timeout`).","file":"dist/ai-chat/AIChatClient.d.ts","line":133},{"name":"reinit","kind":"property","owner":"ConversationTurnOptions","signature":["reinit?: boolean"],"doc":"Reinitialize an existing conversation.","file":"dist/ai-chat/AIChatClient.d.ts","line":135},{"name":"userMetadata","kind":"property","owner":"ConversationTurnOptions","signature":["userMetadata?: Record<string, unknown>"],"doc":"Arbitrary caller metadata (wire `user_meta_data`).","file":"dist/ai-chat/AIChatClient.d.ts","line":137}]},"CreateConversationOptions":{"name":"CreateConversationOptions","kind":"interface","exported":true,"signature":["interface CreateConversationOptions extends ConversationTurnOptions"],"doc":"Options for {@link AIChatClient.createConversation}.","file":"dist/ai-chat/AIChatClient.d.ts","line":140,"members":[{"name":"configUrl","kind":"property","owner":"CreateConversationOptions","signature":["configUrl: string"],"doc":"Config URL locating the agent config (required).","file":"dist/ai-chat/AIChatClient.d.ts","line":142},{"name":"userMessage","kind":"property","owner":"CreateConversationOptions","signature":["userMessage?: string"],"doc":"The opening user message to send with the create (wire `user_message`).","file":"dist/ai-chat/AIChatClient.d.ts","line":144}],"bases":["ConversationTurnOptions"]},"CrudResource":{"name":"CrudResource","kind":"class","exported":true,"signature":["class CrudResource<TList = unknown, TItem = unknown, TCreate = unknown, TUpdate = unknown> extends ReadResource<TList, TItem>"],"doc":"Generic CRUD resource with configurable update method.\n\nProvides `list()`, `paginate()`, `get()`, `create()`, `update()`, and\n`delete()` out of the box — most namespace resources extend this and narrow\nthe generic types. `_updateMethod` may be overridden to `'PUT'` for APIs that\nreplace instead of patch.\n\nExtends {@link ReadResource} (mirroring Python's `CrudResource(ReadResource)`)\nso every CRUD resource inherits the `list()`/`get()`/`paginate()` read surface\n— in particular the async-iterator `paginate()`. A prior version extended\n`BaseResource` directly and re-declared `list()`/`get()`, which silently left\n`paginate()` OFF every CRUD resource (a real runtime gap the hierarchy now closes).\n\n@typeParam TList - Type of the paginated list response.\n@typeParam TItem - Type of a single resource item.\n@typeParam TCreate - Request body type for `create()`.\n@typeParam TUpdate - Request body type for `update()`.","file":"dist/rest/base/CrudResource.d.ts","line":26,"members":[{"name":"constructor","kind":"constructor","owner":"CrudResource","signature":["constructor(http: HttpClient, basePath: string)"],"doc":"","file":"dist/rest/base/CrudResource.d.ts","line":29},{"name":"create","kind":"method","owner":"CrudResource","signature":["create(body: TCreate, requestOptions?: RequestOptionsInit): Promise<TItem>"],"doc":"Create a new resource.\n\n@param body - Request body describing the resource to create.\n@returns The newly-created resource.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/base/CrudResource.d.ts","line":37},{"name":"update","kind":"method","owner":"CrudResource","signature":["update(resourceId: string, body: TUpdate, requestOptions?: RequestOptionsInit): Promise<TItem>"],"doc":"Update a resource by ID.\n\nUses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'`\nwhen the remote API requires a full-replacement semantics.\n\n@param resourceId - Unique identifier of the resource.\n@param body - Request body with updated fields.\n@returns The updated resource.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/base/CrudResource.d.ts","line":49},{"name":"delete","kind":"method","owner":"CrudResource","signature":["delete(resourceId: string, requestOptions?: RequestOptionsInit): Promise<unknown>"],"doc":"Delete a resource by ID.\n\n@param resourceId - Unique identifier of the resource.\n@returns The platform's delete response (often an empty body on success).\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/base/CrudResource.d.ts","line":57}],"bases":["ReadResource"]},"CrudWithAddresses":{"name":"CrudWithAddresses","kind":"class","exported":true,"signature":["class CrudWithAddresses<TList = unknown, TItem = unknown, TCreate = unknown, TUpdate = unknown> extends CrudResource<TList, TItem, TCreate, TUpdate>"],"doc":"{@link CrudResource} extended with a `listAddresses()` helper for resources that\nhave associated Address records (e.g. fabric resources).","file":"dist/rest/base/CrudWithAddresses.d.ts","line":12,"members":[{"name":"constructor","kind":"constructor","owner":"CrudWithAddresses","signature":["constructor(http: HttpClient, basePath: string)"],"doc":"","file":"dist/rest/base/CrudWithAddresses.d.ts","line":13},{"name":"listAddresses","kind":"method","owner":"CrudWithAddresses","signature":["listAddresses(resourceId: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<unknown>"],"doc":"List addresses associated with a specific resource instance.\n\n@param resourceId - Unique identifier of the owning resource.\n@param params - Optional filter / pagination query parameters.\n@returns A paginated list of addresses.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/base/CrudWithAddresses.d.ts","line":22}],"bases":["CrudResource"]},"CustomSkillsSkill":{"name":"CustomSkillsSkill","kind":"class","exported":true,"signature":["class CustomSkillsSkill extends SkillBase"],"doc":"A meta-skill that registers user-defined tools from configuration.\n\nTier 2 built-in skill with no external dependencies. Allows users to define\narbitrary tools via config without writing skill classes. Each tool definition\nspecifies a name, description, parameters, and a JavaScript handler function\nbody that is compiled via the Function constructor at instantiation time.\n\n**Security warning:** This skill uses `new Function()` to compile user-provided\ncode at runtime. It is gated behind the `SWML_ALLOW_CUSTOM_HANDLER_CODE=true`\nenvironment variable to prevent unintended code execution.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\n// Requires SWML_ALLOW_CUSTOM_HANDLER_CODE=true\nawait agent.addSkillByName('custom_skills', {\n tools: [\n {\n name: 'echo',\n description: 'Echo back the caller-supplied message.',\n parameters: [{ name: 'msg', type: 'string', description: 'The message', required: true }],\n handler_code: 'return new FunctionResult(args.msg);',\n },\n ],\n});\n```","file":"dist/skills/builtin/custom_skills.d.ts","line":43,"members":[{"name":"SKILL_NAME","kind":"property","owner":"CustomSkillsSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/custom_skills.d.ts","line":44},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"CustomSkillsSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/custom_skills.d.ts","line":45},{"name":"constructor","kind":"constructor","owner":"CustomSkillsSkill","signature":["constructor(config?: SkillConfig)"],"doc":"@param config - Configuration object containing a `tools` array of custom tool definitions.","file":"dist/skills/builtin/custom_skills.d.ts","line":51},{"name":"getParameterSchema","kind":"method","owner":"CustomSkillsSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/custom_skills.d.ts","line":52},{"name":"getTools","kind":"method","owner":"CustomSkillsSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns Array of dynamically generated tools from the configuration, with compiled handlers.","file":"dist/skills/builtin/custom_skills.d.ts","line":63},{"name":"getCompilationErrors","kind":"method","owner":"CustomSkillsSkill","signature":["getCompilationErrors(): Map<string, string>"],"doc":"Get handler compilation errors for diagnostic purposes.\n@returns A copy of the map from tool name to error message.","file":"dist/skills/builtin/custom_skills.d.ts","line":79}],"bases":["SkillBase"]},"CxmlApplicationsResource":{"name":"CxmlApplicationsResource","kind":"class","exported":true,"signature":["class CxmlApplications extends BaseResource"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":51,"members":[{"name":"constructor","kind":"constructor","owner":"CxmlApplicationsResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":52},{"name":"list","kind":"method","owner":"CxmlApplicationsResource","signature":["list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<CxmlApplicationListResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":53},{"name":"get","kind":"method","owner":"CxmlApplicationsResource","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<CxmlApplicationResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":54},{"name":"update","kind":"method","owner":"CxmlApplicationsResource","signature":["update(id: string, options?: {\n display_name?: string;\n account_sid?: uuid;\n voice_url?: string;\n voice_method?: 'GET' | 'POST';\n voice_fallback_url?: string;\n voice_fallback_method?: 'GET' | 'POST';\n status_callback?: string;\n status_callback_method?: 'GET' | 'POST';\n sms_url?: string;\n sms_method?: 'GET' | 'POST';\n sms_fallback_url?: string;\n sms_fallback_method?: 'GET' | 'POST';\n sms_status_callback?: string;\n sms_status_callback_method?: 'GET' | 'POST';\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CxmlApplicationResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":55},{"name":"delete","kind":"method","owner":"CxmlApplicationsResource","signature":["delete(id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":72},{"name":"listAddresses","kind":"method","owner":"CxmlApplicationsResource","signature":["listAddresses(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<CxmlApplicationAddressListResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":73}],"bases":["BaseResource"]},"CxmlScripts":{"name":"CxmlScripts","kind":"class","exported":true,"signature":["class CxmlScripts extends FabricResource<CXMLScriptListResponse, CXMLScriptResponse, CXMLScriptCreateRequest, CXMLScriptUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":75,"members":[{"name":"constructor","kind":"constructor","owner":"CxmlScripts","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":77},{"name":"create","kind":"method","owner":"CxmlScripts","signature":["create(body: CXMLScriptCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<CXMLScriptResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":79},{"name":"update","kind":"method","owner":"CxmlScripts","signature":["update(id: string, body: CXMLScriptUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<CXMLScriptResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":81}],"bases":["FabricResource"]},"CxmlWebhooks":{"name":"CxmlWebhooks","kind":"class","exported":true,"signature":["class CxmlWebhooks extends FabricResource<CXMLWebhookListResponse, CXMLWebhookResponse, CXMLWebhookCreateRequest, CXMLWebhookUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":83,"members":[{"name":"constructor","kind":"constructor","owner":"CxmlWebhooks","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":84},{"name":"create","kind":"method","owner":"CxmlWebhooks","signature":["create(body: CXMLWebhookCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<CXMLWebhookResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":86},{"name":"update","kind":"method","owner":"CxmlWebhooks","signature":["update(id: string, body: CXMLWebhookUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<CXMLWebhookResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":88}],"bases":["FabricResource"]},"DIALOGUE_ROLES":{"name":"DIALOGUE_ROLES","kind":"variable","exported":true,"signature":["const DIALOGUE_ROLES: readonly string[]"],"doc":"Roles that are actual dialogue. Everything else in a call log is machinery:\n`system` is the prompt, `system-log` is lifecycle and step tracing, `tool` is\nfunction output, and `assistant-manual` is filler speech.","file":"dist/PostPrompt.d.ts","line":32},"DIAL_STATE_TERMINAL":{"name":"DIAL_STATE_TERMINAL","kind":"variable","exported":true,"signature":["const DIAL_STATE_TERMINAL: readonly [\"answered\", \"failed\"]"],"doc":"The terminal {@link DialState} values (`'answered'`, `'failed'`).","file":"dist/relay/closedSets.d.ts","line":75},"DataMap":{"name":"DataMap","kind":"class","exported":true,"signature":["class DataMap"],"doc":"Fluent builder for SWAIG data_map configurations.\n\nBuilds a SWAIG function whose `data_map` the SignalWire platform runs, so\nthe tool needs no webhook endpoint in your application. The platform makes\nthe HTTP requests, matches the expressions and expands the templates; this\nclass only builds the definition.\n\nWhat a template can read depends on where it is. A webhook's `url` and\n`params`, the top-level expressions and the fallback output read the call\ndata, where the arguments are `${args.city}`. A webhook's `output`,\n`expressions` and `foreach` read that webhook's response instead: a JSON\nobject's fields from the root (`${temp}`), a JSON array under `array`\n(`${array[0].joke}`), and the call data under `input`, so the arguments\nthere are `${input.args.city}`; `${args.city}` expands to nothing.\nHeader values are sent as written, with no templates expanded.\n\n@example Simple webhook-driven tool (no handler needed)\n```ts\nimport { DataMap, FunctionResult } from '@signalwire/sdk';\n\nconst weather = new DataMap('get_weather')\n .purpose('Look up the current weather for a city')\n .parameter('city', 'string', 'The city name', { required: true })\n .webhook('GET', 'https://api.example.com/weather?city=${enc:args.city}')\n .output(new FunctionResult('In ${input.args.city} it is ${temp}°F and ${condition}.'));\n\n// Register onto an agent:\nagent.registerSwaigFunction(weather.toSwaigFunction());\n```\n\n@example Expression-based tool (no webhook, pattern matching only)\n```ts\nnew DataMap('classify_intent')\n .purpose('Route callers to the right department.')\n .parameter('utterance', 'string', 'What the caller said', { required: true })\n .expression('${lc:args.utterance}', 'billing|invoice|charge', new FunctionResult('billing'))\n .expression('${lc:args.utterance}', 'tech|broken|error', new FunctionResult('support'));\n```\n\n@see {@link FunctionResult}: the response shape used in `.output()` and `.expression()`\n@see {@link createSimpleApiTool}: a helper for a tool with one webhook and one output\n@see {@link AgentBase.defineTool}: for tools that run in your process","file":"dist/DataMap.d.ts","line":73,"members":[{"name":"functionName","kind":"property","owner":"DataMap","signature":["functionName: string"],"doc":"The name of the SWAIG function this data map defines.","file":"dist/DataMap.d.ts","line":75},{"name":"constructor","kind":"constructor","owner":"DataMap","signature":["constructor(functionName: string)"],"doc":"@param functionName - The unique name for this data map tool.","file":"dist/DataMap.d.ts","line":87},{"name":"enableEnvExpansion","kind":"method","owner":"DataMap","signature":["enableEnvExpansion(enabled?: boolean): this"],"doc":"Turn on `${ENV.NAME}` expansion for this DataMap (off until called).\n\nThe SDK, not the platform, does this expansion: `toSwaigFunction()`\nreplaces each `${ENV.NAME}` in every string of the definition with\n`process.env.NAME`, or with an empty string when the variable is unset or\nits name has no allowed prefix (see {@link DataMap.setAllowedEnvPrefixes}).\nThe values are written into the SWML document.\n\n@param enabled - Whether to turn expansion on (defaults to true).\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":100},{"name":"setAllowedEnvPrefixes","kind":"method","owner":"DataMap","signature":["setAllowedEnvPrefixes(prefixes: string[]): this"],"doc":"Set the allowed env var prefixes for this DataMap instance.\n\nReplaces the global default list (`SIGNALWIRE_`, `SWML_`, `SW_` unless\nchanged with the exported `setAllowedEnvPrefixes()`) for this DataMap.\nOnly variables whose names start with one of these prefixes are\nexpanded. An empty array allows every variable.\n\n@param prefixes - Array of prefix strings to allow.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":112},{"name":"purpose","kind":"method","owner":"DataMap","signature":["purpose(description: string): this"],"doc":"Set the purpose (description) for this data-map tool. The model reads it.\n\nThis string becomes the function's `description` in the SWML, which the\nmodel reads to decide WHEN to call this tool. Write it as a prompt, not\nas developer documentation. With a vague `purpose()`, the model can have\nthe right tool and not call it.\n\n### Bad vs good\n\n```text\nBAD : .purpose('weather api')\nGOOD: .purpose('Get the current weather conditions and forecast for\n a specific city. Use this whenever the user asks about weather,\n temperature, rain, or similar conditions in a named location.')\n```\n\n@param description - Prompt-engineering description of when to call this tool.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":133},{"name":"description","kind":"method","owner":"DataMap","signature":["description(description: string): this"],"doc":"Alias for {@link purpose}; sets the LLM-facing tool description.\n\nThis string is read by the model to decide WHEN to call this tool.\nSee {@link purpose} for bad-vs-good examples.\n\n@param description - Prompt-engineering description of when to call this tool.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":143},{"name":"parameter","kind":"method","owner":"DataMap","signature":["parameter(name: string, paramType: string, description: string, opts?: {\n required?: boolean;\n enum?: string[];\n}): this"],"doc":"Define a parameter for this data-map tool. The model reads its `description`.\n\nEach parameter's `description` becomes\n`parameters.properties.<name>.description` in the SWML. The model reads\nit to decide HOW to fill in the argument from what the caller said.\nWrite it as a prompt, not as developer documentation.\n\n### Bad vs good\n\n```text\nBAD : .parameter('city', 'string', 'the city')\nGOOD: .parameter('city', 'string',\n 'The name of the city to get weather for, e.g. \"San Francisco\".\n Ask the user if they did not provide one. Include the state\n or country if the city name is ambiguous.')\n```\n\n@param name - The parameter name (JSON object key).\n@param paramType - The JSON Schema type (e.g., \"string\", \"number\").\n@param description - Prompt-engineering description telling the model\n how to extract this value from the user's utterance. Read by the LLM.\n@param opts - Options object: `{ required: true }` lists the parameter in the\n schema's `required` array, and `enum` restricts its values.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":170},{"name":"expression","kind":"method","owner":"DataMap","signature":["expression(testValue: string, pattern: string | RegExp, output: FunctionResult, nomatchOutput?: FunctionResult): this"],"doc":"Add a pattern-matching expression that evaluates a test value against a regex.\n\nThe platform expands `testValue` against the call data, where an\nargument is `${args.command}`, and searches it for `pattern`, which can\nmatch anywhere in the value. It tries the expressions in order and stops\nat the first that produces a result: a match gives its `output`, and a\nnon-match gives its `nomatch-output` when it has one, so no expression\nafter one with a `nomatchOutput` runs. The top-level expressions run\nbefore any webhook, and one that produces a result ends the function.\n@param testValue - The string or template variable to test, such as `'${args.input}'`.\n@param pattern - A regex pattern (string or RegExp) to match against. The\n platform wraps a pattern that doesn't start with `/` as `/pattern/i`, so\n matching is case-insensitive by default. To match case-sensitively, write\n the pattern as `'/pattern/'`. For a RegExp only `.source` is kept, so its\n flags are dropped and it matches case-insensitively.\n@param output - The result to return when the pattern matches.\n@param nomatchOutput - Optional result, written as `nomatch-output`, which the\n platform returns when the pattern doesn't match; later expressions are then\n not tried. The SWML schema's expression object doesn't define that key.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":196},{"name":"webhook","kind":"method","owner":"DataMap","signature":["webhook(method: string, url: string, opts?: {\n headers?: Record<string, string>;\n formParam?: string;\n inputArgsAsParams?: boolean;\n requireArgs?: string[];\n}): this"],"doc":"Add a webhook that is called when this data map tool is invoked.\n\nThe platform sends GET and POST requests only. A webhook is sent as a\nPOST when `method` is `POST` or when it has params (see\n{@link DataMap.params}), and as a GET otherwise, so `PUT`, `PATCH` and\n`DELETE` are sent as GET.\n\nThe platform tries the webhooks in order, skipping one whose\n`requireArgs` are all absent. The first one it requests decides the\nresult: if it fails, the fallback output is used and no later webhook is\ntried. A later webhook is useful only when the earlier ones can be skipped\nby their `requireArgs`.\n@param method - HTTP method: `GET` or `POST`. It is uppercased.\n@param url - The webhook URL to call. The platform expands templates in\n it against the call data, such as `${enc:args.city}`.\n@param opts - Optional `headers` (sent as written, with no templates\n expanded), `formParam` (sends the JSON params URL-encoded as one form\n field with this name; written as `form_param`, which the SWML schema\n doesn't define), `inputArgsAsParams` (merges the function's arguments\n into params, which makes the request a POST) and `requireArgs` (the\n webhook is skipped, without a request, unless at least one of these\n arguments is present).\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":222},{"name":"webhookExpressions","kind":"method","owner":"DataMap","signature":["webhookExpressions(expressions: Record<string, unknown>[]): this"],"doc":"Set pattern-matching expressions on the most recently added webhook.\n\nThey run after the webhook's foreach, against its response, and the first\none that produces an output replaces the webhook's own output. Their\ntemplates read the response's fields from the root, and the call data\nunder `input`, such as `${input.args.query}`.\n@param expressions - Array of expression objects to evaluate against the webhook response.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":238},{"name":"body","kind":"method","owner":"DataMap","signature":["body(data: Record<string, unknown>): this"],"doc":"Set the JSON request body for the most recently added webhook; the same\nas {@link DataMap.params}.\n\nThe platform reads a webhook's request body from its `params` field and\nhas no `body` field, so this sets `params`, replacing any `params`\nalready set. See {@link DataMap.params} for how the body is sent.\n@param data - The request body object. Values can contain templates.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":249},{"name":"params","kind":"method","owner":"DataMap","signature":["params(data: Record<string, unknown>): this"],"doc":"Set the JSON request body for the most recently added webhook, written as\nits `params`.\n\nThe platform sends `params` as the request's JSON body, not as URL query\nparameters, expanding templates in its values first (against the call\ndata, so arguments are `${args.name}`), and a webhook with `params` is\nalways a POST, whatever its method. Put query-string values for a GET\nrequest in the URL instead.\n@param data - The request body object. Values can contain templates.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":262},{"name":"foreach","kind":"method","owner":"DataMap","signature":["foreach(config: {\n input_key: string;\n output_key: string;\n append: string;\n max?: number;\n}): this"],"doc":"Configure iteration over an array in the webhook response.\n\n`input_key` is the path to the array in the webhook's template data, such\nas `\"orders\"` or `\"data.items\"` (a path, not a template). `append` is\nexpanded once per element, reading an object element's fields as\n`${this.field}` and a string or number element as `${this}`, along with\nthe response and `${input.args.name}`. The joined text is stored under\n`output_key`, which the webhook's output reads as `${<output_key>}`.\n`max`, when above 0, limits the elements used. The platform runs the\nforeach before the webhook's expressions and output, and skips a foreach\nthat lacks `input_key`, `output_key` or `append`.\n@param config - Foreach configuration with input/output keys, append template, and optional max.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":278},{"name":"output","kind":"method","owner":"DataMap","signature":["output(result: FunctionResult): this"],"doc":"Set the output template for the most recently added webhook.\n\nIts templates read the webhook's JSON response: an object's fields from\nthe root, such as `${current.temp_f}`, or `${array[0].x}` for an array.\nThe call data is under `input`, so an argument is `${input.args.city}`;\n`${args.city}` is empty here. A foreach's text is `${<output_key>}`.\n@param result - The FunctionResult to use as the output template.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":294},{"name":"fallbackOutput","kind":"method","owner":"DataMap","signature":["fallbackOutput(result: FunctionResult): this"],"doc":"Set a fallback output: the `data_map`'s own `output`, used when no\nexpression matched and no webhook produced a result (the webhook failed,\nnone was requested, or its expressions didn't match and it has no\noutput). Its templates read the call data, so arguments are `${args.name}`.\n@param result - The FunctionResult to use as the fallback.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":303},{"name":"errorKeys","kind":"method","owner":"DataMap","signature":["errorKeys(keys: string[]): this"],"doc":"Set error keys on the most recently added webhook, or globally if no webhook exists.\n\nThe platform fails the webhook when any of these keys is present at the\ntop level of its JSON object response, whatever the value (`\"errors\": []`,\n`false` and `null` count). An HTTP status outside 200-299 isn't a failure\nby itself: the platform adds an `http_code` key to such a response, so\n`'http_code'` in this list fails the webhook on any such status. A failed\nwebhook gives the fallback output; the next webhook isn't tried.\n\nThe platform reads error keys only on a webhook. Called before any\nwebhook, this sets a top-level `error_keys` field, which the platform\nignores (see {@link DataMap.globalErrorKeys}).\n@param keys - Response keys whose presence marks the response as a failure.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":320},{"name":"globalErrorKeys","kind":"method","owner":"DataMap","signature":["globalErrorKeys(keys: string[]): this"],"doc":"Set `error_keys` on the `data_map` object itself, regardless of webhook context.\n\nThe SWML schema defines `error_keys` only on a webhook, and the platform\nreads it only there, so these keys fail no request. Use\n{@link DataMap.errorKeys} after each webhook.\n@param keys - Response keys that indicate an error occurred.\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":330},{"name":"registerWithAgent","kind":"method","owner":"DataMap","signature":["registerWithAgent(agent: {\n registerSwaigFunction(fn: Record<string, unknown>): unknown;\n}): this"],"doc":"Register this DataMap tool with an AgentBase instance.\n@param agent - An object with a registerSwaigFunction method (typically an AgentBase).\n@returns This instance for chaining.","file":"dist/DataMap.d.ts","line":336},{"name":"toSwaigFunction","kind":"method","owner":"DataMap","signature":["toSwaigFunction(): Record<string, unknown>"],"doc":"Serialize this data map to a SWAIG function definition object.\n@returns A plain object suitable for inclusion in the SWML SWAIG array.","file":"dist/DataMap.d.ts","line":343}]},"DataSphereServerlessSkill":{"name":"DataSphereServerlessSkill","kind":"class","exported":true,"signature":["class DataSphereServerlessSkill extends SkillBase"],"doc":"Searches SignalWire DataSphere using a server-side DataMap for serverless execution.\n\nTier 3 built-in skill that generates a DataMap configuration SignalWire\nexecutes directly, without a webhook endpoint. Supports `document_id`,\n`count`, `distance`, `tags`, `language`, `pos_to_expand`, `max_synonyms`,\nand `no_results_message` config options.\n\n`space_name`, `project_id`, `token` and `document_id` come only from the\nconfiguration, as in Python. The schema's `env_var` entries for `project_id`\nand `token` name the usual variables for tools that read the schema; the\nskill doesn't read them, so a process-wide API token isn't written into\nthe SWML unless you pass it.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('datasphere_serverless', {\n space_name: 'example',\n project_id: process.env.SIGNALWIRE_PROJECT_ID,\n token: process.env.SIGNALWIRE_API_TOKEN,\n document_id: 'doc_abc123',\n count: 3,\n});\n```","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":40,"members":[{"name":"SKILL_NAME","kind":"property","owner":"DataSphereServerlessSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":41},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"DataSphereServerlessSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":42},{"name":"SKILL_VERSION","kind":"property","owner":"DataSphereServerlessSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":43},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"DataSphereServerlessSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":44},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"DataSphereServerlessSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":45},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"DataSphereServerlessSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":46},{"name":"getParameterSchema","kind":"method","owner":"DataSphereServerlessSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":47},{"name":"getInstanceKey","kind":"method","owner":"DataSphereServerlessSkill","signature":["getInstanceKey(): string"],"doc":"Instance key for the SkillManager. Defaults to\n`datasphere_serverless_search_knowledge`, matching the Python SDK default.\nWhen `tool_name` is set, uses `datasphere_serverless_<tool_name>`.","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":53},{"name":"setup","kind":"method","owner":"DataSphereServerlessSkill","signature":["setup(): Promise<boolean>"],"doc":"Validate required configuration parameters before the skill becomes active.\n\nMirrors Python's `setup()` which checks `space_name`, `project_id`, `token`,\nand `document_id` and returns `False` (logging an error) if any are absent.\n@returns `true` if all required params are present, `false` otherwise.","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":61},{"name":"getGlobalData","kind":"method","owner":"DataSphereServerlessSkill","signature":["getGlobalData(): Record<string, unknown>"],"doc":"Global data injected into the agent's SWML/SWAIG context. Matches\nPython's `get_global_data()` shape so downstream consumers can\ndetect DataSphere availability.","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":67},{"name":"getTools","kind":"method","owner":"DataSphereServerlessSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"Return a stub tool definition since this skill uses DataMap-based execution.\nThe actual DataMap function is provided by getDataMapTools().\n@returns A single stub tool (named via `tool_name`) that explains its DataMap nature.","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":84},{"name":"getDataMapTools","kind":"method","owner":"DataSphereServerlessSkill","signature":["getDataMapTools(): Record<string, unknown>[]"],"doc":"Get DataMap-based tool definitions for server-side execution.\nThese are registered directly in the SWML output as data_map functions\nrather than as webhook-backed SWAIG tools.\n@returns Array containing the DataSphere search DataMap function definition.","file":"dist/skills/builtin/datasphere_serverless.d.ts","line":91}],"bases":["SkillBase"]},"DataSphereSkill":{"name":"DataSphereSkill","kind":"class","exported":true,"signature":["class DataSphereSkill extends SkillBase"],"doc":"Searches SignalWire DataSphere for knowledge base content using semantic search.\n\nTier 3 built-in skill. Credentials can be supplied via params or fall back to\n`SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`, and `SIGNALWIRE_SPACE` environment\nvariables. Supports `count`, `distance`, `tags`, `language`, `pos_to_expand`,\n`max_synonyms`, and `no_results_message` config options.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('datasphere', {\n document_id: 'doc_abc123',\n count: 3,\n tags: ['faq'],\n});\n```","file":"dist/skills/builtin/datasphere.d.ts","line":30,"members":[{"name":"SKILL_NAME","kind":"property","owner":"DataSphereSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/datasphere.d.ts","line":31},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"DataSphereSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/datasphere.d.ts","line":32},{"name":"SKILL_VERSION","kind":"property","owner":"DataSphereSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/datasphere.d.ts","line":33},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"DataSphereSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/datasphere.d.ts","line":34},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"DataSphereSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/datasphere.d.ts","line":35},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"DataSphereSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/datasphere.d.ts","line":36},{"name":"getParameterSchema","kind":"method","owner":"DataSphereSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/datasphere.d.ts","line":37},{"name":"getInstanceKey","kind":"method","owner":"DataSphereSkill","signature":["getInstanceKey(): string"],"doc":"Instance key for the SkillManager. Defaults to `datasphere_search_knowledge`,\nmatching the Python SDK default. When `tool_name` is set, uses\n`datasphere_<tool_name>`.","file":"dist/skills/builtin/datasphere.d.ts","line":43},{"name":"getGlobalData","kind":"method","owner":"DataSphereSkill","signature":["getGlobalData(): Record<string, unknown>"],"doc":"Global data injected into the agent's SWML context. Matches Python's\n`get_global_data()` so downstream consumers can detect DataSphere\navailability, the configured `document_id`, and the knowledge provider.","file":"dist/skills/builtin/datasphere.d.ts","line":49},{"name":"setup","kind":"method","owner":"DataSphereSkill","signature":["setup(): Promise<boolean>"],"doc":"Validate required credentials before the skill becomes active.\n\nMirrors Python skills/datasphere/skill.py:120-128: `setup()` returns false\nwhen any of `space_name`, `project_id`, `token`, or `document_id` is\nmissing from either config or env. Fails closed so SkillManager refuses\nto register a skill that would break at call time.","file":"dist/skills/builtin/datasphere.d.ts","line":58},{"name":"getTools","kind":"method","owner":"DataSphereSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A single tool (named via `tool_name`) that performs semantic search.","file":"dist/skills/builtin/datasphere.d.ts","line":62}],"bases":["SkillBase"]},"DatasphereDocuments":{"name":"DatasphereDocuments","kind":"class","exported":true,"signature":["class DatasphereDocuments extends CrudResource<DocumentListResponse, Document, DocumentCreateRequest, DocumentUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/datasphere.resources.generated.d.ts","line":6,"members":[{"name":"constructor","kind":"constructor","owner":"DatasphereDocuments","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/datasphere.resources.generated.d.ts","line":7},{"name":"create","kind":"method","owner":"DatasphereDocuments","signature":["create(body: DocumentCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<Document>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/datasphere.resources.generated.d.ts","line":9},{"name":"update","kind":"method","owner":"DatasphereDocuments","signature":["update(id: string, body: DocumentUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<Document>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/datasphere.resources.generated.d.ts","line":11},{"name":"search","kind":"method","owner":"DatasphereDocuments","signature":["search(query_string: string, options?: {\n tags?: string[];\n document_id?: docid;\n distance?: number;\n count?: number;\n language?: string;\n pos_to_expand?: string[];\n max_synonyms?: number;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<SearchResponse>"],"doc":"","file":"dist/rest/namespaces/datasphere.resources.generated.d.ts","line":12},{"name":"listChunks","kind":"method","owner":"DatasphereDocuments","signature":["listChunks(document_id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ChunkListResponse>"],"doc":"","file":"dist/rest/namespaces/datasphere.resources.generated.d.ts","line":22},{"name":"getChunk","kind":"method","owner":"DatasphereDocuments","signature":["getChunk(document_id: string, chunk_id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ChunkResponse>"],"doc":"","file":"dist/rest/namespaces/datasphere.resources.generated.d.ts","line":23},{"name":"deleteChunk","kind":"method","owner":"DatasphereDocuments","signature":["deleteChunk(document_id: string, chunk_id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/datasphere.resources.generated.d.ts","line":24}],"bases":["CrudResource"]},"DatasphereNamespace":{"name":"DatasphereNamespace","kind":"class","exported":true,"signature":["class DatasphereNamespace"],"doc":"Generated `client.datasphere` namespace container.","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":17,"members":[{"name":"documents","kind":"property","owner":"DatasphereNamespace","readonly":true,"signature":["readonly documents: DatasphereDocuments"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":18},{"name":"constructor","kind":"constructor","owner":"DatasphereNamespace","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":19}]},"DateTimeSkill":{"name":"DateTimeSkill","kind":"class","exported":true,"signature":["class DateTimeSkill extends SkillBase"],"doc":"Provides the current date and time with optional timezone support.\n\nTier 1 built-in skill with no external dependencies. Supports all IANA\ntimezone identifiers via the Intl.DateTimeFormat API.\n\nRegisters two SWAIG tools: `get_current_time` and `get_current_date`.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('datetime');\n```","file":"dist/skills/builtin/datetime.d.ts","line":23,"members":[{"name":"SKILL_NAME","kind":"property","owner":"DateTimeSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/datetime.d.ts","line":24},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"DateTimeSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/datetime.d.ts","line":25},{"name":"SKILL_VERSION","kind":"property","owner":"DateTimeSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/datetime.d.ts","line":26},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"DateTimeSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/datetime.d.ts","line":27},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"DateTimeSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/datetime.d.ts","line":28},{"name":"getParameterSchema","kind":"method","owner":"DateTimeSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/datetime.d.ts","line":29},{"name":"getTools","kind":"method","owner":"DateTimeSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns Two tools: `get_current_time` and `get_current_date`, each\n accepting an optional IANA timezone and defaulting to UTC.","file":"dist/skills/builtin/datetime.d.ts","line":34}],"bases":["SkillBase"]},"DebugTokenResult":{"name":"DebugTokenResult","kind":"interface","exported":true,"signature":["interface DebugTokenResult"],"doc":"Decoded token debug info matching the Python SDK's nested return structure.","file":"dist/SessionManager.d.ts","line":8,"members":[{"name":"valid_format","kind":"property","owner":"DebugTokenResult","signature":["valid_format: boolean"],"doc":"","file":"dist/SessionManager.d.ts","line":9},{"name":"components","kind":"property","owner":"DebugTokenResult","signature":["components?: {\n call_id: string;\n function: string;\n expiry: string;\n expiry_date: string | null;\n nonce: string;\n signature: string;\n}"],"doc":"","file":"dist/SessionManager.d.ts","line":10},{"name":"status","kind":"property","owner":"DebugTokenResult","signature":["status?: {\n current_time: number;\n is_expired: boolean | null;\n expires_in_seconds: number | null;\n}"],"doc":"","file":"dist/SessionManager.d.ts","line":18},{"name":"parts_count","kind":"property","owner":"DebugTokenResult","signature":["parts_count?: number"],"doc":"","file":"dist/SessionManager.d.ts","line":23},{"name":"token_length","kind":"property","owner":"DebugTokenResult","signature":["token_length?: number"],"doc":"","file":"dist/SessionManager.d.ts","line":24},{"name":"error","kind":"property","owner":"DebugTokenResult","signature":["error?: string"],"doc":"","file":"dist/SessionManager.d.ts","line":25}]},"Deferred":{"name":"Deferred","kind":"interface","exported":true,"signature":["interface Deferred<T>"],"doc":"A promise with externalised `resolve`/`reject` and a `settled` flag,\nused by the RELAY client to bridge server-push events back to in-flight\nJSON-RPC request callers.","file":"dist/relay/Deferred.d.ts","line":11,"members":[{"name":"promise","kind":"property","owner":"Deferred","signature":["promise: Promise<T>"],"doc":"The wrapped promise.","file":"dist/relay/Deferred.d.ts","line":13},{"name":"resolve","kind":"property","owner":"Deferred","signature":["resolve: (value: T | PromiseLike<T>) => void"],"doc":"Resolve the promise idempotently (later calls are ignored).","file":"dist/relay/Deferred.d.ts","line":15},{"name":"reject","kind":"property","owner":"Deferred","signature":["reject: (reason?: unknown) => void"],"doc":"Reject the promise idempotently (later calls are ignored).","file":"dist/relay/Deferred.d.ts","line":17},{"name":"settled","kind":"property","owner":"Deferred","readonly":true,"signature":["readonly settled: boolean"],"doc":"True once either `resolve` or `reject` has been called.","file":"dist/relay/Deferred.d.ts","line":19}]},"DenoiseEvent":{"name":"DenoiseEvent","kind":"class","exported":true,"signature":["class DenoiseEvent extends RelayEvent"],"doc":"`calling.call.denoise` — noise-reduction on/off confirmation.","file":"dist/relay/RelayEvent.d.ts","line":174,"members":[{"name":"denoised","kind":"property","owner":"DenoiseEvent","readonly":true,"signature":["readonly denoised: boolean"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":175},{"name":"constructor","kind":"constructor","owner":"DenoiseEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, denoised?: boolean)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":176},{"name":"fromPayload","kind":"method","owner":"DenoiseEvent","static":true,"signature":["static fromPayload(payload: EventPayload): DenoiseEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":177}],"bases":["RelayEvent"]},"DetectAction":{"name":"DetectAction","kind":"class","exported":true,"signature":["class DetectAction extends Action"],"doc":"Async handle for a `calling.call.detect` action (machine / fax / digit).","file":"dist/relay/Action.d.ts","line":136,"members":[{"name":"constructor","kind":"constructor","owner":"DetectAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":137},{"name":"stop","kind":"method","owner":"DetectAction","signature":["stop(): Promise<CallingDetectStopResult>"],"doc":"Stop detection before the timeout elapses.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":146}],"bases":["Action"]},"DetectEvent":{"name":"DetectEvent","kind":"class","exported":true,"signature":["class DetectEvent extends RelayEvent"],"doc":"`calling.call.detect` — answering-machine / fax / DTMF detection result.","file":"dist/relay/RelayEvent.d.ts","line":112,"members":[{"name":"controlId","kind":"property","owner":"DetectEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":113},{"name":"detect","kind":"property","owner":"DetectEvent","readonly":true,"signature":["readonly detect: EventPayload"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":114},{"name":"constructor","kind":"constructor","owner":"DetectEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, detect?: EventPayload)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":115},{"name":"fromPayload","kind":"method","owner":"DetectEvent","static":true,"signature":["static fromPayload(payload: EventPayload): DetectEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":116}],"bases":["RelayEvent"]},"Device":{"name":"Device","kind":"type","exported":true,"signature":["type Device = PhoneDevice | SipDevice | FabricDevice | Record<string, unknown>"],"doc":"Any device specification.","file":"dist/relay/types.d.ts","line":96},"DialEvent":{"name":"DialEvent","kind":"class","exported":true,"signature":["class DialEvent extends RelayEvent"],"doc":"`calling.call.dial` — outbound dial progress (answered, failed, no-answer, etc.).","file":"dist/relay/RelayEvent.d.ts","line":151,"members":[{"name":"tag","kind":"property","owner":"DialEvent","readonly":true,"signature":["readonly tag: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":152},{"name":"dialState","kind":"property","owner":"DialEvent","readonly":true,"signature":["readonly dialState: DialState"],"doc":"Outbound-dial state — a {@link DialState} (`dialing` | `answered` |\n`failed`; closed literal union, autocompleted + typo-checked). Pass to\n{@link ../relay/closedSets.isDialStateTerminal} to test for resolution.\nDistinct from a {@link CallState}.","file":"dist/relay/RelayEvent.d.ts","line":159},{"name":"call","kind":"property","owner":"DialEvent","readonly":true,"signature":["readonly call: EventPayload"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":160},{"name":"constructor","kind":"constructor","owner":"DialEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, tag?: string, dialState?: DialState, call?: EventPayload)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":161},{"name":"fromPayload","kind":"method","owner":"DialEvent","static":true,"signature":["static fromPayload(payload: EventPayload): DialEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":162}],"bases":["RelayEvent"]},"DialOptions":{"name":"DialOptions","kind":"interface","exported":true,"signature":["interface DialOptions"],"doc":"Options for `RelayClient.dial()`.","file":"dist/relay/types.d.ts","line":98,"members":[{"name":"tag","kind":"property","owner":"DialOptions","signature":["tag?: string"],"doc":"Client-provided tag for event correlation. Auto-generated (UUID) when\nomitted.","file":"dist/relay/types.d.ts","line":103},{"name":"maxDuration","kind":"property","owner":"DialOptions","signature":["maxDuration?: number"],"doc":"Maximum call duration in **minutes** (sent as `max_duration`).","file":"dist/relay/types.d.ts","line":105},{"name":"dialTimeout","kind":"property","owner":"DialOptions","signature":["dialTimeout?: number"],"doc":"Seconds to wait for a device to answer before `dial()` rejects. Defaults\nto `120`.","file":"dist/relay/types.d.ts","line":110}]},"DialState":{"name":"DialState","kind":"type","exported":true,"signature":["type DialState = 'dialing' | 'answered' | 'failed'"],"doc":"Outbound-dial state for the `dial_state` field of a `calling.call.dial`\nevent ({@link ../relay/RelayEvent.DialEvent.dialState}). The platform reports\n`dialing` while a leg is being attempted, then resolves to `answered` (a leg\nwon) or `failed` (all legs failed) — both terminal (see\n{@link isDialStateTerminal}). Grounded in `signalwire/relay/client.py`.\n\nNOTE: distinct from {@link CallState}. A dial's `answered` is the *dial*\nresolving, not a `Call.state` transition.","file":"dist/relay/closedSets.d.ts","line":59},"DialogueTurn":{"name":"DialogueTurn","kind":"type","exported":true,"signature":["type DialogueTurn = Record<'role' | 'content', string>"],"doc":"One user or assistant turn: `{ role, content }`.","file":"dist/PostPrompt.d.ts","line":34},"DynamicConfigCallback":{"name":"DynamicConfigCallback","kind":"type","exported":true,"signature":["type DynamicConfigCallback<TAgent = import('./AgentBase.js').AgentBase> = (queryParams: Record<string, string>, bodyParams: SwmlRequestData, headers: Record<string, string>, agent: TAgent) => void | Promise<void>"],"doc":"Callback invoked on each SWML request to dynamically modify an ephemeral copy of the agent.\n\nThe ephemeral agent is typed as `import('./AgentBase.js').AgentBase` at\ncall sites but kept as a generic type parameter here to avoid a circular\nimport between `types.ts` and `AgentBase.ts`. Cast or import the type\nexplicitly at the call site if you need specific methods.\n\n@param queryParams - URL query parameters from the incoming request.\n@param bodyParams - Parsed JSON body of the incoming request.\n@param headers - HTTP headers from the incoming request.\n@param agent - Ephemeral AgentBase copy that can be mutated without affecting the original.","file":"dist/types.d.ts","line":171},"EVENT_CALLING_ERROR":{"name":"EVENT_CALLING_ERROR","kind":"variable","exported":true,"signature":["const EVENT_CALLING_ERROR"],"doc":"","file":"dist/relay/constants.d.ts","line":56},"EVENT_CALL_COLLECT":{"name":"EVENT_CALL_COLLECT","kind":"variable","exported":true,"signature":["const EVENT_CALL_COLLECT"],"doc":"","file":"dist/relay/constants.d.ts","line":40},"EVENT_CALL_CONNECT":{"name":"EVENT_CALL_CONNECT","kind":"variable","exported":true,"signature":["const EVENT_CALL_CONNECT"],"doc":"","file":"dist/relay/constants.d.ts","line":38},"EVENT_CALL_DENOISE":{"name":"EVENT_CALL_DENOISE","kind":"variable","exported":true,"signature":["const EVENT_CALL_DENOISE"],"doc":"","file":"dist/relay/constants.d.ts","line":48},"EVENT_CALL_DETECT":{"name":"EVENT_CALL_DETECT","kind":"variable","exported":true,"signature":["const EVENT_CALL_DETECT"],"doc":"","file":"dist/relay/constants.d.ts","line":42},"EVENT_CALL_DIAL":{"name":"EVENT_CALL_DIAL","kind":"variable","exported":true,"signature":["const EVENT_CALL_DIAL"],"doc":"","file":"dist/relay/constants.d.ts","line":46},"EVENT_CALL_ECHO":{"name":"EVENT_CALL_ECHO","kind":"variable","exported":true,"signature":["const EVENT_CALL_ECHO"],"doc":"","file":"dist/relay/constants.d.ts","line":52},"EVENT_CALL_FAX":{"name":"EVENT_CALL_FAX","kind":"variable","exported":true,"signature":["const EVENT_CALL_FAX"],"doc":"","file":"dist/relay/constants.d.ts","line":43},"EVENT_CALL_HOLD":{"name":"EVENT_CALL_HOLD","kind":"variable","exported":true,"signature":["const EVENT_CALL_HOLD"],"doc":"","file":"dist/relay/constants.d.ts","line":54},"EVENT_CALL_PAY":{"name":"EVENT_CALL_PAY","kind":"variable","exported":true,"signature":["const EVENT_CALL_PAY"],"doc":"","file":"dist/relay/constants.d.ts","line":49},"EVENT_CALL_PLAY":{"name":"EVENT_CALL_PLAY","kind":"variable","exported":true,"signature":["const EVENT_CALL_PLAY"],"doc":"","file":"dist/relay/constants.d.ts","line":39},"EVENT_CALL_QUEUE":{"name":"EVENT_CALL_QUEUE","kind":"variable","exported":true,"signature":["const EVENT_CALL_QUEUE"],"doc":"","file":"dist/relay/constants.d.ts","line":50},"EVENT_CALL_RECEIVE":{"name":"EVENT_CALL_RECEIVE","kind":"variable","exported":true,"signature":["const EVENT_CALL_RECEIVE"],"doc":"","file":"dist/relay/constants.d.ts","line":37},"EVENT_CALL_RECORD":{"name":"EVENT_CALL_RECORD","kind":"variable","exported":true,"signature":["const EVENT_CALL_RECORD"],"doc":"","file":"dist/relay/constants.d.ts","line":41},"EVENT_CALL_REFER":{"name":"EVENT_CALL_REFER","kind":"variable","exported":true,"signature":["const EVENT_CALL_REFER"],"doc":"","file":"dist/relay/constants.d.ts","line":47},"EVENT_CALL_SEND_DIGITS":{"name":"EVENT_CALL_SEND_DIGITS","kind":"variable","exported":true,"signature":["const EVENT_CALL_SEND_DIGITS"],"doc":"","file":"dist/relay/constants.d.ts","line":45},"EVENT_CALL_STATE":{"name":"EVENT_CALL_STATE","kind":"variable","exported":true,"signature":["const EVENT_CALL_STATE"],"doc":"","file":"dist/relay/constants.d.ts","line":36},"EVENT_CALL_STREAM":{"name":"EVENT_CALL_STREAM","kind":"variable","exported":true,"signature":["const EVENT_CALL_STREAM"],"doc":"","file":"dist/relay/constants.d.ts","line":51},"EVENT_CALL_TAP":{"name":"EVENT_CALL_TAP","kind":"variable","exported":true,"signature":["const EVENT_CALL_TAP"],"doc":"","file":"dist/relay/constants.d.ts","line":44},"EVENT_CALL_TRANSCRIBE":{"name":"EVENT_CALL_TRANSCRIBE","kind":"variable","exported":true,"signature":["const EVENT_CALL_TRANSCRIBE"],"doc":"","file":"dist/relay/constants.d.ts","line":53},"EVENT_CLASS_MAP":{"name":"EVENT_CLASS_MAP","kind":"variable","exported":true,"signature":["const EVENT_CLASS_MAP: Record<string, EventClass>"],"doc":"Maps RELAY `event_type` strings to the typed event subclass that builds\nits wrapper. Used by {@link parseEvent} to dispatch raw payloads.","file":"dist/relay/RelayEvent.d.ts","line":282},"EVENT_CONFERENCE":{"name":"EVENT_CONFERENCE","kind":"variable","exported":true,"signature":["const EVENT_CONFERENCE"],"doc":"","file":"dist/relay/constants.d.ts","line":55},"EVENT_MESSAGING_RECEIVE":{"name":"EVENT_MESSAGING_RECEIVE","kind":"variable","exported":true,"signature":["const EVENT_MESSAGING_RECEIVE"],"doc":"","file":"dist/relay/constants.d.ts","line":57},"EVENT_MESSAGING_STATE":{"name":"EVENT_MESSAGING_STATE","kind":"variable","exported":true,"signature":["const EVENT_MESSAGING_STATE"],"doc":"","file":"dist/relay/constants.d.ts","line":58},"EchoEvent":{"name":"EchoEvent","kind":"class","exported":true,"signature":["class EchoEvent extends RelayEvent"],"doc":"`calling.call.echo` — test/diagnostic echo reflection from the server.","file":"dist/relay/RelayEvent.d.ts","line":198,"members":[{"name":"state","kind":"property","owner":"EchoEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":199},{"name":"constructor","kind":"constructor","owner":"EchoEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, state?: string)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":200},{"name":"fromPayload","kind":"method","owner":"EchoEvent","static":true,"signature":["static fromPayload(payload: EventPayload): EchoEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":201}],"bases":["RelayEvent"]},"EndCall":{"name":"EndCall","kind":"type","exported":true,"signature":["type EndCall = (callId: string) => void | Promise<void>"],"doc":"Hangs a call up server-side, so its teardown hooks run now: `endCall(callId)`.","file":"dist/ai-chat/HandoffRouter.d.ts","line":103},"Error":{"name":"Error","kind":"interface","exported":false,"signature":["interface Error"],"doc":"","file":"node_modules/typescript/lib/lib.es5.d.ts","line":1073,"members":[{"name":"name","kind":"property","owner":"Error","signature":["name: string"],"doc":"","file":"node_modules/typescript/lib/lib.es5.d.ts","line":1074},{"name":"message","kind":"property","owner":"Error","signature":["message: string"],"doc":"","file":"node_modules/typescript/lib/lib.es5.d.ts","line":1075},{"name":"stack","kind":"property","owner":"Error","signature":["stack?: string"],"doc":"","file":"node_modules/typescript/lib/lib.es5.d.ts","line":1076},{"name":"cause","kind":"property","owner":"Error","signature":["cause?: unknown"],"doc":"","file":"node_modules/typescript/lib/lib.es2022.error.d.ts","line":24}]},"EventClass":{"name":"EventClass","kind":"type","exported":true,"signature":["type EventClass = {\n fromPayload(payload: EventPayload): RelayEvent;\n}"],"doc":"Structural type for an event class that exposes a `fromPayload` factory.","file":"dist/relay/RelayEvent.d.ts","line":275},"EventHandler":{"name":"EventHandler","kind":"type","exported":true,"signature":["type EventHandler = (event: RelayEvent) => void | Promise<void>"],"doc":"Handler for relay events.","file":"dist/relay/types.d.ts","line":58},"FAQBotAgent":{"name":"FAQBotAgent","kind":"class","exported":true,"signature":["class FAQBotAgent extends AgentBase"],"doc":"Prefab agent that answers frequently asked questions using keyword matching with optional escalation to a live agent.\n\nPass an array of `{ question, answer, keywords }` entries and the agent will\nfuzzy-match inbound utterances against them. If no match crosses the confidence\nthreshold, the call can optionally escalate to a configured phone number.\n\n@example\n```ts\nimport { FAQBotAgent } from '@signalwire/sdk';\n\nconst agent = new FAQBotAgent({\n faqs: [\n {\n question: 'What are your business hours?',\n answer: \"We're open 9 AM to 5 PM Pacific, Monday through Friday.\",\n keywords: ['hours', 'open', 'closed', 'time'],\n },\n {\n question: 'Where are you located?',\n answer: 'Our headquarters are in San Francisco, California.',\n keywords: ['location', 'address', 'office'],\n },\n ],\n escalationNumber: '+15551234567',\n});\n\nawait agent.serve({ port: 3000 });\n```","file":"dist/prefabs/FAQBotAgent.d.ts","line":76,"members":[{"name":"faqs","kind":"property","owner":"FAQBotAgent","signature":["faqs: FAQEntry[]"],"doc":"The configured FAQ entries.","file":"dist/prefabs/FAQBotAgent.d.ts","line":78},{"name":"suggestRelated","kind":"property","owner":"FAQBotAgent","signature":["suggestRelated: boolean"],"doc":"Whether runner-up FAQ suggestions are appended to matches.","file":"dist/prefabs/FAQBotAgent.d.ts","line":80},{"name":"persona","kind":"property","owner":"FAQBotAgent","signature":["persona: string"],"doc":"The personality description used in the prompt.","file":"dist/prefabs/FAQBotAgent.d.ts","line":82},{"name":"constructor","kind":"constructor","owner":"FAQBotAgent","signature":["constructor(config: FAQBotConfig)"],"doc":"Create a FAQBotAgent with the specified FAQ entries and matching threshold.\n@param config - Configuration including FAQ entries, threshold, and escalation settings.","file":"dist/prefabs/FAQBotAgent.d.ts","line":90},{"name":"defineTools","kind":"method","owner":"FAQBotAgent","protected":true,"signature":["protected defineTools(): void"],"doc":"Register the search_faqs and optional escalate SWAIG tools.","file":"dist/prefabs/FAQBotAgent.d.ts","line":102},{"name":"searchFaqs","kind":"method","owner":"FAQBotAgent","signature":["searchFaqs(args: Record<string, unknown>, _rawData: Record<string, unknown>): FunctionResult"],"doc":"SWAIG handler for `search_faqs`: score the (optionally category-filtered)\nFAQ pool against the query and return the top matches. Mirrors Python\n`FAQBotAgent.search_faqs`.","file":"dist/prefabs/FAQBotAgent.d.ts","line":108},{"name":"onSummary","kind":"method","owner":"FAQBotAgent","signature":["onSummary(summary: Record<string, unknown> | null, _rawData: PostPrompt): void | Promise<void>"],"doc":"Process the interaction summary returned at the end of a call.\nLogs structured summaries as JSON. Subclasses may override to persist or process.","file":"dist/prefabs/FAQBotAgent.d.ts","line":113}],"bases":["AgentBase"]},"FAQBotConfig":{"name":"FAQBotConfig","kind":"interface","exported":true,"signature":["interface FAQBotConfig"],"doc":"Configuration for the {@link FAQBotAgent}.","file":"dist/prefabs/FAQBotAgent.d.ts","line":26,"members":[{"name":"name","kind":"property","owner":"FAQBotConfig","signature":["name?: string"],"doc":"Agent display name (defaults to `\"faq_bot\"`).","file":"dist/prefabs/FAQBotAgent.d.ts","line":28},{"name":"route","kind":"property","owner":"FAQBotConfig","signature":["route?: string"],"doc":"HTTP route for this agent (defaults to `\"/faq\"`).","file":"dist/prefabs/FAQBotAgent.d.ts","line":30},{"name":"faqs","kind":"property","owner":"FAQBotConfig","signature":["faqs: FAQEntry[]"],"doc":"List of FAQ entries for the knowledge base.","file":"dist/prefabs/FAQBotAgent.d.ts","line":32},{"name":"suggestRelated","kind":"property","owner":"FAQBotConfig","signature":["suggestRelated?: boolean"],"doc":"Whether to suggest related questions alongside a match. Default `true`.","file":"dist/prefabs/FAQBotAgent.d.ts","line":34},{"name":"persona","kind":"property","owner":"FAQBotConfig","signature":["persona?: string"],"doc":"Custom personality description for the agent's \"Personality\" prompt section.","file":"dist/prefabs/FAQBotAgent.d.ts","line":36},{"name":"threshold","kind":"property","owner":"FAQBotConfig","signature":["threshold?: number"],"doc":"Minimum match score (0-1) for an FAQ to be considered a match. Default 0.5.","file":"dist/prefabs/FAQBotAgent.d.ts","line":38},{"name":"escalationMessage","kind":"property","owner":"FAQBotConfig","signature":["escalationMessage?: string"],"doc":"Message spoken when no FAQ matches the query.","file":"dist/prefabs/FAQBotAgent.d.ts","line":40},{"name":"escalationNumber","kind":"property","owner":"FAQBotConfig","signature":["escalationNumber?: string"],"doc":"Phone number to transfer to on escalation. If not set, escalate tool is not registered.","file":"dist/prefabs/FAQBotAgent.d.ts","line":42},{"name":"agentOptions","kind":"property","owner":"FAQBotConfig","signature":["agentOptions?: Partial<AgentOptions>"],"doc":"Additional AgentBase options forwarded to super().","file":"dist/prefabs/FAQBotAgent.d.ts","line":44}]},"FAQEntry":{"name":"FAQEntry","kind":"interface","exported":true,"signature":["interface FAQEntry"],"doc":"A single frequently-asked-question entry consumed by {@link FAQBotAgent}.","file":"dist/prefabs/FAQBotAgent.d.ts","line":15,"members":[{"name":"question","kind":"property","owner":"FAQEntry","signature":["question: string"],"doc":"The representative question text.","file":"dist/prefabs/FAQBotAgent.d.ts","line":17},{"name":"answer","kind":"property","owner":"FAQEntry","signature":["answer: string"],"doc":"The answer to provide when this FAQ matches.","file":"dist/prefabs/FAQBotAgent.d.ts","line":19},{"name":"keywords","kind":"property","owner":"FAQEntry","signature":["keywords?: string[]"],"doc":"Additional keywords to boost matching accuracy.","file":"dist/prefabs/FAQBotAgent.d.ts","line":21},{"name":"categories","kind":"property","owner":"FAQEntry","signature":["categories?: string[]"],"doc":"Taxonomy categories this FAQ belongs to (used for filtering and hints).","file":"dist/prefabs/FAQBotAgent.d.ts","line":23}]},"FabricAddresses":{"name":"FabricAddresses","kind":"class","exported":true,"signature":["class FabricAddresses extends ReadResource<FabricAddressesResponse, FabricAddress>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":8,"members":[{"name":"constructor","kind":"constructor","owner":"FabricAddresses","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":9}],"bases":["ReadResource"]},"FabricDevice":{"name":"FabricDevice","kind":"interface","exported":true,"signature":["interface FabricDevice"],"doc":"Fabric device specification for dial/connect — dials a Fabric address directly.\nThe platform resolves the address to whatever it points to (a Subscriber, a\nRelay/LaML application, a video room, …) and builds the appropriate leg(s); the\ncaller just names the address and never picks a transport. For a Subscriber\nthis fans out in parallel to their live registrations (push + WebRTC + SIP),\nreaching the person without provisioning an intermediate SIP address.","file":"dist/relay/types.d.ts","line":89,"members":[{"name":"type","kind":"property","owner":"FabricDevice","signature":["type: 'fabric'"],"doc":"","file":"dist/relay/types.d.ts","line":90},{"name":"to","kind":"property","owner":"FabricDevice","signature":["to: string"],"doc":"","file":"dist/relay/types.d.ts","line":91},{"name":"from","kind":"property","owner":"FabricDevice","signature":["from?: string"],"doc":"","file":"dist/relay/types.d.ts","line":92},{"name":"timeout","kind":"property","owner":"FabricDevice","signature":["timeout?: number"],"doc":"","file":"dist/relay/types.d.ts","line":93}]},"FabricNamespace":{"name":"FabricNamespace","kind":"class","exported":true,"signature":["class FabricNamespace"],"doc":"Generated `client.fabric` namespace container.","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":22,"members":[{"name":"addresses","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly addresses: FabricAddresses"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":23},{"name":"aiAgents","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly aiAgents: AiAgents"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":24},{"name":"callFlows","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly callFlows: CallFlows"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":25},{"name":"conferenceRooms","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly conferenceRooms: ConferenceRooms"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":26},{"name":"cxmlApplications","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly cxmlApplications: CxmlApplications"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":27},{"name":"cxmlScripts","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly cxmlScripts: CxmlScripts"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":28},{"name":"cxmlWebhooks","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly cxmlWebhooks: CxmlWebhooks"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":29},{"name":"freeswitchConnectors","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly freeswitchConnectors: FreeswitchConnectors"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":30},{"name":"relayApplications","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly relayApplications: RelayApplications"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":31},{"name":"resources","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly resources: GenericResources"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":32},{"name":"sipEndpoints","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly sipEndpoints: SipEndpoints"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":33},{"name":"sipGateways","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly sipGateways: SipGateways"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":34},{"name":"subscribers","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly subscribers: Subscribers"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":35},{"name":"swmlScripts","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly swmlScripts: SwmlScripts"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":36},{"name":"swmlWebhooks","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly swmlWebhooks: SwmlWebhooks"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":37},{"name":"tokens","kind":"property","owner":"FabricNamespace","readonly":true,"signature":["readonly tokens: FabricTokens"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":38},{"name":"constructor","kind":"constructor","owner":"FabricNamespace","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":39}]},"FabricResource":{"name":"FabricResource","kind":"class","exported":true,"signature":["class FabricResource<TList = unknown, TItem = unknown, TCreate = unknown, TUpdate = unknown> extends CrudWithAddresses<TList, TItem, TCreate, TUpdate>"],"doc":"Standard fabric resource: CRUD plus address listing (PATCH updates).","file":"dist/rest/base/FabricResource.d.ts","line":10,"members":[],"bases":["CrudWithAddresses"]},"FabricResourcePUT":{"name":"FabricResourcePUT","kind":"class","exported":true,"signature":["class FabricResourcePUT<TList = unknown, TItem = unknown, TCreate = unknown, TUpdate = unknown> extends CrudWithAddresses<TList, TItem, TCreate, TUpdate>"],"doc":"Fabric resource that uses PUT for updates.","file":"dist/rest/base/FabricResource.d.ts","line":13,"members":[],"bases":["CrudWithAddresses"]},"FabricTokens":{"name":"FabricTokens","kind":"class","exported":true,"signature":["class FabricTokens extends BaseResource"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":165,"members":[{"name":"constructor","kind":"constructor","owner":"FabricTokens","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":166},{"name":"createSubscriberToken","kind":"method","owner":"FabricTokens","signature":["createSubscriberToken(reference: string, options?: {\n expire_at?: number;\n application_id?: uuid;\n password?: string;\n first_name?: string;\n last_name?: string;\n display_name?: string;\n job_title?: string;\n time_zone?: string;\n country?: string;\n region?: string;\n company_name?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<SubscriberTokenResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":167},{"name":"refreshSubscriberToken","kind":"method","owner":"FabricTokens","signature":["refreshSubscriberToken(refresh_token: jwt, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<SubscriberRefreshTokenResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":181},{"name":"createInviteToken","kind":"method","owner":"FabricTokens","signature":["createInviteToken(address_id: uuid, options?: {\n expires_at?: number;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<SubscriberInviteTokenCreateResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":184},{"name":"createGuestToken","kind":"method","owner":"FabricTokens","signature":["createGuestToken(allowed_addresses: uuid[], options?: {\n expire_at?: number;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<SubscriberGuestTokenCreateResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":188},{"name":"createEmbedToken","kind":"method","owner":"FabricTokens","signature":["createEmbedToken(token: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<EmbedsTokensResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":192}],"bases":["BaseResource"]},"FaxAction":{"name":"FaxAction","kind":"class","exported":true,"signature":["class FaxAction extends Action"],"doc":"Async handle for a `send_fax` or `receive_fax` action.","file":"dist/relay/Action.d.ts","line":216,"members":[{"name":"constructor","kind":"constructor","owner":"FaxAction","signature":["constructor(call: CallLike, controlId: string, methodPrefix: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":218},{"name":"stop","kind":"method","owner":"FaxAction","signature":["stop(): Promise<Record<string, unknown>>"],"doc":"Stop the fax transfer mid-stream.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":225}],"bases":["Action"]},"FaxEvent":{"name":"FaxEvent","kind":"class","exported":true,"signature":["class FaxEvent extends RelayEvent"],"doc":"`calling.call.fax` — fax send/receive progress update.","file":"dist/relay/RelayEvent.d.ts","line":119,"members":[{"name":"controlId","kind":"property","owner":"FaxEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":120},{"name":"fax","kind":"property","owner":"FaxEvent","readonly":true,"signature":["readonly fax: EventPayload"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":121},{"name":"constructor","kind":"constructor","owner":"FaxEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, fax?: EventPayload)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":122},{"name":"fromPayload","kind":"method","owner":"FaxEvent","static":true,"signature":["static fromPayload(payload: EventPayload): FaxEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":123}],"bases":["RelayEvent"]},"FaxLogs":{"name":"FaxLogs","kind":"class","exported":true,"signature":["class FaxLogs extends ReadResource<LogListResponse, LogResponse>"],"doc":"","file":"dist/rest/namespaces/fax.resources.generated.d.ts","line":4,"members":[{"name":"constructor","kind":"constructor","owner":"FaxLogs","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fax.resources.generated.d.ts","line":5}],"bases":["ReadResource"]},"FaxTone":{"name":"FaxTone","kind":"type","exported":true,"signature":["type FaxTone = 'CED' | 'CNG'"],"doc":"Fax tone to detect for {@link ../relay/Call.Call.detectFax} (`tone` option):\n`\"CED\"` (called-station, answering fax) or `\"CNG\"` (calling-station,\noriginating fax). Restricts detection to one tone; omit to detect either.","file":"dist/relay/closedSets.d.ts","line":40},"FormParamValue":{"name":"FormParamValue","kind":"type","exported":true,"signature":["type FormParamValue = string | number | boolean | null | undefined"],"doc":"Form params can be a record, a list of [key, value] tuples, or a Map. Values\nmay be a string, number, boolean, null/undefined, or an array of those for\nrepeated keys.","file":"dist/WebhookValidator.d.ts","line":22},"FormParams":{"name":"FormParams","kind":"type","exported":true,"signature":["type FormParams = Record<string, FormParamValue | FormParamValue[]> | Array<[string, FormParamValue]> | Map<string, FormParamValue | FormParamValue[]>"],"doc":"","file":"dist/WebhookValidator.d.ts","line":23},"FreeswitchConnectors":{"name":"FreeswitchConnectors","kind":"class","exported":true,"signature":["class FreeswitchConnectors extends FabricResource<FreeswitchConnectorListResponse, FreeswitchConnectorResponse, FreeswitchConnectorCreateRequest, FreeswitchConnectorUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":90,"members":[{"name":"constructor","kind":"constructor","owner":"FreeswitchConnectors","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":92},{"name":"create","kind":"method","owner":"FreeswitchConnectors","signature":["create(body: FreeswitchConnectorCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<FreeswitchConnectorResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":94},{"name":"update","kind":"method","owner":"FreeswitchConnectors","signature":["update(id: string, body: FreeswitchConnectorUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<FreeswitchConnectorResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":96}],"bases":["FabricResource"]},"FunctionInclude":{"name":"FunctionInclude","kind":"interface","exported":true,"signature":["interface FunctionInclude"],"doc":"Reference to an external SWAIG function endpoint to include in the AI configuration.","file":"dist/types.d.ts","line":150,"members":[{"name":"url","kind":"property","owner":"FunctionInclude","signature":["url: string"],"doc":"URL of the remote SWAIG endpoint.","file":"dist/types.d.ts","line":152},{"name":"functions","kind":"property","owner":"FunctionInclude","signature":["functions: string[]"],"doc":"List of function names available at the remote endpoint.","file":"dist/types.d.ts","line":154},{"name":"meta_data","kind":"property","owner":"FunctionInclude","signature":["meta_data?: Record<string, unknown>"],"doc":"Optional metadata to pass along with the include.","file":"dist/types.d.ts","line":156}]},"FunctionResult":{"name":"FunctionResult","kind":"class","exported":true,"signature":["class FunctionResult"],"doc":"Builder for SWAIG function responses.\n\nCarries a response and a list of structured actions (connect, hangup, SMS,\nrecord, transfer and others) that the SignalWire platform executes. Every\nmutating method returns `this` for fluent chaining.\n\nThe response is context for the model, not speech played to the caller. The\nmodel reads it and decides what to say. It can carry facts, an instruction, or\nboth. The clearest form keeps them apart with {@link setToolResponse}, or the\nconstructor's `toolResult` and `toolPrompt`: `tool_result` holds the facts and\n`tool_prompt` the instruction. A plain string of facts (\"Order 1234 shipped\nTuesday.\") or an instruction (\"Tell the caller their order shipped Tuesday.\")\nalso works. Avoid a line written for the caller (\"Your order shipped\nTuesday.\"): the model interprets it rather than speaking it, so it can drift\nor be rephrased. Set `postProcess` when the caller must hear something before\nan action takes effect (hold, connect, transfer, hangup).\n\nReturn an instance (or a promise that resolves to one) from any SWAIG tool\nhandler. Handlers receive `(args, rawData, agent)`.\n\n@example Simple text response\n```ts\nagent.defineTool({\n name: 'say_hi',\n description: 'Say hello.',\n parameters: { type: 'object', properties: {} },\n handler: () => new FunctionResult('Greet the caller warmly.'),\n});\n```\n\n@example Response plus a call-control action\n```ts\nagent.defineTool({\n name: 'transfer_to_sales',\n description: 'Forward the caller to sales.',\n parameters: { type: 'object', properties: {} },\n handler: () =>\n new FunctionResult('Tell the caller you are connecting them to sales.', true).connect(\n '+15551112222',\n ),\n});\n```\n\n@example Chained actions\n```ts\nnew FunctionResult('Tell the caller they are all set and say goodbye.', true)\n .sendSms({ toNumber: '+15551234567', fromNumber: '+15559998888', body: 'Confirmation!' })\n .hangup();\n```\n\n@see {@link AgentBase.defineTool}, where handlers return a `FunctionResult`\n@see {@link DataMap}, an alternative for data-driven tools with no handler","file":"dist/FunctionResult.d.ts","line":117,"members":[{"name":"response","kind":"property","owner":"FunctionResult","signature":["response: string"],"doc":"The response string returned to the model as context. When the structured\nform is set ({@link setToolResponse}), that is sent instead.","file":"dist/FunctionResult.d.ts","line":122},{"name":"action","kind":"property","owner":"FunctionResult","signature":["action: SwaigAction[]"],"doc":"Ordered list of actions to execute after the response.","file":"dist/FunctionResult.d.ts","line":126},{"name":"postProcess","kind":"property","owner":"FunctionResult","signature":["postProcess: boolean"],"doc":"Whether actions should be post-processed after the AI responds.","file":"dist/FunctionResult.d.ts","line":128},{"name":"constructor","kind":"constructor","owner":"FunctionResult","signature":["constructor(response?: string | {\n tool_result?: string;\n tool_prompt?: string;\n}, postProcess?: boolean, toolResult?: string, toolPrompt?: string)"],"doc":"@param response - Initial response: a string of context for the model\n (facts or an instruction), or the structured `{ tool_result, tool_prompt }`\n form. Defaults to an empty string.\n@param postProcess - Whether the model takes one more turn before the\n actions execute (set it when the caller must hear something first).\n@param toolResult - Sets the structured response's `tool_result` (see\n {@link setToolResponse}).\n@param toolPrompt - Sets the structured response's `tool_prompt`.","file":"dist/FunctionResult.d.ts","line":139},{"name":"setResponse","kind":"method","owner":"FunctionResult","signature":["setResponse(response: string): this"],"doc":"Set the response string returned to the model as context. Clears any\nstructured response set by {@link setToolResponse}.\n@param response - The response text: facts or an instruction.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":149},{"name":"setToolResponse","kind":"method","owner":"FunctionResult","signature":["setToolResponse(toolResult?: string, toolPrompt?: string): this"],"doc":"Set the structured response, separating facts from instruction:\n`{ tool_result, tool_prompt }`. Replaces any string response.\n\n- `toolResult`: what the tool did or found. Facts for the model to reason\n from (\"hold initiated\", \"payment declined\", \"3 seats left\").\n- `toolPrompt`: what the model should do next. An instruction, such as\n \"Tell the caller how many seats are left.\"\n\nSplitting them keeps the model from reading a status line aloud, and keeps\nthe instruction from being mistaken for data.\n\n@param toolResult - Facts from the call; omit if there is nothing to\n report beyond the instruction.\n@param toolPrompt - Instruction for what to do next; omit for a\n facts-only result.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":168},{"name":"setPostProcess","kind":"method","owner":"FunctionResult","signature":["setPostProcess(postProcess: boolean): this"],"doc":"Enable or disable post-processing. When enabled, the model takes one more\nturn before the actions execute, so it can tell the caller something first.\n@param postProcess - Whether to post-process actions.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":175},{"name":"addAction","kind":"method","owner":"FunctionResult","signature":["addAction(name: string, data: unknown): this"],"doc":"Append a single named action to the action list.\n@param name - The action name (e.g., \"hangup\", \"say\").\n@param data - The action payload.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":182},{"name":"addActions","kind":"method","owner":"FunctionResult","signature":["addActions(actions: SwaigAction[]): this"],"doc":"Append multiple action objects to the action list.\n@param actions - Array of action objects to append.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":188},{"name":"connect","kind":"method","owner":"FunctionResult","signature":["connect(destination: string, final?: boolean, fromAddr?: string): this"],"doc":"Connect the call to another destination with an inline SWML `connect`\ndocument, emitted with `transfer: \"true\"` or `\"false\"` beside it.\n@param destination - The destination address (phone number or SIP URI).\n@param final - `true` (default) for a permanent transfer that leaves the\n agent; `false` returns the call to the agent when the far end hangs up.\n@param fromAddr - Optional caller ID to use for the outbound leg.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":198},{"name":"swmlTransfer","kind":"method","owner":"FunctionResult","signature":["swmlTransfer(dest: string, aiResponse: string, final?: boolean): this"],"doc":"Transfer the call with an inline SWML document that sets `ai_response` and\nthen runs the `transfer` verb, emitted with `transfer` beside it.\n@param dest - The transfer destination (a SWML URL, SIP address or similar).\n@param aiResponse - Stored as `ai_response`, for the agent to use when a\n non-final transfer returns the call.\n@param final - `true` (default) for a permanent transfer; `false` to return.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":208},{"name":"hangup","kind":"method","owner":"FunctionResult","signature":["hangup(): this"],"doc":"Hang up the call. Emits `{ hangup: true }`.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":213},{"name":"hold","kind":"method","owner":"FunctionResult","signature":["hold(prompt?: string | number, timeout?: number, step?: string, timeoutStep?: string): this"],"doc":"Put the call on hold, optionally announcing it and routing what happens next.\n\nThe hold action carries no prompt of its own, and during a hold speech\ndetection is paused and the agent doesn't respond, so anything the caller\nneeds to hear has to be said before the hold takes effect. Passing `prompt`\ndoes that: it becomes the structured response's `tool_prompt` (with\n`tool_result: \"status: on hold\"`) and turns on `postProcess`, so the model\ntakes one more turn, and can tell the caller, before the hold runs.\n\n`step` and `timeoutStep` move the call to a step when the hold ends:\n`step` when it's taken off hold, `timeoutStep` when the hold times out.\nThey fire when the hold ends, unlike {@link swmlChangeStep}, which applies\nat once and would move the caller before the hold begins. Omit one, and a\nhold that ends that way resumes in the current step. Omitting both emits\nthe bare timeout (`{ hold: 300 }`); either one emits\n`{ hold: { timeout, step?, timeout_step? } }`.\n\n@example\n```ts\nnew FunctionResult().hold('Tell the caller you are checking if they are available.', 300,\n 'back_with_agent', 'take_a_message');\n```\n\n@param prompt - Instruction for the model to act on before the hold. A\n number here is taken as `timeout`, so `hold(120)` keeps working.\n@param timeout - Hold duration in seconds, clamped to 0-900 (default 300).\n@param step - Step to move to when the call is taken off hold.\n@param timeoutStep - Step to move to when the hold times out.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":245},{"name":"waitForUser","kind":"method","owner":"FunctionResult","signature":["waitForUser(opts?: {\n enabled?: boolean;\n timeout?: number;\n answerFirst?: boolean;\n}): this"],"doc":"Emit a `wait_for_user` action. The first option set wins, in this order:\n`answerFirst` (emits `\"answer_first\"`), `timeout`, `enabled`; with none,\nit emits `true`.\n@param opts - Options controlling wait behavior: enable/disable, timeout in\n seconds, or answer-first mode.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":254},{"name":"stop","kind":"method","owner":"FunctionResult","signature":["stop(): this"],"doc":"Stop the AI conversation. Emits `{ stop: true }`.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":263},{"name":"say","kind":"method","owner":"FunctionResult","signature":["say(text: string): this"],"doc":"Speak text to the caller via TTS. Unlike the response, this text is\nspoken to the caller.\n@param text - The text to speak.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":270},{"name":"playBackgroundFile","kind":"method","owner":"FunctionResult","signature":["playBackgroundFile(filename: string, wait?: boolean): this"],"doc":"Play an audio file in the background during the call.\n@param filename - URL or path of the audio file.\n@param wait - Whether to wait for playback to finish before continuing.\n `true` emits `{ file, wait: true }`; `false` emits the file name alone.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":278},{"name":"stopBackgroundFile","kind":"method","owner":"FunctionResult","signature":["stopBackgroundFile(): this"],"doc":"Stop any currently playing background audio file.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":283},{"name":"addDynamicHints","kind":"method","owner":"FunctionResult","signature":["addDynamicHints(hints: (string | {\n pattern: string;\n replace: string;\n ignore_case?: boolean;\n})[]): this"],"doc":"Add dynamic speech recognition hints to improve transcription accuracy.\n@param hints - Array of hint strings or pattern-replacement objects.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":289},{"name":"clearDynamicHints","kind":"method","owner":"FunctionResult","signature":["clearDynamicHints(): this"],"doc":"Remove all previously added dynamic speech hints.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":298},{"name":"setEndOfSpeechTimeout","kind":"method","owner":"FunctionResult","signature":["setEndOfSpeechTimeout(milliseconds: number): this"],"doc":"Set the silence after detected speech that finalizes speech recognition.\n@param milliseconds - Timeout in milliseconds.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":304},{"name":"setSpeechEventTimeout","kind":"method","owner":"FunctionResult","signature":["setSpeechEventTimeout(milliseconds: number): this"],"doc":"Set the time since the last speech detection event after which speech\nrecognition is finalized. Suits noisy environments.\n@param milliseconds - Timeout in milliseconds.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":311},{"name":"updateGlobalData","kind":"method","owner":"FunctionResult","signature":["updateGlobalData(data: Record<string, unknown>): this"],"doc":"Merge key-value pairs into the call's global data (`set_global_data`),\nwhich persists for the AI session and is readable by every function.\n@param data - Key-value pairs to set or update.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":318},{"name":"removeGlobalData","kind":"method","owner":"FunctionResult","signature":["removeGlobalData(keys: string | string[]): this"],"doc":"Remove keys from the global data store.\n@param keys - A single key or array of keys to remove.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":324},{"name":"setMetadata","kind":"method","owner":"FunctionResult","signature":["setMetadata(data: Record<string, unknown>): this"],"doc":"Set metadata (`set_meta_data`) scoped to the current function's\n`meta_data_token`. Functions sharing a token share the metadata.\n@param data - Metadata key-value pairs to set.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":331},{"name":"removeMetadata","kind":"method","owner":"FunctionResult","signature":["removeMetadata(keys: string | string[]): this"],"doc":"Remove metadata keys (`unset_meta_data`) from the current function's\n`meta_data_token` scope.\n@param keys - A single key or array of keys to remove.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":338},{"name":"executeSwml","kind":"method","owner":"FunctionResult","signature":["executeSwml(swmlContent: string | Record<string, unknown> | {\n toDict(): Record<string, unknown>;\n}, transfer?: boolean): this"],"doc":"Execute arbitrary SWML content as an action.\n\nA JSON string is parsed; a string that isn't JSON is sent as\n`{ raw_swml: <string> }`. An object with a `toDict()` method is converted\nthrough it, and a plain object is copied. Any other value throws.\n\n@param swmlContent - SWML as a JSON string, a plain object, or an object\n with `toDict()`.\n@param transfer - When `true`, emits `transfer: \"true\"` beside the `SWML`\n key, so the call leaves the agent for the SWML.\n@returns This instance for chaining.\n@throws {Error} When `swmlContent` is not a string, a plain object, or an\n object with `toDict()` (for example a number, an array or `null`).","file":"dist/FunctionResult.d.ts","line":354},{"name":"swmlChangeStep","kind":"method","owner":"FunctionResult","signature":["swmlChangeStep(stepName: string): this"],"doc":"Move the conversation to a step in the current context (`change_step`).\nThe change applies at once, and the step must exist in the current\ncontext of the agent's contexts (see `defineContexts()`).\n@param stepName - The name of the step to switch to.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":364},{"name":"swmlChangeContext","kind":"method","owner":"FunctionResult","signature":["swmlChangeContext(contextName: string): this"],"doc":"Move the conversation to another context (`change_context`). The context\nmust exist in the agent's contexts (see `defineContexts()`).\n@param contextName - The name of the context to switch to.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":371},{"name":"swmlUserEvent","kind":"method","owner":"FunctionResult","signature":["swmlUserEvent(eventData: Record<string, unknown>): this"],"doc":"Send an event to the client connected to the call, through an inline SWML\n`user_event` verb. The client receives it as a `user_event` event.\n@param eventData - The event payload.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":378},{"name":"switchContext","kind":"method","owner":"FunctionResult","signature":["switchContext(opts?: {\n systemPrompt?: string;\n userPrompt?: string;\n consolidate?: boolean;\n fullReset?: boolean;\n}): this"],"doc":"Replace the agent's prompt mid-call (`context_switch`). With only\n`systemPrompt`, emits the prompt string; otherwise emits an object with the\nfields that are set.\n@param opts - The new system prompt, a user prompt to add, whether to\n summarize the conversation so far (`consolidate`), and whether to reset the\n context completely (`fullReset`).\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":388},{"name":"toggleFunctions","kind":"method","owner":"FunctionResult","signature":["toggleFunctions(toggles: {\n function: string;\n active: boolean;\n}[]): this"],"doc":"Enable or disable SWAIG functions by name.\n@param toggles - Array of function name and active state pairs.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":399},{"name":"enableFunctionsOnTimeout","kind":"method","owner":"FunctionResult","signature":["enableFunctionsOnTimeout(enabled?: boolean): this"],"doc":"Control whether functions can be called on speaker timeout\n(`functions_on_speaker_timeout`).\n@param enabled - Whether to enable function execution on timeout.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":409},{"name":"updateSettings","kind":"method","owner":"FunctionResult","signature":["updateSettings(settings: Record<string, unknown>): this"],"doc":"Update AI settings at runtime (`settings`). The platform validates the\nkeys, such as `temperature`, `top-p` and `barge-confidence`.\n@param settings - Key-value pairs of settings to update.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":416},{"name":"simulateUserInput","kind":"method","owner":"FunctionResult","signature":["simulateUserInput(text: string): this"],"doc":"Queue text as if the user had said it (`user_input`).\n@param text - The simulated user input text.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":422},{"name":"enableExtensiveData","kind":"method","owner":"FunctionResult","signature":["enableExtensiveData(enabled?: boolean): this"],"doc":"Send the full data to the model for this turn only, then a smaller\nreplacement in later turns (`extensive_data`).\n@param enabled - Whether to send extensive data this turn.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":429},{"name":"replaceInHistory","kind":"method","owner":"FunctionResult","signature":["replaceInHistory(text?: string | boolean): this"],"doc":"After the first send, replace this tool call and its result in the\nconversation history (`replace_in_history`).\n@param text - A string replaces the pair with an assistant message holding\n that text; `true` (default) removes the pair from the history.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":437},{"name":"sendSms","kind":"method","owner":"FunctionResult","signature":["sendSms(opts: {\n toNumber: string;\n fromNumber: string;\n body?: string;\n media?: string[];\n tags?: string[];\n region?: string;\n}): this"],"doc":"Send an SMS or MMS message from within the call flow.\n\n@param opts - SMS parameters. Must include `body` (text SMS), `media`\n (MMS), or both; supplying neither throws.\n@returns This instance for chaining.\n@throws {Error} When neither `body` nor `media` is provided.","file":"dist/FunctionResult.d.ts","line":446},{"name":"recordCall","kind":"method","owner":"FunctionResult","signature":["recordCall(opts?: {\n controlId?: string;\n stereo?: boolean;\n format?: 'wav' | 'mp3' | 'mp4';\n direction?: 'speak' | 'listen' | 'both';\n terminators?: string;\n beep?: boolean;\n inputSensitivity?: number;\n initialTimeout?: number;\n endSilenceTimeout?: number;\n maxLength?: number;\n statusUrl?: string;\n}): this"],"doc":"Start a background recording of the call (SWML `record_call`).\n@param opts - Recording options including format, direction, and timeouts.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":459},{"name":"stopRecordCall","kind":"method","owner":"FunctionResult","signature":["stopRecordCall(controlId?: string): this"],"doc":"Stop an active call recording.\n@param controlId - Optional control ID of the recording to stop.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":477},{"name":"tap","kind":"method","owner":"FunctionResult","signature":["tap(opts: {\n uri: string;\n controlId?: string;\n /** `speak` (what the party says), `listen` (what it hears) or `both` (default). */\n direction?: 'speak' | 'listen' | 'both';\n codec?: 'PCMU' | 'PCMA';\n rtpPtime?: number;\n statusUrl?: string;\n}): this"],"doc":"Start a media tap to stream audio to an external URI (`ws://`, `wss://` or\n`rtp://IP:port`). `direction` is always sent; `codec` and `rtpPtime` are\nsent only when they differ from `PCMU` and 20.\n@param opts - Tap parameters including URI, direction, and codec.\n@throws {Error} On a `direction` or `codec` outside the allowed values, or\n an `rtpPtime` that isn't positive.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":487},{"name":"stopTap","kind":"method","owner":"FunctionResult","signature":["stopTap(controlId?: string): this"],"doc":"Stop an active media tap.\n@param controlId - Optional control ID of the tap to stop.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":501},{"name":"joinRoom","kind":"method","owner":"FunctionResult","signature":["joinRoom(name: string): this"],"doc":"Join a RELAY room by name (SWML `join_room`).\n@param name - The room name to join.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":507},{"name":"sipRefer","kind":"method","owner":"FunctionResult","signature":["sipRefer(toUri: string): this"],"doc":"Send a SIP REFER to transfer the call.\n@param toUri - The SIP URI to refer the call to.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":513},{"name":"joinConference","kind":"method","owner":"FunctionResult","signature":["joinConference(name: string, opts?: {\n muted?: boolean;\n beep?: 'true' | 'false' | 'onEnter' | 'onExit';\n startOnEnter?: boolean;\n endOnExit?: boolean;\n waitUrl?: string;\n maxParticipants?: number | string;\n record?: 'do-not-record' | 'record-from-start';\n region?: string;\n trim?: 'trim-silence' | 'do-not-trim';\n coach?: string;\n statusCallbackEvent?: string;\n statusCallback?: string;\n statusCallbackMethod?: 'GET' | 'POST';\n recordingStatusCallback?: string;\n recordingStatusCallbackMethod?: 'GET' | 'POST';\n recordingStatusCallbackEvent?: string;\n result?: unknown;\n}): this"],"doc":"Join a conference by name with optional configuration. Options at their\ndefault value are left out; with none left, `join_conference` is the name\nstring alone.\n\n`maxParticipants` is sent whenever it is given, as an integer of 2 or\nmore: the platform refuses a conference of fewer than 2 and sets no upper\nlimit (the SWML schema's cap of 100000 isn't enforced). A numeric string\nis converted, and a SWML variable reference such as `'${room_size}'` is\npassed through.\n@param name - The conference name to join.\n@param opts - Optional conference settings such as mute, recording, and callbacks.\n@throws {Error} When `name` is blank, or `maxParticipants` isn't an\n integer of at least 2 or a SWML variable reference.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":530},{"name":"executeRpc","kind":"method","owner":"FunctionResult","signature":["executeRpc(opts: {\n method: string;\n params?: Record<string, unknown>;\n callId?: string;\n nodeId?: string;\n}): this"],"doc":"Execute a SignalWire RPC method via SWML.\n@param opts - RPC parameters including method name and optional call/node IDs.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":554},{"name":"rpcDial","kind":"method","owner":"FunctionResult","signature":["rpcDial(toNumber: string, fromNumber: string, destSwml: string, deviceType?: string): this"],"doc":"Dial out with the `dial` RPC method, optionally specifying device type.\n@param toNumber - The destination phone number.\n@param fromNumber - The caller ID number.\n@param destSwml - URL of the SWML that handles the dialed call.\n@param deviceType - The device type (defaults to \"phone\").\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":568},{"name":"rpcAiMessage","kind":"method","owner":"FunctionResult","signature":["rpcAiMessage(callId: string, messageText?: string | null, role?: string, globalData?: Record<string, unknown>): this"],"doc":"Send a message and/or global data to an AI agent on another call.\n\nTwo payloads, either or both: `messageText` lands as a turn in the other\nagent's conversation, where it competes with everything else arriving at\nthat moment; `globalData` is merged into the other call's global data,\nwhere it stays silent until a prompt expands it with\n`${global_data.your_key}`. That makes data the better channel for content a\nlater step needs to say.\n\n@param callId - The target call ID.\n@param messageText - Message to inject into the other conversation.\n@param role - The message role (defaults to \"system\"); sent with the message.\n@param globalData - Object merged into the target call's global data.\n@returns This instance for chaining.\n@throws Error when neither `messageText` nor `globalData` is given.","file":"dist/FunctionResult.d.ts","line":586},{"name":"rpcAiGlobalData","kind":"method","owner":"FunctionResult","signature":["rpcAiGlobalData(callId: string, data: Record<string, unknown>): this"],"doc":"Merge data into another call's global data, with no conversation turn.\nThe other call's prompt reads it back with `${global_data.key}`.\n@param callId - The target call ID.\n@param data - Object merged into that call's global data.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":594},{"name":"rpcAiUnhold","kind":"method","owner":"FunctionResult","signature":["rpcAiUnhold(callId: string): this"],"doc":"Take another call off hold with the `ai_unhold` RPC method.\n@param callId - The target call ID to unhold.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":600},{"name":"pay","kind":"method","owner":"FunctionResult","signature":["pay(opts: {\n paymentConnectorUrl: string;\n inputMethod?: string;\n statusUrl?: string;\n paymentMethod?: string;\n timeout?: number | string;\n maxAttempts?: number | string;\n securityCode?: boolean | string;\n postalCode?: boolean | string;\n minPostalCodeLength?: number | string;\n tokenType?: string;\n chargeAmount?: string;\n currency?: string;\n language?: string;\n voice?: string;\n description?: string;\n validCardTypes?: string;\n parameters?: PaymentParameter[];\n prompts?: PaymentPrompt[];\n aiResponse?: string;\n}): this"],"doc":"Start a payment collection flow on the call. Emits an inline SWML document\nthat sets `ai_response` and then runs the `pay` verb.\n\n`timeout`, `max_attempts`, `min_postal_code_length`, `security_code` and\n`postal_code` are sent as strings, as the platform reads them: its SWML\nvalidator requires strings for `security_code` and `postal_code`, and the\npay request reads all five as strings. Each input is checked first:\n`timeout`, `maxAttempts` and `minPostalCodeLength` must be integers (or\nnumeric strings), and `securityCode` a boolean (or `\"true\"`/`\"false\"`).\nA SWML variable reference such as `'${timeout}'` is passed through.\n`postalCode` is a boolean (whether to ask for it) or the postal code\nitself, as a string.\n@param opts - Payment configuration including connector URL, method, and prompt options.\n@throws {Error} When `timeout`, `maxAttempts` or `minPostalCodeLength`\n isn't an integer, or `securityCode` isn't a boolean, or a SWML variable\n reference.\n@returns This instance for chaining.","file":"dist/FunctionResult.d.ts","line":620},{"name":"createPaymentPrompt","kind":"method","owner":"FunctionResult","static":true,"signature":["static createPaymentPrompt(forSituation: string, actions: PaymentAction[], cardType?: string, errorType?: string): PaymentPrompt"],"doc":"Create a payment prompt configuration object.\n@param forSituation - The situation this prompt applies to.\n@param actions - Actions to perform for this prompt.\n@param cardType - Optional card type filter.\n@param errorType - Optional error type this prompt handles.\n@returns A new PaymentPrompt object.","file":"dist/FunctionResult.d.ts","line":649},{"name":"createPaymentAction","kind":"method","owner":"FunctionResult","static":true,"signature":["static createPaymentAction(actionType: string, phrase: string): PaymentAction"],"doc":"Create a payment action for use within a payment prompt.\n@param actionType - The action type: \"Say\" or \"Play\".\n@param phrase - The text to say, or for \"Play\" the audio file URL.\n@returns A new PaymentAction object.","file":"dist/FunctionResult.d.ts","line":656},{"name":"createPaymentParameter","kind":"method","owner":"FunctionResult","static":true,"signature":["static createPaymentParameter(name: string, value: string): PaymentParameter"],"doc":"Create a custom payment parameter for the payment connector.\n@param name - The parameter name.\n@param value - The parameter value.\n@returns A new PaymentParameter object.","file":"dist/FunctionResult.d.ts","line":663},{"name":"toDict","kind":"method","owner":"FunctionResult","signature":["toDict(): SwaigResultDict"],"doc":"Serialize this result to a plain object for the SWAIG response.\n@returns A dictionary with response, action, and post_process fields; falls back to \"Action completed.\" if empty.","file":"dist/FunctionResult.d.ts","line":668},{"name":"toJSON","kind":"method","owner":"FunctionResult","signature":["toJSON(): SwaigResultDict"],"doc":"TS-native serialization hook. `JSON.stringify(result)` emits the wire\nshape (delegates to {@link FunctionResult.toDict}) instead of the\ninternal field layout. No Python counterpart.","file":"dist/FunctionResult.d.ts","line":674}]},"GatewayRejection":{"name":"GatewayRejection","kind":"class","exported":true,"signature":["class GatewayRejection extends Error"],"doc":"A request the gateway refused, with the status the browser should see.\n\nDeliberately coarse: the browser learns that it was refused and, at most,\nwhich of a few categories it fell into. Anything finer would let a caller\nmap out the caps and the allowlist by probing.","file":"dist/ai-chat/ChatGateway.d.ts","line":129,"members":[{"name":"status","kind":"property","owner":"GatewayRejection","readonly":true,"signature":["readonly status: number"],"doc":"HTTP status to return: 400, 401, 403, 413 or 429.","file":"dist/ai-chat/ChatGateway.d.ts","line":131},{"name":"reason","kind":"property","owner":"GatewayRejection","readonly":true,"signature":["readonly reason: string"],"doc":"Short explanation that reaches the browser. It names a category and\nnothing finer: a handle that fails is reported as `malformed handle`,\n`invalid handle` (bad signature) or `expired handle`, and a cap as\n`too many new conversations` or `conversation turn limit reached`.","file":"dist/ai-chat/ChatGateway.d.ts","line":138},{"name":"constructor","kind":"constructor","owner":"GatewayRejection","signature":["constructor(status: number, reason: string)"],"doc":"@param status - HTTP status to return (401 bad key, 403 origin or handle,\n 400 malformed request, 413 a request, message or metadata over its size\n limit, 429 a cap was hit).\n@param reason - Short explanation, safe to show the browser: a category,\n never a detail such as a cap's value.","file":"dist/ai-chat/ChatGateway.d.ts","line":146}],"bases":["Error"]},"GatherInfo":{"name":"GatherInfo","kind":"class","exported":true,"signature":["class GatherInfo"],"doc":"Collects structured information from the user through a series of questions.","file":"dist/ContextBuilder.d.ts","line":163,"members":[{"name":"constructor","kind":"constructor","owner":"GatherInfo","signature":["constructor(opts?: {\n outputKey?: string;\n completionAction?: string;\n prompt?: string;\n isolated?: boolean;\n})"],"doc":"Creates a new GatherInfo.\n@param opts - Optional output key, completion action, prompt, and isolated-default configuration.","file":"dist/ContextBuilder.d.ts","line":173},{"name":"addQuestion","kind":"method","owner":"GatherInfo","signature":["addQuestion(opts: {\n key: string;\n question: string;\n type?: string;\n confirm?: boolean;\n prompt?: string;\n functions?: string[];\n isolated?: boolean;\n}): this"],"doc":"Adds a question to this gather operation.\n@param opts - Question configuration including key, question text, and optional type/confirm/prompt/functions/isolated.\n@returns This GatherInfo for chaining.","file":"dist/ContextBuilder.d.ts","line":184},{"name":"getQuestions","kind":"method","owner":"GatherInfo","signature":["getQuestions(): GatherQuestion[]"],"doc":"Returns all questions in this gather operation.\n@returns The array of GatherQuestion instances.","file":"dist/ContextBuilder.d.ts","line":197},{"name":"getCompletionAction","kind":"method","owner":"GatherInfo","signature":["getCompletionAction(): string | undefined"],"doc":"Returns the completion action for this gather info.\n@internal","file":"dist/ContextBuilder.d.ts","line":202},{"name":"toDict","kind":"method","owner":"GatherInfo","signature":["toDict(): GatherInfoDict"],"doc":"Serializes this gather operation to a plain object for SWML output.\n@returns A dictionary representation of the gather info and its questions.","file":"dist/ContextBuilder.d.ts","line":207},{"name":"toJSON","kind":"method","owner":"GatherInfo","signature":["toJSON(): GatherInfoDict"],"doc":"TS-native serialization hook so `JSON.stringify` emits the wire shape via\n{@link GatherInfo.toDict}. No Python counterpart.","file":"dist/ContextBuilder.d.ts","line":212}]},"GatherQuestion":{"name":"GatherQuestion","kind":"class","exported":true,"signature":["class GatherQuestion"],"doc":"Represents a single question within a gather operation.","file":"dist/ContextBuilder.d.ts","line":117,"members":[{"name":"key","kind":"property","owner":"GatherQuestion","signature":["key: string"],"doc":"Unique key used to store the answer.","file":"dist/ContextBuilder.d.ts","line":119},{"name":"question","kind":"property","owner":"GatherQuestion","signature":["question: string"],"doc":"The question text presented to the user.","file":"dist/ContextBuilder.d.ts","line":121},{"name":"type","kind":"property","owner":"GatherQuestion","signature":["type: string"],"doc":"Expected answer type (e.g., \"string\", \"number\").","file":"dist/ContextBuilder.d.ts","line":123},{"name":"confirm","kind":"property","owner":"GatherQuestion","signature":["confirm: boolean"],"doc":"Whether the answer requires user confirmation.","file":"dist/ContextBuilder.d.ts","line":125},{"name":"prompt","kind":"property","owner":"GatherQuestion","signature":["prompt?: string"],"doc":"Optional additional prompt context for this question.","file":"dist/ContextBuilder.d.ts","line":127},{"name":"functions","kind":"property","owner":"GatherQuestion","signature":["functions?: string[]"],"doc":"Optional list of SWAIG function names available during this question.","file":"dist/ContextBuilder.d.ts","line":129},{"name":"isolated","kind":"property","owner":"GatherQuestion","signature":["isolated?: boolean"],"doc":"Overrides the gather's `isolated` default for this one question.\nTri-state: `true` hides the sibling Q&A while this question is asked;\n`false` keeps it visible even inside an isolated gather; `undefined`\n(the default) inherits the gather's setting. `false` is NOT the same as\nunset — it is emitted to SWML so it can override an isolated gather.","file":"dist/ContextBuilder.d.ts","line":137},{"name":"constructor","kind":"constructor","owner":"GatherQuestion","signature":["constructor(opts: {\n key: string;\n question: string;\n type?: string;\n confirm?: boolean;\n prompt?: string;\n functions?: string[];\n isolated?: boolean;\n})"],"doc":"Creates a new GatherQuestion.\n@param opts - Question configuration including key, question text, and optional type/confirm/prompt/functions/isolated.","file":"dist/ContextBuilder.d.ts","line":142},{"name":"toDict","kind":"method","owner":"GatherQuestion","signature":["toDict(): Record<string, unknown>"],"doc":"Serializes this question to a plain object for SWML output.\n@returns A dictionary representation of this question.","file":"dist/ContextBuilder.d.ts","line":155},{"name":"toJSON","kind":"method","owner":"GatherQuestion","signature":["toJSON(): Record<string, unknown>"],"doc":"TS-native serialization hook so `JSON.stringify` emits the wire shape via\n{@link GatherQuestion.toDict}. No Python counterpart.","file":"dist/ContextBuilder.d.ts","line":160}]},"GenericResources":{"name":"GenericResources","kind":"class","exported":true,"signature":["class GenericResources extends BaseResource"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":11,"members":[{"name":"constructor","kind":"constructor","owner":"GenericResources","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":12},{"name":"list","kind":"method","owner":"GenericResources","signature":["list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ResourceListResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":13},{"name":"get","kind":"method","owner":"GenericResources","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ResourceResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":14},{"name":"delete","kind":"method","owner":"GenericResources","signature":["delete(id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":15},{"name":"listAddresses","kind":"method","owner":"GenericResources","signature":["listAddresses(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ResourceAddressListResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":16},{"name":"assignPhoneRoute","kind":"method","owner":"GenericResources","signature":["assignPhoneRoute(id: string, phone_route_id: uuid, handler: UsedForType, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<PhoneRouteResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":17},{"name":"assignDomainApplication","kind":"method","owner":"GenericResources","signature":["assignDomainApplication(id: string, domain_application_id: uuid, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<DomainApplicationResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":20}],"bases":["BaseResource"]},"GoogleMapsSkill":{"name":"GoogleMapsSkill","kind":"class","exported":true,"signature":["class GoogleMapsSkill extends SkillBase"],"doc":"Validates addresses and computes driving routes with Google Maps: the\n`lookup_address` tool geocodes an address or business name, and the\n`compute_route` tool returns the driving distance and time between two\ncoordinates.\n\nNeeds a Google Maps API key with the Geocoding and Routes APIs enabled,\npassed as `api_key` or set in the `GOOGLE_MAPS_API_KEY` environment\nvariable; setup fails without one. `lookup_tool_name` and\n`route_tool_name` rename the tools.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('google_maps', { api_key: process.env.MAPS_KEY });\n```","file":"dist/skills/builtin/google_maps.d.ts","line":31,"members":[{"name":"SKILL_NAME","kind":"property","owner":"GoogleMapsSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/google_maps.d.ts","line":32},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"GoogleMapsSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/google_maps.d.ts","line":33},{"name":"SKILL_VERSION","kind":"property","owner":"GoogleMapsSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/google_maps.d.ts","line":34},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"GoogleMapsSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/google_maps.d.ts","line":35},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"GoogleMapsSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/google_maps.d.ts","line":36},{"name":"getParameterSchema","kind":"method","owner":"GoogleMapsSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/google_maps.d.ts","line":37},{"name":"setup","kind":"method","owner":"GoogleMapsSkill","signature":["setup(): Promise<boolean>"],"doc":"Fail fast when there's no API key, mirroring Python's `setup()`\n(google_maps/skill.py:502), which fails without `api_key`.\n@returns `true` if the API key is present, `false` otherwise.","file":"dist/skills/builtin/google_maps.d.ts","line":45},{"name":"getHints","kind":"method","owner":"GoogleMapsSkill","signature":["getHints(): string[]"],"doc":"@returns Speech recognition hints for maps/directions keywords.","file":"dist/skills/builtin/google_maps.d.ts","line":47},{"name":"getTools","kind":"method","owner":"GoogleMapsSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns Two tools matching the Python reference exactly:\n `lookup_address` (geocode an address/business name, optional lat/lng\n bias) and `compute_route` (driving distance + time between two\n coordinates). No `required` arrays — Python omits them (skill.py:433,457).","file":"dist/skills/builtin/google_maps.d.ts","line":54}],"bases":["SkillBase"]},"HISTORY_MODES":{"name":"HISTORY_MODES","kind":"variable","exported":true,"signature":["const HISTORY_MODES: readonly [\"keep\", \"default\", \"hide\"]"],"doc":"Valid values for a step's or context's `history` visibility mode.\n\n- `keep`: nothing is cleared — every prior step's instructions *and*\n dialogue stay in the model's context.\n- `default`: prior step instructions are hidden; the dialogue is kept.\n This is the behavior when `history` is unset.\n- `hide`: prior instructions hidden **and** the prior dialogue pulled\n out of the model's context. The only way back in is an explicit\n `${step_history.*}` reference in the new prompt.","file":"dist/ContextBuilder.d.ts","line":18},"HandoffRouter":{"name":"HandoffRouter","kind":"class","exported":true,"signature":["class HandoffRouter"],"doc":"The three routes a browser client needs beside a {@link ChatGateway}.","file":"dist/ai-chat/HandoffRouter.d.ts","line":153,"members":[{"name":"gateway","kind":"property","owner":"HandoffRouter","signature":["gateway: ChatGateway"],"doc":"The gateway that issues and reads handles and checks origins.","file":"dist/ai-chat/HandoffRouter.d.ts","line":155},{"name":"captureLeg","kind":"property","owner":"HandoffRouter","signature":["captureLeg: CaptureLeg | null"],"doc":"Ends a leg and writes its record, or null.","file":"dist/ai-chat/HandoffRouter.d.ts","line":157},{"name":"endCall","kind":"property","owner":"HandoffRouter","signature":["endCall: EndCall | null"],"doc":"Hangs a call up server-side, or null.","file":"dist/ai-chat/HandoffRouter.d.ts","line":159},{"name":"sendMessage","kind":"property","owner":"HandoffRouter","signature":["sendMessage: SendMessage | null"],"doc":"Delivers typed text into a call, or null (typing off).","file":"dist/ai-chat/HandoffRouter.d.ts","line":161},{"name":"nextConversationId","kind":"property","owner":"HandoffRouter","signature":["nextConversationId: (conversationId: string) => string"],"doc":"Produces the id for a new leg.","file":"dist/ai-chat/HandoffRouter.d.ts","line":163},{"name":"nonceTtl","kind":"property","owner":"HandoffRouter","signature":["nonceTtl: number"],"doc":"Seconds a nonce stays usable for `/handoff` and `/say`, from registration.","file":"dist/ai-chat/HandoffRouter.d.ts","line":165},{"name":"maxMessagesPerCall","kind":"property","owner":"HandoffRouter","signature":["maxMessagesPerCall: number"],"doc":"Typed messages allowed per call.","file":"dist/ai-chat/HandoffRouter.d.ts","line":167},{"name":"captureTimeout","kind":"property","owner":"HandoffRouter","signature":["captureTimeout: number"],"doc":"Seconds to wait for `captureLeg`.","file":"dist/ai-chat/HandoffRouter.d.ts","line":169},{"name":"constructor","kind":"constructor","owner":"HandoffRouter","signature":["constructor(options: HandoffRouterOptions)"],"doc":"@param options - The gateway, the application's callbacks, and the limits.","file":"dist/ai-chat/HandoffRouter.d.ts","line":174},{"name":"register","kind":"method","owner":"HandoffRouter","signature":["register(nonce: string, opts: {\n conversationId: string;\n callId?: string | null;\n}): void"],"doc":"Record what a nonce gives access to.\n\nCall it from the per-call config callback of the dial that carried the\nnonce, with `callId` from the request the platform sent, never from\nanything the browser supplied.\n\nRegistering a nonce that's already in the table changes nothing, since\nthe callback runs on every config request for the call. The first\nregistration's call, time and message count stand, and a nonce `/handoff`\nhas used stays used until it would have expired.\n\n@param nonce - The nonce put in the dial's user variables.\n@param opts - `conversationId`: the conversation; `callId`: the call.","file":"dist/ai-chat/HandoffRouter.d.ts","line":192},{"name":"redeem","kind":"method","owner":"HandoffRouter","signature":["redeem(nonce: string): Promise<string | null>"],"doc":"Exchange a nonce for a chat handle, once.\n\nEnds the call, waits for its record, and only then issues a handle for a\nnew leg of the same conversation.\n\n@param nonce - The nonce the browser presented.\n@returns The handle, or null for a nonce that's unknown, expired or\n already used; the three can't be told apart.","file":"dist/ai-chat/HandoffRouter.d.ts","line":210},{"name":"escalate","kind":"method","owner":"HandoffRouter","signature":["escalate(handle: string): Promise<boolean>"],"doc":"End a chat leg and wait for its record, before a call is placed.\n\nThe browser waits for this, so a voice leg started right after finds the\ntext leg already recorded.\n\n@param handle - The chat leg's handle.\n@returns False when the handle doesn't verify.","file":"dist/ai-chat/HandoffRouter.d.ts","line":220},{"name":"say","kind":"method","owner":"HandoffRouter","signature":["say(nonce: string, text: string): Promise<boolean>"],"doc":"Deliver typed text into the call the nonce names.\n\nDoesn't use up the nonce: typing works until `/handoff` uses it or\n`nonceTtl` seconds pass from its registration, even if the call is\nstill live. The call is found by nonce, never by a browser-supplied call\nid, and no other request field is forwarded. In particular, `global_data`\nis agent state that step logic trusts, and a page must not write it.\n\nText over {@link MAX_MESSAGE_BYTES} (UTF-8), the gateway's limit for a\nchat message, is refused.\n\n@param nonce - The nonce the browser presented.\n@param text - The typed text; surrounding whitespace is removed.\n@returns True when the text was delivered: `sendMessage` neither threw\n nor returned false.","file":"dist/ai-chat/HandoffRouter.d.ts","line":238},{"name":"router","kind":"method","owner":"HandoffRouter","signature":["router(): Hono"],"doc":"A Hono app serving `POST /handoff`, `/escalate` and `/say`. Mount it at\nthe same prefix as the gateway, since the browser derives all three\npaths from the gateway's URL:\n\n```ts\nimport { AgentBase, ChatGateway, HandoffRouter } from '@signalwire/sdk';\n\nconst agent = new AgentBase({ name: 'shop', route: '/swml' });\nconst gateway = new ChatGateway({\n configUrl: 'https://my-agent.example.com/swml',\n key: 'pk_live_...',\n allowedOrigins: ['https://shop.example.com'],\n});\nconst handoff = new HandoffRouter({ gateway });\nagent.mount(gateway.router(), { prefix: '/chat' });\nagent.mount(handoff.router(), { prefix: '/chat' });\n```\n\n- `/handoff` takes `{ nonce }` and returns `{ handle }`.\n- `/escalate` takes `{ handle }` and returns `{ ok: true }`.\n- `/say` takes `{ nonce, text }` and returns `{ ok: true }`.\n\nEach returns 403 for a refused origin, and 404 `{ error: 'not found' }`\nwhen the nonce or handle doesn't verify. Each returns 413\n`{ error: 'request too large' }` for a body over the gateway's\n`MAX_REQUEST_BODY_BYTES`, and `/say` returns 413\n`{ error: 'message too large' }` for text over its `MAX_MESSAGE_BYTES`.\nBoth are checked before the nonce is looked up, so the answer says\nnothing about whether the nonce is live. Each answers its own CORS\npreflight, and sends CORS headers to an origin the gateway allows.\n\n@returns The Hono app.","file":"dist/ai-chat/HandoffRouter.d.ts","line":281}]},"HandoffRouterOptions":{"name":"HandoffRouterOptions","kind":"interface","exported":true,"signature":["interface HandoffRouterOptions"],"doc":"Constructor options for {@link HandoffRouter}.","file":"dist/ai-chat/HandoffRouter.d.ts","line":107,"members":[{"name":"gateway","kind":"property","owner":"HandoffRouterOptions","signature":["gateway: ChatGateway"],"doc":"The gateway that owns the conversations. Used to issue and read handles\nand to check origins, so all routes on the URL apply the same origin policy.","file":"dist/ai-chat/HandoffRouter.d.ts","line":112},{"name":"captureLeg","kind":"property","owner":"HandoffRouterOptions","signature":["captureLeg?: CaptureLeg"],"doc":"Ends a leg and writes its record; return true only once the record is\nwritten. When omitted, nothing waits and the ordering guarantee doesn't hold.","file":"dist/ai-chat/HandoffRouter.d.ts","line":117},{"name":"endCall","kind":"property","owner":"HandoffRouterOptions","signature":["endCall?: EndCall"],"doc":"Hangs a call up server-side.","file":"dist/ai-chat/HandoffRouter.d.ts","line":119},{"name":"sendMessage","kind":"property","owner":"HandoffRouterOptions","signature":["sendMessage?: SendMessage"],"doc":"Delivers text for `/say`. When omitted, typing is off and the route returns 404.","file":"dist/ai-chat/HandoffRouter.d.ts","line":121},{"name":"nextConversationId","kind":"property","owner":"HandoffRouterOptions","signature":["nextConversationId?: (conversationId: string) => string"],"doc":"The id for the new leg, from the current one. An ended conversation can't\nbe reopened, so each leg needs a new id. Defaults to appending `.N`; use\n`.` as the separator, the only one the service keeps that can't appear in\na generated id.","file":"dist/ai-chat/HandoffRouter.d.ts","line":128},{"name":"nonceTtl","kind":"property","owner":"HandoffRouterOptions","signature":["nonceTtl?: number"],"doc":"Seconds a nonce stays usable for `/handoff` and `/say`, from registration.\nDefault {@link DEFAULT_NONCE_TTL}.","file":"dist/ai-chat/HandoffRouter.d.ts","line":133},{"name":"maxMessagesPerCall","kind":"property","owner":"HandoffRouterOptions","signature":["maxMessagesPerCall?: number"],"doc":"Typed messages allowed per call. Each is a billed turn, so this limits\nspending as well as abuse. Default {@link DEFAULT_MAX_MESSAGES_PER_CALL}.","file":"dist/ai-chat/HandoffRouter.d.ts","line":138},{"name":"captureTimeout","kind":"property","owner":"HandoffRouterOptions","signature":["captureTimeout?: number"],"doc":"Seconds to wait for `captureLeg`, as an upper limit; a capture normally\ntakes under a second. Default {@link DEFAULT_CAPTURE_TIMEOUT}.","file":"dist/ai-chat/HandoffRouter.d.ts","line":143},{"name":"registry","kind":"property","owner":"HandoffRouterOptions","signature":["registry?: Map<string, NonceEntry>"],"doc":"The nonce table. Supply one backed by shared storage to run more than one\nreplica. It may return copies of its entries: the router writes every\nchange back with `set()`. Its read-then-write steps aren't atomic across\nreplicas that share it; see the module documentation.","file":"dist/ai-chat/HandoffRouter.d.ts","line":150}]},"HistoryMode":{"name":"HistoryMode","kind":"type","exported":true,"signature":["type HistoryMode = (typeof HISTORY_MODES)[number]"],"doc":"One of the three valid `history` visibility modes.","file":"dist/ContextBuilder.d.ts","line":20},"HoldEvent":{"name":"HoldEvent","kind":"class","exported":true,"signature":["class HoldEvent extends RelayEvent"],"doc":"`calling.call.hold` — hold/unhold state change on the call.","file":"dist/relay/RelayEvent.d.ts","line":215,"members":[{"name":"state","kind":"property","owner":"HoldEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":216},{"name":"constructor","kind":"constructor","owner":"HoldEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, state?: string)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":217},{"name":"fromPayload","kind":"method","owner":"HoldEvent","static":true,"signature":["static fromPayload(payload: EventPayload): HoldEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":218}],"bases":["RelayEvent"]},"HostAppRouter":{"name":"HostAppRouter","kind":"type","exported":true,"signature":["type HostAppRouter = Hono"],"doc":"A Hono app/router returned by `asRouter()`.\n\nBehaviourally identical to `Hono` (no added state or methods) — it exists to\nname the \"embed my routes in a host app\" return type as a stable cross-port\nsymbol. See the module docstring.","file":"dist/web.d.ts","line":27},"HttpClient":{"name":"HttpClient","kind":"class","exported":true,"signature":["class HttpClient"],"doc":"Low-level HTTP client used by every REST namespace resource.\n\nHandles Basic Auth, JSON encoding/decoding, error normalisation\n({@link RestError} on non-2xx), and the {@link RequestOptions} transport\nenvelope (timeout / retry / abort). Normally you do not instantiate this\ndirectly — construct a {@link RestClient} instead.","file":"dist/rest/HttpClient.d.ts","line":24,"members":[{"name":"baseUrl","kind":"property","owner":"HttpClient","readonly":true,"signature":["readonly baseUrl: string"],"doc":"Fully-qualified base URL (no trailing slash).","file":"dist/rest/HttpClient.d.ts","line":26},{"name":"constructor","kind":"constructor","owner":"HttpClient","signature":["constructor(options: HttpClientOptions)"],"doc":"Build a new HTTP client.\n\n@param options - Connection options. Either `host` (bare hostname;\n `https://` is prepended automatically) or `baseUrl` (fully-qualified)\n must be provided along with `project` + `token`. An optional\n `requestOptions` sets the client-default transport envelope.\n@throws {Error} When neither `host` nor `baseUrl` is supplied.","file":"dist/rest/HttpClient.d.ts","line":40},{"name":"get","kind":"method","owner":"HttpClient","signature":["get<T = unknown>(path: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<T>"],"doc":"Perform an authenticated HTTP GET and return the parsed JSON response.\n\n@typeParam T - Expected response body type.\n@param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.\n@param params - Optional query parameters; `undefined` values are skipped.\n@param requestOptions - Optional per-request transport envelope override.\n@returns The parsed JSON body, or `{}` on `204 No Content`.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/HttpClient.d.ts","line":63},{"name":"post","kind":"method","owner":"HttpClient","signature":["post<T = unknown>(path: string, body?: unknown, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<T>"],"doc":"Perform an authenticated HTTP POST and return the parsed JSON response.\n\n@typeParam T - Expected response body type.\n@param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.\n@param body - JSON-serialisable request body. Omit to send no body.\n@param params - Optional query parameters appended to the URL.\n@param requestOptions - Optional per-request transport envelope override.\n@returns The parsed JSON body, or `{}` on `204 No Content`.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/HttpClient.d.ts","line":75},{"name":"put","kind":"method","owner":"HttpClient","signature":["put<T = unknown>(path: string, body?: unknown, requestOptions?: RequestOptionsInit): Promise<T>"],"doc":"Perform an authenticated HTTP PUT and return the parsed JSON response.\n\n@typeParam T - Expected response body type.\n@param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.\n@param body - JSON-serialisable request body.\n@param requestOptions - Optional per-request transport envelope override.\n@returns The parsed JSON body, or `{}` on `204 No Content`.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/HttpClient.d.ts","line":86},{"name":"patch","kind":"method","owner":"HttpClient","signature":["patch<T = unknown>(path: string, body?: unknown, requestOptions?: RequestOptionsInit): Promise<T>"],"doc":"Perform an authenticated HTTP PATCH and return the parsed JSON response.\n\n@typeParam T - Expected response body type.\n@param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.\n@param body - JSON-serialisable partial request body.\n@param requestOptions - Optional per-request transport envelope override.\n@returns The parsed JSON body, or `{}` on `204 No Content`.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/HttpClient.d.ts","line":97},{"name":"delete","kind":"method","owner":"HttpClient","signature":["delete<T = unknown>(path: string, requestOptions?: RequestOptionsInit): Promise<T>"],"doc":"Perform an authenticated HTTP DELETE and return the parsed JSON response.\n\n@typeParam T - Expected response body type.\n@param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.\n@param requestOptions - Optional per-request transport envelope override.\n@returns The parsed JSON body, or `{}` on `204 No Content`.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/HttpClient.d.ts","line":107}]},"HttpClientOptions":{"name":"HttpClientOptions","kind":"interface","exported":true,"signature":["interface HttpClientOptions"],"doc":"Options for constructing an HttpClient.","file":"dist/rest/types.d.ts","line":23,"members":[{"name":"baseUrl","kind":"property","owner":"HttpClientOptions","signature":["baseUrl?: string"],"doc":"Base URL (e.g. \"https://example.signalwire.com\").\nEither `baseUrl` or `host` must be provided. If both are given, `host` takes precedence\n(matching the Python SDK convention where `host` is the canonical parameter).","file":"dist/rest/types.d.ts","line":29},{"name":"host","kind":"property","owner":"HttpClientOptions","signature":["host?: string"],"doc":"Bare hostname (e.g. \"example.signalwire.com\"). `https://` is prepended automatically,\nmatching the Python SDK's `HttpClient(project, token, host)` convention.","file":"dist/rest/types.d.ts","line":34},{"name":"project","kind":"property","owner":"HttpClientOptions","signature":["project: string"],"doc":"Project ID for Basic Auth username.","file":"dist/rest/types.d.ts","line":36},{"name":"token","kind":"property","owner":"HttpClientOptions","signature":["token: string"],"doc":"API token for Basic Auth password.","file":"dist/rest/types.d.ts","line":38},{"name":"fetchImpl","kind":"property","owner":"HttpClientOptions","signature":["fetchImpl?: typeof globalThis.fetch"],"doc":"Custom fetch implementation for testing.","file":"dist/rest/types.d.ts","line":40},{"name":"requestOptions","kind":"property","owner":"HttpClientOptions","signature":["requestOptions?: RequestOptionsInit"],"doc":"Client-default transport envelope (timeout / retries / abort) applied to\nevery request; a per-request `requestOptions` shallow-overrides it. See\n{@link RequestOptions}.","file":"dist/rest/types.d.ts","line":46}]},"ImportedNumbersResource":{"name":"ImportedNumbersResource","kind":"class","exported":true,"signature":["class ImportedNumbers extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":18,"members":[{"name":"constructor","kind":"constructor","owner":"ImportedNumbersResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":19},{"name":"create","kind":"method","owner":"ImportedNumbersResource","signature":["create(number: string, number_type: 'longcode' | 'tollfree', options?: {\n capabilities?: ('sms' | 'voice' | 'fax' | 'mms')[];\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":20}],"bases":["BaseResource"]},"InferredSchema":{"name":"InferredSchema","kind":"interface","exported":true,"signature":["interface InferredSchema"],"doc":"Result of schema inference from a function.","file":"dist/TypeInference.d.ts","line":49,"members":[{"name":"parameters","kind":"property","owner":"InferredSchema","signature":["parameters: Record<string, {\n type: string;\n description?: string;\n}>"],"doc":"JSON Schema properties keyed by parameter name.","file":"dist/TypeInference.d.ts","line":51},{"name":"required","kind":"property","owner":"InferredSchema","signature":["required: string[]"],"doc":"List of required parameter names (those without defaults).","file":"dist/TypeInference.d.ts","line":56},{"name":"paramNames","kind":"property","owner":"InferredSchema","signature":["paramNames: string[]"],"doc":"Ordered parameter names (excluding rawData).","file":"dist/TypeInference.d.ts","line":58},{"name":"hasRawData","kind":"property","owner":"InferredSchema","signature":["hasRawData: boolean"],"doc":"Whether the function accepts a rawData parameter.","file":"dist/TypeInference.d.ts","line":60}]},"InfoGathererAgent":{"name":"InfoGathererAgent","kind":"class","exported":true,"signature":["class InfoGathererAgent extends AgentBase"],"doc":"Prefab agent that gathers caller information one question at a time.\n\nSupports two modes:\n\n- **Static** — provide `questions` at construction; the same questions are\n asked on every call.\n- **Dynamic** — leave `questions` unset and register a callback via\n `questionCallback` (or `setQuestionCallback()`); the callback decides which\n questions to ask per incoming call based on query params, body, or headers.\n\n@example Static questions\n```ts\nimport { InfoGathererAgent } from '@signalwire/sdk';\n\nconst agent = new InfoGathererAgent({\n questions: [\n { key_name: 'name', question_text: 'What is your name?' },\n { key_name: 'email', question_text: 'What is your email address?', confirm: true },\n { key_name: 'issue', question_text: 'How can we help?' },\n ],\n});\n\nawait agent.serve({ port: 3000 });\n```\n\n@example Dynamic questions per request\n```ts\nimport { InfoGathererAgent } from '@signalwire/sdk';\n\nconst agent = new InfoGathererAgent({\n questionCallback: async (query) => {\n if (query.intake === 'medical') {\n return [\n { key_name: 'dob', question_text: 'Date of birth?' },\n { key_name: 'insurance_id', question_text: 'Insurance member ID?' },\n ];\n }\n return [{ key_name: 'message', question_text: 'How can I help?' }];\n },\n});\n```","file":"dist/prefabs/InfoGathererAgent.d.ts","line":95,"members":[{"name":"constructor","kind":"constructor","owner":"InfoGathererAgent","signature":["constructor(config?: InfoGathererConfig)"],"doc":"Create an InfoGathererAgent.\n@param config - Either `questions` (static mode) or leave omitted and use\n `questionCallback` / `setQuestionCallback()` (dynamic mode).","file":"dist/prefabs/InfoGathererAgent.d.ts","line":103},{"name":"setQuestionCallback","kind":"method","owner":"InfoGathererAgent","signature":["setQuestionCallback(callback: InfoGathererQuestionCallback): this"],"doc":"Register a callback for dynamic question configuration. The callback is\ninvoked on each incoming SWML request with the query params, body, and\nheaders, and must return the list of questions to ask on that call.\nMirrors Python `set_question_callback`.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":110},{"name":"onSwmlRequest","kind":"method","owner":"InfoGathererAgent","signature":["onSwmlRequest(rawData: SwmlRequestData, _callbackPath?: string, context?: Context): Promise<Record<string, unknown> | void>"],"doc":"Handle dynamic configuration using the registered callback. Returns the\nper-request global_data payload which AgentBase merges into the SWML\nresponse. Mirrors Python's `on_swml_request` return-dict contract.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":123},{"name":"defineTools","kind":"method","owner":"InfoGathererAgent","protected":true,"signature":["protected defineTools(): void"],"doc":"Register the `start_questions` and `submit_answer` SWAIG tools.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":125},{"name":"startQuestions","kind":"method","owner":"InfoGathererAgent","signature":["startQuestions(_args: Record<string, unknown>, rawData: Record<string, unknown>): FunctionResult"],"doc":"SWAIG handler for `start_questions`: emit the instruction for the first\nquestion from the per-call `global_data`. Mirrors Python\n`InfoGathererAgent.start_questions`.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":131},{"name":"submitAnswer","kind":"method","owner":"InfoGathererAgent","signature":["submitAnswer(args: Record<string, unknown>, rawData: Record<string, unknown>): FunctionResult"],"doc":"SWAIG handler for `submit_answer`: record the answer to the current question\nand advance to the next one. Mirrors Python\n`InfoGathererAgent.submit_answer`.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":137}],"bases":["AgentBase"]},"InfoGathererConfig":{"name":"InfoGathererConfig","kind":"interface","exported":true,"signature":["interface InfoGathererConfig"],"doc":"Configuration for the InfoGathererAgent.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":33,"members":[{"name":"questions","kind":"property","owner":"InfoGathererConfig","signature":["questions?: InfoGathererQuestion[]"],"doc":"Optional list of questions to ask. When omitted, the agent runs in\ndynamic mode and resolves questions via the callback registered with\n`setQuestionCallback()` (or via `questionCallback` below).","file":"dist/prefabs/InfoGathererAgent.d.ts","line":39},{"name":"questionCallback","kind":"property","owner":"InfoGathererConfig","signature":["questionCallback?: InfoGathererQuestionCallback"],"doc":"Convenience alternative to calling `setQuestionCallback()` after\nconstruction. Only consulted when `questions` is not provided.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":44},{"name":"name","kind":"property","owner":"InfoGathererConfig","signature":["name?: string"],"doc":"Agent display name (defaults to `\"info_gatherer\"`).","file":"dist/prefabs/InfoGathererAgent.d.ts","line":46},{"name":"route","kind":"property","owner":"InfoGathererConfig","signature":["route?: string"],"doc":"HTTP route for this agent (defaults to `\"/info_gatherer\"`).","file":"dist/prefabs/InfoGathererAgent.d.ts","line":48},{"name":"agentOptions","kind":"property","owner":"InfoGathererConfig","signature":["agentOptions?: Partial<AgentOptions>"],"doc":"Additional AgentBase options forwarded to super().","file":"dist/prefabs/InfoGathererAgent.d.ts","line":50}]},"InfoGathererQuestion":{"name":"InfoGathererQuestion","kind":"interface","exported":true,"signature":["interface InfoGathererQuestion"],"doc":"A single question in the information-gathering flow.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":15,"members":[{"name":"key_name","kind":"property","owner":"InfoGathererQuestion","signature":["key_name: string"],"doc":"Identifier used as the key when storing the caller's answer.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":17},{"name":"question_text","kind":"property","owner":"InfoGathererQuestion","signature":["question_text: string"],"doc":"The question text to ask the caller.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":19},{"name":"confirm","kind":"property","owner":"InfoGathererQuestion","signature":["confirm?: boolean"],"doc":"When true, the agent insists the caller confirms before submitting.","file":"dist/prefabs/InfoGathererAgent.d.ts","line":21}]},"InfoGathererQuestionCallback":{"name":"InfoGathererQuestionCallback","kind":"type","exported":true,"signature":["type InfoGathererQuestionCallback = (queryParams: Record<string, string>, bodyParams: SwmlRequestData, headers: Record<string, string>) => InfoGathererQuestion[] | Promise<InfoGathererQuestion[]>"],"doc":"Callback invoked on each incoming SWML request to produce the list of\nquestions for that request. Mirrors Python's `set_question_callback`.\n`queryParams` are the request URL's query parameters, `bodyParams` the\nparsed request body, and `headers` the HTTP request headers (lower-case\nnames, without Authorization, Cookie and other credential headers).\n@returns a list of questions (may be async).","file":"dist/prefabs/InfoGathererAgent.d.ts","line":31},"InfoGathererSkill":{"name":"InfoGathererSkill","kind":"class","exported":true,"signature":["class InfoGathererSkill extends SkillBase"],"doc":"Collects answers to a configurable list of questions, one at a time.\n\nMirrors Python `InfoGathererSkill` exactly: the same required\n`questions` config, the same `prefix` / `completion_message` options,\nthe same two tools (`start_questions`, `submit_answer`), and the same\nstate shape in `global_data`.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('info_gatherer', {\n questions: [\n { key_name: 'name', question_text: 'What is your name?' },\n { key_name: 'email', question_text: 'Your email?', confirm: true },\n ],\n});\n```","file":"dist/skills/builtin/info_gatherer.d.ts","line":34,"members":[{"name":"SKILL_NAME","kind":"property","owner":"InfoGathererSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/info_gatherer.d.ts","line":35},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"InfoGathererSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/info_gatherer.d.ts","line":36},{"name":"SKILL_VERSION","kind":"property","owner":"InfoGathererSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/info_gatherer.d.ts","line":37},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"InfoGathererSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/info_gatherer.d.ts","line":38},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"InfoGathererSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/info_gatherer.d.ts","line":39},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"InfoGathererSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/info_gatherer.d.ts","line":40},{"name":"getParameterSchema","kind":"method","owner":"InfoGathererSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/info_gatherer.d.ts","line":49},{"name":"getInstanceKey","kind":"method","owner":"InfoGathererSkill","signature":["getInstanceKey(): string"],"doc":"Instance key for the SkillManager. When `prefix` is configured, returns\n`info_gatherer_<prefix>` to support multi-instance use. Matches Python's\n`get_instance_key()` (skill.py:81-85).","file":"dist/skills/builtin/info_gatherer.d.ts","line":55},{"name":"setup","kind":"method","owner":"InfoGathererSkill","signature":["setup(): Promise<boolean>"],"doc":"Validate the `questions` config, derive tool names (with optional prefix),\nand cache the completion message.\n\nPython equivalent: skill.py:91-121. Returns `false` (logging an error) when\n`questions` is missing or fails validation; setup must produce a\nfunctional skill or fail closed.","file":"dist/skills/builtin/info_gatherer.d.ts","line":64},{"name":"getGlobalData","kind":"method","owner":"InfoGathererSkill","signature":["getGlobalData(): Record<string, unknown>"],"doc":"Seed SWAIG `global_data` with the initial question state under this\nskill's namespace. Mirrors Python `get_global_data()` (skill.py:127-135).\n\nDefensive no-op when the skill was not successfully set up (empty\n`questions`). Python relies on the SkillManager to skip unloaded skills;\nTS adds this guard so `getGlobalData()` called without a successful\n`setup()` returns `{}` instead of a malformed state payload.","file":"dist/skills/builtin/info_gatherer.d.ts","line":74},{"name":"getTools","kind":"method","owner":"InfoGathererSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"Register the two sequential-flow tools. Mirrors Python\n`register_tools()` (skill.py:162-184). Returns an empty array when\n`setup()` did not complete (no questions) so the skill never exposes\nhalf-initialized tools.","file":"dist/skills/builtin/info_gatherer.d.ts","line":81}],"bases":["SkillBase"]},"JokeSkill":{"name":"JokeSkill","kind":"class","exported":true,"signature":["class JokeSkill extends SkillBase"],"doc":"Tells random jokes from a curated built-in collection.\n\nTier 1 built-in skill with no external dependencies. The SWAIG tool\n*interface* matches the Python reference (`get_joke` tool, required `type`\nparameter with enum `jokes` / `dadjokes`); the implementation differs by\ndesign — Python calls the API-Ninjas joke API, this SDK serves from a\nbuilt-in offline collection (so it needs no API key). `dadjokes` returns a\ndad joke; `jokes` returns a general/programming joke.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('joke');\n```","file":"dist/skills/builtin/joke.d.ts","line":26,"members":[{"name":"SKILL_NAME","kind":"property","owner":"JokeSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/joke.d.ts","line":27},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"JokeSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/joke.d.ts","line":28},{"name":"SKILL_VERSION","kind":"property","owner":"JokeSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/joke.d.ts","line":29},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"JokeSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/joke.d.ts","line":30},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"JokeSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/joke.d.ts","line":31},{"name":"getParameterSchema","kind":"method","owner":"JokeSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/joke.d.ts","line":32},{"name":"getGlobalData","kind":"method","owner":"JokeSkill","signature":["getGlobalData(): Record<string, unknown>"],"doc":"Signal to the agent prompt that the joke skill is active. Matches the\nPython SDK: `get_global_data` returns `{\"joke_skill_enabled\": true}`.","file":"dist/skills/builtin/joke.d.ts","line":37},{"name":"getTools","kind":"method","owner":"JokeSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A single `get_joke` tool (configurable name). The interface\n matches Python (`joke/skill.py:68-77`): a required `type` parameter with\n enum `jokes` / `dadjokes`. Served from the offline collection.","file":"dist/skills/builtin/joke.d.ts","line":43}],"bases":["SkillBase"]},"LamlPaginatedResponse":{"name":"LamlPaginatedResponse","kind":"interface","exported":true,"signature":["interface LamlPaginatedResponse<_T = unknown>"],"doc":"LAML-style paginated response with next_page_uri. The resource array is\ncarried under a resource-named key (e.g. `calls`, `messages`), so the index\nsignature is open; callers read the known key. Values are `unknown` (the\ncaller narrows) rather than `any`.","file":"dist/rest/types.d.ts","line":64,"members":[{"name":"next_page_uri","kind":"property","owner":"LamlPaginatedResponse","signature":["next_page_uri?: string | null"],"doc":"","file":"dist/rest/types.d.ts","line":66},{"name":"uri","kind":"property","owner":"LamlPaginatedResponse","signature":["uri?: string"],"doc":"","file":"dist/rest/types.d.ts","line":67},{"name":"page","kind":"property","owner":"LamlPaginatedResponse","signature":["page?: number"],"doc":"","file":"dist/rest/types.d.ts","line":68},{"name":"page_size","kind":"property","owner":"LamlPaginatedResponse","signature":["page_size?: number"],"doc":"","file":"dist/rest/types.d.ts","line":69}]},"LanguageConfig":{"name":"LanguageConfig","kind":"interface","exported":true,"signature":["interface LanguageConfig"],"doc":"Configuration for a supported language in the AI agent.","file":"dist/types.d.ts","line":105,"members":[{"name":"name","kind":"property","owner":"LanguageConfig","signature":["name: string"],"doc":"Human-readable language name (e.g. \"English\").","file":"dist/types.d.ts","line":107},{"name":"code","kind":"property","owner":"LanguageConfig","signature":["code: string"],"doc":"BCP-47 language code (e.g. \"en-US\").","file":"dist/types.d.ts","line":109},{"name":"voice","kind":"property","owner":"LanguageConfig","signature":["voice?: string"],"doc":"Voice identifier to use for this language.","file":"dist/types.d.ts","line":111},{"name":"engine","kind":"property","owner":"LanguageConfig","signature":["engine?: string"],"doc":"TTS engine identifier.","file":"dist/types.d.ts","line":113},{"name":"model","kind":"property","owner":"LanguageConfig","signature":["model?: string"],"doc":"Explicit TTS model identifier (e.g. \"mistv2\", \"eleven_turbo_v2_5\").","file":"dist/types.d.ts","line":115},{"name":"speechFillers","kind":"property","owner":"LanguageConfig","signature":["speechFillers?: string[]"],"doc":"Phrases the AI can say to fill a pause in speech (`speech_fillers`).","file":"dist/types.d.ts","line":117},{"name":"functionFillers","kind":"property","owner":"LanguageConfig","signature":["functionFillers?: string[] | Record<string, Record<string, string[]>>"],"doc":"Phrases said while a function runs (`function_fillers`). The older form,\nkeyed by function name then language code, is flattened into one list;\nfor fillers per tool, use the tool's own `fillers` option.","file":"dist/types.d.ts","line":123},{"name":"fillers","kind":"property","owner":"LanguageConfig","signature":["fillers?: string[] | Record<string, string[]>"],"doc":"Filler phrases for both speech and functions, the schema's older `fillers`\nlist. The older form keyed by category is flattened into one list and\nsent as `speechFillers`.","file":"dist/types.d.ts","line":129},{"name":"speechModel","kind":"property","owner":"LanguageConfig","signature":["speechModel?: string"],"doc":"Speech recognition model identifier.","file":"dist/types.d.ts","line":131},{"name":"params","kind":"property","owner":"LanguageConfig","signature":["params?: Record<string, unknown>"],"doc":"Optional per-language params dict (engine-specific tuning, voice settings,\netc.). Emitted as the language object's `params` key in SWML — only\npresent in the wire payload when non-empty so existing entries remain\nbyte-identical when no params are passed.","file":"dist/types.d.ts","line":138}]},"LogLevel":{"name":"LogLevel","kind":"type","exported":true,"signature":["type LogLevel = keyof typeof LEVELS"],"doc":"Log severity level — the closed set this Logger emits and filters on.\n\n`'warn'` (not `'warning'`) matches the keys of {@link LEVELS} and the\n`Logger.warn()` method; the Python reference's logger has no `set_log_level`\ncounterpart (this setter is a documented TS addition — see\n`PORT_ADDITIONS.md`), so the canonical set is this port's own.","file":"dist/Logger.d.ts","line":23},"Logger":{"name":"Logger","kind":"class","exported":true,"signature":["class Logger"],"doc":"Structured logger that respects global level, format, and color settings.","file":"dist/Logger.d.ts","line":88,"members":[{"name":"constructor","kind":"constructor","owner":"Logger","signature":["constructor(name: string, context?: Record<string, unknown>)"],"doc":"Create a new Logger instance.\n@param name - Logger name shown in log output.\n@param context - Optional key-value pairs included in every log entry.","file":"dist/Logger.d.ts","line":96},{"name":"bind","kind":"method","owner":"Logger","signature":["bind(context: Record<string, unknown>): Logger"],"doc":"Create a child logger with additional bound context fields merged into the parent's context.\n@param context - Key-value pairs to merge into the child logger's context.\n@returns A new Logger instance with the merged context.","file":"dist/Logger.d.ts","line":102},{"name":"debug","kind":"method","owner":"Logger","signature":["debug(msg: string, data?: Record<string, unknown>): void"],"doc":"Log a message at the debug level.\n@param msg - The log message.\n@param data - Optional structured data to include.","file":"dist/Logger.d.ts","line":108},{"name":"info","kind":"method","owner":"Logger","signature":["info(msg: string, data?: Record<string, unknown>): void"],"doc":"Log a message at the info level.\n@param msg - The log message.\n@param data - Optional structured data to include.","file":"dist/Logger.d.ts","line":114},{"name":"warn","kind":"method","owner":"Logger","signature":["warn(msg: string, data?: Record<string, unknown>): void"],"doc":"Log a message at the warn level.\n@param msg - The log message.\n@param data - Optional structured data to include.","file":"dist/Logger.d.ts","line":120},{"name":"error","kind":"method","owner":"Logger","signature":["error(msg: string, data?: Record<string, unknown>): void"],"doc":"Log a message at the error level.\n@param msg - The log message.\n@param data - Optional structured data to include.","file":"dist/Logger.d.ts","line":126}]},"LogsNamespace":{"name":"LogsNamespace","kind":"class","exported":true,"signature":["class LogsNamespace"],"doc":"Generated `client.logs` namespace container.","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":42,"members":[{"name":"conferences","kind":"property","owner":"LogsNamespace","readonly":true,"signature":["readonly conferences: ConferenceLogs"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":43},{"name":"fax","kind":"property","owner":"LogsNamespace","readonly":true,"signature":["readonly fax: FaxLogs"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":44},{"name":"messages","kind":"property","owner":"LogsNamespace","readonly":true,"signature":["readonly messages: MessageLogs"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":45},{"name":"voice","kind":"property","owner":"LogsNamespace","readonly":true,"signature":["readonly voice: VoiceLogs"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":46},{"name":"constructor","kind":"constructor","owner":"LogsNamespace","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":47}]},"LookupResource":{"name":"LookupResource","kind":"class","exported":true,"signature":["class Lookup extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":25,"members":[{"name":"constructor","kind":"constructor","owner":"LookupResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":26},{"name":"phoneNumber","kind":"method","owner":"LookupResource","signature":["phoneNumber(e164_number: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<PhoneNumberLookupResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":27}],"bases":["BaseResource"]},"MAX_MESSAGE_BYTES":{"name":"MAX_MESSAGE_BYTES","kind":"variable","exported":true,"signature":["const MAX_MESSAGE_BYTES: number"],"doc":"Limit on one typed message, in UTF-8 bytes: a chat turn here, and the text\na `HandoffRouter`'s `/say` sends into a live call. 8 KiB is several pages,\nfar more than a visitor types into a widget, and every byte of it goes into\na billed turn.","file":"dist/ai-chat/ChatGateway.d.ts","line":108},"MAX_REQUEST_BODY_BYTES":{"name":"MAX_REQUEST_BODY_BYTES","kind":"variable","exported":true,"signature":["const MAX_REQUEST_BODY_BYTES: number"],"doc":"Limit on a whole request body, in bytes, checked before it's parsed. The\nlargest honest request is a chat turn with a full message and a full\nmetadata bag; JSON escaping can triple the size of non-ASCII text, and this\nleaves room for that.","file":"dist/ai-chat/ChatGateway.d.ts","line":115},"MAX_SKILL_INPUT_LENGTH":{"name":"MAX_SKILL_INPUT_LENGTH","kind":"variable","exported":true,"signature":["const MAX_SKILL_INPUT_LENGTH"],"doc":"Maximum allowed input length for skill handler arguments (characters).","file":"dist/SecurityUtils.d.ts","line":8},"MAX_USER_METADATA_BYTES":{"name":"MAX_USER_METADATA_BYTES","kind":"variable","exported":true,"signature":["const MAX_USER_METADATA_BYTES: number"],"doc":"Limit on the browser-supplied `user_meta_data`, serialized, in bytes. A\nwidget's real payload is one to two KB; without a limit a page could send\nunbounded bytes to a metered service with every turn.","file":"dist/ai-chat/ChatGateway.d.ts","line":101},"MESSAGE_STATE_DELIVERED":{"name":"MESSAGE_STATE_DELIVERED","kind":"variable","exported":true,"signature":["const MESSAGE_STATE_DELIVERED"],"doc":"","file":"dist/relay/constants.d.ts","line":62},"MESSAGE_STATE_FAILED":{"name":"MESSAGE_STATE_FAILED","kind":"variable","exported":true,"signature":["const MESSAGE_STATE_FAILED"],"doc":"","file":"dist/relay/constants.d.ts","line":64},"MESSAGE_STATE_INITIATED":{"name":"MESSAGE_STATE_INITIATED","kind":"variable","exported":true,"signature":["const MESSAGE_STATE_INITIATED"],"doc":"","file":"dist/relay/constants.d.ts","line":60},"MESSAGE_STATE_QUEUED":{"name":"MESSAGE_STATE_QUEUED","kind":"variable","exported":true,"signature":["const MESSAGE_STATE_QUEUED"],"doc":"","file":"dist/relay/constants.d.ts","line":59},"MESSAGE_STATE_RECEIVED":{"name":"MESSAGE_STATE_RECEIVED","kind":"variable","exported":true,"signature":["const MESSAGE_STATE_RECEIVED"],"doc":"","file":"dist/relay/constants.d.ts","line":65},"MESSAGE_STATE_SENT":{"name":"MESSAGE_STATE_SENT","kind":"variable","exported":true,"signature":["const MESSAGE_STATE_SENT"],"doc":"","file":"dist/relay/constants.d.ts","line":61},"MESSAGE_STATE_TERMINAL":{"name":"MESSAGE_STATE_TERMINAL","kind":"variable","exported":true,"signature":["const MESSAGE_STATE_TERMINAL: readonly [\"delivered\", \"undelivered\", \"failed\"]"],"doc":"The terminal {@link MessageState} values\n(`'delivered'`, `'undelivered'`, `'failed'`). Mirrors the runtime\n`MESSAGE_TERMINAL_STATES` in `relay/constants.ts`.","file":"dist/relay/closedSets.d.ts","line":81},"MESSAGE_STATE_UNDELIVERED":{"name":"MESSAGE_STATE_UNDELIVERED","kind":"variable","exported":true,"signature":["const MESSAGE_STATE_UNDELIVERED"],"doc":"","file":"dist/relay/constants.d.ts","line":63},"MathSkill":{"name":"MathSkill","kind":"class","exported":true,"signature":["class MathSkill extends SkillBase"],"doc":"Evaluates mathematical expressions safely using a sandboxed parser.\n\nTier 1 built-in skill with no external dependencies. Only allows digits,\nbasic arithmetic operators, parentheses, decimal points, and spaces.\n\nRegisters a single SWAIG tool: `calculate`.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('math');\n```","file":"dist/skills/builtin/math.d.ts","line":25,"members":[{"name":"SKILL_NAME","kind":"property","owner":"MathSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/math.d.ts","line":26},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"MathSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/math.d.ts","line":27},{"name":"SKILL_VERSION","kind":"property","owner":"MathSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/math.d.ts","line":28},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"MathSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/math.d.ts","line":29},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"MathSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/math.d.ts","line":30},{"name":"getParameterSchema","kind":"method","owner":"MathSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/math.d.ts","line":31},{"name":"getTools","kind":"method","owner":"MathSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A single `calculate` tool that evaluates a math expression string.","file":"dist/skills/builtin/math.d.ts","line":33}],"bases":["SkillBase"]},"McpGatewaySkill":{"name":"McpGatewaySkill","kind":"class","exported":true,"signature":["class McpGatewaySkill extends SkillBase"],"doc":"Bridge MCP (Model Context Protocol) servers with SWAIG functions.\n\nWhen configured, calls a gateway's `/services` endpoint to discover MCP\nservices, enumerates each service's tools, and registers them as SWAIG\ntools prefixed with `tool_prefix` (default `mcp_`). A hidden hangup hook\ntool cleans up MCP sessions when the call ends.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('mcp_gateway', {\n gateway_url: 'https://mcp-gateway.example.com',\n auth_token: process.env.MCP_GATEWAY_AUTH_TOKEN,\n tool_prefix: 'mcp_',\n});\n```","file":"dist/skills/builtin/mcp_gateway.d.ts","line":58,"members":[{"name":"SKILL_NAME","kind":"property","owner":"McpGatewaySkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/mcp_gateway.d.ts","line":59},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"McpGatewaySkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/mcp_gateway.d.ts","line":60},{"name":"SKILL_VERSION","kind":"property","owner":"McpGatewaySkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/mcp_gateway.d.ts","line":61},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"McpGatewaySkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/mcp_gateway.d.ts","line":62},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"McpGatewaySkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/mcp_gateway.d.ts","line":63},{"name":"getParameterSchema","kind":"method","owner":"McpGatewaySkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/mcp_gateway.d.ts","line":64},{"name":"setup","kind":"method","owner":"McpGatewaySkill","signature":["setup(): Promise<boolean>"],"doc":"","file":"dist/skills/builtin/mcp_gateway.d.ts","line":84},{"name":"getHints","kind":"method","owner":"McpGatewaySkill","signature":["getHints(): string[]"],"doc":"","file":"dist/skills/builtin/mcp_gateway.d.ts","line":85},{"name":"getGlobalData","kind":"method","owner":"McpGatewaySkill","signature":["getGlobalData(): Record<string, unknown>"],"doc":"","file":"dist/skills/builtin/mcp_gateway.d.ts","line":86},{"name":"getTools","kind":"method","owner":"McpGatewaySkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns Dynamically discovered MCP tools plus an internal hangup-cleanup\n tool. If discovery has not completed, returns a single fallback\n `mcp_invoke` tool that explains configuration is missing.","file":"dist/skills/builtin/mcp_gateway.d.ts","line":92}],"bases":["SkillBase"]},"Message":{"name":"Message","kind":"class","exported":true,"signature":["class Message"],"doc":"SMS/MMS message in the RELAY messaging namespace.\n\nOutbound messages progress through `queued` → `initiated` → `sent` → `delivered`\n(or `undelivered` / `failed`). Inbound messages arrive with state `received`.\nCall {@link Message.wait} to await a terminal state.\n\n@example Wait for delivery confirmation\n```ts\nimport { RelayClient } from '@signalwire/sdk';\nconst client = new RelayClient();\nconst msg = await client.sendMessage({\n toNumber: '+15551234567',\n fromNumber: '+15557654321',\n body: 'Your code is 4242',\n});\n\nconst final = await msg.wait(30); // seconds\nconsole.log('Final state:', final.params.message_state);\n```","file":"dist/relay/Message.d.ts","line":32,"members":[{"name":"messageId","kind":"property","owner":"Message","signature":["messageId: string"],"doc":"Unique message identifier assigned by the platform.","file":"dist/relay/Message.d.ts","line":34},{"name":"context","kind":"property","owner":"Message","signature":["context: string"],"doc":"RELAY context the message belongs to.","file":"dist/relay/Message.d.ts","line":36},{"name":"direction","kind":"property","owner":"Message","signature":["direction: string"],"doc":"`\"inbound\"` or `\"outbound\"`.","file":"dist/relay/Message.d.ts","line":38},{"name":"fromNumber","kind":"property","owner":"Message","signature":["fromNumber: string"],"doc":"Sender phone number in E.164 format.","file":"dist/relay/Message.d.ts","line":40},{"name":"toNumber","kind":"property","owner":"Message","signature":["toNumber: string"],"doc":"Destination phone number in E.164 format.","file":"dist/relay/Message.d.ts","line":42},{"name":"body","kind":"property","owner":"Message","signature":["body: string"],"doc":"Plain-text message body.","file":"dist/relay/Message.d.ts","line":44},{"name":"media","kind":"property","owner":"Message","signature":["media: string[]"],"doc":"Media URLs attached to the message (MMS).","file":"dist/relay/Message.d.ts","line":46},{"name":"segments","kind":"property","owner":"Message","signature":["segments: number"],"doc":"Number of segments the carrier split the message into.","file":"dist/relay/Message.d.ts","line":48},{"name":"state","kind":"property","owner":"Message","signature":["state: MessageState"],"doc":"Current message state. One of the {@link MessageState} values\n(`\"queued\"` | `\"initiated\"` | `\"sent\"` | `\"delivered\"` | `\"undelivered\"` |\n`\"failed\"` | `\"received\"`; closed literal union, autocompleted +\ntypo-checked). A raw wire value is cast to the closed type at the hydration\nboundary. Use {@link Message.isTerminal} to test for a final delivery\noutcome rather than comparing strings by hand.","file":"dist/relay/Message.d.ts","line":57},{"name":"reason","kind":"property","owner":"Message","signature":["reason: string"],"doc":"Failure / undelivery reason when `state` is non-successful.","file":"dist/relay/Message.d.ts","line":59},{"name":"tags","kind":"property","owner":"Message","signature":["tags: string[]"],"doc":"Opaque tags attached to the message.","file":"dist/relay/Message.d.ts","line":61},{"name":"constructor","kind":"constructor","owner":"Message","signature":["constructor(options?: {\n messageId?: string;\n context?: string;\n direction?: string;\n fromNumber?: string;\n toNumber?: string;\n body?: string;\n media?: string[];\n segments?: number;\n state?: MessageState;\n reason?: string;\n tags?: string[];\n})"],"doc":"","file":"dist/relay/Message.d.ts","line":65},{"name":"isDone","kind":"accessor","owner":"Message","signature":["get isDone(): boolean"],"doc":"True once the message has reached a terminal state.","file":"dist/relay/Message.d.ts","line":79},{"name":"isTerminal","kind":"accessor","owner":"Message","signature":["get isTerminal(): boolean"],"doc":"Whether this message's current {@link Message.state} is a terminal\ndelivery outcome (`delivered` | `undelivered` | `failed`).\n\nDistinct from {@link Message.isDone}: `isDone` reflects whether the\ninternal completion promise has settled (driven by event dispatch),\nwhereas `isTerminal` is a pure test of the state *value*\n({@link ../relay/closedSets.MessageState}) and is meaningful even on a\nfreshly-constructed inbound message.","file":"dist/relay/Message.d.ts","line":90},{"name":"result","kind":"accessor","owner":"Message","signature":["get result(): RelayEvent | null"],"doc":"Final event that terminated the message, or `null` if still in-flight.","file":"dist/relay/Message.d.ts","line":92},{"name":"on","kind":"method","owner":"Message","signature":["on(handler: EventHandler): void"],"doc":"Register an event listener for state changes on this message.\n\nThe handler fires every time the server emits a `messaging.state` event\nfor this message (multiple listeners are supported). Listener errors are\nlogged but do not disrupt dispatch.\n\n@param handler - Callback invoked for each state-change event.","file":"dist/relay/Message.d.ts","line":103},{"name":"wait","kind":"method","owner":"Message","signature":["wait(timeout?: number): Promise<RelayEvent>"],"doc":"Wait for the message to reach a terminal state (`delivered`, `failed`,\n`undelivered`, etc.).\n\n@param timeout - Maximum time to wait in **seconds** (matches the Python\n SDK convention — not milliseconds).\n@returns The final `messaging.state` {@link RelayEvent}.\n@throws {Error} When the optional timeout elapses before a terminal state.","file":"dist/relay/Message.d.ts","line":113},{"name":"toString","kind":"method","owner":"Message","signature":["toString(): string"],"doc":"Return a human-readable diagnostic string.\n\n@returns `Message(id=..., direction=..., state=..., from=..., to=...)` —\n handy for log output.","file":"dist/relay/Message.d.ts","line":123}]},"MessageHandler":{"name":"MessageHandler","kind":"type","exported":true,"signature":["type MessageHandler = (message: Message) => void | Promise<void>"],"doc":"Handler for inbound messages.","file":"dist/relay/types.d.ts","line":56},"MessageLogs":{"name":"MessageLogs","kind":"class","exported":true,"signature":["class MessageLogs extends ReadResource<LogListResponse, LogRetrieveResponse>"],"doc":"","file":"dist/rest/namespaces/message.resources.generated.d.ts","line":4,"members":[{"name":"constructor","kind":"constructor","owner":"MessageLogs","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/message.resources.generated.d.ts","line":5}],"bases":["ReadResource"]},"MessageReceiveEvent":{"name":"MessageReceiveEvent","kind":"class","exported":true,"signature":["class MessageReceiveEvent extends RelayEvent"],"doc":"`messaging.receive` — inbound SMS/MMS received on a subscribed context.","file":"dist/relay/RelayEvent.d.ts","line":236,"members":[{"name":"messageId","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly messageId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":237},{"name":"context","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly context: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":238},{"name":"direction","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly direction: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":239},{"name":"fromNumber","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly fromNumber: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":240},{"name":"toNumber","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly toNumber: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":241},{"name":"body","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly body: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":242},{"name":"media","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly media: string[]"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":243},{"name":"segments","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly segments: number"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":244},{"name":"messageState","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly messageState: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":245},{"name":"tags","kind":"property","owner":"MessageReceiveEvent","readonly":true,"signature":["readonly tags: string[]"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":246},{"name":"constructor","kind":"constructor","owner":"MessageReceiveEvent","signature":["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[])"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":247},{"name":"fromPayload","kind":"method","owner":"MessageReceiveEvent","static":true,"signature":["static fromPayload(payload: EventPayload): MessageReceiveEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":248}],"bases":["RelayEvent"]},"MessageState":{"name":"MessageState","kind":"type","exported":true,"signature":["type MessageState = 'queued' | 'initiated' | 'sent' | 'delivered' | 'undelivered' | 'failed' | 'received'"],"doc":"Message lifecycle state for {@link ../relay/Message.Message.state} and the\n`message_state` field of a `messaging.state` event\n({@link ../relay/RelayEvent.MessageStateEvent.messageState}). Outbound\nmessages walk `queued → initiated → sent → delivered` (or `undelivered` /\n`failed`); inbound messages arrive as `received`. The terminal set is\n`delivered | undelivered | failed` (see {@link isMessageStateTerminal} and\n`MESSAGE_TERMINAL_STATES`).\n\nNOTE: distinct from {@link CallState} and {@link DialState}.","file":"dist/relay/closedSets.d.ts","line":71},"MessageStateEvent":{"name":"MessageStateEvent","kind":"class","exported":true,"signature":["class MessageStateEvent extends RelayEvent"],"doc":"`messaging.state` — state change for an outbound message (queued → sent → delivered/failed).","file":"dist/relay/RelayEvent.d.ts","line":251,"members":[{"name":"messageId","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly messageId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":252},{"name":"context","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly context: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":253},{"name":"direction","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly direction: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":254},{"name":"fromNumber","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly fromNumber: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":255},{"name":"toNumber","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly toNumber: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":256},{"name":"body","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly body: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":257},{"name":"media","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly media: string[]"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":258},{"name":"segments","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly segments: number"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":259},{"name":"messageState","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly messageState: MessageState"],"doc":"Message lifecycle state — a {@link MessageState} (`queued` |\n`initiated` | `sent` | `delivered` | `undelivered` | `failed` | `received`;\nclosed literal union, autocompleted + typo-checked). Pass to\n{@link ../relay/closedSets.isMessageStateTerminal} to test for a final\ndelivery outcome. Distinct from a {@link CallState} /\n{@link DialState}.","file":"dist/relay/RelayEvent.d.ts","line":268},{"name":"reason","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly reason: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":269},{"name":"tags","kind":"property","owner":"MessageStateEvent","readonly":true,"signature":["readonly tags: string[]"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":270},{"name":"constructor","kind":"constructor","owner":"MessageStateEvent","signature":["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[])"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":271},{"name":"fromPayload","kind":"method","owner":"MessageStateEvent","static":true,"signature":["static fromPayload(payload: EventPayload): MessageStateEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":272}],"bases":["RelayEvent"]},"MfaResource":{"name":"MfaResource","kind":"class","exported":true,"signature":["class Mfa extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":29,"members":[{"name":"constructor","kind":"constructor","owner":"MfaResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":30},{"name":"sms","kind":"method","owner":"MfaResource","signature":["sms(to: string, options?: {\n from?: string;\n message?: string;\n token_length?: number;\n valid_for?: number;\n max_attempts?: number;\n allow_alphas?: boolean;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<MfaResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":31},{"name":"call","kind":"method","owner":"MfaResource","signature":["call(to: string, options?: {\n from?: string;\n message?: string;\n token_length?: number;\n valid_for?: number;\n max_attempts?: number;\n allow_alphas?: boolean;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<MfaResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":40},{"name":"verify","kind":"method","owner":"MfaResource","signature":["verify(mfa_request_id: string, token: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<MfaVerifyResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":49}],"bases":["BaseResource"]},"NativeVectorSearchSkill":{"name":"NativeVectorSearchSkill","kind":"class","exported":true,"signature":["class NativeVectorSearchSkill extends SkillBase"],"doc":"Document search using TF-IDF in-memory scoring or a remote search server.\n\nMulti-instance capable (distinguished by `tool_name` + `index_file`). The\nPython skill's local-index parameters (`index_file`, `build_index`,\n`backend` and the rest) are accepted but not used, except `index_file` in\nthe instance key.\n\n@example In-memory documents\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('native_vector_search', {\n tool_name: 'search_docs',\n documents: [\n { id: 'returns', text: 'Items can be returned within 30 days with a receipt.' },\n { id: 'hours', text: 'The store is open 9am to 6pm, Monday to Saturday.' },\n ],\n count: 3,\n});\n```","file":"dist/skills/builtin/native_vector_search.d.ts","line":71,"members":[{"name":"SKILL_NAME","kind":"property","owner":"NativeVectorSearchSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":72},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"NativeVectorSearchSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":73},{"name":"SKILL_VERSION","kind":"property","owner":"NativeVectorSearchSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":74},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"NativeVectorSearchSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":75},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"NativeVectorSearchSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":76},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"NativeVectorSearchSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":77},{"name":"getParameterSchema","kind":"method","owner":"NativeVectorSearchSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":78},{"name":"getInstanceKey","kind":"method","owner":"NativeVectorSearchSkill","signature":["getInstanceKey(): string"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":110},{"name":"setup","kind":"method","owner":"NativeVectorSearchSkill","signature":["setup(): Promise<boolean>"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":111},{"name":"getHints","kind":"method","owner":"NativeVectorSearchSkill","signature":["getHints(): string[]"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":112},{"name":"getGlobalData","kind":"method","owner":"NativeVectorSearchSkill","signature":["getGlobalData(): Record<string, unknown>"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":113},{"name":"cleanup","kind":"method","owner":"NativeVectorSearchSkill","signature":["cleanup(): Promise<void>"],"doc":"","file":"dist/skills/builtin/native_vector_search.d.ts","line":114},{"name":"getTools","kind":"method","owner":"NativeVectorSearchSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A single search tool using the configured `tool_name` (default `search_knowledge`).","file":"dist/skills/builtin/native_vector_search.d.ts","line":121}],"bases":["SkillBase"]},"NonceEntry":{"name":"NonceEntry","kind":"class","exported":true,"signature":["class NonceEntry"],"doc":"What a registered nonce gives access to.","file":"dist/ai-chat/HandoffRouter.d.ts","line":73,"members":[{"name":"conversationId","kind":"property","owner":"NonceEntry","signature":["conversationId: string"],"doc":"The conversation the call belongs to.","file":"dist/ai-chat/HandoffRouter.d.ts","line":75},{"name":"callId","kind":"property","owner":"NonceEntry","signature":["callId: string | null"],"doc":"The platform call id, from the request the platform sent.","file":"dist/ai-chat/HandoffRouter.d.ts","line":77},{"name":"issuedAt","kind":"property","owner":"NonceEntry","signature":["issuedAt: number"],"doc":"When it was registered, in monotonic seconds.","file":"dist/ai-chat/HandoffRouter.d.ts","line":79},{"name":"messages","kind":"property","owner":"NonceEntry","signature":["messages: number"],"doc":"Typed messages delivered so far.","file":"dist/ai-chat/HandoffRouter.d.ts","line":81},{"name":"redeemed","kind":"property","owner":"NonceEntry","signature":["redeemed: boolean"],"doc":"True once `/handoff` has used the nonce. The entry stays in the table\nuntil it would have expired, so registering the nonce again can't make\nit usable again.","file":"dist/ai-chat/HandoffRouter.d.ts","line":87},{"name":"constructor","kind":"constructor","owner":"NonceEntry","signature":["constructor(conversationId: string, callId?: string | null, issuedAt?: number, messages?: number, redeemed?: boolean)"],"doc":"@param conversationId - The conversation the call belongs to.\n@param callId - The platform call id.\n@param issuedAt - When it was registered, in monotonic seconds; now by default.\n@param messages - Typed messages delivered so far.\n@param redeemed - Whether `/handoff` has used the nonce.","file":"dist/ai-chat/HandoffRouter.d.ts","line":95}]},"NormalizedPostPrompt":{"name":"NormalizedPostPrompt","kind":"class","exported":true,"signature":["class NormalizedPostPrompt"],"doc":"One finished conversation leg, in a shape that doesn't vary by engine.","file":"dist/PostPrompt.d.ts","line":36,"members":[{"name":"medium","kind":"property","owner":"NormalizedPostPrompt","readonly":true,"signature":["readonly medium: string"],"doc":"`conversation_type` as reported, e.g. `voice` or `chat`; '' when the engine didn't say.","file":"dist/PostPrompt.d.ts","line":38},{"name":"conversationId","kind":"property","owner":"NormalizedPostPrompt","readonly":true,"signature":["readonly conversationId: string | null"],"doc":"Present on chat, absent on voice; null when the engine didn't supply one.\nCallers that need a stable key should fall back to their own (global\ndata, the call id) rather than treat this as authoritative.","file":"dist/PostPrompt.d.ts","line":44},{"name":"summary","kind":"property","owner":"NormalizedPostPrompt","readonly":true,"signature":["readonly summary: Record<string, unknown>"],"doc":"The parsed `post_prompt_data`, with whatever keys the post-prompt asked\nfor; `{}` when there was none or it couldn't be parsed. A model that\nanswered in prose instead of JSON yields `{ summary: '<the prose>' }`.","file":"dist/PostPrompt.d.ts","line":50},{"name":"dialogue","kind":"property","owner":"NormalizedPostPrompt","readonly":true,"signature":["readonly dialogue: readonly DialogueTurn[]"],"doc":"User and assistant turns only, with tool calls and the chat engine's summary echo removed.","file":"dist/PostPrompt.d.ts","line":52},{"name":"callId","kind":"property","owner":"NormalizedPostPrompt","readonly":true,"signature":["readonly callId: string | null"],"doc":"The platform call id, when present.","file":"dist/PostPrompt.d.ts","line":54},{"name":"raw","kind":"property","owner":"NormalizedPostPrompt","readonly":true,"signature":["readonly raw: Record<string, unknown>"],"doc":"The complete request body, untouched.","file":"dist/PostPrompt.d.ts","line":56},{"name":"constructor","kind":"constructor","owner":"NormalizedPostPrompt","signature":["constructor(fields?: Partial<NormalizedPostPrompt>)"],"doc":"@param fields - Field values; any left out take the empty defaults above.\n {@link normalizePostPrompt} is the usual way to get one.","file":"dist/PostPrompt.d.ts","line":61}]},"NumberGroupsResource":{"name":"NumberGroupsResource","kind":"class","exported":true,"signature":["class NumberGroups extends CrudResource<NumberGroupListResponse, NumberGroupResponse, CreateNumberGroupRequest, UpdateNumberGroupRequest>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":53,"members":[{"name":"constructor","kind":"constructor","owner":"NumberGroupsResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":55},{"name":"create","kind":"method","owner":"NumberGroupsResource","signature":["create(body: CreateNumberGroupRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<NumberGroupResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":57},{"name":"update","kind":"method","owner":"NumberGroupsResource","signature":["update(id: string, body: UpdateNumberGroupRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<NumberGroupResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":59},{"name":"listMemberships","kind":"method","owner":"NumberGroupsResource","signature":["listMemberships(number_group_id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<NumberGroupMembershipListResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":60},{"name":"addMembership","kind":"method","owner":"NumberGroupsResource","signature":["addMembership(number_group_id: string, phone_number_id: uuid, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<NumberGroupMembershipResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":61},{"name":"getMembership","kind":"method","owner":"NumberGroupsResource","signature":["getMembership(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<NumberGroupMembershipResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":64},{"name":"deleteMembership","kind":"method","owner":"NumberGroupsResource","signature":["deleteMembership(id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":65}],"bases":["CrudResource"]},"OnRequestCallback":{"name":"OnRequestCallback","kind":"type","exported":true,"signature":["type OnRequestCallback = (queryParams: Record<string, string>, bodyParams: SwmlRequestData, headers: Record<string, string>) => SwmlBuilder | Promise<SwmlBuilder>"],"doc":"Callback invoked per-request to dynamically build SWML.","file":"dist/SWMLService.d.ts","line":134},"PaginatedResponse":{"name":"PaginatedResponse","kind":"interface","exported":true,"signature":["interface PaginatedResponse<T>"],"doc":"Standard paginated response with links-based navigation (relay REST).","file":"dist/rest/types.d.ts","line":49,"members":[{"name":"data","kind":"property","owner":"PaginatedResponse","signature":["data: T[]"],"doc":"","file":"dist/rest/types.d.ts","line":50},{"name":"links","kind":"property","owner":"PaginatedResponse","signature":["links?: {\n first?: string;\n self?: string;\n next?: string;\n last?: string;\n}"],"doc":"","file":"dist/rest/types.d.ts","line":51}]},"ParameterProperty":{"name":"ParameterProperty","kind":"interface","exported":true,"signature":["interface ParameterProperty"],"doc":"A single JSON-Schema property entry inside a tool's `parameters.properties`.\nMirrors the shape the model reads on every turn: `type` + LLM-facing\n`description`, with an optional `enum` / `items` and any extra JSON-Schema\nkeywords (`minLength`, `pattern`, `format`, …) merged through verbatim.","file":"dist/ParameterSchema.d.ts","line":109,"members":[{"name":"type","kind":"property","owner":"ParameterProperty","signature":["type: ParameterType"],"doc":"","file":"dist/ParameterSchema.d.ts","line":110},{"name":"description","kind":"property","owner":"ParameterProperty","signature":["description: string"],"doc":"","file":"dist/ParameterSchema.d.ts","line":111},{"name":"enum","kind":"property","owner":"ParameterProperty","signature":["enum?: readonly unknown[]"],"doc":"","file":"dist/ParameterSchema.d.ts","line":112},{"name":"items","kind":"property","owner":"ParameterProperty","signature":["items?: Record<string, unknown>"],"doc":"","file":"dist/ParameterSchema.d.ts","line":113}]},"ParameterSchema":{"name":"ParameterSchema","kind":"class","exported":true,"signature":["class ParameterSchema"],"doc":"Fluent builder producing a {@link ParameterSchemaObject} byte-identical to\nthe equivalent hand-written `parameters` blob. Every method returns `this`\nfor chaining; call {@link build} to obtain the plain object to hand to\n`defineTool`/`defineTypedTool`.\n\nInsertion order is preserved: properties appear in the order their methods\nwere called (matching a hand-written object literal), and `required` lists\nnames in the order {@link required} received them.","file":"dist/ParameterSchema.d.ts","line":202,"members":[{"name":"property","kind":"method","owner":"ParameterSchema","signature":["property(name: string, type: ParameterType, description?: string, extra?: Record<string, unknown>): this"],"doc":"Add a property with an explicit JSON-Schema `type`.\n\n@param name - Parameter name (the JSON key the model emits).\n@param type - JSON-Schema scalar type keyword.\n@param description - LLM-facing description (prompt engineering; tells the\n model HOW to fill this argument). Defaults to `''` to match a\n hand-written entry that omits a description.\n@param extra - Additional JSON-Schema keywords merged into the property\n verbatim (`enum`, `minLength`, `pattern`, `format`, `items`, …).\n@returns This builder, for chaining.","file":"dist/ParameterSchema.d.ts","line":217},{"name":"string","kind":"method","owner":"ParameterSchema","signature":["string(name: string, description?: string, extra?: Record<string, unknown>): this"],"doc":"Add a `string` property. @see {@link property}","file":"dist/ParameterSchema.d.ts","line":219},{"name":"integer","kind":"method","owner":"ParameterSchema","signature":["integer(name: string, description?: string, extra?: Record<string, unknown>): this"],"doc":"Add an `integer` property. @see {@link property}","file":"dist/ParameterSchema.d.ts","line":221},{"name":"number","kind":"method","owner":"ParameterSchema","signature":["number(name: string, description?: string, extra?: Record<string, unknown>): this"],"doc":"Add a `number` (float) property. @see {@link property}","file":"dist/ParameterSchema.d.ts","line":223},{"name":"boolean","kind":"method","owner":"ParameterSchema","signature":["boolean(name: string, description?: string, extra?: Record<string, unknown>): this"],"doc":"Add a `boolean` property. @see {@link property}","file":"dist/ParameterSchema.d.ts","line":225},{"name":"array","kind":"method","owner":"ParameterSchema","signature":["array(name: string, items?: Record<string, unknown>, description?: string): this"],"doc":"Add an `array` property.\n\n@param name - Parameter name.\n@param items - JSON-Schema for the array's element type (e.g.\n `{ type: 'string' }`). Omit for an untyped array.\n@param description - LLM-facing description.\n@returns This builder, for chaining.","file":"dist/ParameterSchema.d.ts","line":235},{"name":"enum","kind":"method","owner":"ParameterSchema","signature":["enum(name: string, values: readonly unknown[], description?: string, type?: ParameterType): this"],"doc":"Add a `string` property constrained to a closed set of values, rendered as\n`enum:[...]` — the JSON-Schema form the model and the SignalWire validator\nboth honour. This is the typed-closed-set affordance: pass one of the\nexported Tier-1 value arrays ({@link RECORD_FORMATS} etc.) or any literal\nlist, and the values land verbatim in `enum`.\n\n@param name - Parameter name.\n@param values - The allowed values (a `readonly` array — the `as const`\n Tier-1 arrays are accepted directly). Emitted as `enum`, in order.\n@param description - LLM-facing description.\n@param type - The JSON-Schema base type for the enum (default `'string'`).\n@returns This builder, for chaining.","file":"dist/ParameterSchema.d.ts","line":250},{"name":"recordFormat","kind":"method","owner":"ParameterSchema","signature":["recordFormat(name: string, description?: string): this"],"doc":"Add a `record_call` **format** property (`enum: ['wav','mp3','mp4']`) — the\nTier-1 closed set baked in. @see {@link RECORD_FORMATS}","file":"dist/ParameterSchema.d.ts","line":255},{"name":"recordDirection","kind":"method","owner":"ParameterSchema","signature":["recordDirection(name: string, description?: string): this"],"doc":"Add a `record_call` **direction** property\n(`enum: ['speak','listen','both']`). Uses record's `listen` (not tap's\n`hear`). @see {@link RECORD_DIRECTIONS}","file":"dist/ParameterSchema.d.ts","line":261},{"name":"tapDirection","kind":"method","owner":"ParameterSchema","signature":["tapDirection(name: string, description?: string): this"],"doc":"Add a `tap` **direction** property (`enum: ['speak','hear','both']`). Uses\ntap's `hear` (not record's `listen`). @see {@link TAP_DIRECTIONS}","file":"dist/ParameterSchema.d.ts","line":266},{"name":"codec","kind":"method","owner":"ParameterSchema","signature":["codec(name: string, description?: string): this"],"doc":"Add a `tap` **codec** property (`enum: ['PCMU','PCMA']`) — the 2-value\nSWAIG tap codec (NOT the 7-value RELAY superset). @see {@link TAP_CODECS}","file":"dist/ParameterSchema.d.ts","line":271},{"name":"required","kind":"method","owner":"ParameterSchema","signature":["required(...names: string[]): this"],"doc":"Mark one or more already-added properties as required. Names are appended\nto the `required` array in the order received; duplicates are ignored.\nRequired-ness is independent of property order — call this at any point.\n\n@param names - Parameter names to require.\n@returns This builder, for chaining.","file":"dist/ParameterSchema.d.ts","line":280},{"name":"build","kind":"method","owner":"ParameterSchema","signature":["build(): ParameterSchemaObject"],"doc":"Materialise the JSON-Schema `object`. Produces\n`{ type: 'object', properties: {…} }`, plus `required: [...]` only when at\nleast one property was marked required — exactly matching a hand-written\nblob (an omitted `required` is the same as `defineTool` receiving none).\n\n@returns A fresh {@link ParameterSchemaObject}; safe to mutate without\n affecting the builder.","file":"dist/ParameterSchema.d.ts","line":290}]},"ParameterSchemaEntry":{"name":"ParameterSchemaEntry","kind":"interface","exported":true,"signature":["interface ParameterSchemaEntry"],"doc":"Schema entry describing a single skill configuration parameter.","file":"dist/skills/SkillBase.d.ts","line":116,"members":[{"name":"type","kind":"property","owner":"ParameterSchemaEntry","signature":["type: 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array'"],"doc":"JSON Schema type of the parameter value.","file":"dist/skills/SkillBase.d.ts","line":118},{"name":"description","kind":"property","owner":"ParameterSchemaEntry","signature":["description: string"],"doc":"Human-readable description of the parameter.","file":"dist/skills/SkillBase.d.ts","line":120},{"name":"default","kind":"property","owner":"ParameterSchemaEntry","signature":["default?: unknown"],"doc":"Default value used when the parameter is not provided.","file":"dist/skills/SkillBase.d.ts","line":122},{"name":"required","kind":"property","owner":"ParameterSchemaEntry","signature":["required?: boolean"],"doc":"Whether the parameter must be supplied.","file":"dist/skills/SkillBase.d.ts","line":124},{"name":"hidden","kind":"property","owner":"ParameterSchemaEntry","signature":["hidden?: boolean"],"doc":"Whether the parameter should be hidden from user-facing output (e.g., API keys).","file":"dist/skills/SkillBase.d.ts","line":126},{"name":"env_var","kind":"property","owner":"ParameterSchemaEntry","signature":["env_var?: string"],"doc":"Environment variable a configuration tool can read this value from. A hint only: the SDK doesn't read it, so the skill gets the value from its params.","file":"dist/skills/SkillBase.d.ts","line":128},{"name":"enum","kind":"property","owner":"ParameterSchemaEntry","signature":["enum?: unknown[]"],"doc":"Allowed values for the parameter.","file":"dist/skills/SkillBase.d.ts","line":130},{"name":"min","kind":"property","owner":"ParameterSchemaEntry","signature":["min?: number"],"doc":"Minimum value (for numeric types).","file":"dist/skills/SkillBase.d.ts","line":132},{"name":"max","kind":"property","owner":"ParameterSchemaEntry","signature":["max?: number"],"doc":"Maximum value (for numeric types).","file":"dist/skills/SkillBase.d.ts","line":134},{"name":"items","kind":"property","owner":"ParameterSchemaEntry","signature":["items?: Record<string, unknown>"],"doc":"Item schema for array-type parameters.","file":"dist/skills/SkillBase.d.ts","line":136}]},"ParameterSchemaObject":{"name":"ParameterSchemaObject","kind":"interface","exported":true,"signature":["interface ParameterSchemaObject"],"doc":"The serialised SWAIG parameter schema: a JSON-Schema `object`. This is the\nexact shape `defineTool({ parameters })` accepts and what the SDK renders\ninto the OpenAI tool schema's `parameters` field.","file":"dist/ParameterSchema.d.ts","line":121,"members":[{"name":"type","kind":"property","owner":"ParameterSchemaObject","signature":["type: 'object'"],"doc":"","file":"dist/ParameterSchema.d.ts","line":122},{"name":"properties","kind":"property","owner":"ParameterSchemaObject","signature":["properties: Record<string, ParameterProperty>"],"doc":"","file":"dist/ParameterSchema.d.ts","line":123},{"name":"required","kind":"property","owner":"ParameterSchemaObject","signature":["required?: string[]"],"doc":"","file":"dist/ParameterSchema.d.ts","line":124}]},"ParameterType":{"name":"ParameterType","kind":"type","exported":true,"signature":["type ParameterType = 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object'"],"doc":"The JSON-Schema scalar `type` keywords a SWAIG parameter property may use.","file":"dist/ParameterSchema.d.ts","line":102},"ParsedParam":{"name":"ParsedParam","kind":"interface","exported":true,"signature":["interface ParsedParam"],"doc":"A parsed function parameter with optional default value.","file":"dist/TypeInference.d.ts","line":44,"members":[{"name":"name","kind":"property","owner":"ParsedParam","signature":["name: string"],"doc":"","file":"dist/TypeInference.d.ts","line":45},{"name":"defaultValue","kind":"property","owner":"ParsedParam","signature":["defaultValue?: string"],"doc":"","file":"dist/TypeInference.d.ts","line":46}]},"PayAction":{"name":"PayAction","kind":"class","exported":true,"signature":["class PayAction extends Action"],"doc":"Async handle for a `calling.call.pay` action (PCI-compliant payment collection).","file":"dist/relay/Action.d.ts","line":250,"members":[{"name":"constructor","kind":"constructor","owner":"PayAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":251},{"name":"stop","kind":"method","owner":"PayAction","signature":["stop(): Promise<CallingPayStopResult>"],"doc":"Cancel the payment collection before it completes.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":258}],"bases":["Action"]},"PayEvent":{"name":"PayEvent","kind":"class","exported":true,"signature":["class PayEvent extends RelayEvent"],"doc":"`calling.call.pay` — PCI-compliant payment collection progress update.","file":"dist/relay/RelayEvent.d.ts","line":180,"members":[{"name":"controlId","kind":"property","owner":"PayEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":181},{"name":"state","kind":"property","owner":"PayEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":182},{"name":"constructor","kind":"constructor","owner":"PayEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":183},{"name":"fromPayload","kind":"method","owner":"PayEvent","static":true,"signature":["static fromPayload(payload: EventPayload): PayEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":184}],"bases":["RelayEvent"]},"PaymentAction":{"name":"PaymentAction","kind":"interface","exported":true,"signature":["interface PaymentAction"],"doc":"A single action within a payment prompt: a phrase to say or a file to play.","file":"dist/FunctionResult.d.ts","line":50,"members":[{"name":"type","kind":"property","owner":"PaymentAction","signature":["type: string"],"doc":"The action type: \"Say\" or \"Play\" (the SWML `pay` schema's values).","file":"dist/FunctionResult.d.ts","line":52},{"name":"phrase","kind":"property","owner":"PaymentAction","signature":["phrase: string"],"doc":"The text to say, or for \"Play\" the URL of the audio file.","file":"dist/FunctionResult.d.ts","line":54}]},"PaymentParameter":{"name":"PaymentParameter","kind":"interface","exported":true,"signature":["interface PaymentParameter"],"doc":"A custom key-value parameter passed to the payment connector.","file":"dist/FunctionResult.d.ts","line":57,"members":[{"name":"name","kind":"property","owner":"PaymentParameter","signature":["name: string"],"doc":"The parameter name.","file":"dist/FunctionResult.d.ts","line":59},{"name":"value","kind":"property","owner":"PaymentParameter","signature":["value: string"],"doc":"The parameter value.","file":"dist/FunctionResult.d.ts","line":61}]},"PaymentPrompt":{"name":"PaymentPrompt","kind":"interface","exported":true,"signature":["interface PaymentPrompt"],"doc":"Prompt configuration for a payment collection flow.","file":"dist/FunctionResult.d.ts","line":39,"members":[{"name":"for","kind":"property","owner":"PaymentPrompt","signature":["for: string"],"doc":"The payment step this prompt applies to (for example \"payment-card-number\").","file":"dist/FunctionResult.d.ts","line":41},{"name":"actions","kind":"property","owner":"PaymentPrompt","signature":["actions: PaymentAction[]"],"doc":"Actions to perform for this prompt.","file":"dist/FunctionResult.d.ts","line":43},{"name":"card_type","kind":"property","owner":"PaymentPrompt","signature":["card_type?: string"],"doc":"Optional card type filter for this prompt.","file":"dist/FunctionResult.d.ts","line":45},{"name":"error_type","kind":"property","owner":"PaymentPrompt","signature":["error_type?: string"],"doc":"Optional error type this prompt handles.","file":"dist/FunctionResult.d.ts","line":47}]},"PhoneCallHandler":{"name":"PhoneCallHandler","kind":"type","exported":true,"signature":["const PhoneCallHandler: {\n readonly RELAY_SCRIPT: \"relay_script\";\n readonly LAML_WEBHOOKS: \"laml_webhooks\";\n readonly LAML_APPLICATION: \"laml_application\";\n readonly AI_AGENT: \"ai_agent\";\n readonly CALL_FLOW: \"call_flow\";\n readonly RELAY_APPLICATION: \"relay_application\";\n readonly RELAY_TOPIC: \"relay_topic\";\n readonly RELAY_CONTEXT: \"relay_context\";\n readonly RELAY_CONNECTOR: \"relay_connector\";\n readonly VIDEO_ROOM: \"video_room\";\n readonly DIALOGFLOW: \"dialogflow\";\n}","type PhoneCallHandler = (typeof PhoneCallHandler)[keyof typeof PhoneCallHandler]"],"doc":"PhoneCallHandler — enum of `call_handler` values accepted by\n{@link PhoneNumbersResource.update}.\n\nNamed `PhoneCallHandler` (not `CallHandler`) to avoid colliding with the\nRELAY client's inbound-call-handler callback type already exported from\n`src/relay/types.ts`.\n\nSetting a phone number's `call_handler` + the handler-specific companion\nfield routes inbound calls and auto-materializes the matching Fabric\nresource on the server. See the high-level helpers on\n{@link PhoneNumbersResource} (`setSwmlWebhook`, `setCxmlWebhook`,\n`setCxmlApplication`, `setAiAgent`, `setCallFlow`, `setRelayApplication`,\n`setRelayTopic`).\n\n| Member | Wire value | Companion field | Auto-creates Fabric resource |\n|---|---|---|---|\n| `RELAY_SCRIPT` | `relay_script` | `call_relay_script_url` | `swml_webhook` |\n| `LAML_WEBHOOKS` | `laml_webhooks` | `call_request_url` | `cxml_webhook` |\n| `LAML_APPLICATION` | `laml_application` | `call_laml_application_id` | `cxml_application` |\n| `AI_AGENT` | `ai_agent` | `call_ai_agent_id` | `ai_agent` |\n| `CALL_FLOW` | `call_flow` | `call_flow_id` | `call_flow` |\n| `RELAY_APPLICATION` | `relay_application` | `call_relay_application` | `relay_application` |\n| `RELAY_TOPIC` | `relay_topic` | `call_relay_topic` | *(routes via RELAY)* |\n| `RELAY_CONTEXT` | `relay_context` | `call_relay_context` | *(legacy, prefer topic)* |\n| `RELAY_CONNECTOR` | `relay_connector` | *(connector config)* | *(internal)* |\n| `VIDEO_ROOM` | `video_room` | `call_video_room_id` | *(routes to Video API)* |\n| `DIALOGFLOW` | `dialogflow` | `call_dialogflow_agent_id` | *(none)* |\n\nNote: `LAML_WEBHOOKS` (wire value `laml_webhooks`) produces a **cXML**\nhandler, not a generic webhook. For SWML, use `RELAY_SCRIPT`.\n\n@example\n```ts\nimport { PhoneCallHandler, RestClient } from '@signalwire/sdk';\n\nconst client = new RestClient();\nconst pnSid = 'pn-uuid';\n\nawait client.phoneNumbers.update(pnSid, {\n call_handler: PhoneCallHandler.RELAY_SCRIPT,\n call_relay_script_url: 'https://example.com/swml',\n});\n\n// Or use the typed helper:\nawait client.phoneNumbers.setSwmlWebhook(pnSid, 'https://example.com/swml');\n```","file":"dist/rest/callHandler.d.ts","line":49},"PhoneDevice":{"name":"PhoneDevice","kind":"interface","exported":true,"signature":["interface PhoneDevice"],"doc":"Phone device specification for dial/connect.","file":"dist/relay/types.d.ts","line":62,"members":[{"name":"type","kind":"property","owner":"PhoneDevice","signature":["type: 'phone'"],"doc":"","file":"dist/relay/types.d.ts","line":63},{"name":"to","kind":"property","owner":"PhoneDevice","signature":["to: string"],"doc":"","file":"dist/relay/types.d.ts","line":64},{"name":"from","kind":"property","owner":"PhoneDevice","signature":["from: string"],"doc":"","file":"dist/relay/types.d.ts","line":65},{"name":"timeout","kind":"property","owner":"PhoneDevice","signature":["timeout?: number"],"doc":"","file":"dist/relay/types.d.ts","line":66},{"name":"max_duration","kind":"property","owner":"PhoneDevice","signature":["max_duration?: number"],"doc":"","file":"dist/relay/types.d.ts","line":67},{"name":"codecs","kind":"property","owner":"PhoneDevice","signature":["codecs?: string[]"],"doc":"","file":"dist/relay/types.d.ts","line":68},{"name":"headers","kind":"property","owner":"PhoneDevice","signature":["headers?: Record<string, string>[]"],"doc":"","file":"dist/relay/types.d.ts","line":69}]},"PhoneNumbersResource":{"name":"PhoneNumbersResource","kind":"class","exported":true,"signature":["class PhoneNumbers extends CrudResource<PhoneNumberListResponse, PhoneNumberResponse, PurchasePhoneNumberRequest, UpdatePhoneNumberRequest>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":67,"members":[{"name":"constructor","kind":"constructor","owner":"PhoneNumbersResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":69},{"name":"create","kind":"method","owner":"PhoneNumbersResource","signature":["create(body: PurchasePhoneNumberRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":71},{"name":"update","kind":"method","owner":"PhoneNumbersResource","signature":["update(id: string, body: UpdatePhoneNumberRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":73},{"name":"search","kind":"method","owner":"PhoneNumbersResource","signature":["search(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<AvailablePhoneNumbersResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":74},{"name":"setSwmlWebhook","kind":"method","owner":"PhoneNumbersResource","signature":["setSwmlWebhook(resourceId: string, url: string, extra?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":75},{"name":"setCxmlWebhook","kind":"method","owner":"PhoneNumbersResource","signature":["setCxmlWebhook(resourceId: string, url: string, fallback_url?: string, status_callback_url?: string, extra?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":76},{"name":"setCxmlApplication","kind":"method","owner":"PhoneNumbersResource","signature":["setCxmlApplication(resourceId: string, application_id: string, extra?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":77},{"name":"setAiAgent","kind":"method","owner":"PhoneNumbersResource","signature":["setAiAgent(resourceId: string, agent_id: uuid, extra?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":78},{"name":"setCallFlow","kind":"method","owner":"PhoneNumbersResource","signature":["setCallFlow(resourceId: string, flow_id: uuid, version?: 'working_copy' | 'current_deployed', extra?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":79},{"name":"setRelayApplication","kind":"method","owner":"PhoneNumbersResource","signature":["setRelayApplication(resourceId: string, name: string, extra?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":80},{"name":"setRelayTopic","kind":"method","owner":"PhoneNumbersResource","signature":["setRelayTopic(resourceId: string, topic: string, status_callback_url?: string, extra?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<PhoneNumberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":81}],"bases":["CrudResource"]},"PlayAction":{"name":"PlayAction","kind":"class","exported":true,"signature":["class PlayAction extends Action"],"doc":"Async handle for a `calling.call.play` action — controls playback in progress.","file":"dist/relay/Action.d.ts","line":74,"members":[{"name":"constructor","kind":"constructor","owner":"PlayAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":75},{"name":"stop","kind":"method","owner":"PlayAction","signature":["stop(): Promise<CallingPlayStopResult>"],"doc":"Stop the playback.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":82},{"name":"pause","kind":"method","owner":"PlayAction","signature":["pause(behavior?: string): Promise<CallingPlayPauseResult>"],"doc":"Pause active playback (resumable with {@link resume}).\n\n@param behavior - Optional behaviour hint controlling what plays in place\n of the paused audio.\n@returns The platform's pause response.\n@throws {RelayError} When the pause command is rejected.","file":"dist/relay/Action.d.ts","line":91},{"name":"resume","kind":"method","owner":"PlayAction","signature":["resume(): Promise<CallingPlayResumeResult>"],"doc":"Resume playback paused by {@link pause}.\n\n@returns The platform's resume response.\n@throws {RelayError} When the resume command is rejected.","file":"dist/relay/Action.d.ts","line":98},{"name":"volume","kind":"method","owner":"PlayAction","signature":["volume(volume: number): Promise<CallingPlayVolumeResult>"],"doc":"Adjust playback volume.\n\n@param volume - Volume adjustment in dB.\n@returns The platform's volume response.\n@throws {RelayError} When the volume command is rejected.","file":"dist/relay/Action.d.ts","line":106}],"bases":["Action"]},"PlayBackgroundFileSkill":{"name":"PlayBackgroundFileSkill","kind":"class","exported":true,"signature":["class PlayBackgroundFileSkill extends SkillBase"],"doc":"Controls background audio playback during calls via SWML actions.\n\nTier 2 built-in skill with no external dependencies. Requires a non-empty\n`files` array (matching the Python skill, which raises if `files` is empty);\nemits a single configurable tool whose `action` enum maps to `start_<key>` /\n`stop` values that trigger the corresponding pre-configured file playback.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('play_background_file', {\n files: [\n { key: 'hold', url: 'https://cdn.example.com/hold-music.mp3', description: 'Hold music' },\n ],\n});\n```","file":"dist/skills/builtin/play_background_file.d.ts","line":29,"members":[{"name":"SKILL_NAME","kind":"property","owner":"PlayBackgroundFileSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/play_background_file.d.ts","line":30},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"PlayBackgroundFileSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/play_background_file.d.ts","line":31},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"PlayBackgroundFileSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/play_background_file.d.ts","line":32},{"name":"getParameterSchema","kind":"method","owner":"PlayBackgroundFileSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/play_background_file.d.ts","line":33},{"name":"getInstanceKey","kind":"method","owner":"PlayBackgroundFileSkill","signature":["getInstanceKey(): string"],"doc":"Produce a compound instance key so multiple copies of the skill with\ndistinct `tool_name` values can coexist in a single agent.","file":"dist/skills/builtin/play_background_file.d.ts","line":38},{"name":"setup","kind":"method","owner":"PlayBackgroundFileSkill","signature":["setup(): Promise<boolean>"],"doc":"Validate configuration. Mirrors Python `_validate_config()`\n(skill.py:106), which raises `ValueError(\"files parameter must be a\nnon-empty list\")` when no files are configured — the Python skill cannot\noperate without pre-configured files. Returning `false` here is the TS\nequivalent: the SkillManager treats a falsy `setup()` as fatal and refuses\nto register the skill (skill_manager.ts loadSkill contract).","file":"dist/skills/builtin/play_background_file.d.ts","line":47},{"name":"getTools","kind":"method","owner":"PlayBackgroundFileSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A single enum-based tool whose `action` selects a pre-configured\n file (`start_<key>`) or stops playback (`stop`). Matches the Python\n skill, which only ever emits this one tool. `setup()` has already\n guaranteed `files` is non-empty, so the skill is never registered with\n an empty list.","file":"dist/skills/builtin/play_background_file.d.ts","line":56}],"bases":["SkillBase"]},"PlayEvent":{"name":"PlayEvent","kind":"class","exported":true,"signature":["class PlayEvent extends RelayEvent"],"doc":"`calling.call.play` — play-media action state change (`playing`, `paused`, `finished`, `error`).","file":"dist/relay/RelayEvent.d.ts","line":78,"members":[{"name":"controlId","kind":"property","owner":"PlayEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":79},{"name":"state","kind":"property","owner":"PlayEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":80},{"name":"constructor","kind":"constructor","owner":"PlayEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":81},{"name":"fromPayload","kind":"method","owner":"PlayEvent","static":true,"signature":["static fromPayload(payload: EventPayload): PlayEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":82}],"bases":["RelayEvent"]},"PlayItem":{"name":"PlayItem","kind":"type","exported":true,"signature":["type PlayItem = CallingPlayParams['play'][number] | {\n type: 'tts';\n text: string;\n language?: string;\n gender?: string;\n} | {\n type: 'audio';\n url: string;\n} | {\n type: 'ringtone';\n name: string;\n duration?: number;\n} | {\n type: 'silence';\n duration: number;\n}"],"doc":"A play item accepted by `play()` / `playAndCollect()`.\n\nThe canonical RELAY wire form is `{ type, params }`\n(`CallingPlayParams['play'][number]`). The SDK also accepts the friendly flat\nshorthands below (`{ type: 'tts', text }`, etc.), which\n{@link normalizePlayItem} expands into `params` before sending. So the\naccepted-input type is the wire shape OR one of the flat shorthands — exactly\nthe set the normalizer handles, not the post-normalization wire shape alone.","file":"dist/relay/types.d.ts","line":147},"PomBuilder":{"name":"PomBuilder","kind":"class","exported":true,"signature":["class PomBuilder"],"doc":"Builds a structured prompt by composing named POM sections, with Markdown and dict export.\n\nThe Prompt Object Model lets you assemble a large system prompt from reusable,\nnamed sections (Role, Objective, Constraints, etc.) instead of a single string.\nThis plays well with {@link AgentBase} methods like `promptAddSection()` and\n`promptAddToSection()` that let user code and skills add prompt content\nincrementally.\n\n@example Build a structured prompt\n```ts\nimport { PomBuilder } from '@signalwire/sdk';\n\nconst pom = new PomBuilder()\n .addSection('Role', { body: 'You are a friendly customer service agent.' })\n .addSection('Objectives', { bullets: [\n 'Identify the customer politely',\n 'Resolve their issue in under 3 turns if possible',\n ]})\n .addSection('Constraints', { bullets: [\n 'Never reveal internal tool names',\n ]});\n\nconst systemPrompt = pom.renderMarkdown();\n```\n\n@see {@link PomSection}\n@see {@link AgentBase.promptAddSection}","file":"dist/PomBuilder.d.ts","line":115,"members":[{"name":"reset","kind":"method","owner":"PomBuilder","signature":["reset(): this"],"doc":"Clears all sections, returning the builder to its initial empty state.\n@returns This builder for chaining.","file":"dist/PomBuilder.d.ts","line":129},{"name":"addSection","kind":"method","owner":"PomBuilder","signature":["addSection(title: string, opts?: {\n body?: string;\n bullets?: string[];\n numbered?: boolean;\n numberedBullets?: boolean;\n subsections?: {\n title: string;\n body?: string;\n bullets?: string[];\n }[];\n}): this"],"doc":"Adds a new top-level section to the prompt.\n@param title - The section heading.\n@param opts - Optional body, bullets, numbering, and subsection configuration.\n@returns This builder for chaining.","file":"dist/PomBuilder.d.ts","line":136},{"name":"addToSection","kind":"method","owner":"PomBuilder","signature":["addToSection(title: string, opts?: {\n body?: string;\n bullet?: string;\n bullets?: string[];\n}): this"],"doc":"Appends body text or bullets to an existing section, creating it if absent.\n@param title - The section heading to append to.\n@param opts - Body text and/or bullets to add.\n@returns This builder for chaining.","file":"dist/PomBuilder.d.ts","line":153},{"name":"addSubsection","kind":"method","owner":"PomBuilder","signature":["addSubsection(parentTitle: string, title: string, opts?: {\n body?: string;\n bullets?: string[];\n}): this"],"doc":"Adds a subsection under an existing parent section, creating the parent if absent.\n@param parentTitle - The heading of the parent section.\n@param title - The subsection heading.\n@param opts - Optional body text and bullets for the subsection.\n@returns This builder for chaining.","file":"dist/PomBuilder.d.ts","line":165},{"name":"hasSection","kind":"method","owner":"PomBuilder","signature":["hasSection(title: string): boolean"],"doc":"Checks whether a top-level section with the given title exists.\n@param title - The section heading to look for.\n@returns True if the section exists.","file":"dist/PomBuilder.d.ts","line":174},{"name":"getSection","kind":"method","owner":"PomBuilder","signature":["getSection(title: string): PomSection | undefined"],"doc":"Returns a top-level section by title.\n@param title - The section heading to retrieve.\n@returns The matching PomSection, or undefined if not found.","file":"dist/PomBuilder.d.ts","line":180},{"name":"findSection","kind":"method","owner":"PomBuilder","signature":["findSection(title: string): PomSection | undefined"],"doc":"Recursively searches all sections and subsections for one matching the given title.\n@param title - The section heading to search for.\n@returns The matching PomSection, or undefined if not found.","file":"dist/PomBuilder.d.ts","line":186},{"name":"addPomAsSubsection","kind":"method","owner":"PomBuilder","signature":["addPomAsSubsection(target: string | PomSection, pomToAdd: PomBuilder): this"],"doc":"Appends every top-level section of another PomBuilder as subsections of a target section.\n@param target - The heading of the target section, or the PomSection to append into.\n@param pomToAdd - The PomBuilder whose sections should be appended as subsections.\n@returns This builder for chaining.\n@throws {Error} If target is a string and no section with that title is found.","file":"dist/PomBuilder.d.ts","line":194},{"name":"toDict","kind":"method","owner":"PomBuilder","signature":["toDict(): PomSectionData[]"],"doc":"Serializes all sections to an array of plain data objects.\n@returns An array of PomSectionData representing all top-level sections.","file":"dist/PomBuilder.d.ts","line":199},{"name":"toJson","kind":"method","owner":"PomBuilder","signature":["toJson(): string"],"doc":"Serializes all sections to a JSON string.\n@returns A JSON string representation of all top-level sections.","file":"dist/PomBuilder.d.ts","line":204},{"name":"toJSON","kind":"method","owner":"PomBuilder","signature":["toJSON(): PomSectionData[]"],"doc":"TS-native serialization hook so `JSON.stringify(builder)` emits the wire\nshape via {@link PomBuilder.toDict}. Distinct from {@link PomBuilder.toJson}\n(which returns a string). No Python counterpart.","file":"dist/PomBuilder.d.ts","line":210},{"name":"fromSections","kind":"method","owner":"PomBuilder","static":true,"signature":["static fromSections(sections: PomSectionData[]): PomBuilder"],"doc":"Creates a PomBuilder from an array of section data objects.\n@param sections - Array of section data to reconstruct.\n@returns A new PomBuilder populated with the given sections.","file":"dist/PomBuilder.d.ts","line":216},{"name":"pom","kind":"accessor","owner":"PomBuilder","signature":["get pom(): PromptObjectModel"],"doc":"Returns the underlying {@link PromptObjectModel} for the builder.\n\nMirrors Python's `PomBuilder.pom` attribute (the wrapped low-level model).\nReturns a fresh `PromptObjectModel` populated from the builder's current\nsections; mutations on the returned instance do not propagate back to\nthis builder.","file":"dist/PomBuilder.d.ts","line":225},{"name":"renderMarkdown","kind":"method","owner":"PomBuilder","signature":["renderMarkdown(): string"],"doc":"Renders all sections as a combined Markdown string.\n@returns The complete rendered Markdown prompt text.","file":"dist/PomBuilder.d.ts","line":230},{"name":"renderXml","kind":"method","owner":"PomBuilder","signature":["renderXml(): string"],"doc":"Renders all sections as a combined XML string with a `<prompt>` root element.\n@returns The complete rendered XML prompt text.","file":"dist/PomBuilder.d.ts","line":235}]},"PomSection":{"name":"PomSection","kind":"class","exported":true,"signature":["class PomSection"],"doc":"A single section in a Prompt Object Model, with optional title, body, bullets, and nested subsections.","file":"dist/PomBuilder.d.ts","line":25,"members":[{"name":"title","kind":"property","owner":"PomSection","signature":["title: string | null"],"doc":"Section heading text, or null if untitled.","file":"dist/PomBuilder.d.ts","line":27},{"name":"body","kind":"property","owner":"PomSection","signature":["body: string"],"doc":"Section body paragraph text.","file":"dist/PomBuilder.d.ts","line":29},{"name":"bullets","kind":"property","owner":"PomSection","signature":["bullets: string[]"],"doc":"List of bullet point strings.","file":"dist/PomBuilder.d.ts","line":31},{"name":"subsections","kind":"property","owner":"PomSection","signature":["subsections: PomSection[]"],"doc":"Nested child sections.","file":"dist/PomBuilder.d.ts","line":33},{"name":"numbered","kind":"property","owner":"PomSection","signature":["numbered: boolean | null"],"doc":"Whether this section is numbered when rendered; null means inherit from parent context.","file":"dist/PomBuilder.d.ts","line":35},{"name":"numberedBullets","kind":"property","owner":"PomSection","signature":["numberedBullets: boolean"],"doc":"Whether bullet points are rendered as a numbered list.","file":"dist/PomBuilder.d.ts","line":37},{"name":"constructor","kind":"constructor","owner":"PomSection","signature":["constructor(opts?: {\n title?: string | null;\n body?: string;\n bullets?: string[];\n numbered?: boolean | null;\n numberedBullets?: boolean;\n})"],"doc":"Creates a new PomSection.\n@param opts - Optional section configuration.","file":"dist/PomBuilder.d.ts","line":42},{"name":"addSubsection","kind":"method","owner":"PomSection","signature":["addSubsection(opts: {\n title: string;\n body?: string;\n bullets?: string[];\n numbered?: boolean;\n numberedBullets?: boolean;\n}): PomSection"],"doc":"Adds a nested subsection to this section.\n@param opts - Subsection configuration including title and optional body/bullets.\n@returns The newly created child PomSection.","file":"dist/PomBuilder.d.ts","line":54},{"name":"toDict","kind":"method","owner":"PomSection","signature":["toDict(): PomSectionData"],"doc":"Serializes this section to a plain data object.\n@returns A PomSectionData representation of this section and its subsections.","file":"dist/PomBuilder.d.ts","line":65},{"name":"toJSON","kind":"method","owner":"PomSection","signature":["toJSON(): PomSectionData"],"doc":"TS-native serialization hook so `JSON.stringify` emits the wire shape via\n{@link PomSection.toDict}. No Python counterpart.","file":"dist/PomBuilder.d.ts","line":70},{"name":"renderMarkdown","kind":"method","owner":"PomSection","signature":["renderMarkdown(level?: number, sectionNumber?: number[]): string"],"doc":"Renders this section and its subsections as a Markdown string.\n@param level - The heading level to start at (default 2 for ##).\n@param sectionNumber - Hierarchical numbering prefix for numbered sections.\n@returns The rendered Markdown string.","file":"dist/PomBuilder.d.ts","line":77},{"name":"renderXml","kind":"method","owner":"PomSection","signature":["renderXml(indent?: number, sectionNumber?: number[]): string"],"doc":"Renders this section and its subsections as an XML string.\n@param indent - The indentation depth (default 0).\n@param sectionNumber - Hierarchical numbering prefix for numbered sections.\n@returns The rendered XML string.","file":"dist/PomBuilder.d.ts","line":84}]},"PomSectionData":{"name":"PomSectionData","kind":"interface","exported":true,"signature":["interface PomSectionData"],"doc":"Serializable representation of a POM section, used for JSON export.","file":"dist/PomBuilder.d.ts","line":10,"members":[{"name":"title","kind":"property","owner":"PomSectionData","signature":["title?: string"],"doc":"Section heading text.","file":"dist/PomBuilder.d.ts","line":12},{"name":"body","kind":"property","owner":"PomSectionData","signature":["body?: string"],"doc":"Section body paragraph text.","file":"dist/PomBuilder.d.ts","line":14},{"name":"bullets","kind":"property","owner":"PomSectionData","signature":["bullets?: string[]"],"doc":"List of bullet point strings.","file":"dist/PomBuilder.d.ts","line":16},{"name":"numbered","kind":"property","owner":"PomSectionData","signature":["numbered?: boolean"],"doc":"Whether subsections are numbered.","file":"dist/PomBuilder.d.ts","line":18},{"name":"numberedBullets","kind":"property","owner":"PomSectionData","signature":["numberedBullets?: boolean"],"doc":"Whether bullet points are rendered as a numbered list.","file":"dist/PomBuilder.d.ts","line":20},{"name":"subsections","kind":"property","owner":"PomSectionData","signature":["subsections?: PomSectionData[]"],"doc":"Nested child sections.","file":"dist/PomBuilder.d.ts","line":22}]},"PostPrompt":{"name":"PostPrompt","kind":"interface","exported":true,"signature":["interface PostPrompt"],"doc":"Built by ais_get_post_data (ai_utils.c) + openai_post_process (post_process.c). No `version` field. Open shape: conditional fields appear only when their precondition holds.","file":"dist/SwaigContracts.generated.d.ts","line":67,"members":[{"name":"content_type","kind":"property","owner":"PostPrompt","signature":["content_type?: 'text/json'"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":68},{"name":"content_disposition","kind":"property","owner":"PostPrompt","signature":["content_disposition?: 'agent.summary'"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":69},{"name":"conversation_type","kind":"property","owner":"PostPrompt","signature":["conversation_type?: 'voice'"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":70},{"name":"action","kind":"property","owner":"PostPrompt","signature":["action?: 'post_conversation'"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":71},{"name":"project_id","kind":"property","owner":"PostPrompt","signature":["project_id?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":72},{"name":"space_id","kind":"property","owner":"PostPrompt","signature":["space_id?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":73},{"name":"call_id","kind":"property","owner":"PostPrompt","signature":["call_id?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":74},{"name":"app_name","kind":"property","owner":"PostPrompt","signature":["app_name?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":75},{"name":"ai_session_id","kind":"property","owner":"PostPrompt","signature":["ai_session_id?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":76},{"name":"ai_id_tag","kind":"property","owner":"PostPrompt","signature":["ai_id_tag?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":77},{"name":"conversation_id","kind":"property","owner":"PostPrompt","signature":["conversation_id?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":78},{"name":"call_ended_by","kind":"property","owner":"PostPrompt","signature":["call_ended_by?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":79},{"name":"caller_id_name","kind":"property","owner":"PostPrompt","signature":["caller_id_name?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":80},{"name":"caller_id_number","kind":"property","owner":"PostPrompt","signature":["caller_id_number?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":81},{"name":"conversation_summary","kind":"property","owner":"PostPrompt","signature":["conversation_summary?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":82},{"name":"hard_timeout","kind":"property","owner":"PostPrompt","signature":["hard_timeout?: boolean"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":83},{"name":"call_start_date","kind":"property","owner":"PostPrompt","signature":["call_start_date?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":84},{"name":"call_answer_date","kind":"property","owner":"PostPrompt","signature":["call_answer_date?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":85},{"name":"call_end_date","kind":"property","owner":"PostPrompt","signature":["call_end_date?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":86},{"name":"ai_start_date","kind":"property","owner":"PostPrompt","signature":["ai_start_date?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":87},{"name":"ai_end_date","kind":"property","owner":"PostPrompt","signature":["ai_end_date?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":88},{"name":"post_prompt_data","kind":"property","owner":"PostPrompt","signature":["post_prompt_data?: PostPromptData"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":89},{"name":"global_data","kind":"property","owner":"PostPrompt","signature":["global_data?: Record<string, unknown>"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":90},{"name":"SWMLVars","kind":"property","owner":"PostPrompt","signature":["SWMLVars?: Record<string, unknown>"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":91},{"name":"SWMLCall","kind":"property","owner":"PostPrompt","signature":["SWMLCall?: Record<string, unknown>"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":92},{"name":"call_log","kind":"property","owner":"PostPrompt","signature":["call_log?: PostPromptCallLogEntry[]"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":93},{"name":"raw_call_log","kind":"property","owner":"PostPrompt","signature":["raw_call_log?: PostPromptCallLogEntry[]"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":94},{"name":"call_timeline","kind":"property","owner":"PostPrompt","signature":["call_timeline?: Record<string, unknown>[]"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":95},{"name":"previous_contexts","kind":"property","owner":"PostPrompt","signature":["previous_contexts?: Record<string, unknown>[][]"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":96},{"name":"times","kind":"property","owner":"PostPrompt","signature":["times?: PostPromptTimesEntry[]"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":97},{"name":"swaig_log","kind":"property","owner":"PostPrompt","signature":["swaig_log?: PostPromptSwaigLogEntry[]"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":98},{"name":"total_minutes","kind":"property","owner":"PostPrompt","signature":["total_minutes?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":99},{"name":"total_input_tokens","kind":"property","owner":"PostPrompt","signature":["total_input_tokens?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":100},{"name":"total_output_tokens","kind":"property","owner":"PostPrompt","signature":["total_output_tokens?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":101},{"name":"total_wire_input_tokens","kind":"property","owner":"PostPrompt","signature":["total_wire_input_tokens?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":102},{"name":"total_wire_input_tokens_per_minute","kind":"property","owner":"PostPrompt","signature":["total_wire_input_tokens_per_minute?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":103},{"name":"total_wire_output_tokens","kind":"property","owner":"PostPrompt","signature":["total_wire_output_tokens?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":104},{"name":"total_wire_output_tokens_per_minute","kind":"property","owner":"PostPrompt","signature":["total_wire_output_tokens_per_minute?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":105},{"name":"total_tts_chars","kind":"property","owner":"PostPrompt","signature":["total_tts_chars?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":106},{"name":"total_tts_chars_per_min","kind":"property","owner":"PostPrompt","signature":["total_tts_chars_per_min?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":107},{"name":"total_asr_minutes","kind":"property","owner":"PostPrompt","signature":["total_asr_minutes?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":108},{"name":"total_asr_cost_factor","kind":"property","owner":"PostPrompt","signature":["total_asr_cost_factor?: number"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":109}]},"PostPromptData":{"name":"PostPromptData","kind":"interface","exported":true,"signature":["interface PostPromptData"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":112,"members":[{"name":"parsed","kind":"property","owner":"PostPromptData","signature":["parsed?: Record<string, unknown>[]"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":113},{"name":"raw","kind":"property","owner":"PostPromptData","signature":["raw?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":114},{"name":"substituted","kind":"property","owner":"PostPromptData","signature":["substituted?: string"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":115}]},"ProjectNamespace":{"name":"ProjectNamespace","kind":"class","exported":true,"signature":["class ProjectNamespace"],"doc":"Generated `client.project` namespace container.","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":50,"members":[{"name":"tokens","kind":"property","owner":"ProjectNamespace","readonly":true,"signature":["readonly tokens: ProjectTokens"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":51},{"name":"constructor","kind":"constructor","owner":"ProjectNamespace","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":52}]},"ProjectTokens":{"name":"ProjectTokens","kind":"class","exported":true,"signature":["class ProjectTokens extends BaseResource"],"doc":"","file":"dist/rest/namespaces/project.resources.generated.d.ts","line":5,"members":[{"name":"constructor","kind":"constructor","owner":"ProjectTokens","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/project.resources.generated.d.ts","line":6},{"name":"create","kind":"method","owner":"ProjectTokens","signature":["create(name: string, permissions: TokenPermission[], options?: {\n subproject_id?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<TokenResponse>"],"doc":"","file":"dist/rest/namespaces/project.resources.generated.d.ts","line":7},{"name":"update","kind":"method","owner":"ProjectTokens","signature":["update(token_id: string, options?: {\n name?: string;\n permissions?: TokenPermission[];\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<TokenResponse>"],"doc":"","file":"dist/rest/namespaces/project.resources.generated.d.ts","line":11},{"name":"delete","kind":"method","owner":"ProjectTokens","signature":["delete(token_id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/project.resources.generated.d.ts","line":16}],"bases":["BaseResource"]},"PromptManager":{"name":"PromptManager","kind":"class","exported":true,"signature":["class PromptManager"],"doc":"Manages agent prompt text, supporting both raw text and structured POM-based prompts.","file":"dist/PromptManager.d.ts","line":9,"members":[{"name":"agent","kind":"property","owner":"PromptManager","readonly":true,"signature":["readonly agent?: AgentBase"],"doc":"The agent this manager belongs to (the reference's public `self.agent`,\n`core/agent/prompt/manager.py:32`), or `undefined` for standalone use.\n\nThe reference takes the parent agent as its sole constructor argument and keeps\nit as a public back-reference. A caller holding the manager can therefore walk\nback to its owner; this is the read-back of that same value.","file":"dist/PromptManager.d.ts","line":22},{"name":"constructor","kind":"constructor","owner":"PromptManager","signature":["constructor(usePom?: boolean, agent?: AgentBase)"],"doc":"Creates a new PromptManager.\n@param usePom - Whether to use structured POM sections (default true).\n@param agent - Optional parent agent, kept as a public back-reference\n (the reference's `PromptManager(agent)`). Omit for standalone use.","file":"dist/PromptManager.d.ts","line":29},{"name":"setPromptText","kind":"method","owner":"PromptManager","signature":["setPromptText(text: string): void"],"doc":"Sets the raw prompt text, bypassing POM rendering.\n@param text - The raw prompt string.","file":"dist/PromptManager.d.ts","line":43},{"name":"setPostPrompt","kind":"method","owner":"PromptManager","signature":["setPostPrompt(text: string): void"],"doc":"Sets the post-prompt text appended after the main prompt.\n@param text - The post-prompt string.","file":"dist/PromptManager.d.ts","line":48},{"name":"addSection","kind":"method","owner":"PromptManager","signature":["addSection(title: string, opts?: {\n body?: string;\n bullets?: string[];\n numbered?: boolean;\n numberedBullets?: boolean;\n subsections?: {\n title: string;\n body?: string;\n bullets?: string[];\n }[];\n}): void"],"doc":"Adds a POM section to the prompt, initializing the PomBuilder if needed.\n@param title - The section heading.\n@param opts - Optional body, bullets, numbering, and subsection configuration.","file":"dist/PromptManager.d.ts","line":54},{"name":"addToSection","kind":"method","owner":"PromptManager","signature":["addToSection(title: string, opts?: {\n body?: string;\n bullet?: string;\n bullets?: string[];\n}): void"],"doc":"Appends body text or bullets to an existing POM section, creating it if absent.\n@param title - The section heading to append to.\n@param opts - Body text and/or bullets to add.","file":"dist/PromptManager.d.ts","line":70},{"name":"addSubsection","kind":"method","owner":"PromptManager","signature":["addSubsection(parentTitle: string, title: string, opts?: {\n body?: string;\n bullets?: string[];\n}): void"],"doc":"Adds a subsection under a parent POM section, creating the parent if absent.\n@param parentTitle - The heading of the parent section.\n@param title - The subsection heading.\n@param opts - Optional body text and bullets for the subsection.","file":"dist/PromptManager.d.ts","line":81},{"name":"hasSection","kind":"method","owner":"PromptManager","signature":["hasSection(title: string): boolean"],"doc":"Checks whether a POM section with the given title exists.\n@param title - The section heading to look for.\n@returns True if the section exists.","file":"dist/PromptManager.d.ts","line":90},{"name":"getPrompt","kind":"method","owner":"PromptManager","signature":["getPrompt(): string"],"doc":"Returns the fully rendered prompt text, either raw text or POM-rendered Markdown.\n@returns The prompt string, or empty string if nothing is set.","file":"dist/PromptManager.d.ts","line":95},{"name":"getPostPrompt","kind":"method","owner":"PromptManager","signature":["getPostPrompt(): string | null"],"doc":"Returns the post-prompt text.\n@returns The post-prompt string, or null if not set.","file":"dist/PromptManager.d.ts","line":100},{"name":"getPomBuilder","kind":"method","owner":"PromptManager","signature":["getPomBuilder(): PomBuilder | null"],"doc":"Returns the underlying PomBuilder instance, if POM mode is active.\n@returns The PomBuilder, or null if POM is not in use.","file":"dist/PromptManager.d.ts","line":105},{"name":"getRawPrompt","kind":"method","owner":"PromptManager","signature":["getRawPrompt(): string | null"],"doc":"Returns the raw prompt text whatever `setPromptText` stored, or null\nwhen no raw prompt has been set. Mirrors Python's\n`PromptManager.get_raw_prompt`.\n@returns The raw prompt string, or null if not set.","file":"dist/PromptManager.d.ts","line":112}]},"PromptObjectModel":{"name":"PromptObjectModel","kind":"class","exported":true,"signature":["class PromptObjectModel"],"doc":"The Prompt Object Model — a structured, serializable representation of a\nfull prompt document. Direct port of Python's\n`signalwire.pom.pom.PromptObjectModel`.","file":"dist/POM/PromptObjectModel.d.ts","line":97,"members":[{"name":"sections","kind":"property","owner":"PromptObjectModel","signature":["sections: Section[]"],"doc":"Top-level sections in the model.","file":"dist/POM/PromptObjectModel.d.ts","line":99},{"name":"debug","kind":"property","owner":"PromptObjectModel","signature":["debug: boolean"],"doc":"Whether to print debug info during {@link renderMarkdown}.","file":"dist/POM/PromptObjectModel.d.ts","line":101},{"name":"constructor","kind":"constructor","owner":"PromptObjectModel","signature":["constructor(debug?: boolean)"],"doc":"","file":"dist/POM/PromptObjectModel.d.ts","line":102},{"name":"addSection","kind":"method","owner":"PromptObjectModel","signature":["addSection(title?: string | null, opts?: {\n body?: string;\n bullets?: string[] | string | null;\n numbered?: boolean | null;\n numberedBullets?: boolean;\n}): Section"],"doc":"Add a top-level section to the model.\n\n@throws Error if a section without a title is added after the first section.","file":"dist/POM/PromptObjectModel.d.ts","line":108},{"name":"findSection","kind":"method","owner":"PromptObjectModel","signature":["findSection(title: string): Section | null"],"doc":"Find a section by its title (recursive search through all sections and subsections).\n\n@returns The matching Section or null if not found.","file":"dist/POM/PromptObjectModel.d.ts","line":119},{"name":"toDict","kind":"method","owner":"PromptObjectModel","signature":["toDict(): SectionData[]"],"doc":"Convert the entire model to a list of dictionaries.","file":"dist/POM/PromptObjectModel.d.ts","line":121},{"name":"toJson","kind":"method","owner":"PromptObjectModel","signature":["toJson(): string"],"doc":"Convert the entire model to a JSON string (pretty-printed with 2-space indent).","file":"dist/POM/PromptObjectModel.d.ts","line":123},{"name":"toJSON","kind":"method","owner":"PromptObjectModel","signature":["toJSON(): SectionData[]"],"doc":"TS-native serialization hook so `JSON.stringify(model)` emits the wire\nshape via {@link PromptObjectModel.toDict}. Distinct from\n{@link PromptObjectModel.toJson} (which returns a string). No Python counterpart.","file":"dist/POM/PromptObjectModel.d.ts","line":129},{"name":"toYaml","kind":"method","owner":"PromptObjectModel","signature":["toYaml(): string"],"doc":"Convert the entire model to a YAML string.","file":"dist/POM/PromptObjectModel.d.ts","line":131},{"name":"renderMarkdown","kind":"method","owner":"PromptObjectModel","signature":["renderMarkdown(): string"],"doc":"Render the entire model as markdown.","file":"dist/POM/PromptObjectModel.d.ts","line":135},{"name":"renderXml","kind":"method","owner":"PromptObjectModel","signature":["renderXml(): string"],"doc":"Render the entire model as XML.","file":"dist/POM/PromptObjectModel.d.ts","line":139},{"name":"addPomAsSubsection","kind":"method","owner":"PromptObjectModel","signature":["addPomAsSubsection(target: string | Section, pomToAdd: PromptObjectModel): void"],"doc":"Add another PromptObjectModel as subsections of an existing section.\n\n@param target Either the title of the target section, or a `Section` reference.\n@param pomToAdd The model whose top-level sections will be appended as subsections.\n@throws Error if `target` is a string and no section with that title is found.","file":"dist/POM/PromptObjectModel.d.ts","line":147},{"name":"fromJson","kind":"method","owner":"PromptObjectModel","static":true,"signature":["static fromJson(jsonData: string | unknown): PromptObjectModel"],"doc":"Create a PromptObjectModel from JSON data (string or already-parsed object).","file":"dist/POM/PromptObjectModel.d.ts","line":151},{"name":"fromYaml","kind":"method","owner":"PromptObjectModel","static":true,"signature":["static fromYaml(yamlData: string | unknown): PromptObjectModel"],"doc":"Create a PromptObjectModel from YAML data (string or already-parsed object).","file":"dist/POM/PromptObjectModel.d.ts","line":155}]},"PronunciationRule":{"name":"PronunciationRule","kind":"interface","exported":true,"signature":["interface PronunciationRule"],"doc":"Rule for overriding how the TTS engine pronounces a specific word or phrase.","file":"dist/types.d.ts","line":141,"members":[{"name":"replace","kind":"property","owner":"PronunciationRule","signature":["replace: string"],"doc":"The text pattern to match.","file":"dist/types.d.ts","line":143},{"name":"with","kind":"property","owner":"PronunciationRule","signature":["with: string"],"doc":"The replacement pronunciation.","file":"dist/types.d.ts","line":145},{"name":"ignoreCase","kind":"property","owner":"PronunciationRule","signature":["ignoreCase?: boolean"],"doc":"Whether the match should be case-insensitive.","file":"dist/types.d.ts","line":147}]},"PubSubResource":{"name":"PubSubResource","kind":"class","exported":true,"signature":["class PubSub extends BaseResource"],"doc":"","file":"dist/rest/namespaces/pubsub.resources.generated.d.ts","line":5,"members":[{"name":"constructor","kind":"constructor","owner":"PubSubResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/pubsub.resources.generated.d.ts","line":6},{"name":"createToken","kind":"method","owner":"PubSubResource","signature":["createToken(ttl: number, channels: PubSubChannels, options?: {\n member_id?: string;\n state?: PubSubState;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<PubSubToken>"],"doc":"","file":"dist/rest/namespaces/pubsub.resources.generated.d.ts","line":7}],"bases":["BaseResource"]},"QueryParams":{"name":"QueryParams","kind":"type","exported":true,"signature":["type QueryParams = Record<string, string | number | boolean | undefined>"],"doc":"Query parameters for list operations.","file":"dist/rest/types.d.ts","line":72},"QueueEvent":{"name":"QueueEvent","kind":"class","exported":true,"signature":["class QueueEvent extends RelayEvent"],"doc":"`calling.call.queue` — call-queue position update (queued, waiting, member answered, timed out).","file":"dist/relay/RelayEvent.d.ts","line":187,"members":[{"name":"controlId","kind":"property","owner":"QueueEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":188},{"name":"status","kind":"property","owner":"QueueEvent","readonly":true,"signature":["readonly status: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":189},{"name":"queueId","kind":"property","owner":"QueueEvent","readonly":true,"signature":["readonly queueId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":190},{"name":"queueName","kind":"property","owner":"QueueEvent","readonly":true,"signature":["readonly queueName: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":191},{"name":"position","kind":"property","owner":"QueueEvent","readonly":true,"signature":["readonly position: number"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":192},{"name":"size","kind":"property","owner":"QueueEvent","readonly":true,"signature":["readonly size: number"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":193},{"name":"constructor","kind":"constructor","owner":"QueueEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, status?: string, queueId?: string, queueName?: string, position?: number, size?: number)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":194},{"name":"fromPayload","kind":"method","owner":"QueueEvent","static":true,"signature":["static fromPayload(payload: EventPayload): QueueEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":195}],"bases":["RelayEvent"]},"QueuesResource":{"name":"QueuesResource","kind":"class","exported":true,"signature":["class Queues extends CrudResource<QueueListResponse, QueueResponse, CreateQueueRequest, UpdateQueueRequest>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":83,"members":[{"name":"constructor","kind":"constructor","owner":"QueuesResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":85},{"name":"create","kind":"method","owner":"QueuesResource","signature":["create(body: CreateQueueRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<QueueResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":87},{"name":"update","kind":"method","owner":"QueuesResource","signature":["update(id: string, body: UpdateQueueRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<QueueResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":89},{"name":"listMembers","kind":"method","owner":"QueuesResource","signature":["listMembers(queue_id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<QueueMemberListResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":90},{"name":"getNextMember","kind":"method","owner":"QueuesResource","signature":["getNextMember(queue_id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<QueueMemberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":91},{"name":"getMember","kind":"method","owner":"QueuesResource","signature":["getMember(queue_id: string, id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<QueueMemberResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":92}],"bases":["CrudResource"]},"RECORD_DIRECTIONS":{"name":"RECORD_DIRECTIONS","kind":"variable","exported":true,"signature":["const RECORD_DIRECTIONS: readonly [\"speak\", \"listen\", \"both\"]"],"doc":"Recording direction for the SWAIG `record_call` verb — Tier-1 closed set\n(`function_result.py:918`). NOTE: distinct from {@link TAP_DIRECTIONS} —\nrecord uses `listen`, tap uses `hear` (never unify; see journal §3 \"three\ndirection vocabularies\"). Used by {@link ParameterSchema.recordDirection}.","file":"dist/ParameterSchema.d.ts","line":81},"RECORD_FORMATS":{"name":"RECORD_FORMATS","kind":"variable","exported":true,"signature":["const RECORD_FORMATS: readonly [\"wav\", \"mp3\", \"mp4\"]"],"doc":"Recording format for the SWAIG `record_call` verb — the strongly-grounded\nTier-1 closed set (`function_result.py:914` `raise ValueError`-validated;\nSWML `$defs/RecordCall.format`). Used by {@link ParameterSchema.recordFormat}.","file":"dist/ParameterSchema.d.ts","line":72},"RateLimitError":{"name":"RateLimitError","kind":"class","exported":true,"signature":["class RateLimitError extends AIChatError"],"doc":"Project or conversation rate limit hit (-32005 / -32006).","file":"dist/ai-chat/AIChatClient.d.ts","line":67,"members":[{"name":"constructor","kind":"constructor","owner":"RateLimitError","signature":["constructor(code: number | null, message: string)"],"doc":"","file":"dist/ai-chat/AIChatClient.d.ts","line":68}],"bases":["AIChatError"]},"ReadResource":{"name":"ReadResource","kind":"class","exported":false,"signature":["class ReadResource<TList = unknown, TItem = unknown> extends BaseResource"],"doc":"Read-only REST resource exposing `list()` and `get()` (no create/update/delete).\n\nThe read-only counterpart of {@link CrudResource} — used by resources whose\nsurface is just listing and fetching (e.g. video room sessions, fabric\naddresses). Generated subclasses bind the two generic types and add any\ndeclared sub-resource accessors.\n\n@typeParam TList - Type of the paginated list response.\n@typeParam TItem - Type of a single resource item.","file":"dist/rest/base/ReadResource.d.ts","line":19,"members":[{"name":"constructor","kind":"constructor","owner":"ReadResource","signature":["constructor(http: HttpClient, basePath: string)"],"doc":"","file":"dist/rest/base/ReadResource.d.ts","line":20},{"name":"list","kind":"method","owner":"ReadResource","signature":["list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<TList>"],"doc":"List resources with optional query parameters.\n\n@param params - Optional filter / pagination query parameters.\n@returns The paginated list response.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/base/ReadResource.d.ts","line":28},{"name":"paginate","kind":"method","owner":"ReadResource","signature":["paginate(params?: QueryParams, requestOptions?: RequestOptionsInit): AsyncGenerator<TItem, void, undefined>"],"doc":"Iterate every item across all pages of this resource's list endpoint.\n\n`list()` returns a single raw page (the server's first response).\n`paginate()` walks every page transparently, following the server's\n`links.next` / `next_page_uri` cursor, and yields one item at a time — so\ncallers no longer hand-build the page-token loop:\n\n```typescript\nimport { RestClient } from '@signalwire/sdk';\nconst client = new RestClient();\nfor await (const address of client.fabric.addresses.paginate()) {\n console.log(address);\n}\n```\n\nThe TS analogue of Python's `ReadResource.paginate()` /\n`PaginatedIterator`: an async iterator wired to the shared {@link paginate}\ngenerator, reading items from `resp[\"data\"]`.\n\n@param params - Query parameters applied to the FIRST request only;\n subsequent pages follow the server-supplied next-page URL.\n@returns An async iterator yielding each `TItem` across all pages.","file":"dist/rest/base/ReadResource.d.ts","line":53},{"name":"get","kind":"method","owner":"ReadResource","signature":["get(resourceId: string, requestOptions?: RequestOptionsInit): Promise<TItem>"],"doc":"Fetch a single resource by ID.\n\n@param resourceId - Unique identifier of the resource.\n@returns The resource record.\n@throws {RestError} On any non-2xx HTTP response.","file":"dist/rest/base/ReadResource.d.ts","line":61}],"bases":["BaseResource"]},"ReceptionistAgent":{"name":"ReceptionistAgent","kind":"class","exported":true,"signature":["class ReceptionistAgent extends AgentBase"],"doc":"Prefab agent that greets callers, collects basic information, and transfers them to the correct department.\n\nOptionally supports visitor check-in — when enabled, the agent can collect a visitor's name\nand purpose-of-visit and invoke a callback (e.g., notify reception via Slack, write to a\ndatabase). If not transferring, the call ends after check-in.\n\n@example\n```ts\nimport { ReceptionistAgent } from '@signalwire/sdk';\n\nconst notifyFrontDesk = async (visitor: Record<string, string>) => {\n console.log('visitor checked in', visitor);\n};\n\nconst agent = new ReceptionistAgent({\n companyName: 'Acme Co',\n greeting: 'Thanks for calling Acme! How can I direct your call?',\n departments: [\n { name: 'sales', description: 'New customer inquiries', number: '+15551112222' },\n { name: 'support', description: 'Existing customer help', number: '+15553334444' },\n { name: 'billing', description: 'Billing and payments', number: '+15555556666' },\n ],\n checkInEnabled: true,\n onVisitorCheckIn: async (visitor) => {\n await notifyFrontDesk(visitor);\n },\n});\n\nawait agent.serve({ port: 3000 });\n```","file":"dist/prefabs/ReceptionistAgent.d.ts","line":74,"members":[{"name":"constructor","kind":"constructor","owner":"ReceptionistAgent","signature":["constructor(config: ReceptionistConfig)"],"doc":"Create a ReceptionistAgent with the specified departments.\n@param config - Configuration including departments (name/description/number), greeting, and voice.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":86},{"name":"defineTools","kind":"method","owner":"ReceptionistAgent","protected":true,"signature":["protected defineTools(): void"],"doc":"Register the `collect_caller_info` and `transfer_call` SWAIG tools\n(matching the Python SDK). When `checkInEnabled` is `true`, also registers the\nTS-specific `check_in_visitor` tool.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":96},{"name":"onSummary","kind":"method","owner":"ReceptionistAgent","signature":["onSummary(_summary: Record<string, unknown> | null, rawData: PostPrompt): void | Promise<void>"],"doc":"Python-style receptionist summary hook; subclasses may override to\npersist the summary. Mirrors Python `on_summary` (receptionist.py lines\n278-287), which does nothing.\n\nThe summary marks the end of the call, so this drops the call's check-in\nstate. A subclass that overrides this hook should call\n`super.onSummary(summary, rawData)`; otherwise the state is dropped after\nthe call has been idle for an hour.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":107}],"bases":["AgentBase"]},"ReceptionistConfig":{"name":"ReceptionistConfig","kind":"interface","exported":true,"signature":["interface ReceptionistConfig"],"doc":"Configuration for the {@link ReceptionistAgent}.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":22,"members":[{"name":"departments","kind":"property","owner":"ReceptionistConfig","signature":["departments: ReceptionistDepartment[]"],"doc":"Departments the agent can transfer callers to.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":24},{"name":"name","kind":"property","owner":"ReceptionistConfig","signature":["name?: string"],"doc":"Agent display name (defaults to `\"receptionist\"`).","file":"dist/prefabs/ReceptionistAgent.d.ts","line":26},{"name":"route","kind":"property","owner":"ReceptionistConfig","signature":["route?: string"],"doc":"HTTP route for this agent (defaults to `\"/receptionist\"`).","file":"dist/prefabs/ReceptionistAgent.d.ts","line":28},{"name":"greeting","kind":"property","owner":"ReceptionistConfig","signature":["greeting?: string"],"doc":"Initial greeting message. Defaults to the Python receptionist greeting.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":30},{"name":"voice","kind":"property","owner":"ReceptionistConfig","signature":["voice?: string"],"doc":"Voice identifier passed to `addLanguage`. Defaults to `\"rime.spore\"`.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":32},{"name":"companyName","kind":"property","owner":"ReceptionistConfig","signature":["companyName?: string"],"doc":"Optional company name. Appended to the greeting when provided.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":34},{"name":"checkInEnabled","kind":"property","owner":"ReceptionistConfig","signature":["checkInEnabled?: boolean"],"doc":"Whether visitor check-in functionality is enabled. Default `false`.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":36},{"name":"onVisitorCheckIn","kind":"property","owner":"ReceptionistConfig","signature":["onVisitorCheckIn?: (visitor: Record<string, string>) => void | Promise<void>"],"doc":"Callback fired when a visitor checks in.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":38},{"name":"agentOptions","kind":"property","owner":"ReceptionistConfig","signature":["agentOptions?: Partial<AgentOptions>"],"doc":"Additional AgentBase options forwarded to super().","file":"dist/prefabs/ReceptionistAgent.d.ts","line":40}]},"ReceptionistDepartment":{"name":"ReceptionistDepartment","kind":"interface","exported":true,"signature":["interface ReceptionistDepartment"],"doc":"A department the receptionist can route callers to.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":13,"members":[{"name":"name","kind":"property","owner":"ReceptionistDepartment","signature":["name: string"],"doc":"Department identifier (e.g. `\"sales\"`, `\"support\"`).","file":"dist/prefabs/ReceptionistAgent.d.ts","line":15},{"name":"description","kind":"property","owner":"ReceptionistDepartment","signature":["description: string"],"doc":"Description of the department's purpose (shown to the AI).","file":"dist/prefabs/ReceptionistAgent.d.ts","line":17},{"name":"number","kind":"property","owner":"ReceptionistDepartment","signature":["number: string"],"doc":"Phone number (or SIP address) used by `transfer_call`.","file":"dist/prefabs/ReceptionistAgent.d.ts","line":19}]},"RecordAction":{"name":"RecordAction","kind":"class","exported":true,"signature":["class RecordAction extends Action"],"doc":"Async handle for a `calling.call.record` action — controls recording in progress.","file":"dist/relay/Action.d.ts","line":109,"members":[{"name":"constructor","kind":"constructor","owner":"RecordAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":110},{"name":"stop","kind":"method","owner":"RecordAction","signature":["stop(): Promise<CallingRecordStopResult>"],"doc":"Stop the recording and finalise the file.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":117},{"name":"pause","kind":"method","owner":"RecordAction","signature":["pause(behavior?: string): Promise<CallingRecordPauseResult>"],"doc":"Pause the recording (resumable with {@link resume}).\n\n@param behavior - Optional behaviour hint (e.g. `\"silence\"`) controlling\n what is recorded in place of paused audio.\n@returns The platform's pause response.\n@throws {RelayError} When the pause command is rejected.","file":"dist/relay/Action.d.ts","line":126},{"name":"resume","kind":"method","owner":"RecordAction","signature":["resume(): Promise<CallingRecordResumeResult>"],"doc":"Resume recording paused by {@link pause}.\n\n@returns The platform's resume response.\n@throws {RelayError} When the resume command is rejected.","file":"dist/relay/Action.d.ts","line":133}],"bases":["Action"]},"RecordDirection":{"name":"RecordDirection","kind":"type","exported":true,"signature":["type RecordDirection = (typeof RECORD_DIRECTIONS)[number]"],"doc":"A single {@link RECORD_DIRECTIONS} value.","file":"dist/ParameterSchema.d.ts","line":83},"RecordEvent":{"name":"RecordEvent","kind":"class","exported":true,"signature":["class RecordEvent extends RelayEvent"],"doc":"`calling.call.record` — recording state change with final URL, duration, and size when finished.","file":"dist/relay/RelayEvent.d.ts","line":85,"members":[{"name":"controlId","kind":"property","owner":"RecordEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":86},{"name":"state","kind":"property","owner":"RecordEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":87},{"name":"url","kind":"property","owner":"RecordEvent","readonly":true,"signature":["readonly url: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":88},{"name":"duration","kind":"property","owner":"RecordEvent","readonly":true,"signature":["readonly duration: number"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":89},{"name":"size","kind":"property","owner":"RecordEvent","readonly":true,"signature":["readonly size: number"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":90},{"name":"record","kind":"property","owner":"RecordEvent","readonly":true,"signature":["readonly record: EventPayload"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":91},{"name":"constructor","kind":"constructor","owner":"RecordEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, url?: string, duration?: number, size?: number, record?: EventPayload)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":92},{"name":"fromPayload","kind":"method","owner":"RecordEvent","static":true,"signature":["static fromPayload(payload: EventPayload): RecordEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":93}],"bases":["RelayEvent"]},"RecordFormat":{"name":"RecordFormat","kind":"type","exported":true,"signature":["type RecordFormat = (typeof RECORD_FORMATS)[number]"],"doc":"A single {@link RECORD_FORMATS} value.","file":"dist/ParameterSchema.d.ts","line":74},"RecordingsResource":{"name":"RecordingsResource","kind":"class","exported":true,"signature":["class Recordings extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":94,"members":[{"name":"constructor","kind":"constructor","owner":"RecordingsResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":95},{"name":"list","kind":"method","owner":"RecordingsResource","signature":["list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<RecordingListResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":96},{"name":"get","kind":"method","owner":"RecordingsResource","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":97},{"name":"delete","kind":"method","owner":"RecordingsResource","signature":["delete(id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":98}],"bases":["BaseResource"]},"ReferEvent":{"name":"ReferEvent","kind":"class","exported":true,"signature":["class ReferEvent extends RelayEvent"],"doc":"`calling.call.refer` — SIP REFER result (off-platform transfer response codes).","file":"dist/relay/RelayEvent.d.ts","line":165,"members":[{"name":"state","kind":"property","owner":"ReferEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":166},{"name":"sipReferTo","kind":"property","owner":"ReferEvent","readonly":true,"signature":["readonly sipReferTo: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":167},{"name":"sipReferResponseCode","kind":"property","owner":"ReferEvent","readonly":true,"signature":["readonly sipReferResponseCode: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":168},{"name":"sipNotifyResponseCode","kind":"property","owner":"ReferEvent","readonly":true,"signature":["readonly sipNotifyResponseCode: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":169},{"name":"constructor","kind":"constructor","owner":"ReferEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, state?: string, sipReferTo?: string, sipReferResponseCode?: string, sipNotifyResponseCode?: string)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":170},{"name":"fromPayload","kind":"method","owner":"ReferEvent","static":true,"signature":["static fromPayload(payload: EventPayload): ReferEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":171}],"bases":["RelayEvent"]},"RegistryBrands":{"name":"RegistryBrands","kind":"class","exported":true,"signature":["class RegistryBrands extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":100,"members":[{"name":"constructor","kind":"constructor","owner":"RegistryBrands","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":101},{"name":"list","kind":"method","owner":"RegistryBrands","signature":["list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<BrandListResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":102},{"name":"create","kind":"method","owner":"RegistryBrands","signature":["create(body: CreateManagedBrandRequest | CreateCspBrandRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<BrandResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":103},{"name":"get","kind":"method","owner":"RegistryBrands","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<BrandResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":104},{"name":"listCampaigns","kind":"method","owner":"RegistryBrands","signature":["listCampaigns(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<CampaignListResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":105},{"name":"createCampaign","kind":"method","owner":"RegistryBrands","signature":["createCampaign(id: string, body: CreateManagedCampaignRequest | CreatePartnerCampaignRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<CampaignResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":106}],"bases":["BaseResource"]},"RegistryCampaigns":{"name":"RegistryCampaigns","kind":"class","exported":true,"signature":["class RegistryCampaigns extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":108,"members":[{"name":"constructor","kind":"constructor","owner":"RegistryCampaigns","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":109},{"name":"get","kind":"method","owner":"RegistryCampaigns","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<CampaignResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":110},{"name":"update","kind":"method","owner":"RegistryCampaigns","signature":["update(id: string, options?: {\n name?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<CampaignResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":111},{"name":"listNumbers","kind":"method","owner":"RegistryCampaigns","signature":["listNumbers(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<AssignedNumberListResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":115},{"name":"listOrders","kind":"method","owner":"RegistryCampaigns","signature":["listOrders(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<OrderListResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":116},{"name":"createOrder","kind":"method","owner":"RegistryCampaigns","signature":["createOrder(id: string, options?: {\n phone_numbers?: string[];\n status_callback_url?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<OrderResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":117}],"bases":["BaseResource"]},"RegistryNamespace":{"name":"RegistryNamespace","kind":"class","exported":true,"signature":["class RegistryNamespace"],"doc":"Generated `client.registry` namespace container.","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":55,"members":[{"name":"brands","kind":"property","owner":"RegistryNamespace","readonly":true,"signature":["readonly brands: RegistryBrands"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":56},{"name":"campaigns","kind":"property","owner":"RegistryNamespace","readonly":true,"signature":["readonly campaigns: RegistryCampaigns"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":57},{"name":"numbers","kind":"property","owner":"RegistryNamespace","readonly":true,"signature":["readonly numbers: RegistryNumbers"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":58},{"name":"orders","kind":"property","owner":"RegistryNamespace","readonly":true,"signature":["readonly orders: RegistryOrders"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":59},{"name":"constructor","kind":"constructor","owner":"RegistryNamespace","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":60}]},"RegistryNumbers":{"name":"RegistryNumbers","kind":"class","exported":true,"signature":["class RegistryNumbers extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":123,"members":[{"name":"constructor","kind":"constructor","owner":"RegistryNumbers","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":124},{"name":"delete","kind":"method","owner":"RegistryNumbers","signature":["delete(id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":125}],"bases":["BaseResource"]},"RegistryOrders":{"name":"RegistryOrders","kind":"class","exported":true,"signature":["class RegistryOrders extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":127,"members":[{"name":"constructor","kind":"constructor","owner":"RegistryOrders","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":128},{"name":"get","kind":"method","owner":"RegistryOrders","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<OrderResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":129}],"bases":["BaseResource"]},"RelayApplications":{"name":"RelayApplications","kind":"class","exported":true,"signature":["class RelayApplications extends FabricResource<RelayApplicationListResponse, RelayApplicationResponse, RelayApplicationCreateRequest, RelayApplicationUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":98,"members":[{"name":"constructor","kind":"constructor","owner":"RelayApplications","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":100},{"name":"create","kind":"method","owner":"RelayApplications","signature":["create(body: RelayApplicationCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<RelayApplicationResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":102},{"name":"update","kind":"method","owner":"RelayApplications","signature":["update(id: string, body: RelayApplicationUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<RelayApplicationResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":104}],"bases":["FabricResource"]},"RelayClient":{"name":"RelayClient","kind":"class","exported":true,"signature":["class RelayClient"],"doc":"Real-time WebSocket client for SignalWire RELAY.\n\nOne instance = one persistent JSON-RPC 2.0 WebSocket connection. Lets you\nplace / receive calls and SMS, play/record media, run TTS, conference calls\ntogether, and subscribe to platform events — all without HTTP polling.\n\nAuthentication supports either a project/token pair or a JWT.\n\n@example Inbound-call handler\n```ts\nimport { RelayClient } from '@signalwire/sdk';\n\nconst client = new RelayClient({\n project: process.env.SIGNALWIRE_PROJECT_ID!,\n token: process.env.SIGNALWIRE_API_TOKEN!,\n host: 'example.signalwire.com',\n contexts: ['office'],\n});\n\nclient.onCall(async (call) => {\n await call.answer();\n const played = await call.play([{ type: 'tts', text: 'Thanks for calling!' }]);\n await played.wait();\n await call.hangup();\n});\n\nawait client.connect();\n```\n\n@example Outbound dial + SMS\n```ts\nimport { RelayClient } from '@signalwire/sdk';\nconst client = new RelayClient();\nawait client.connect();\nconst call = await client.dial([\n [{ type: 'phone', to: '+15551234567', from: '+15557654321' }],\n]);\nawait client.sendMessage({ toNumber: '+15551234567', fromNumber: '+15557654321', body: 'Hi!' });\n```\n\n@see {@link Call}\n@see {@link Message}","file":"dist/relay/RelayClient.d.ts","line":69,"members":[{"name":"project","kind":"property","owner":"RelayClient","readonly":true,"signature":["readonly project: string"],"doc":"Project ID used for Basic Auth.","file":"dist/relay/RelayClient.d.ts","line":71},{"name":"token","kind":"property","owner":"RelayClient","readonly":true,"signature":["readonly token: string"],"doc":"API token used for Basic Auth.","file":"dist/relay/RelayClient.d.ts","line":73},{"name":"jwtToken","kind":"property","owner":"RelayClient","readonly":true,"signature":["readonly jwtToken: string"],"doc":"JWT used instead of project/token if provided.","file":"dist/relay/RelayClient.d.ts","line":75},{"name":"host","kind":"property","owner":"RelayClient","readonly":true,"signature":["readonly host: string"],"doc":"Hostname of the RELAY endpoint (e.g. `example.signalwire.com`).","file":"dist/relay/RelayClient.d.ts","line":77},{"name":"scheme","kind":"property","owner":"RelayClient","readonly":true,"signature":["readonly scheme: 'ws' | 'wss'"],"doc":"WebSocket scheme — `'wss'` (production) or `'ws'` (loopback audits).\nSee {@link RelayClientOptions.scheme} for the full rationale.","file":"dist/relay/RelayClient.d.ts","line":82},{"name":"contexts","kind":"property","owner":"RelayClient","readonly":true,"signature":["readonly contexts: string[]"],"doc":"Contexts this client subscribes to for inbound events.","file":"dist/relay/RelayClient.d.ts","line":84},{"name":"constructor","kind":"constructor","owner":"RelayClient","signature":["constructor(options?: RelayClientOptions)"],"doc":"Create a new RELAY client.\nCredentials fall back to the `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`,\n`SIGNALWIRE_JWT_TOKEN`, and `SIGNALWIRE_SPACE` env vars when omitted.\n@param options - Optional client configuration.","file":"dist/relay/RelayClient.d.ts","line":125},{"name":"relayProtocol","kind":"accessor","owner":"RelayClient","signature":["get relayProtocol(): string"],"doc":"The protocol name the server assigned to this client after `connect()`.","file":"dist/relay/RelayClient.d.ts","line":127},{"name":"onCall","kind":"method","owner":"RelayClient","signature":["onCall(handler: CallHandler): CallHandler"],"doc":"Register the inbound call handler.\n\nThe handler is invoked once per inbound call, with a fully-formed\n{@link Call} already in state `\"created\"`. Answer, reject, or forward\nthe call from inside the handler.\n\n@param handler - Callback invoked for each inbound call. May return a\n promise; errors are logged but do not tear down the client.\n@returns The same handler, to support decorator-style usage.","file":"dist/relay/RelayClient.d.ts","line":162},{"name":"onMessage","kind":"method","owner":"RelayClient","signature":["onMessage(handler: MessageHandler): MessageHandler"],"doc":"Register the inbound message handler.\n\nThe handler is invoked once per inbound SMS/MMS delivered to a subscribed\ncontext, with a {@link Message} already in state `\"received\"`.\n\n@param handler - Callback invoked for each inbound message. May return a\n promise; errors are logged but do not tear down the client.\n@returns The same handler, to support decorator-style usage.","file":"dist/relay/RelayClient.d.ts","line":173},{"name":"onEvent","kind":"method","owner":"RelayClient","signature":["onEvent(handler: (eventType: string, params: Record<string, unknown>) => void | Promise<void>): typeof handler"],"doc":"Register a low-level observer that fires for every inbound\n`signalwire.event`, regardless of event type or whether a typed\nCall / Message could be matched.\n\nMost users want {@link onCall} / {@link onMessage} — those deliver\ntyped objects and handle correlation. `onEvent` is the generic\nescape hatch for reacting to every event the platform pushes.\n\nFires BEFORE typed routing, so the same event will be observed here\nAND on any matching {@link Call} / {@link Message}.\n\n@param handler - Callback receiving `(eventType, params)`. May be async.\n@returns The same handler, for decorator-style usage.","file":"dist/relay/RelayClient.d.ts","line":189},{"name":"connect","kind":"method","owner":"RelayClient","signature":["connect(): Promise<void>"],"doc":"Connect to RELAY and authenticate.\n\nOpens the WebSocket, runs the JSON-RPC `signalwire.connect` handshake,\nand starts the client-side ping loop. Safe to call again after a\n`disconnect()` to reconnect; the process-wide concurrent-connection limit\nis enforced here.\n\n@returns Resolves once the client is connected and authenticated.\n@throws {Error} When the process-wide connection limit is reached,\n authentication fails, or the WebSocket cannot be opened.","file":"dist/relay/RelayClient.d.ts","line":202},{"name":"disconnect","kind":"method","owner":"RelayClient","signature":["disconnect(): Promise<void>"],"doc":"Cleanly close the connection.\n\nStops the ping loop, drops the WebSocket, rejects every pending request\nand dial with a `Connection closed` {@link RelayError}, and removes the\nclient from the process-wide active set. Safe to call repeatedly.\n\n@returns Resolves once all resources have been released.","file":"dist/relay/RelayClient.d.ts","line":230},{"name":"execute","kind":"method","owner":"RelayClient","signature":["execute(method: string, params: Record<string, unknown>): Promise<Record<string, unknown>>"],"doc":"Send a JSON-RPC request and await the response.\n\nThis is the low-level escape hatch for calling RELAY methods that don't\nyet have a higher-level helper on this class. Queued if the client is\ncurrently disconnected; sent immediately otherwise.\n\n@param method - Fully-qualified JSON-RPC method name (e.g. `\"calling.play\"`).\n@param params - Method-specific params object.\n@returns The `result` field of the JSON-RPC response.\n@throws {RelayError} When the server returns a non-2xx code.","file":"dist/relay/RelayClient.d.ts","line":243},{"name":"notify","kind":"method","owner":"RelayClient","signature":["notify(method: string, params: Record<string, unknown>): void"],"doc":"Fire-and-forget JSON-RPC notification (no response awaited).\n\nSends a JSON-RPC frame on the open socket without registering a\npending-response future. Used by the audit harness to emit a\n`signalwire.event`-method frame the fixture watches for; production\nusers should always use {@link execute} instead so the response code\nis checked.\n\nNo-ops when the socket is closed.\n\n@param method - JSON-RPC method name.\n@param params - Method params object.","file":"dist/relay/RelayClient.d.ts","line":258},{"name":"dial","kind":"method","owner":"RelayClient","signature":["dial(devices: Record<string, unknown>[][], options?: {\n tag?: string;\n /** Maximum call duration in minutes. */\n maxDuration?: number;\n /** Dial timeout in seconds (default 120). */\n dialTimeout?: number;\n}): Promise<Call>"],"doc":"Initiate an outbound call.\n\nAccepts a \"dial plan\" — an outer array of serial groups, each containing\nan inner array of devices dialled in parallel. Resolves when any device\nanswers; rejects if no device answers within `dialTimeout`.\n\n@param devices - Serial/parallel dial plan. `[[A], [B, C]]` dials A first,\n then B and C in parallel.\n@param options - Optional dial behaviour overrides.\n@param options.tag - Client-provided tag for event correlation.\n Auto-generated (UUID) when omitted.\n@param options.maxDuration - Maximum call duration in minutes.\n@param options.dialTimeout - Seconds to wait for the dial to complete.\n Defaults to `120`.\n@returns A {@link Call} representing the answered leg.\n@throws {Error} When the dial times out.\n@throws {RelayError} When the server rejects the dial request.","file":"dist/relay/RelayClient.d.ts","line":278},{"name":"sendMessage","kind":"method","owner":"RelayClient","signature":["sendMessage(options: {\n toNumber: string;\n fromNumber: string;\n context?: string;\n body?: string;\n media?: string[];\n tags?: string[];\n region?: string;\n onCompleted?: CompletedCallback;\n}): Promise<Message>"],"doc":"Send an outbound SMS / MMS message.\n\nThe method returns as soon as the server has accepted the send; track the\nmessage's terminal state with {@link Message.wait} or the `onCompleted`\ncallback.\n\n@param options - Send parameters.\n@param options.toNumber - Destination phone number in E.164 format.\n@param options.fromNumber - Sender phone number in E.164 format.\n@param options.context - Context for receiving state events. Defaults to\n the negotiated relay protocol.\n@param options.body - Text body of the message.\n@param options.media - List of media URLs for MMS.\n@param options.tags - Tags attached to the message for correlation.\n@param options.region - Origination region override.\n@param options.onCompleted - Optional callback fired when the message\n reaches a terminal state (delivered / failed / undelivered).\n@returns A {@link Message} tracking the outbound send.\n@throws {RelayError} When the server rejects the send request.","file":"dist/relay/RelayClient.d.ts","line":306},{"name":"receive","kind":"method","owner":"RelayClient","signature":["receive(contexts: string[]): Promise<void>"],"doc":"Subscribe to additional RELAY contexts on an already-connected client.\n\nInbound calls and messages on any of the listed contexts will be delivered\nto the `onCall` / `onMessage` handlers. A no-op when `contexts` is empty.\n\n@param contexts - Context names to subscribe to.\n@returns Resolves once the server has confirmed the subscription.\n@throws {RelayError} When the server rejects the subscribe request.","file":"dist/relay/RelayClient.d.ts","line":326},{"name":"unreceive","kind":"method","owner":"RelayClient","signature":["unreceive(contexts: string[]): Promise<void>"],"doc":"Unsubscribe from contexts previously passed to {@link receive} (or the\nconstructor). A no-op when `contexts` is empty.\n\n@param contexts - Context names to unsubscribe from.\n@returns Resolves once the server has confirmed the unsubscribe.\n@throws {RelayError} When the server rejects the unsubscribe request.","file":"dist/relay/RelayClient.d.ts","line":335},{"name":"run","kind":"method","owner":"RelayClient","signature":["run(): Promise<void>"],"doc":"Blocking entry point — connects and maintains the connection with\nauto-reconnect, returning only after a clean shutdown (Ctrl+C, SIGTERM,\nor {@link disconnect} from another scope).\n\nInstalls `SIGINT` / `SIGTERM` handlers, so typically only one `RelayClient`\nper process should call `run()`.\n\n@returns Resolves once a shutdown has been requested and cleanup completes.\n@throws {Error} Only on unrecoverable startup failures — normal\n disconnects are handled internally by the reconnect loop.","file":"dist/relay/RelayClient.d.ts","line":348}]},"RelayClientLike":{"name":"RelayClientLike","kind":"interface","exported":true,"signature":["interface RelayClientLike"],"doc":"Interface the Call needs from RelayClient (avoids circular import).","file":"dist/relay/Call.d.ts","line":15,"members":[{"name":"execute","kind":"method","owner":"RelayClientLike","signature":["execute(method: string, params: Record<string, unknown>): Promise<Record<string, unknown>>"],"doc":"","file":"dist/relay/Call.d.ts","line":16}]},"RelayClientOptions":{"name":"RelayClientOptions","kind":"interface","exported":true,"signature":["interface RelayClientOptions"],"doc":"Options for constructing a RelayClient.","file":"dist/relay/types.d.ts","line":9,"members":[{"name":"project","kind":"property","owner":"RelayClientOptions","signature":["project?: string"],"doc":"SignalWire project ID. Defaults to env SIGNALWIRE_PROJECT_ID.","file":"dist/relay/types.d.ts","line":11},{"name":"token","kind":"property","owner":"RelayClientOptions","signature":["token?: string"],"doc":"SignalWire API token. Defaults to env SIGNALWIRE_API_TOKEN.","file":"dist/relay/types.d.ts","line":13},{"name":"jwtToken","kind":"property","owner":"RelayClientOptions","signature":["jwtToken?: string"],"doc":"JWT token for authentication. Defaults to env SIGNALWIRE_JWT_TOKEN.","file":"dist/relay/types.d.ts","line":15},{"name":"host","kind":"property","owner":"RelayClientOptions","signature":["host?: string"],"doc":"RELAY host. Defaults to relay.signalwire.com.","file":"dist/relay/types.d.ts","line":17},{"name":"scheme","kind":"property","owner":"RelayClientOptions","signature":["scheme?: 'ws' | 'wss'"],"doc":"WebSocket scheme — `'wss'` (production, the default) or `'ws'`\n(loopback fixtures and local audit harnesses). Reads from\n`SIGNALWIRE_RELAY_SCHEME` if not explicitly set; defaults to `'wss'`.\n\nProduction deployments should never pass `'ws'` — the value exists\nsolely so tests can drive the real client against a plain-WS loopback\nfixture without standing up TLS termination.","file":"dist/relay/types.d.ts","line":27},{"name":"contexts","kind":"property","owner":"RelayClientOptions","signature":["contexts?: string[]"],"doc":"Contexts (topics) to receive inbound calls/messages on.","file":"dist/relay/types.d.ts","line":29},{"name":"maxActiveCalls","kind":"property","owner":"RelayClientOptions","signature":["maxActiveCalls?: number"],"doc":"Maximum number of concurrent active calls. Defaults to env RELAY_MAX_ACTIVE_CALLS or 1000.","file":"dist/relay/types.d.ts","line":31}]},"RelayError":{"name":"RelayError","kind":"class","exported":true,"signature":["class RelayError extends Error"],"doc":"Custom error class for RELAY protocol errors.\n\nThrown when the server returns a non-2xx JSON-RPC result code. Mirrors the\nPython SDK signature: `RelayError(code, message)`.","file":"dist/relay/RelayError.d.ts","line":7,"members":[{"name":"code","kind":"property","owner":"RelayError","readonly":true,"signature":["readonly code: number"],"doc":"Numeric RELAY result code returned by the server.","file":"dist/relay/RelayError.d.ts","line":9},{"name":"serverMessage","kind":"property","owner":"RelayError","readonly":true,"signature":["readonly serverMessage: string"],"doc":"The RAW server message, undecorated — the reference's public `self.message`\n(`relay/client.py:1332`).\n\nKept as its own property because JS `Error` owns `message` and `super(...)`\nfills it with the DECORATED text (`\"RELAY error {code}: {message}\"`, the\nreference's `super().__init__` on line 1333). A caller who wants the server's\nown wording — to match on it, surface it in a UI, or forward it — reads this;\n`message` gives the decorated form, matching Python's `str(exc)`.\n\nSame spelling and rationale as {@link AIChatError.serverMessage}. The surface\nenumerator folds it onto the reference's `message` attribute.","file":"dist/relay/RelayError.d.ts","line":23},{"name":"constructor","kind":"constructor","owner":"RelayError","signature":["constructor(code: number, message: string)"],"doc":"@param code - Numeric RELAY result code (e.g. `404`, `503`).\n@param message - Human-readable error message from the server.","file":"dist/relay/RelayError.d.ts","line":28}],"bases":["Error"]},"RelayEvent":{"name":"RelayEvent","kind":"class","exported":true,"signature":["class RelayEvent"],"doc":"Base class for all typed RELAY events.\n\nRaw events arrive as `signalwire.event` JSON-RPC notifications; the client\nlooks up the correct subclass in {@link EVENT_CLASS_MAP} and invokes\n{@link RelayEvent.fromPayload} to build a typed wrapper. Handlers receive\nthis wrapper; they can always read the original dict from `params`.","file":"dist/relay/RelayEvent.d.ts","line":24,"members":[{"name":"eventType","kind":"property","owner":"RelayEvent","readonly":true,"signature":["readonly eventType: string"],"doc":"Fully-qualified event type (e.g. `\"calling.call.state\"`).","file":"dist/relay/RelayEvent.d.ts","line":26},{"name":"params","kind":"property","owner":"RelayEvent","readonly":true,"signature":["readonly params: EventPayload"],"doc":"Raw params dict from the RELAY notification.","file":"dist/relay/RelayEvent.d.ts","line":28},{"name":"callId","kind":"property","owner":"RelayEvent","readonly":true,"signature":["readonly callId: string"],"doc":"Call ID associated with the event, or `\"\"` for non-call events.","file":"dist/relay/RelayEvent.d.ts","line":30},{"name":"timestamp","kind":"property","owner":"RelayEvent","readonly":true,"signature":["readonly timestamp: number"],"doc":"Server timestamp (epoch seconds) at which the event was emitted.","file":"dist/relay/RelayEvent.d.ts","line":32},{"name":"constructor","kind":"constructor","owner":"RelayEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number)"],"doc":"@param eventType - Fully-qualified event type.\n@param params - Raw event params dict.\n@param callId - Call ID (if applicable).\n@param timestamp - Server-side event timestamp.","file":"dist/relay/RelayEvent.d.ts","line":39},{"name":"fromPayload","kind":"method","owner":"RelayEvent","static":true,"signature":["static fromPayload(payload: EventPayload): RelayEvent"],"doc":"Factory that builds a typed event from a raw `signalwire.event` payload.\nSubclasses override this to populate their specialised fields; the base\nimplementation returns a minimal `RelayEvent` used as the fallback for\nunrecognised event types.","file":"dist/relay/RelayEvent.d.ts","line":46}]},"RequestOptions":{"name":"RequestOptions","kind":"class","exported":true,"signature":["class RequestOptions"],"doc":"Per-request transport options value object. Mirrors the Python reference's\n``RequestOptions`` dataclass: all fields optional (`undefined` = inherit),\nplus a {@link merge} method for the per-request-over-client-default shallow\nmerge. A call site may pass either an instance or a plain\n{@link RequestOptionsInit} object literal — every verb normalizes both.","file":"dist/rest/RequestOptions.d.ts","line":74,"members":[{"name":"timeout","kind":"property","owner":"RequestOptions","readonly":true,"signature":["readonly timeout?: number"],"doc":"","file":"dist/rest/RequestOptions.d.ts","line":75},{"name":"retries","kind":"property","owner":"RequestOptions","readonly":true,"signature":["readonly retries?: number"],"doc":"","file":"dist/rest/RequestOptions.d.ts","line":76},{"name":"retryOnStatus","kind":"property","owner":"RequestOptions","readonly":true,"signature":["readonly retryOnStatus?: ReadonlySet<number>"],"doc":"","file":"dist/rest/RequestOptions.d.ts","line":77},{"name":"retryBackoff","kind":"property","owner":"RequestOptions","readonly":true,"signature":["readonly retryBackoff?: number"],"doc":"","file":"dist/rest/RequestOptions.d.ts","line":78},{"name":"abortSignal","kind":"property","owner":"RequestOptions","readonly":true,"signature":["readonly abortSignal?: AbortSignal"],"doc":"","file":"dist/rest/RequestOptions.d.ts","line":79},{"name":"constructor","kind":"constructor","owner":"RequestOptions","signature":["constructor(init?: RequestOptionsInit)"],"doc":"","file":"dist/rest/RequestOptions.d.ts","line":80},{"name":"merge","kind":"method","owner":"RequestOptions","signature":["merge(override: RequestOptionsInit | undefined): RequestOptions"],"doc":"Return a new RequestOptions with any set (non-`undefined`) field of\n`override` applied over this one. The per-request-over-client-default\nshallow merge: an unset field on `override` leaves this value intact.","file":"dist/rest/RequestOptions.d.ts","line":86}]},"RequestOptionsInit":{"name":"RequestOptionsInit","kind":"interface","exported":true,"signature":["interface RequestOptionsInit"],"doc":"Plain-object initializer for {@link RequestOptions}. All fields optional;\n`undefined` = inherit (fall back to the client default, then the built-in).\nEvery REST verb accepts this directly, so a call site passes an object\nliteral — `client.get(path, params, { retries: 1 })` — without constructing a\nclass instance.","file":"dist/rest/RequestOptions.d.ts","line":34,"members":[{"name":"timeout","kind":"property","owner":"RequestOptionsInit","signature":["timeout?: number"],"doc":"Max wall-clock seconds per attempt; on exceed the request raises the\ntransport-error type ({@link RestTransportError}). Built-in default `30.0`.","file":"dist/rest/RequestOptions.d.ts","line":39},{"name":"retries","kind":"property","owner":"RequestOptionsInit","signature":["retries?: number"],"doc":"Number of RETRY attempts (total attempts = `retries + 1`) on a retryable\nfailure. Built-in default `0` (opt-in resilience — the no-retry behavior\nstays the default; a caller opts into retries).","file":"dist/rest/RequestOptions.d.ts","line":45},{"name":"retryOnStatus","kind":"property","owner":"RequestOptionsInit","signature":["retryOnStatus?: ReadonlySet<number>"],"doc":"HTTP statuses that trigger a retry for an idempotent method. Built-in\n`{429, 500, 502, 503, 504}`.","file":"dist/rest/RequestOptions.d.ts","line":50},{"name":"retryBackoff","kind":"property","owner":"RequestOptionsInit","signature":["retryBackoff?: number"],"doc":"Base seconds for exponential backoff between retries\n(`backoff * 2 ** (attempt - 1)`), honoring `Retry-After` when present.\nBuilt-in `0.5`.","file":"dist/rest/RequestOptions.d.ts","line":56},{"name":"abortSignal","kind":"property","owner":"RequestOptionsInit","signature":["abortSignal?: AbortSignal"],"doc":"Native cancellation primitive; passed straight to `fetch` for TRUE\nin-flight abort, and also checked before each attempt. Built-in none.","file":"dist/rest/RequestOptions.d.ts","line":61}]},"RestClient":{"name":"RestClient","kind":"class","exported":true,"signature":["class RestClient extends _GeneratedResourceTree"],"doc":"REST client for the SignalWire platform APIs.\n\n@example\n```ts\nimport { RestClient } from '@signalwire/sdk';\n\nconst client = new RestClient({\n project: 'your-project-id',\n token: 'your-api-token',\n host: 'your-space.signalwire.com',\n});\n\n// Or use env vars (SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE):\n// const client = new RestClient();\n\n// Use namespaced resources\nconst callId = 'call-uuid';\nawait client.fabric.aiAgents.list();\nawait client.calling.play(callId, [{ type: 'audio', params: { url: 'https://cdn.example.com/greeting.mp3' } }]);\nawait client.phoneNumbers.search({ areacode: '512' });\nawait client.video.rooms.create({ name: 'standup' });\n```","file":"dist/rest/index.d.ts","line":32,"members":[{"name":"constructor","kind":"constructor","owner":"RestClient","signature":["constructor(options?: ClientOptions)"],"doc":"Create a new REST client.\n\n@param options - Connection options. `project`, `token`, and `host` are\n required. If any are omitted they fall back to `SIGNALWIRE_PROJECT_ID`,\n `SIGNALWIRE_API_TOKEN`, and `SIGNALWIRE_SPACE` environment variables.\n@throws {Error} When `project`, `token`, or `host` is missing from both\n the options and the environment.","file":"dist/rest/index.d.ts","line":42}],"bases":["_GeneratedResourceTree"]},"RestError":{"name":"RestError","kind":"class","exported":true,"signature":["class RestError extends Error"],"doc":"Custom error class for REST API errors.\n\n`body` may be a parsed JSON object (when the server returned valid JSON)\nor a plain string (when JSON parsing failed), matching the Python SDK's\n`SignalWireRestError` behavior.","file":"dist/rest/RestError.d.ts","line":9,"members":[{"name":"statusCode","kind":"property","owner":"RestError","readonly":true,"signature":["readonly statusCode: number | null"],"doc":"HTTP status code returned by the server (e.g. `404`, `500`).\n\n`null` for a TRANSPORT failure — a {@link RestTransportError} — where the\nrequest never reached a response (connection refused, DNS failure,\nconnection reset, TLS error), so there is no HTTP status to report.\nCallers catch this one family (`instanceof RestError`) for every REST\nfailure, HTTP or transport.","file":"dist/rest/RestError.d.ts","line":19},{"name":"body","kind":"property","owner":"RestError","readonly":true,"signature":["readonly body: string | SignalWireErrorBody"],"doc":"Parsed response body. An object when the server returned valid JSON,\notherwise the raw response text as a string. For a transport failure it is\nthe underlying transport error message.","file":"dist/rest/RestError.d.ts","line":25},{"name":"url","kind":"property","owner":"RestError","readonly":true,"signature":["readonly url: string"],"doc":"Fully-qualified URL that produced the error.","file":"dist/rest/RestError.d.ts","line":27},{"name":"method","kind":"property","owner":"RestError","readonly":true,"signature":["readonly method: string"],"doc":"HTTP method that produced the error (`GET`, `POST`, etc.).","file":"dist/rest/RestError.d.ts","line":29},{"name":"headers","kind":"property","owner":"RestError","readonly":true,"signature":["readonly headers: Record<string, string> | null"],"doc":"Response header map captured from the failed HTTP response, or `null` for a\ntransport failure that produced no response. Client-side observability with\nno wire-contract change — mirrors the python reference `SignalWireRestError.headers`.","file":"dist/rest/RestError.d.ts","line":35},{"name":"requestId","kind":"property","owner":"RestError","readonly":true,"signature":["readonly requestId: string | null"],"doc":"The platform request id pulled from {@link headers} (`x-request-id` /\n`x-signalwire-request-id` / `request-id` / `x-amzn-requestid`, case-insensitive,\nin that precedence), or `null` if absent. Log/correlate a failure against\nSignalWire's own request id — mirrors the python reference `request_id`.","file":"dist/rest/RestError.d.ts","line":42},{"name":"constructor","kind":"constructor","owner":"RestError","signature":["constructor(statusCode: number | null, body: string | SignalWireErrorBody, url: string, method?: string, headers?: Record<string, string> | null)"],"doc":"@param statusCode - HTTP status code returned by the server, or `null` for\n a transport-level failure that never reached a response.\n@param body - Response body — an object if JSON-parseable, otherwise the\n raw response text.\n@param url - Fully-qualified URL that produced the error.\n@param method - HTTP method that produced the error. Defaults to `\"GET\"`.\n@param headers - Response header map (for request-id extraction), or `null`\n for a transport failure that produced no response.","file":"dist/rest/RestError.d.ts","line":53}],"bases":["Error"]},"RestTransportError":{"name":"RestTransportError","kind":"class","exported":true,"signature":["class RestTransportError extends RestError"],"doc":"Raised when a REST request never reached a response — a transport-level\nfailure (connection refused, DNS failure, connection reset, TLS error).\n\nA member of the {@link RestError} family (`statusCode` is `null`, `body` is\nthe underlying transport error message) so a caller catching `RestError`\n(aka `SignalWireRestError`) handles both HTTP-error and transport-error\nresponses with one `catch`, instead of a bare `fetch` `TypeError` leaking\nthrough. `headers` and `requestId` are `null` — no response was produced.","file":"dist/rest/RestError.d.ts","line":65,"members":[{"name":"constructor","kind":"constructor","owner":"RestTransportError","signature":["constructor(body: string, url: string, method?: string)"],"doc":"@param body - The underlying transport error message.\n@param url - Fully-qualified URL that produced the error.\n@param method - HTTP method that produced the error. Defaults to `\"GET\"`.","file":"dist/rest/RestError.d.ts","line":71}],"bases":["RestError"]},"RoutingCallback":{"name":"RoutingCallback","kind":"type","exported":true,"signature":["type RoutingCallback = (body: SwmlRequestData, headers?: Record<string, string>) => string | null | undefined | Promise<string | null | undefined>"],"doc":"Callback invoked at a registered routing endpoint to determine how to handle an\nincoming request. Return a route string to redirect to that agent route, or\nnull / undefined to let normal SWML processing continue.\n\nMirrors Python `web_mixin.register_routing_callback` callback signature. Python\ndecomposed the routing callback to `callback_fn(body, headers)` — the parsed body\nplus the request headers (the raw Hono request object is not forwarded). `headers`\nis optional so existing body-only callbacks keep working.","file":"dist/AgentBase.d.ts","line":34},"SIGNALWIRE_SHA256_SIGNATURE_HEADER":{"name":"SIGNALWIRE_SHA256_SIGNATURE_HEADER","kind":"variable","exported":true,"signature":["const SIGNALWIRE_SHA256_SIGNATURE_HEADER"],"doc":"The HMAC-SHA256 signature header, preferred over the SHA-1 one when present.","file":"dist/WebhookMiddleware.d.ts","line":34},"SIGNALWIRE_SIGNATURE_HEADER":{"name":"SIGNALWIRE_SIGNATURE_HEADER","kind":"variable","exported":true,"signature":["const SIGNALWIRE_SIGNATURE_HEADER"],"doc":"Canonical lowercase header names (Hono's c.req.header() is case-insensitive).","file":"dist/WebhookMiddleware.d.ts","line":32},"SWMLService":{"name":"SWMLService","kind":"class","exported":true,"signature":["class SWMLService"],"doc":"","file":"dist/SWMLService.d.ts","line":164,"members":[{"name":"name","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly name: string"],"doc":"Service display name.","file":"dist/SWMLService.d.ts","line":166},{"name":"route","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly route: string"],"doc":"HTTP route path.","file":"dist/SWMLService.d.ts","line":168},{"name":"host","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly host: string"],"doc":"Host the server binds to.","file":"dist/SWMLService.d.ts","line":170},{"name":"port","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly port: number"],"doc":"Port the server binds to.","file":"dist/SWMLService.d.ts","line":172},{"name":"log","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly log: Logger"],"doc":"Structured logger, exposed for subclass access. Mirrors Python's public `self.log`.","file":"dist/SWMLService.d.ts","line":174},{"name":"security","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly security: SecurityConfig"],"doc":"Unified security configuration. Mirrors Python's `self.security`.","file":"dist/SWMLService.d.ts","line":176},{"name":"sslEnabled","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly sslEnabled: boolean"],"doc":"Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`.","file":"dist/SWMLService.d.ts","line":178},{"name":"domain","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly domain: string | undefined"],"doc":"Domain name for SSL. Mirrors Python's `self.domain`.","file":"dist/SWMLService.d.ts","line":180},{"name":"sslCertPath","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly sslCertPath: string | undefined"],"doc":"Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`.","file":"dist/SWMLService.d.ts","line":182},{"name":"sslKeyPath","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly sslKeyPath: string | undefined"],"doc":"Path to SSL private key. Mirrors Python's `self.ssl_key_path`.","file":"dist/SWMLService.d.ts","line":184},{"name":"schemaUtils","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly schemaUtils: SchemaUtils"],"doc":"Schema validation utilities. Mirrors Python's `self.schema_utils`.","file":"dist/SWMLService.d.ts","line":186},{"name":"verbRegistry","kind":"property","owner":"SWMLService","readonly":true,"signature":["readonly verbRegistry: VerbHandlerRegistry"],"doc":"Custom verb handler registry. Mirrors Python's `self.verb_registry`.","file":"dist/SWMLService.d.ts","line":193},{"name":"swmlBuilder","kind":"property","owner":"SWMLService","protected":true,"signature":["protected swmlBuilder: SwmlBuilder"],"doc":"","file":"dist/SWMLService.d.ts","line":194},{"name":"onRequestCallback","kind":"property","owner":"SWMLService","protected":true,"signature":["protected onRequestCallback?: OnRequestCallback"],"doc":"","file":"dist/SWMLService.d.ts","line":197},{"name":"authCredentials","kind":"property","owner":"SWMLService","protected":true,"signature":["protected authCredentials?: [string, string]"],"doc":"","file":"dist/SWMLService.d.ts","line":198},{"name":"authSource","kind":"property","owner":"SWMLService","protected":true,"signature":["protected authSource: 'provided' | 'environment' | 'config file' | 'generated'"],"doc":"","file":"dist/SWMLService.d.ts","line":199},{"name":"validateBasicAuth","kind":"method","owner":"SWMLService","signature":["validateBasicAuth(username: string, password: string): boolean | Promise<boolean>"],"doc":"Validate provided basic-auth credentials against the configured ones\nusing a constant-time comparison. (Python equivalent:\n``AuthMixin.validate_basic_auth(username, password)``.)","file":"dist/SWMLService.d.ts","line":203},{"name":"toolRegistry","kind":"property","owner":"SWMLService","protected":true,"signature":["protected toolRegistry: Map<string, SwaigFunction | Record<string, unknown>>"],"doc":"","file":"dist/SWMLService.d.ts","line":208},{"name":"constructor","kind":"constructor","owner":"SWMLService","signature":["constructor(opts: SWMLServiceOptions)","constructor(opts?: Partial<SWMLServiceOptions>)"],"doc":"@deprecated Prefer passing an options object with a required `name`. The no-arg form defaults name to 'swml-service'.","file":"dist/SWMLService.d.ts","line":209},{"name":"defineTool","kind":"method","owner":"SWMLService","signature":["defineTool<const P extends ToolParameters = ToolParameters, const R extends readonly PropertyKey[] = []>(opts: Omit<SwaigFunctionOptions, 'parameters' | 'required' | 'handler'> & {\n parameters?: P;\n required?: R;\n handler: (args: ToolArgs<P, R>, rawData: SwaigRequest, agent?: AgentBase) => FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string>;\n}): this"],"doc":"Define a SWAIG function the AI can call. Tool descriptions and\nparameter descriptions are LLM-facing prompt engineering — see\nPORTING_GUIDE for guidance on writing them.\n\nGeneric over the `parameters` schema (`P`) and `required` list (`R`): when\n`parameters` is written as a FLAT inline map (`{ name: { type, … } }`), the\n`const` type parameters capture its literals and the handler's `args` is\ninferred precisely — `args.phone` typed `string`, an `enum` prop narrowed to\nits literal union, `required` keys present and the rest optional (see\n{@link ToolArgs}/{@link InferArgs}). The WRAPPED JSON-Schema object\n(`{ type:'object', properties }`) and a pre-built `Record` are still\naccepted and keep the prior open-record `args` behavior. The args type is a\ncompile-time authoring convenience — at runtime args is the JSON the model\nextracted, so the handler is the ordinary {@link SwaigHandler}.","file":"dist/SWMLService.d.ts","line":228},{"name":"registerSwaigFunction","kind":"method","owner":"SWMLService","signature":["registerSwaigFunction(fn: SwaigFunction | Record<string, unknown>): this"],"doc":"Register a SwaigFunction instance or a raw function descriptor (DataMap).","file":"dist/SWMLService.d.ts","line":234},{"name":"onFunctionCall","kind":"method","owner":"SWMLService","signature":["onFunctionCall(name: string, args: Record<string, unknown>, rawData: SwaigRequest): FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string | void> | void | null | undefined"],"doc":"Dispatch a function call to the registered handler.\nReturns null when the function isn't registered or has no handler.\nSubclasses (AgentBase) override to add session-token validation\nand FunctionResult-shape normalization. Return type is wide enough\nto accommodate the agent override (which may also return void\nshapes for fire-and-forget tool calls).","file":"dist/SWMLService.d.ts","line":243},{"name":"hasTool","kind":"method","owner":"SWMLService","signature":["hasTool(name: string): boolean"],"doc":"Whether a tool with the given name is registered.","file":"dist/SWMLService.d.ts","line":245},{"name":"hasFunction","kind":"method","owner":"SWMLService","signature":["hasFunction(name: string): boolean"],"doc":"Whether a SWAIG function with the given name is registered.\n(Python equivalent: ``ToolRegistry.has_function``.)","file":"dist/SWMLService.d.ts","line":248},{"name":"getFunction","kind":"method","owner":"SWMLService","signature":["getFunction(name: string): SwaigFunction | Record<string, unknown> | undefined"],"doc":"Get a registered SWAIG function entry, or undefined.\n(Python equivalent: ``ToolRegistry.get_function``.)","file":"dist/SWMLService.d.ts","line":251},{"name":"getAllFunctions","kind":"method","owner":"SWMLService","signature":["getAllFunctions(): Record<string, SwaigFunction | Record<string, unknown>>"],"doc":"Snapshot of all registered SWAIG functions keyed by name.\n(Python equivalent: ``ToolRegistry.get_all_functions``.)","file":"dist/SWMLService.d.ts","line":254},{"name":"removeFunction","kind":"method","owner":"SWMLService","signature":["removeFunction(name: string): boolean"],"doc":"Remove a registered SWAIG function. Returns true when removed,\nfalse when not found. (Python equivalent:\n``ToolRegistry.remove_function``.)","file":"dist/SWMLService.d.ts","line":258},{"name":"listToolNames","kind":"method","owner":"SWMLService","signature":["listToolNames(): string[]"],"doc":"List registered tool names in insertion order (Map preserves it).","file":"dist/SWMLService.d.ts","line":260},{"name":"getRegisteredTools","kind":"method","owner":"SWMLService","signature":["getRegisteredTools(): {\n name: string;\n description: string;\n parameters: Record<string, unknown>;\n}[]"],"doc":"Get a summary of all registered tools with their names, descriptions, and\nparameter schemas. Lifted from AgentBase so the swaig-test CLI can list\ntools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG\nhost).\n\n@returns Array of tool descriptors.","file":"dist/SWMLService.d.ts","line":269},{"name":"getTool","kind":"method","owner":"SWMLService","signature":["getTool(name: string): SwaigFunction | undefined"],"doc":"Look up a registered SwaigFunction by name. Lifted from AgentBase so\n`swaig-test --exec <name>` works against a non-AgentBase SWMLService\ntarget.\n\n@param name - The tool name to search for.\n@returns The SwaigFunction instance, or undefined if not found or not a SwaigFunction.","file":"dist/SWMLService.d.ts","line":282},{"name":"swaigPreDispatch","kind":"method","owner":"SWMLService","protected":true,"signature":["protected swaigPreDispatch(_requestData: SwaigRequest, _funcName: string): [SWMLService, unknown]"],"doc":"Extension point: invoked between argument parsing and function dispatch\non POST /swaig. Returns [target, shortCircuit]: when shortCircuit is\nnon-null, it's returned directly without dispatching. AgentBase may\noverride to add session-token validation or ephemeral dynamic-config.","file":"dist/SWMLService.d.ts","line":289},{"name":"registerAdditionalRoutes","kind":"method","owner":"SWMLService","protected":true,"signature":["protected registerAdditionalRoutes(_app: Hono): void"],"doc":"Extension point: register additional Hono routes after SWMLService\nmounts /health, /ready, /swaig, and the main route. AgentBase uses\nthis to add /post_prompt, /check_for_input, /debug_events, /mcp.","file":"dist/SWMLService.d.ts","line":295},{"name":"fullValidationEnabled","kind":"accessor","owner":"SWMLService","signature":["get fullValidationEnabled(): boolean"],"doc":"Check if full JSON Schema validation is enabled.\nMirrors Python's `@property full_validation_enabled`.\n@returns True if schema-based verb validation is active.","file":"dist/SWMLService.d.ts","line":301},{"name":"getBuilder","kind":"method","owner":"SWMLService","signature":["getBuilder(): SwmlBuilder"],"doc":"Get the underlying SwmlBuilder for direct manipulation.\n@returns The SwmlBuilder instance.","file":"dist/SWMLService.d.ts","line":306},{"name":"addVerb","kind":"method","owner":"SWMLService","signature":["addVerb(name: string, config: unknown): this"],"doc":"Add a verb to the SWML document.\n@param name - Verb name (e.g., 'answer', 'play', 'hangup').\n@param config - Verb configuration.\n@returns This service for chaining.","file":"dist/SWMLService.d.ts","line":313},{"name":"addSection","kind":"method","owner":"SWMLService","signature":["addSection(sectionName: string): this"],"doc":"Add a new named section to the SWML document.\nMirrors Python's `add_section()`.\n@param sectionName - Name of the section to create.\n@returns This service for chaining.","file":"dist/SWMLService.d.ts","line":320},{"name":"addVerbToSection","kind":"method","owner":"SWMLService","signature":["addVerbToSection(sectionName: string, verbName: string, config: unknown): this"],"doc":"Add a verb to a specific named section.\nMirrors Python's `add_verb_to_section()`.\n@param sectionName - Target section name (auto-created if missing).\n@param verbName - Verb name.\n@param config - Verb configuration.\n@returns This service for chaining.","file":"dist/SWMLService.d.ts","line":329},{"name":"resetDocument","kind":"method","owner":"SWMLService","signature":["resetDocument(): this"],"doc":"Reset the SWML document to an empty state.\nMirrors Python's `reset_document()`.\n@returns This service for chaining.","file":"dist/SWMLService.d.ts","line":335},{"name":"renderSwml","kind":"method","owner":"SWMLService","signature":["renderSwml(_callId?: string, _modifications?: Record<string, unknown>): Record<string, unknown> | string"],"doc":"Render the SWML document.\n\nSubclass-override-friendly signature: AgentBase overrides this with\n`(callId?: string, modifications?: Record<string, unknown>): string`\nto return a serialized JSON string built from prompts + dynamic config.\nPlain SWMLService returns the in-memory document object.\n\n@returns The SWML document (object) or its serialized form (subclass).","file":"dist/SWMLService.d.ts","line":346},{"name":"getDocument","kind":"method","owner":"SWMLService","signature":["getDocument(): Record<string, unknown>"],"doc":"Get the SWML document as a dictionary. Matches Python's `get_document()`.\n@returns The SWML document.","file":"dist/SWMLService.d.ts","line":351},{"name":"renderDocument","kind":"method","owner":"SWMLService","signature":["renderDocument(): string"],"doc":"Render the SWML document as a JSON string.\nMirrors Python's `render_document()`.\n@returns JSON-encoded SWML document.","file":"dist/SWMLService.d.ts","line":357},{"name":"handleRequest","kind":"method","owner":"SWMLService","signature":["handleRequest(method: string, url: string, headers: Record<string, string>, body?: Record<string, unknown> | null): Promise<[number, Record<string, string>, string]>"],"doc":"Framework-free request-dispatch core.\n\nThe primitive dispatch surface the SDK ports share (mirrors Python's\n`SWMLService.handle_request(method, url, headers, body)` and, e.g., the\ndotnet `(int, Dictionary, string) HandleRequest(...)`). It performs the\nrouting-callback check, `on_request` modification, and basic-auth exactly as\nthe Hono handler path does, but over plain primitives instead of Hono\n`Context`/`Response` objects — so both paths produce identical responses.\n\n@param method HTTP method, e.g. `\"GET\"` or `\"POST\"`.\n@param url The full request URL (used to derive the callback path).\n@param headers Request headers as a plain dict.\n@param body The already-parsed JSON body for POST requests, or `undefined`.\n@returns A `[status, responseHeaders, bodyString]` triple. For a routing\n redirect the status is 307 with a `Location` header and an empty body; an\n auth failure is 401 with `WWW-Authenticate: Basic`; otherwise 200 with the\n SWML document as the body string.","file":"dist/SWMLService.d.ts","line":377},{"name":"registerVerbHandler","kind":"method","owner":"SWMLService","signature":["registerVerbHandler(handler: SWMLVerbHandler): void"],"doc":"Register a custom verb handler.\nMirrors Python's `register_verb_handler()`.\n@param handler - The verb handler to register.","file":"dist/SWMLService.d.ts","line":396},{"name":"registerRoutingCallback","kind":"method","owner":"SWMLService","signature":["registerRoutingCallback(callbackFn: RoutingCallback, path?: string): void"],"doc":"Register a routing callback at a given path.\nWhen a POST request arrives at `path`, the callback is invoked with the\nparsed request body. If it returns a string, the response is a 307 redirect\nto that route; if it returns null, normal SWML serving continues.\nMirrors Python's `register_routing_callback()`.\n\n@param callbackFn - Callback receiving the request body and returning a route or null.\n@param path - HTTP path for the callback (default '/sip').","file":"dist/SWMLService.d.ts","line":407},{"name":"extractSipUsername","kind":"method","owner":"SWMLService","static":true,"signature":["static extractSipUsername(requestBody: SwmlRequestData): string | null"],"doc":"Extract the SIP username from a request body's call.to field.\nMirrors Python's `@staticmethod extract_sip_username()`.\n@param requestBody - The parsed request body containing call information.\n@returns The extracted SIP username, or null if not found.","file":"dist/SWMLService.d.ts","line":422},{"name":"buildSwmlForRequest","kind":"method","owner":"SWMLService","protected":true,"signature":["protected buildSwmlForRequest(_queryParams: Record<string, string>, _bodyParams: Record<string, unknown>, _headers: Record<string, string>, _callbackPath?: string): SwmlBuilder | null"],"doc":"Service-side SWML-builder hook. Subclasses return a `SwmlBuilder`\nto fully replace the document for this request, or `null` to fall\nthrough to `setOnRequestCallback` or the static builder.\n\nThis is distinct from the WebMixin `onRequest(requestData,\ncallbackPath)` hook on AgentBase (which mirrors Python's\n`on_request -> on_swml_request` modification-merge contract).\nUse this hook when you want to swap the entire SWML builder; use\n`onRequest` / `onSwmlRequest` on AgentBase when you want to merge\ntargeted modifications into the rendered document.\n\nDefault implementation returns `null` (no-op).\n\n@param queryParams - URL query parameters from the request.\n@param bodyParams - Parsed POST body (empty object for GET requests).\n@param headers - HTTP request headers.\n@param callbackPath - The callback sub-path being handled, if any.\n@returns A `SwmlBuilder` whose document is sent as the response, or\n `null` to delegate to the next handler in the chain.","file":"dist/SWMLService.d.ts","line":444},{"name":"setOnRequestCallback","kind":"method","owner":"SWMLService","signature":["setOnRequestCallback(cb: OnRequestCallback): this"],"doc":"Set a callback invoked per-request to dynamically build SWML.\nWhen set, the static SwmlBuilder is ignored and the callback's\nreturned SwmlBuilder is used instead.\n@param cb - Callback receiving query params, body params, and headers.\n@returns This service for chaining.","file":"dist/SWMLService.d.ts","line":452},{"name":"getBasicAuthCredentials","kind":"method","owner":"SWMLService","signature":["getBasicAuthCredentials(includeSource?: false): [string, string]","getBasicAuthCredentials(includeSource: true): [string, string, 'provided' | 'environment' | 'config file' | 'generated']"],"doc":"Get the basic-auth credentials used by this service.\nMirrors Python's `get_basic_auth_credentials()`.\n@param includeSource - When true, a third element indicating the credential source is appended.\n@returns A tuple of [username, password] or [username, password, source].","file":"dist/SWMLService.d.ts","line":459},{"name":"manualSetProxyUrl","kind":"method","owner":"SWMLService","signature":["manualSetProxyUrl(url: string): this"],"doc":"Manually set the proxy base URL used for webhook URL generation.\nMirrors Python's `manual_set_proxy_url()`.\n@param url - The external-facing base URL (trailing slashes are stripped).\n@returns This service for chaining.","file":"dist/SWMLService.d.ts","line":467},{"name":"getApp","kind":"method","owner":"SWMLService","signature":["getApp(): Hono"],"doc":"Get the Hono application for mounting or testing.\nThis is the TypeScript equivalent of Python's `as_router()`, which returns\na FastAPI `APIRouter`. Both expose the underlying app/router so callers can\nmount it into a larger framework. Use `asRouter()` when porting Python code\nthat calls `as_router()` directly.\n@returns The configured Hono app.","file":"dist/SWMLService.d.ts","line":476},{"name":"asRouter","kind":"method","owner":"SWMLService","signature":["asRouter(): HostAppRouter"],"doc":"Get a router to embed this service's routes in a host web app.\n\nReturns the fully-wired Hono app as a mountable sub-app; the host mounts it\nwith `hostApp.route(path, service.asRouter())`. This is the TypeScript\nrealization of Python's `as_router()`; the named {@link HostAppRouter} type\nis the cross-port \"embed my routes in a host app\" contract.\n\n@returns A mountable Hono sub-app carrying this service's routes.","file":"dist/SWMLService.d.ts","line":487},{"name":"serve","kind":"method","owner":"SWMLService","signature":["serve(hostOrOpts?: string | {\n host?: string;\n port?: number;\n sslCert?: string;\n sslKey?: string;\n sslEnabled?: boolean;\n domain?: string;\n}, port?: number, opts?: {\n sslCert?: string;\n sslKey?: string;\n sslEnabled?: boolean;\n domain?: string;\n}): Promise<void>"],"doc":"Start the HTTP server. Canonical entrypoint, matching Python's\n`SWMLService.serve()`.\n\nMatches Python's `serve()` parameters including SSL options. When\n`SWAIG_CLI_MODE=true` is set in the environment (e.g. while running the\n`swaig-test` CLI) the call is a no-op.\n\n@param hostOrOpts - Hostname, or an options object. Defaults to `this.host`\n (constructor value) or `'0.0.0.0'`.\n@param port - Port. Defaults to `this.port` (constructor value) or `3000`.\n@param opts - Optional SSL/TLS configuration overrides.\n@param opts.sslCert - Path to the PEM certificate file.\n@param opts.sslKey - Path to the PEM private key file.\n@param opts.sslEnabled - When `true`, serve over HTTPS.\n@param opts.domain - Domain used for HSTS header configuration.\n@returns Resolves once the server has begun listening.","file":"dist/SWMLService.d.ts","line":506},{"name":"stop","kind":"method","owner":"SWMLService","signature":["stop(): void"],"doc":"Stop the HTTP server.\nMirrors Python's `stop()`.","file":"dist/SWMLService.d.ts","line":523}]},"SWMLServiceOptions":{"name":"SWMLServiceOptions","kind":"interface","exported":true,"signature":["interface SWMLServiceOptions"],"doc":"Configuration options for SWMLService.","file":"dist/SWMLService.d.ts","line":137,"members":[{"name":"name","kind":"property","owner":"SWMLServiceOptions","signature":["name: string"],"doc":"Service display name.\nRequired to match Python SDK where `name` is a positional required parameter.","file":"dist/SWMLService.d.ts","line":142},{"name":"route","kind":"property","owner":"SWMLServiceOptions","signature":["route?: string"],"doc":"HTTP route path (default '/').","file":"dist/SWMLService.d.ts","line":144},{"name":"host","kind":"property","owner":"SWMLServiceOptions","signature":["host?: string"],"doc":"Host to bind the web server to (default '0.0.0.0').","file":"dist/SWMLService.d.ts","line":146},{"name":"port","kind":"property","owner":"SWMLServiceOptions","signature":["port?: number"],"doc":"Port to bind the web server to (default PORT env var or 3000).","file":"dist/SWMLService.d.ts","line":148},{"name":"basicAuth","kind":"property","owner":"SWMLServiceOptions","signature":["basicAuth?: [string, string]"],"doc":"Basic auth credentials as [username, password].","file":"dist/SWMLService.d.ts","line":150},{"name":"schemaPath","kind":"property","owner":"SWMLServiceOptions","signature":["schemaPath?: string"],"doc":"Path to a JSON Schema file for verb validation.","file":"dist/SWMLService.d.ts","line":152},{"name":"configFile","kind":"property","owner":"SWMLServiceOptions","signature":["configFile?: string"],"doc":"Path to a security configuration file.","file":"dist/SWMLService.d.ts","line":154},{"name":"schemaValidation","kind":"property","owner":"SWMLServiceOptions","signature":["schemaValidation?: boolean"],"doc":"Enable schema validation (default true). Can also be disabled via SWML_SKIP_SCHEMA_VALIDATION=true.","file":"dist/SWMLService.d.ts","line":156}]},"SWMLVerbHandler":{"name":"SWMLVerbHandler","kind":"class","exported":true,"signature":["abstract class SWMLVerbHandler"],"doc":"Abstract base class for pluggable SWML verb handlers.\n\nEach concrete handler owns one verb name and provides validate/build\nlogic for that verb's configuration. Subclass this to create handlers\nfor custom or complex SWML verbs that require specialized handling\nbeyond generic schema-driven validation.\n\n@example\n```ts\nclass MyVerbHandler extends SWMLVerbHandler {\n getVerbName(): string { return 'my_verb'; }\n validateConfig(config: Record<string, unknown>): [boolean, string[]] {\n const errors: string[] = [];\n if (!config['url']) errors.push(\"Missing required field 'url'\");\n return [errors.length === 0, errors];\n }\n buildConfig(opts: Record<string, unknown>): Record<string, unknown> {\n return { url: opts['url'] };\n }\n}\n```","file":"dist/SWMLHandler.d.ts","line":42,"members":[{"name":"getVerbName","kind":"method","owner":"SWMLVerbHandler","signature":["abstract getVerbName(): string"],"doc":"Get the name of the SWML verb this handler handles.\n@returns The verb name as a string (e.g. \"ai\", \"play\").","file":"dist/SWMLHandler.d.ts","line":47},{"name":"validateConfig","kind":"method","owner":"SWMLVerbHandler","signature":["abstract validateConfig(config: Record<string, unknown>): [boolean, string[]]"],"doc":"Validate the configuration for this verb.\n@param config - The configuration dictionary for this verb.\n@returns A `[isValid, errorMessages]` tuple where `isValid` is `true`\n when the config is valid and `errorMessages` lists any issues found.","file":"dist/SWMLHandler.d.ts","line":54},{"name":"buildConfig","kind":"method","owner":"SWMLVerbHandler","signature":["abstract buildConfig(opts: Record<string, unknown>): Record<string, unknown>"],"doc":"Build a configuration object for this verb from the provided arguments.\n@param opts - Key-value arguments specific to this verb.\n@returns A configuration dictionary ready for inclusion in a SWML document.","file":"dist/SWMLHandler.d.ts","line":60}]},"SchemaUtils":{"name":"SchemaUtils","kind":"class","exported":true,"signature":["class SchemaUtils"],"doc":"Validates SWML documents against structural rules with an LRU-style result cache.","file":"dist/SchemaUtils.d.ts","line":48,"members":[{"name":"constructor","kind":"constructor","owner":"SchemaUtils","signature":["constructor(opts?: {\n skipValidation?: boolean;\n maxCacheSize?: number;\n schemaPath?: string;\n})"],"doc":"Create a SchemaUtils instance.\n@param opts - Optional settings for skipping validation, limiting cache size, or overriding the schema file path.","file":"dist/SchemaUtils.d.ts","line":70},{"name":"schemaPath","kind":"accessor","owner":"SchemaUtils","signature":["get schemaPath(): string | null"],"doc":"The schema file path in effect — the reference's public `self.schema_path`\n(`utils/schema_utils.py:69`), or `null` when the bundled schema is in use.\n\nA caller who passes `schemaPath` at construction can read back which schema the\ninstance actually resolved. The reference additionally rewrites the attribute to\nthe resolved DEFAULT path when none was supplied (line 71); TS keeps `null` for\n\"bundled\", which is the same information without hardcoding a filesystem path\ninto the surface — the bundled schema is imported, not read from disk.","file":"dist/SchemaUtils.d.ts","line":85},{"name":"loadSchema","kind":"method","owner":"SchemaUtils","signature":["loadSchema(): Record<string, unknown> | null"],"doc":"Load the schema from the path specified in opts.schemaPath (if given) or fall back\nto the bundled schema.json. Mirrors Python's SchemaUtils which accepts an explicit\nschema_path and falls back to _get_default_schema_path() when None is supplied.\nPublic accessor matching Python SDK's `load_schema()`, which returns the loaded\nschema dictionary (or `null` if unavailable). Also (re)populates the internal\nverb definitions as a side effect.\n@returns The loaded schema object, or `null` if it could not be loaded.","file":"dist/SchemaUtils.d.ts","line":95},{"name":"fullValidationAvailable","kind":"accessor","owner":"SchemaUtils","signature":["get fullValidationAvailable(): boolean"],"doc":"Whether full JSON-Schema validation is available. Mirrors Python SDK's\n`full_validation_available` property (which reports whether `jsonschema` is\ninstalled). This SDK always bundles Ajv, so full validation is always\navailable — this is constantly `true`.","file":"dist/SchemaUtils.d.ts","line":107},{"name":"getVerbNames","kind":"method","owner":"SchemaUtils","signature":["getVerbNames(): string[]"],"doc":"Get all verb names defined in the schema.\n@returns Array of verb names (e.g. [\"answer\", \"ai\", \"hangup\", ...]).","file":"dist/SchemaUtils.d.ts","line":112},{"name":"getVerbProperties","kind":"method","owner":"SchemaUtils","signature":["getVerbProperties(verbName: string): Record<string, unknown>"],"doc":"Get the inner properties schema for a specific verb.\nFor example, for \"hangup\" this returns `{ type: \"object\", properties: { reason: ... }, ... }`.\n@param verbName - The verb name (e.g. \"answer\", \"tap\").\n@returns The inner schema definition or an empty object if not found.","file":"dist/SchemaUtils.d.ts","line":119},{"name":"getVerbParameters","kind":"method","owner":"SchemaUtils","signature":["getVerbParameters(verbName: string): Record<string, unknown>"],"doc":"Get the parameter definitions for a specific verb — the map of parameter\nname → JSON-schema definition. Mirrors Python SDK's `get_verb_parameters()`:\nit returns the nested `properties` object of the verb's inner schema (whereas\n`getVerbProperties` returns the whole inner schema object).\n@param verbName - The verb name (e.g. \"ai\", \"answer\").\n@returns Dictionary mapping parameter names to their definitions, or `{}`.","file":"dist/SchemaUtils.d.ts","line":128},{"name":"getVerbRequiredProperties","kind":"method","owner":"SchemaUtils","signature":["getVerbRequiredProperties(verbName: string): string[]"],"doc":"Get the required properties for a verb's inner config.\n@param verbName - The verb name.\n@returns Array of required property names.","file":"dist/SchemaUtils.d.ts","line":134},{"name":"getVerbDescription","kind":"method","owner":"SchemaUtils","signature":["getVerbDescription(verbName: string): string"],"doc":"Get the description text for a verb.\n@param verbName - The verb name.\n@returns The description string or empty string.","file":"dist/SchemaUtils.d.ts","line":140},{"name":"hasVerb","kind":"method","owner":"SchemaUtils","signature":["hasVerb(verbName: string): boolean"],"doc":"Check if a verb name is defined in the schema.\n@param verbName - The verb name.\n@returns True if the verb exists.","file":"dist/SchemaUtils.d.ts","line":146},{"name":"validateVerb","kind":"method","owner":"SchemaUtils","signature":["validateVerb(verbName: string, config: unknown): ValidationResult"],"doc":"Lightweight validation of a verb config against the schema.\nChecks that the verb exists and required properties are present.\nMirrors Python SDK's `_validate_verb_lightweight()`.\n\n@param verbName - The verb name.\n@param config - The verb configuration to validate.\n@returns Validation result.","file":"dist/SchemaUtils.d.ts","line":156},{"name":"validate","kind":"method","owner":"SchemaUtils","signature":["validate(swml: string | Record<string, unknown>): ValidationResult"],"doc":"Validate a SWML document against structural rules.\n@param swml - The SWML document as a JSON string or parsed object.\n@returns The validation result indicating success or a list of errors.","file":"dist/SchemaUtils.d.ts","line":211},{"name":"clearCache","kind":"method","owner":"SchemaUtils","signature":["clearCache(): void"],"doc":"Clear the validation cache","file":"dist/SchemaUtils.d.ts","line":214},{"name":"getCacheSize","kind":"method","owner":"SchemaUtils","signature":["getCacheSize(): number"],"doc":"Get the number of cached validation results.\n@returns The current cache entry count.","file":"dist/SchemaUtils.d.ts","line":219}]},"SchemaValidationError":{"name":"SchemaValidationError","kind":"class","exported":true,"signature":["class SchemaValidationError extends Error"],"doc":"Thrown when schema validation of a SWML verb config fails.\n\nMirrors the reference `signalwire.utils.schema_utils.SchemaValidationError`\n(`SchemaValidationError(verb_name, errors)`, `utils/schema_utils.py:25`) and the\nsame class in java / cpp / dotnet / ruby.\n\nBoth construction arguments are readable back, so a caller can branch on WHICH\nverb failed and enumerate the individual messages programmatically. Previously\n`addVerb` threw a bare `Error` whose only content was a joined string, which meant\nneither piece was recoverable without parsing the message text.","file":"dist/SchemaUtils.d.ts","line":27,"members":[{"name":"verbName","kind":"property","owner":"SchemaValidationError","readonly":true,"signature":["readonly verbName: string"],"doc":"The verb whose config failed validation.","file":"dist/SchemaUtils.d.ts","line":29},{"name":"errors","kind":"property","owner":"SchemaValidationError","readonly":true,"signature":["readonly errors: readonly string[]"],"doc":"The individual human-readable validation error messages.","file":"dist/SchemaUtils.d.ts","line":31},{"name":"constructor","kind":"constructor","owner":"SchemaValidationError","signature":["constructor(verbName: string, errors: string[])"],"doc":"@param verbName - The verb whose config failed validation.\n@param errors - The individual validation error messages.","file":"dist/SchemaUtils.d.ts","line":36}],"bases":["Error"]},"Section":{"name":"Section","kind":"class","exported":true,"signature":["class Section"],"doc":"A section in the Prompt Object Model.\n\nEach section contains a title, optional body text, optional bullet points,\nand can have any number of nested subsections.","file":"dist/POM/PromptObjectModel.d.ts","line":30,"members":[{"name":"title","kind":"property","owner":"Section","signature":["title: string | null"],"doc":"The name of the section.","file":"dist/POM/PromptObjectModel.d.ts","line":32},{"name":"body","kind":"property","owner":"Section","signature":["body: string"],"doc":"A paragraph of text associated with the section.","file":"dist/POM/PromptObjectModel.d.ts","line":34},{"name":"bullets","kind":"property","owner":"Section","signature":["bullets: string[]"],"doc":"Bullet-pointed items.","file":"dist/POM/PromptObjectModel.d.ts","line":36},{"name":"subsections","kind":"property","owner":"Section","signature":["subsections: Section[]"],"doc":"Nested sections with the same structure.","file":"dist/POM/PromptObjectModel.d.ts","line":38},{"name":"numbered","kind":"property","owner":"Section","signature":["numbered: boolean | null"],"doc":"Whether this section should be numbered.","file":"dist/POM/PromptObjectModel.d.ts","line":40},{"name":"numberedBullets","kind":"property","owner":"Section","signature":["numberedBullets: boolean"],"doc":"Whether bullets should be numbered instead of using bullet points.","file":"dist/POM/PromptObjectModel.d.ts","line":42},{"name":"constructor","kind":"constructor","owner":"Section","signature":["constructor(title?: string | null, opts?: {\n body?: string;\n bullets?: string[] | null;\n numbered?: boolean | null;\n numberedBullets?: boolean;\n})"],"doc":"@param title Section title (null permitted only on the very first top-level section).\n@param opts Keyword-style options matching Python's `body=`/`bullets=`/`numbered=`/`numberedBullets=`.","file":"dist/POM/PromptObjectModel.d.ts","line":47},{"name":"addBody","kind":"method","owner":"Section","signature":["addBody(body: string): void"],"doc":"Add or replace the body text for this section.","file":"dist/POM/PromptObjectModel.d.ts","line":54},{"name":"addBullets","kind":"method","owner":"Section","signature":["addBullets(bullets: string[]): void"],"doc":"Add bullet points to this section (extends the existing list).","file":"dist/POM/PromptObjectModel.d.ts","line":56},{"name":"addSubsection","kind":"method","owner":"Section","signature":["addSubsection(title: string, opts?: {\n body?: string;\n bullets?: string[] | null;\n numbered?: boolean;\n numberedBullets?: boolean;\n}): Section"],"doc":"Add a subsection to this section.\n\n@param title The title of the subsection (required — subsections must have a title).\n@param opts Optional body / bullets / numbering for the subsection.\n@returns The newly created Section.","file":"dist/POM/PromptObjectModel.d.ts","line":64},{"name":"toDict","kind":"method","owner":"Section","signature":["toDict(): SectionData"],"doc":"Convert the section to a dictionary representation.","file":"dist/POM/PromptObjectModel.d.ts","line":71},{"name":"toJSON","kind":"method","owner":"Section","signature":["toJSON(): SectionData"],"doc":"TS-native serialization hook so `JSON.stringify` emits the wire shape via\n{@link Section.toDict}. No Python counterpart.","file":"dist/POM/PromptObjectModel.d.ts","line":76},{"name":"renderMarkdown","kind":"method","owner":"Section","signature":["renderMarkdown(level?: number, sectionNumber?: number[] | null): string"],"doc":"Render this section and all its subsections as markdown.\n\n@param level The heading level to start with (default 2 = `##`).\n@param sectionNumber The current section number for numbered sections.","file":"dist/POM/PromptObjectModel.d.ts","line":83},{"name":"renderXml","kind":"method","owner":"Section","signature":["renderXml(indent?: number, sectionNumber?: number[] | null): string"],"doc":"Render this section and all its subsections as XML.\n\n@param indent The indentation level to start with (default 0).\n@param sectionNumber The current section number for numbered sections.","file":"dist/POM/PromptObjectModel.d.ts","line":90}]},"SectionData":{"name":"SectionData","kind":"interface","exported":true,"signature":["interface SectionData"],"doc":"Plain serializable representation of a section, used for JSON/YAML and `to_dict()` exchange.","file":"dist/POM/PromptObjectModel.d.ts","line":16,"members":[{"name":"title","kind":"property","owner":"SectionData","signature":["title?: string"],"doc":"","file":"dist/POM/PromptObjectModel.d.ts","line":17},{"name":"body","kind":"property","owner":"SectionData","signature":["body?: string"],"doc":"","file":"dist/POM/PromptObjectModel.d.ts","line":18},{"name":"bullets","kind":"property","owner":"SectionData","signature":["bullets?: string[]"],"doc":"","file":"dist/POM/PromptObjectModel.d.ts","line":19},{"name":"subsections","kind":"property","owner":"SectionData","signature":["subsections?: SectionData[]"],"doc":"","file":"dist/POM/PromptObjectModel.d.ts","line":20},{"name":"numbered","kind":"property","owner":"SectionData","signature":["numbered?: boolean"],"doc":"","file":"dist/POM/PromptObjectModel.d.ts","line":21},{"name":"numberedBullets","kind":"property","owner":"SectionData","signature":["numberedBullets?: boolean"],"doc":"","file":"dist/POM/PromptObjectModel.d.ts","line":22}]},"SecurityConfig":{"name":"SecurityConfig","kind":"class","exported":true,"signature":["class SecurityConfig"],"doc":"Unified security configuration.\nMirrors Python SDK's `SecurityConfig` — reads from env vars and optional config file.","file":"dist/SWMLService.d.ts","line":49,"members":[{"name":"sslEnabled","kind":"property","owner":"SecurityConfig","signature":["sslEnabled: boolean"],"doc":"Whether SSL is enabled.","file":"dist/SWMLService.d.ts","line":51},{"name":"sslCertPath","kind":"property","owner":"SecurityConfig","signature":["sslCertPath: string | null"],"doc":"Filesystem path to the PEM certificate.","file":"dist/SWMLService.d.ts","line":53},{"name":"sslKeyPath","kind":"property","owner":"SecurityConfig","signature":["sslKeyPath: string | null"],"doc":"Filesystem path to the PEM private key.","file":"dist/SWMLService.d.ts","line":55},{"name":"domain","kind":"property","owner":"SecurityConfig","signature":["domain: string | null"],"doc":"Domain name for SSL.","file":"dist/SWMLService.d.ts","line":57},{"name":"basicAuthUser","kind":"property","owner":"SecurityConfig","signature":["basicAuthUser: string | null"],"doc":"Basic auth username from config, or null.","file":"dist/SWMLService.d.ts","line":59},{"name":"basicAuthPassword","kind":"property","owner":"SecurityConfig","signature":["basicAuthPassword: string | null"],"doc":"Basic auth password from config, or null.","file":"dist/SWMLService.d.ts","line":61},{"name":"basicAuthSource","kind":"property","owner":"SecurityConfig","signature":["basicAuthSource: 'environment' | 'config file' | null"],"doc":"Where {@link basicAuthPassword} came from: `'environment'`\n(`SWML_BASIC_AUTH_PASSWORD`), `'config file'` (which takes precedence), or\n`null` when neither set one.","file":"dist/SWMLService.d.ts","line":67},{"name":"allowedHosts","kind":"property","owner":"SecurityConfig","signature":["allowedHosts: string[]"],"doc":"Allowed request hosts (`['*']` = allow all).","file":"dist/SWMLService.d.ts","line":69},{"name":"corsOrigins","kind":"property","owner":"SecurityConfig","signature":["corsOrigins: string[]"],"doc":"Allowed CORS origins.","file":"dist/SWMLService.d.ts","line":71},{"name":"useHsts","kind":"property","owner":"SecurityConfig","signature":["useHsts: boolean"],"doc":"Whether to emit an HSTS header on HTTPS responses.","file":"dist/SWMLService.d.ts","line":73},{"name":"hstsMaxAge","kind":"property","owner":"SecurityConfig","signature":["hstsMaxAge: number"],"doc":"HSTS `max-age` in seconds.","file":"dist/SWMLService.d.ts","line":75},{"name":"constructor","kind":"constructor","owner":"SecurityConfig","signature":["constructor(opts?: {\n configFile?: string;\n serviceName?: string;\n})"],"doc":"","file":"dist/SWMLService.d.ts","line":77},{"name":"loadFromEnv","kind":"method","owner":"SecurityConfig","signature":["loadFromEnv(): void"],"doc":"(Re)load host/CORS/HSTS settings from environment variables. Mirrors Python\nSDK's `SecurityConfig.load_from_env()`. SSL/auth are loaded in the constructor\nfrom their own env vars; this refreshes the network-policy fields.","file":"dist/SWMLService.d.ts","line":88},{"name":"getBasicAuth","kind":"method","owner":"SecurityConfig","signature":["getBasicAuth(): [string, string] | null"],"doc":"Get basic auth credentials from the config file or environment, or null\nwhen no password is configured. The user defaults to `signalwire`.","file":"dist/SWMLService.d.ts","line":94},{"name":"validateSslConfig","kind":"method","owner":"SecurityConfig","signature":["validateSslConfig(): [boolean, string | null]"],"doc":"Validate that SSL cert and key files are present when SSL is enabled.","file":"dist/SWMLService.d.ts","line":96},{"name":"getSslContextKwargs","kind":"method","owner":"SecurityConfig","signature":["getSslContextKwargs(): Record<string, string>"],"doc":"Build the SSL parameters for the HTTPS server, as a plain dictionary of\nprimitive filesystem paths. Mirrors Python's\n`SecurityConfig.get_ssl_context_kwargs()` verbatim: the reference targets\nuvicorn's `ssl_certfile`/`ssl_keyfile` kwargs, and this returns the exact\nsame primitive path pair (the TS HTTPS server passes them to\n`node:https.createServer` / `readFileSync`). Returns an empty object when\nSSL is disabled or the cert/key files fail validation.\n@returns `{ ssl_certfile, ssl_keyfile }` path strings, or `{}` when unavailable.","file":"dist/SWMLService.d.ts","line":107},{"name":"getUrlScheme","kind":"method","owner":"SecurityConfig","signature":["getUrlScheme(): string"],"doc":"Get the URL scheme based on SSL configuration. Mirrors Python's `get_url_scheme()`.","file":"dist/SWMLService.d.ts","line":109},{"name":"shouldAllowHost","kind":"method","owner":"SecurityConfig","signature":["shouldAllowHost(host: string): boolean"],"doc":"Check whether a host is allowed. Mirrors Python's `should_allow_host()`:\na wildcard `*` in the allow-list permits any host.","file":"dist/SWMLService.d.ts","line":114},{"name":"getCorsConfig","kind":"method","owner":"SecurityConfig","signature":["getCorsConfig(): Record<string, unknown>"],"doc":"Get CORS configuration. Mirrors Python's `get_cors_config()`.\n@returns An object of CORS settings (origins, credentials, methods, headers).","file":"dist/SWMLService.d.ts","line":119},{"name":"getSecurityHeaders","kind":"method","owner":"SecurityConfig","signature":["getSecurityHeaders(isHttps?: boolean): Record<string, string>"],"doc":"Get the security headers to add to responses. Mirrors Python's\n`get_security_headers()`; adds an HSTS header when the request is HTTPS and\nHSTS is enabled.\n@param isHttps - Whether the connection is over HTTPS.","file":"dist/SWMLService.d.ts","line":126},{"name":"logConfig","kind":"method","owner":"SecurityConfig","signature":["logConfig(serviceName: string): void"],"doc":"Log the current security configuration. Mirrors Python's `log_config()`.\n@param serviceName - The service name to tag the log line with.","file":"dist/SWMLService.d.ts","line":131}]},"SendDigitsEvent":{"name":"SendDigitsEvent","kind":"class","exported":true,"signature":["class SendDigitsEvent extends RelayEvent"],"doc":"`calling.call.send_digits` — progress update for DTMF digits sent out on a call.","file":"dist/relay/RelayEvent.d.ts","line":144,"members":[{"name":"controlId","kind":"property","owner":"SendDigitsEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":145},{"name":"state","kind":"property","owner":"SendDigitsEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":146},{"name":"constructor","kind":"constructor","owner":"SendDigitsEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":147},{"name":"fromPayload","kind":"method","owner":"SendDigitsEvent","static":true,"signature":["static fromPayload(payload: EventPayload): SendDigitsEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":148}],"bases":["RelayEvent"]},"SendMessage":{"name":"SendMessage","kind":"type","exported":true,"signature":["type SendMessage = (callId: string, text: string) => boolean | Promise<boolean>"],"doc":"Delivers typed text into a live call as if the caller said it: `sendMessage(callId, text)`.","file":"dist/ai-chat/HandoffRouter.d.ts","line":105},"SendMessageOptions":{"name":"SendMessageOptions","kind":"interface","exported":true,"signature":["interface SendMessageOptions"],"doc":"Options for `RelayClient.sendMessage()`.","file":"dist/relay/types.d.ts","line":113,"members":[{"name":"toNumber","kind":"property","owner":"SendMessageOptions","signature":["toNumber: string"],"doc":"Destination phone number in E.164 format.","file":"dist/relay/types.d.ts","line":115},{"name":"fromNumber","kind":"property","owner":"SendMessageOptions","signature":["fromNumber: string"],"doc":"Sender phone number in E.164 format.","file":"dist/relay/types.d.ts","line":117},{"name":"context","kind":"property","owner":"SendMessageOptions","signature":["context?: string"],"doc":"Context for receiving state events. Defaults to the negotiated relay\nprotocol.","file":"dist/relay/types.d.ts","line":122},{"name":"body","kind":"property","owner":"SendMessageOptions","signature":["body?: string"],"doc":"Message body text. At least one of `body` or `media` is required.","file":"dist/relay/types.d.ts","line":124},{"name":"media","kind":"property","owner":"SendMessageOptions","signature":["media?: string[]"],"doc":"Media URLs for MMS. At least one of `body` or `media` is required.","file":"dist/relay/types.d.ts","line":126},{"name":"tags","kind":"property","owner":"SendMessageOptions","signature":["tags?: string[]"],"doc":"Tags attached to the message for correlation.","file":"dist/relay/types.d.ts","line":128},{"name":"region","kind":"property","owner":"SendMessageOptions","signature":["region?: string"],"doc":"Origination region override.","file":"dist/relay/types.d.ts","line":130},{"name":"onCompleted","kind":"property","owner":"SendMessageOptions","signature":["onCompleted?: CompletedCallback"],"doc":"Callback fired once when the message reaches a terminal state\n(`delivered`, `undelivered` or `failed`).","file":"dist/relay/types.d.ts","line":135}]},"ServerlessAdapter":{"name":"ServerlessAdapter","kind":"class","exported":true,"signature":["class ServerlessAdapter"],"doc":"Adapts a Hono application for deployment on AWS Lambda, Google Cloud Functions, Azure Functions, or CGI.\n\nAccepts the provider's native event shape (`APIGatewayProxyEvent`, Google Functions `Request`,\nAzure function arguments, CGI env + stdin) and returns a provider-native response.\n\n@example AWS Lambda handler\n```ts\nimport { AgentBase, ServerlessAdapter } from '@signalwire/sdk';\n\nconst agent = new AgentBase({ name: 'lambda', route: '/' });\nagent.setPromptText('You are a helpful assistant.');\n\nconst adapter = new ServerlessAdapter('lambda');\n\nexport const handler = async (event: any) => {\n return adapter.handleRequest(agent.asRouter(), event);\n};\n```","file":"dist/ServerlessAdapter.d.ts","line":134,"members":[{"name":"constructor","kind":"constructor","owner":"ServerlessAdapter","signature":["constructor(platform?: ServerlessPlatform)"],"doc":"Create a ServerlessAdapter for the given platform.\n@param platform - Target platform; defaults to 'auto' which detects from environment variables.","file":"dist/ServerlessAdapter.d.ts","line":140},{"name":"detectPlatform","kind":"method","owner":"ServerlessAdapter","signature":["detectPlatform(): ServerlessPlatform"],"doc":"Detect the serverless platform by inspecting well-known environment variables.\n@returns The detected platform identifier; defaults to 'lambda' if no match is found.","file":"dist/ServerlessAdapter.d.ts","line":145},{"name":"getPlatform","kind":"method","owner":"ServerlessAdapter","signature":["getPlatform(): ServerlessPlatform"],"doc":"Get the resolved platform identifier.\n@returns The serverless platform this adapter is configured for.","file":"dist/ServerlessAdapter.d.ts","line":150},{"name":"handleRequest","kind":"method","owner":"ServerlessAdapter","signature":["handleRequest(app: {\n fetch: (req: Request, env?: Record<string, unknown>) => Response | Promise<Response>;\n}, event: ServerlessEvent): Promise<ServerlessResponse>"],"doc":"Convert a serverless event into a standard Request, route it through the Hono app, and return a normalized response.\n\nThe app also receives, in its `env`, the URL the platform was called on,\nso a webhook signature is checked against the URL SignalWire signed: with\nan API Gateway stage or other platform prefix, and the query as the\nplatform received it (for API Gateway REST, which decodes the query, both\ncommon encodings are tried).\n\n@param app - A Hono-compatible application with a `fetch` method.\n@param event - The incoming serverless event to process.\n@returns The normalized serverless response.","file":"dist/ServerlessAdapter.d.ts","line":164},{"name":"generateUrl","kind":"method","owner":"ServerlessAdapter","signature":["generateUrl(opts?: {\n region?: string;\n projectId?: string;\n functionName?: string;\n stage?: string;\n apiId?: string;\n}): string"],"doc":"Generate the platform-specific invocation URL for a deployed function.\n@param opts - Optional overrides for region, project, function name, stage, or API ID.\n@returns The constructed URL string.","file":"dist/ServerlessAdapter.d.ts","line":179},{"name":"createLambdaHandler","kind":"method","owner":"ServerlessAdapter","static":true,"signature":["static createLambdaHandler(app: {\n fetch: (req: Request, env?: Record<string, unknown>) => Response | Promise<Response>;\n}): (event: ServerlessEvent) => Promise<ServerlessResponse>"],"doc":"Create an AWS Lambda-compatible handler function from a Hono app.\n@param app - A Hono-compatible application with a `fetch` method.\n@returns A function that accepts a Lambda event and returns a promise of a serverless response.","file":"dist/ServerlessAdapter.d.ts","line":191},{"name":"createGcfHandler","kind":"method","owner":"ServerlessAdapter","static":true,"signature":["static createGcfHandler(app: {\n fetch: (req: Request, env?: Record<string, unknown>) => Response | Promise<Response>;\n}): (req: GcfRequest, res: GcfResponse) => Promise<void>"],"doc":"Create a Google Cloud Functions-compatible handler from a Hono app.\n@param app - A Hono-compatible application with a `fetch` method.\n@returns A function that accepts GCF request/response objects.","file":"dist/ServerlessAdapter.d.ts","line":199},{"name":"MAX_CGI_BODY_SIZE","kind":"property","owner":"ServerlessAdapter","static":true,"readonly":true,"signature":["static readonly MAX_CGI_BODY_SIZE: number"],"doc":"Maximum CGI request body size (10MB), matching Python's `MAX_CGI_BODY_SIZE`.","file":"dist/ServerlessAdapter.d.ts","line":221},{"name":"buildCgiEvent","kind":"method","owner":"ServerlessAdapter","static":true,"signature":["static buildCgiEvent(env?: NodeJS.ProcessEnv, body?: string): ServerlessEvent"],"doc":"Build a {@link ServerlessEvent} from a CGI environment + request body.\n\nCGI has no \"event\" object: the request is described by environment variables\n(`REQUEST_METHOD`, `PATH_INFO`, `QUERY_STRING`, `CONTENT_TYPE`, `HTTP_*`) and\nthe body arrives on stdin. This reconstructs the normalized event so a CGI\ninvocation dispatches through the same Hono routing as Lambda/GCF/Azure\n(mirrors Python `serverless_mixin` CGI mode: `PATH_INFO` + stdin body).\n\n@param env - The process environment (defaults to `process.env`).\n@param body - The already-read request body from stdin (optional).\n@returns A normalized serverless event.","file":"dist/ServerlessAdapter.d.ts","line":235},{"name":"createCgiHandler","kind":"method","owner":"ServerlessAdapter","static":true,"signature":["static createCgiHandler(app: {\n fetch: (req: Request, env?: Record<string, unknown>) => Response | Promise<Response>;\n}): () => Promise<void>"],"doc":"Create a CGI handler that reads the request from the CGI environment + stdin,\nroutes it through the Hono app, and writes a CGI response (status line,\nheaders, blank line, body) to stdout.\n\n@param app - A Hono-compatible application with a `fetch` method.\n@returns An async function that performs one CGI request/response cycle.","file":"dist/ServerlessAdapter.d.ts","line":244},{"name":"createAzureHandler","kind":"method","owner":"ServerlessAdapter","static":true,"signature":["static createAzureHandler(app: {\n fetch: (req: Request, env?: Record<string, unknown>) => Response | Promise<Response>;\n}): (context: AzureContext, req: AzureRequest) => Promise<void>"],"doc":"Create an Azure Functions-compatible handler from a Hono app.\n@param app - A Hono-compatible application with a `fetch` method.\n@returns A function that accepts an Azure context and request object.","file":"dist/ServerlessAdapter.d.ts","line":264}]},"ServerlessEvent":{"name":"ServerlessEvent","kind":"interface","exported":true,"signature":["interface ServerlessEvent"],"doc":"Normalized incoming event from a serverless platform.","file":"dist/ServerlessAdapter.d.ts","line":10,"members":[{"name":"httpMethod","kind":"property","owner":"ServerlessEvent","signature":["httpMethod?: string"],"doc":"HTTP method (AWS Lambda style).","file":"dist/ServerlessAdapter.d.ts","line":12},{"name":"method","kind":"property","owner":"ServerlessEvent","signature":["method?: string"],"doc":"HTTP method (GCF/Azure style).","file":"dist/ServerlessAdapter.d.ts","line":14},{"name":"headers","kind":"property","owner":"ServerlessEvent","signature":["headers?: Record<string, string>"],"doc":"Request headers as key-value pairs.","file":"dist/ServerlessAdapter.d.ts","line":16},{"name":"body","kind":"property","owner":"ServerlessEvent","signature":["body?: string | Record<string, unknown>"],"doc":"Request body, either raw JSON string or parsed object.","file":"dist/ServerlessAdapter.d.ts","line":18},{"name":"isBase64Encoded","kind":"property","owner":"ServerlessEvent","signature":["isBase64Encoded?: boolean"],"doc":"When true, `body` is base64-encoded (AWS API Gateway proxy integration).","file":"dist/ServerlessAdapter.d.ts","line":20},{"name":"path","kind":"property","owner":"ServerlessEvent","signature":["path?: string"],"doc":"Request path.","file":"dist/ServerlessAdapter.d.ts","line":22},{"name":"rawPath","kind":"property","owner":"ServerlessEvent","signature":["rawPath?: string"],"doc":"Raw request path (AWS API Gateway v2).","file":"dist/ServerlessAdapter.d.ts","line":24},{"name":"queryStringParameters","kind":"property","owner":"ServerlessEvent","signature":["queryStringParameters?: Record<string, string>"],"doc":"Query string parameters as key-value pairs.","file":"dist/ServerlessAdapter.d.ts","line":26},{"name":"multiValueQueryStringParameters","kind":"property","owner":"ServerlessEvent","signature":["multiValueQueryStringParameters?: Record<string, string[]>"],"doc":"Repeated query parameters (AWS API Gateway REST).","file":"dist/ServerlessAdapter.d.ts","line":28},{"name":"rawQueryString","kind":"property","owner":"ServerlessEvent","signature":["rawQueryString?: string"],"doc":"The raw, still-encoded query string (AWS API Gateway v2 and function URLs).","file":"dist/ServerlessAdapter.d.ts","line":30},{"name":"pathParameters","kind":"property","owner":"ServerlessEvent","signature":["pathParameters?: Record<string, string>"],"doc":"Path parameters; `proxy` is the path below a `{proxy+}` resource (AWS API Gateway REST).","file":"dist/ServerlessAdapter.d.ts","line":32},{"name":"requestContext","kind":"property","owner":"ServerlessEvent","signature":["requestContext?: Record<string, unknown>"],"doc":"Platform-specific request context metadata.","file":"dist/ServerlessAdapter.d.ts","line":34}]},"ServerlessPlatform":{"name":"ServerlessPlatform","kind":"type","exported":true,"signature":["type ServerlessPlatform = 'lambda' | 'gcf' | 'azure' | 'cgi' | 'auto'"],"doc":"Supported serverless platform identifiers, or 'auto' for environment-based detection.","file":"dist/ServerlessAdapter.d.ts","line":8},"ServerlessResponse":{"name":"ServerlessResponse","kind":"interface","exported":true,"signature":["interface ServerlessResponse"],"doc":"Normalized outgoing response returned to a serverless platform.","file":"dist/ServerlessAdapter.d.ts","line":106,"members":[{"name":"statusCode","kind":"property","owner":"ServerlessResponse","signature":["statusCode: number"],"doc":"HTTP status code.","file":"dist/ServerlessAdapter.d.ts","line":108},{"name":"headers","kind":"property","owner":"ServerlessResponse","signature":["headers: Record<string, string>"],"doc":"Response headers as key-value pairs.","file":"dist/ServerlessAdapter.d.ts","line":110},{"name":"body","kind":"property","owner":"ServerlessResponse","signature":["body: string"],"doc":"Response body as a string.","file":"dist/ServerlessAdapter.d.ts","line":112}]},"SessionManager":{"name":"SessionManager","kind":"class","exported":true,"signature":["class SessionManager"],"doc":"Stateless HMAC-SHA256 token manager for SWAIG function call authentication and per-session metadata storage.","file":"dist/SessionManager.d.ts","line":28,"members":[{"name":"tokenExpirySecs","kind":"property","owner":"SessionManager","signature":["tokenExpirySecs: number"],"doc":"Token validity duration in seconds.","file":"dist/SessionManager.d.ts","line":30},{"name":"secretKey","kind":"property","owner":"SessionManager","signature":["secretKey: string"],"doc":"HMAC signing secret.","file":"dist/SessionManager.d.ts","line":32},{"name":"debugMode","kind":"property","owner":"SessionManager","signature":["debugMode: boolean"],"doc":"When true, {@link debugToken} decodes token internals.\nWhen false (default), it returns `{ error: \"debug mode not enabled\" }`.","file":"dist/SessionManager.d.ts","line":37},{"name":"constructor","kind":"constructor","owner":"SessionManager","signature":["constructor(tokenExpirySecs?: number, secretKey?: string)"],"doc":"Create a new SessionManager.\n@param tokenExpirySecs - Token validity duration in seconds (default 900).\n@param secretKey - HMAC signing secret; a random key is generated if omitted.","file":"dist/SessionManager.d.ts","line":46},{"name":"createSession","kind":"method","owner":"SessionManager","signature":["createSession(callId?: string): string"],"doc":"Return the given callId or generate a new random session identifier.\n@param callId - Existing call ID to reuse.\n@returns The call ID string.","file":"dist/SessionManager.d.ts","line":52},{"name":"generateToken","kind":"method","owner":"SessionManager","signature":["generateToken(functionName: string, callId: string): string"],"doc":"Generate a signed, base64url-encoded token binding a function name to a call ID.\n@param functionName - The SWAIG function name to bind.\n@param callId - The call ID to bind.\n@returns A base64url-encoded token string.","file":"dist/SessionManager.d.ts","line":59},{"name":"createToolToken","kind":"method","owner":"SessionManager","signature":["createToolToken(functionName: string, callId: string): string"],"doc":"Generate a signed token. Equivalent to {@link generateToken} (same\nparameter order); both exist to match the Python SDK (`SessionManager`\nexposes `generate_token` and `create_tool_token`).\n@param functionName - The SWAIG function name to bind.\n@param callId - The call ID to bind.\n@returns A base64url-encoded token string.","file":"dist/SessionManager.d.ts","line":68},{"name":"validateToken","kind":"method","owner":"SessionManager","signature":["validateToken(callId: string, functionName: string, token: string): boolean"],"doc":"Validate a token against the expected call ID and function name.\n@param callId - The expected call ID.\n@param functionName - The expected function name.\n@param token - The base64url-encoded token to validate.\n@returns True if the token is valid and not expired.","file":"dist/SessionManager.d.ts","line":76},{"name":"validateToolToken","kind":"method","owner":"SessionManager","signature":["validateToolToken(functionName: string, token: string, callId: string): boolean"],"doc":"Validate a token. Equivalent to {@link validateToken}, but **note the\ndifferent parameter order** — `validateToolToken(functionName, token,\ncallId)` vs `validateToken(callId, functionName, token)`. Both exist for\nmatching the Python SDK (`SessionManager.validate_token` / `validate_tool_token`,\nwhich use these exact orders). The forwarding maps the arguments to the\ncorrect positions, so both produce identical validation for the same\nlogical token; just be careful not to pass arguments in the wrong order\nwhen switching between the two names.\n@param functionName - The expected function name.\n@param token - The base64url-encoded token to validate.\n@param callId - The expected call ID.\n@returns True if the token is valid and not expired.","file":"dist/SessionManager.d.ts","line":91},{"name":"debugToken","kind":"method","owner":"SessionManager","signature":["debugToken(token: string): DebugTokenResult"],"doc":"Debug a token without validating it.\n\nRequires {@link debugMode} to be `true`. When disabled, returns\n`{ error: \"debug mode not enabled\" }` matching the Python SDK behaviour.\n\n@param token - The base64url-encoded token to decode.\n@returns A nested debug structure matching the Python SDK, or an error object.","file":"dist/SessionManager.d.ts","line":101},{"name":"getSessionMetadata","kind":"method","owner":"SessionManager","signature":["getSessionMetadata(sessionId: string): Record<string, unknown>"],"doc":"Retrieve metadata associated with a session.\n\nReturns an empty object when no metadata has been stored for the session,\nmatching Python SDK behavior (`get_session_metadata` always returns `{}`).\nCallers can safely check truthiness or iterate keys without a null guard.\n\n@param sessionId - The session identifier.\n@returns The metadata record for the session, or `{}` if no metadata exists.","file":"dist/SessionManager.d.ts","line":112},{"name":"setSessionMetadata","kind":"method","owner":"SessionManager","signature":["setSessionMetadata(sessionId: string, metadataOrKey: Record<string, unknown>): void","setSessionMetadata(sessionId: string, key: string, value: unknown): boolean"],"doc":"Merge metadata into a session, creating the entry if it does not exist.\n\nSupports two call signatures for Python SDK compatibility:\n- `setSessionMetadata(sessionId, metadata)` — bulk merge (TS-native)\n- `setSessionMetadata(sessionId, key, value)` — single key/value (Python-compatible)\n\n@param sessionId - The session identifier.\n@param metadataOrKey - A metadata record to merge, or a string key when called with three arguments.\n@param value - The value to set when called with a string key.","file":"dist/SessionManager.d.ts","line":124},{"name":"cleanup","kind":"method","owner":"SessionManager","signature":["cleanup(maxAgeMs?: number): void"],"doc":"Remove session metadata entries older than `maxAgeMs`.\n@param maxAgeMs - Maximum age in milliseconds (defaults to `tokenExpirySecs * 1000`).","file":"dist/SessionManager.d.ts","line":130},{"name":"activateSession","kind":"method","owner":"SessionManager","signature":["activateSession(_callId: string): boolean"],"doc":"Legacy method retained for API compatibility with the Python SDK.\nDoes nothing and returns `true`.\n@param _callId - The call/session identifier (unused).\n@returns Always `true`.","file":"dist/SessionManager.d.ts","line":137},{"name":"endSession","kind":"method","owner":"SessionManager","signature":["endSession(_callId: string): boolean"],"doc":"Legacy method retained for API compatibility with the Python SDK.\nDoes nothing and returns `true`.\n@param _callId - The call/session identifier (unused).\n@returns Always `true`.","file":"dist/SessionManager.d.ts","line":144},{"name":"deleteSessionMetadata","kind":"method","owner":"SessionManager","signature":["deleteSessionMetadata(sessionId: string): boolean"],"doc":"Delete all metadata for a session.\n@param sessionId - The session identifier.\n@returns True if the session existed and was deleted.","file":"dist/SessionManager.d.ts","line":150}]},"ShortCodesResource":{"name":"ShortCodesResource","kind":"class","exported":true,"signature":["class ShortCodes extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":131,"members":[{"name":"constructor","kind":"constructor","owner":"ShortCodesResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":132},{"name":"list","kind":"method","owner":"ShortCodesResource","signature":["list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ShortCodeListResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":133},{"name":"get","kind":"method","owner":"ShortCodesResource","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ShortCodeResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":134},{"name":"update","kind":"method","owner":"ShortCodesResource","signature":["update(id: string, name: string, message_handler: ShortCodeMessageHandler, options?: {\n message_request_url?: string;\n message_request_method?: HttpMethod;\n message_fallback_url?: string;\n message_fallback_method?: HttpMethod;\n message_laml_application_id?: uuid;\n message_relay_context?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<ShortCodeResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":135}],"bases":["BaseResource"]},"SignalWireErrorBody":{"name":"SignalWireErrorBody","kind":"interface","exported":true,"signature":["interface SignalWireErrorBody"],"doc":"Error body returned by the Compatibility REST API (single-error form). Source: signalwire/docs specs/compatibility-api/_shared/errors.tsp (CompatibilityErrorResponse).","file":"dist/PlatformContracts.generated.d.ts","line":100,"members":[{"name":"code","kind":"property","owner":"SignalWireErrorBody","signature":["code: number"],"doc":"Numeric error code.","file":"dist/PlatformContracts.generated.d.ts","line":102},{"name":"message","kind":"property","owner":"SignalWireErrorBody","signature":["message: string"],"doc":"Human-readable error message.","file":"dist/PlatformContracts.generated.d.ts","line":104},{"name":"more_info","kind":"property","owner":"SignalWireErrorBody","signature":["more_info?: string"],"doc":"URL with more information about the error.","file":"dist/PlatformContracts.generated.d.ts","line":106},{"name":"status","kind":"property","owner":"SignalWireErrorBody","signature":["status?: number"],"doc":"HTTP status code.","file":"dist/PlatformContracts.generated.d.ts","line":108}]},"SipDevice":{"name":"SipDevice","kind":"interface","exported":true,"signature":["interface SipDevice"],"doc":"SIP device specification for dial/connect.","file":"dist/relay/types.d.ts","line":72,"members":[{"name":"type","kind":"property","owner":"SipDevice","signature":["type: 'sip'"],"doc":"","file":"dist/relay/types.d.ts","line":73},{"name":"to","kind":"property","owner":"SipDevice","signature":["to: string"],"doc":"","file":"dist/relay/types.d.ts","line":74},{"name":"from","kind":"property","owner":"SipDevice","signature":["from: string"],"doc":"","file":"dist/relay/types.d.ts","line":75},{"name":"timeout","kind":"property","owner":"SipDevice","signature":["timeout?: number"],"doc":"","file":"dist/relay/types.d.ts","line":76},{"name":"max_duration","kind":"property","owner":"SipDevice","signature":["max_duration?: number"],"doc":"","file":"dist/relay/types.d.ts","line":77},{"name":"codecs","kind":"property","owner":"SipDevice","signature":["codecs?: string[]"],"doc":"","file":"dist/relay/types.d.ts","line":78},{"name":"headers","kind":"property","owner":"SipDevice","signature":["headers?: Record<string, string>[]"],"doc":"","file":"dist/relay/types.d.ts","line":79}]},"SipEndpoints":{"name":"SipEndpoints","kind":"class","exported":true,"signature":["class SipEndpoints extends FabricResource<SipEndpointListResponse, SipEndpointResponse, SipEndpointCreateRequest, SipEndpointUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":106,"members":[{"name":"constructor","kind":"constructor","owner":"SipEndpoints","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":108},{"name":"create","kind":"method","owner":"SipEndpoints","signature":["create(body: SipEndpointCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SipEndpointResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":110},{"name":"update","kind":"method","owner":"SipEndpoints","signature":["update(id: string, body: SipEndpointUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SipEndpointResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":112}],"bases":["FabricResource"]},"SipGateways":{"name":"SipGateways","kind":"class","exported":true,"signature":["class SipGateways extends FabricResource<SipGatewayListResponse, SipGatewayResponse, SipGatewayRequest, SipGatewayRequestUpdate>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":114,"members":[{"name":"constructor","kind":"constructor","owner":"SipGateways","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":115},{"name":"create","kind":"method","owner":"SipGateways","signature":["create(body: SipGatewayRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SipGatewayResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":117},{"name":"update","kind":"method","owner":"SipGateways","signature":["update(id: string, body: SipGatewayRequestUpdate, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SipGatewayResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":119}],"bases":["FabricResource"]},"SipProfileResource":{"name":"SipProfileResource","kind":"class","exported":true,"signature":["class SipProfile extends BaseResource"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":145,"members":[{"name":"constructor","kind":"constructor","owner":"SipProfileResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":146},{"name":"get","kind":"method","owner":"SipProfileResource","signature":["get(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<SipProfileResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":147},{"name":"update","kind":"method","owner":"SipProfileResource","signature":["update(options?: {\n domain_identifier?: string;\n default_codecs?: string[];\n default_ciphers?: string[];\n default_encryption?: 'required' | 'optional';\n default_send_as?: string;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<SipProfileResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":148}],"bases":["BaseResource"]},"SkillBase":{"name":"SkillBase","kind":"class","exported":true,"signature":["abstract class SkillBase"],"doc":"Abstract base class for agent skills.\n\nSkills are modular, reusable capabilities that plug into an {@link AgentBase}.\nA single skill can contribute:\n\n- **Tools** (SWAIG functions) via `getTools()` or `defineTool()`\n- **Prompt sections** via `_getPromptSections()`\n- **Speech hints** via `getHints()`\n- **Global data** seeded into each call via `getGlobalData()`\n\nSkills are added to an agent with `agent.addSkill(new MySkill(config))`, or\nby registered name with `agent.addSkillByName('name', config)`. The agent\ncalls `setAgent()`, and the {@link SkillManager} then calls `setup()`,\nbefore the skill's tools are registered.\n\n@example Custom skill\n```ts\nimport { AgentBase, SkillBase, FunctionResult, type SkillToolDefinition } from '@signalwire/sdk';\n\nexport class GreetingSkill extends SkillBase {\n static override SKILL_NAME = 'greeting';\n static override SKILL_DESCRIPTION = 'Responds with a configurable greeting.';\n\n override getTools(): SkillToolDefinition[] {\n return [{\n name: 'say_hello',\n description: 'Say a friendly hello.',\n parameters: { type: 'object', properties: {} },\n handler: () => new FunctionResult(this.getConfig('message', 'Hi!')),\n }];\n }\n}\n\n// In your agent:\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkill(new GreetingSkill({ message: 'Howdy!' }));\n```\n\n@see {@link SkillManager}\n@see {@link SkillRegistry}\n@see {@link AgentBase.addSkill}","file":"dist/skills/SkillBase.d.ts","line":181,"members":[{"name":"SKILL_NAME","kind":"property","owner":"SkillBase","static":true,"signature":["static SKILL_NAME: string"],"doc":"Unique skill name. Subclasses MUST override with a non-empty string.\n\nPython equivalent:`SKILL_NAME: str = None` at `core/skill_base.py:23`.\nPython raises `ValueError` in `__init__` when this is left as `None`;\nTS throws at construction when this is left as the empty default.","file":"dist/skills/SkillBase.d.ts","line":189},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"SkillBase","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"Human-readable description of the skill. Subclasses MUST override.\n\nPython equivalent:`SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`.","file":"dist/skills/SkillBase.d.ts","line":195},{"name":"SKILL_VERSION","kind":"property","owner":"SkillBase","static":true,"signature":["static SKILL_VERSION: string"],"doc":"Semantic version string. Subclasses may override; defaults to `\"1.0.0\"`.\n\nPython equivalent:`SKILL_VERSION: str = \"1.0.0\"` at `core/skill_base.py:25`.","file":"dist/skills/SkillBase.d.ts","line":201},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"SkillBase","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"Packages required by the skill, checked at load time by `validatePackages()`.\n\nPython equivalent:`REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`.\nIn TS these are npm package names importable via dynamic `import()`.","file":"dist/skills/SkillBase.d.ts","line":208},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"SkillBase","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"Environment variables required for the skill to function, checked at load\ntime by `validateEnvVars()`.\n\nPython equivalent:`REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`.","file":"dist/skills/SkillBase.d.ts","line":215},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"SkillBase","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"Whether this skill type supports multiple simultaneous instances (e.g., with different tool_name).\n\nPython equivalent:`SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`.","file":"dist/skills/SkillBase.d.ts","line":221},{"name":"getParameterSchema","kind":"method","owner":"SkillBase","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"Get the parameter schema for this skill class, describing all accepted configuration options.\nSubclasses should override and call `super.getParameterSchema()` to include base parameters.\n\nMirrors Python's `SkillBase.get_parameter_schema()` (skill_base.py:197-266):\nreturns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a\n`tool_name` entry with `default: cls.SKILL_NAME` for classes with\n`SUPPORTS_MULTIPLE_INSTANCES = true`.\n\n@returns Record mapping parameter names to their schema entries.","file":"dist/skills/SkillBase.d.ts","line":233},{"name":"skillName","kind":"property","owner":"SkillBase","readonly":true,"signature":["readonly skillName: string"],"doc":"The registered name of this skill type.","file":"dist/skills/SkillBase.d.ts","line":235},{"name":"instanceId","kind":"property","owner":"SkillBase","readonly":true,"signature":["readonly instanceId: string"],"doc":"Unique identifier for this skill instance (includes timestamp and random bytes).","file":"dist/skills/SkillBase.d.ts","line":237},{"name":"config","kind":"property","owner":"SkillBase","protected":true,"signature":["protected config: SkillConfig"],"doc":"Configuration options provided at construction time.","file":"dist/skills/SkillBase.d.ts","line":239},{"name":"swaigFields","kind":"property","owner":"SkillBase","readonly":true,"signature":["readonly swaigFields: Record<string, unknown>"],"doc":"Additional SWAIG fields extracted from config, merged into tool definitions.","file":"dist/skills/SkillBase.d.ts","line":241},{"name":"agent","kind":"property","owner":"SkillBase","signature":["agent?: AgentBase"],"doc":"Reference to the agent that owns this skill.\nSet via `setAgent()` when the skill is added to an agent.\nPython equivalent: `self.agent` (set in `__init__`).\n\nIn the Python SDK `agent` is always non-null because it is injected in the\nconstructor. In the TypeScript SDK the SkillManager always calls\n`setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being\nsafe to call inside `setup()` and any method invoked after it.\n\nReadable by anyone holding the skill, so a test or an introspection tool can\ncheck which agent a skill was bound to. Subclasses that need a guaranteed\nnon-null agent should still prefer the asserting {@link getAgent}.","file":"dist/skills/SkillBase.d.ts","line":256},{"name":"logger","kind":"property","owner":"SkillBase","protected":true,"readonly":true,"signature":["protected readonly logger: Logger"],"doc":"Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)`\nset in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`.","file":"dist/skills/SkillBase.d.ts","line":261},{"name":"getAgent","kind":"method","owner":"SkillBase","protected":true,"signature":["protected getAgent(): AgentBase"],"doc":"Return the agent that owns this skill, asserting it is non-null.\nEquivalent to accessing `self.agent` in Python, where the agent reference\nis always set before `setup()` is called.\n\nThe SkillManager lifecycle guarantees that `setAgent()` is called before\n`setup()`, so this method is safe to use inside `setup()` and in any\ntool handler invoked during an active agent session.\n\n@returns The owning `AgentBase` instance.\n@throws {Error} If called before `setAgent()` (i.e., before the skill is\n attached to an agent by the SkillManager).","file":"dist/skills/SkillBase.d.ts","line":287},{"name":"params","kind":"accessor","owner":"SkillBase","signature":["get params(): Readonly<SkillConfig>"],"doc":"The configuration this skill was constructed with — the reference's public\n`self.params` (`core/skill_base.py:40`), read-only.\n\n`swaig_fields` is absent: the constructor pops it into {@link swaigFields},\nmirroring the reference's `self.swaig_fields = self.params.pop(...)`\n(`core/skill_base.py:44`). Use {@link getConfig} for a single typed key; this\nreturns the whole map, which is what the reference attribute exposes.","file":"dist/skills/SkillBase.d.ts","line":297},{"name":"constructor","kind":"constructor","owner":"SkillBase","signature":["constructor(config?: SkillConfig)"],"doc":"Create a new skill instance.\n\nPython equivalent:`core/skill_base.py:32-43`.\nPython `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION`\nis left as `None` on the subclass. TS throws the equivalent when the static\ndefaults haven't been overridden.\n\n@param config - Optional configuration key-value pairs (Python: `params`).","file":"dist/skills/SkillBase.d.ts","line":308},{"name":"setup","kind":"method","owner":"SkillBase","signature":["setup(): Promise<boolean>"],"doc":"Setup the skill. Called when the skill is added to an agent.\nOverride to perform initialization (API connections, config validation, etc.)\n@returns `true` if setup succeeded, `false` otherwise.\n Python equivalent: abstract `setup() -> bool`.","file":"dist/skills/SkillBase.d.ts","line":315},{"name":"getTools","kind":"method","owner":"SkillBase","signature":["getTools(): SkillToolDefinition[]"],"doc":"Return the SWAIG tool definitions this skill provides.\n\nDefault implementation returns tools registered imperatively via\n`defineTool()`. Skills using the declarative pattern override this\nmethod to return a static array built from their config.\n\nPython equivalent:replaces the `@abstractmethod register_tools()` contract\n— Python skills call `self.define_tool(...)` inside `register_tools()`;\nTypeScript skills either call `this.defineTool(...)` in `setup()` (and\nlet the default `getTools()` return them) or override `getTools()`\ndirectly.\n\n@returns Array of tool definitions to register with the agent.","file":"dist/skills/SkillBase.d.ts","line":331},{"name":"defineTool","kind":"method","owner":"SkillBase","protected":true,"signature":["protected defineTool(toolDef: SkillToolDefinition): void"],"doc":"Imperatively register a tool with this skill.\n\nPython equivalent:`core/skill_base.py:58` `def define_tool(self, **kwargs)`.\nMerges `this.swaigFields` into the tool definition (explicit fields on\n`toolDef` take precedence), then pushes the result into `_dynamicTools`\nso the default `getTools()` returns it at SWML render time.\n\nIntended for skills whose tool shape depends on config evaluated at\n`setup()` time. Skills with a static tool list should override\n`getTools()` instead.\n\n@param toolDef - The tool definition to register. Must include at\n minimum `name`, `description`, `parameters`, and `handler`.","file":"dist/skills/SkillBase.d.ts","line":347},{"name":"getDataMapTools","kind":"method","owner":"SkillBase","signature":["getDataMapTools(): Record<string, unknown>[]"],"doc":"Optional DataMap-style tool definitions. Skills that build their own\nSWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them\nhere and `AgentBase.addSkill()` registers each via `registerSwaigFunction`.\n\nPython equivalent: the direct `self.agent.register_swaig_function(fn)`\ncall inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`).\nDefault returns `[]` — skills using only the declarative `getTools()` path\ndo not need to override this.\n\n@returns Array of fully-built SWAIG function dicts.","file":"dist/skills/SkillBase.d.ts","line":360},{"name":"getPromptSections","kind":"method","owner":"SkillBase","signature":["getPromptSections(): SkillPromptSection[]"],"doc":"Get prompt sections to inject into the agent's system prompt.\nRespects the `skip_prompt` config option — returns `[]` if set to `true`.\nSubclasses should override `_getPromptSections()` instead of this method.\n@returns Array of prompt sections with titles, bodies, and bullets.","file":"dist/skills/SkillBase.d.ts","line":367},{"name":"getHints","kind":"method","owner":"SkillBase","signature":["getHints(): string[]"],"doc":"Get speech recognition hints relevant to this skill.\n@returns Array of hint strings to improve speech recognition accuracy.","file":"dist/skills/SkillBase.d.ts","line":378},{"name":"getGlobalData","kind":"method","owner":"SkillBase","signature":["getGlobalData(): Record<string, unknown>"],"doc":"Get global data to merge into the agent's global data store.\n@returns Key-value pairs to be merged into the agent's global data.","file":"dist/skills/SkillBase.d.ts","line":383},{"name":"getInstanceKey","kind":"method","owner":"SkillBase","signature":["getInstanceKey(): string"],"doc":"Get the instance key used for deduplication in the SkillManager.\n\nFor single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns\nthe skill name. For multi-instance skills, returns `${skillName}_${toolName}`\nusing the `tool_name` config (falls back to the skill name).\n\nMatches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`).\nMulti-instance subclasses only need to override when their key derivation\ndepends on config beyond `tool_name`.\n\n@returns A unique key identifying this skill instance.","file":"dist/skills/SkillBase.d.ts","line":397},{"name":"getSkillNamespace","kind":"method","owner":"SkillBase","signature":["getSkillNamespace(): string"],"doc":"Get the namespaced key for storing per-skill data in global_data.\n@returns A string like \"skill:datetime\" or \"skill:my_prefix\".","file":"dist/skills/SkillBase.d.ts","line":402},{"name":"getSkillData","kind":"method","owner":"SkillBase","signature":["getSkillData(rawData: SwaigRequest): Record<string, unknown>"],"doc":"Read this skill's data from a raw call data object's global_data.\n@param rawData - The raw request data containing global_data.\n@returns The skill's stored data, or an empty object if not found.","file":"dist/skills/SkillBase.d.ts","line":408},{"name":"updateSkillData","kind":"method","owner":"SkillBase","signature":["updateSkillData(result: FunctionResult, data: Record<string, unknown>): FunctionResult"],"doc":"Update this skill's namespaced data on a FunctionResult via updateGlobalData.\n@param result - The FunctionResult to update.\n@param data - The data to store under this skill's namespace.\n@returns The FunctionResult for chaining.","file":"dist/skills/SkillBase.d.ts","line":415},{"name":"cleanup","kind":"method","owner":"SkillBase","signature":["cleanup(): Promise<void>"],"doc":"Cleanup resources. Called when the skill is removed from an agent.","file":"dist/skills/SkillBase.d.ts","line":419},{"name":"validateEnvVars","kind":"method","owner":"SkillBase","signature":["validateEnvVars(): string[]"],"doc":"Validate that all required environment variables declared on the skill class\nare set in the current process environment.\n\nPython equivalent:`core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS`\ndirectly. TS reads the same static from the class.\n\nReturns the list of missing variable names so callers can produce actionable\nerror messages. This differs from Python's `validate_env_vars() -> bool`\nreturn shape; {@link hasAllEnvVars} is the boolean equivalent.\n\n@returns Array of missing environment variable names (empty if all are present).","file":"dist/skills/SkillBase.d.ts","line":433},{"name":"isInitialized","kind":"method","owner":"SkillBase","signature":["isInitialized(): boolean"],"doc":"Check if the skill has been initialized by the SkillManager.\n@returns True if setup() has completed and the skill is marked initialized.","file":"dist/skills/SkillBase.d.ts","line":438},{"name":"markInitialized","kind":"method","owner":"SkillBase","signature":["markInitialized(): void"],"doc":"Mark the skill as initialized (called by SkillManager).","file":"dist/skills/SkillBase.d.ts","line":442},{"name":"getConfig","kind":"method","owner":"SkillBase","signature":["getConfig<T = unknown>(key: string, defaultValue?: T): T"],"doc":"Get a configuration value by key, falling back to a default if not set.\n@param key - The configuration key to look up.\n@param defaultValue - Value to return if the key is not present.\n@returns The configuration value cast to type T, or the default value.","file":"dist/skills/SkillBase.d.ts","line":449},{"name":"setAgent","kind":"method","owner":"SkillBase","signature":["setAgent(agent: AgentBase): void"],"doc":"Set the agent reference for this skill.\nCalled by the SkillManager/AgentBase when the skill is attached to an agent.\nPython equivalent: `self.agent = agent` in `__init__`.\n@param agent - The agent that owns this skill.","file":"dist/skills/SkillBase.d.ts","line":456},{"name":"hasAllEnvVars","kind":"method","owner":"SkillBase","signature":["hasAllEnvVars(): boolean"],"doc":"Check if all required environment variables are present.\nConvenience wrapper around `validateEnvVars()` that returns a boolean,\nmatching the Python `validate_env_vars() -> bool` return type.\n@returns `true` if all required env vars are set, `false` otherwise.","file":"dist/skills/SkillBase.d.ts","line":463},{"name":"validatePackages","kind":"method","owner":"SkillBase","signature":["validatePackages(): Promise<string[]>"],"doc":"Validate that all required packages declared on the skill class can be imported.\n\nPython equivalent:`core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES`\ndirectly and tries `importlib.import_module(pkg)` for each; TS does the\nequivalent with a dynamic `import()`.\n\n@returns Array of package names that could not be imported (empty if all present).","file":"dist/skills/SkillBase.d.ts","line":473},{"name":"hasAllPackages","kind":"method","owner":"SkillBase","signature":["hasAllPackages(): Promise<boolean>"],"doc":"Check if all required packages declared in the manifest are available.\nConvenience wrapper around `validatePackages()` that returns a boolean,\nmatching the Python `validate_packages() -> bool` return type.\n@returns `true` if all required packages are importable, `false` otherwise.","file":"dist/skills/SkillBase.d.ts","line":480}]},"SkillConfig":{"name":"SkillConfig","kind":"interface","exported":true,"signature":["interface SkillConfig"],"doc":"Configuration key-value pairs passed to a skill at construction time.","file":"dist/skills/SkillBase.d.ts","line":14,"members":[]},"SkillManager":{"name":"SkillManager","kind":"class","exported":true,"signature":["class SkillManager"],"doc":"Manages the lifecycle of skills attached to an agent.\n\nHandles loading, unloading, validation, and aggregation of skill tools,\nhints, global data, and prompt sections.\n\n@remarks\n`AgentBase` owns a manager (`agent.skillManager`). {@link addSkill} only\nchecks, sets up and records a skill: `AgentBase.addSkill()` calls it, then\nregisters the skill's tools, prompt sections, hints and global data on the\nagent. {@link loadSkill} and {@link loadSkillByName} on a manager that\nbelongs to an agent go through `AgentBase.addSkill()`, so the skill is\nregistered on the agent as well, as Python's `SkillManager.load_skill()`\ndoes (`core/skill_manager.py`). On a standalone manager they only record\nthe skill.\n\nThe owning agent is kept as a public back-reference ({@link agent}), the\nreference's readable `self.agent` (`core/skill_manager.py:22`).","file":"dist/skills/SkillManager.d.ts","line":28,"members":[{"name":"agent","kind":"property","owner":"SkillManager","readonly":true,"signature":["readonly agent?: AgentBase"],"doc":"The agent this manager belongs to (the reference's public `self.agent`), or\n`undefined` when the manager is used standalone (a bare `new SkillManager()`,\nas in tests and the doc examples).","file":"dist/skills/SkillManager.d.ts","line":38},{"name":"constructor","kind":"constructor","owner":"SkillManager","signature":["constructor(agent?: AgentBase)"],"doc":"@param agent - Optional owning agent, kept as a public back-reference\n (the reference's `SkillManager(agent)`). Omit for standalone use.","file":"dist/skills/SkillManager.d.ts","line":43},{"name":"loadedSkills","kind":"accessor","owner":"SkillManager","signature":["get loadedSkills(): ReadonlyMap<string, SkillBase>"],"doc":"Public read-only view of all loaded skill instances, keyed by instance key.\nPython equivalent: `self.loaded_skills` (public `Dict[str, SkillBase]`).\n\nUse this to iterate or inspect loaded skills without mutating the internal map.","file":"dist/skills/SkillManager.d.ts","line":65},{"name":"addSkill","kind":"method","owner":"SkillManager","signature":["addSkill(skill: SkillBase): Promise<void>"],"doc":"Add a skill to the manager, validating env vars and calling setup().\nUses the skill's instance key for deduplication. This records the skill\nonly; it doesn't register the skill's tools on the agent. Use\n{@link loadSkill}, or `AgentBase.addSkill()`, for that.\n\n{@link loadSkill} / {@link loadSkillByName} wrap this and catch to return\n`[false, msg]`, matching Python `load_skill`'s return contract\n(`skill_manager.py` lines 114-118).\n\n@param skill - The skill instance to add.\n@returns Resolves once the skill is registered.\n@throws {Error} When a single-instance skill is already loaded, its\n required environment variables are missing, its parameter schema is\n empty, its required packages cannot be imported, or `setup()` returns\n `false`.","file":"dist/skills/SkillManager.d.ts","line":83},{"name":"removeSkill","kind":"method","owner":"SkillManager","signature":["removeSkill(keyOrId: string): Promise<boolean>"],"doc":"Remove a skill by its instance key or instance ID, calling cleanup() before removal.\n@param keyOrId - The instance key or instance ID of the skill to remove.\n@returns True if the skill was found and removed, false otherwise.\n\n@remarks Equivalent to Python's `unload_skill(skill_identifier)`. Callers porting\n from Python should change `skill_manager.unload_skill(id)` →\n `skillManager.removeSkill(id)`.","file":"dist/skills/SkillManager.d.ts","line":93},{"name":"removeSkillByName","kind":"method","owner":"SkillManager","signature":["removeSkillByName(skillName: string): Promise<number>"],"doc":"Remove all skill instances matching a given skill name.\n@param skillName - The skill name to match against.\n@returns The number of skill instances removed.","file":"dist/skills/SkillManager.d.ts","line":99},{"name":"hasSkill","kind":"method","owner":"SkillManager","signature":["hasSkill(skillName: string): boolean"],"doc":"Check if any skill instance with the given name is currently loaded.\n@param skillName - The skill name to check for.\n@returns True if at least one instance with this name is loaded.","file":"dist/skills/SkillManager.d.ts","line":105},{"name":"hasSkillByKey","kind":"method","owner":"SkillManager","signature":["hasSkillByKey(instanceKey: string): boolean"],"doc":"Check if a skill with the given instance key is currently loaded.\nThis matches Python's `has_skill` semantics, which performs a direct\ndictionary key lookup (`skill_identifier in self.loaded_skills`).\n\nUse `hasSkill(name)` to check by skill name (iterates values).\nUse `hasSkillByKey(key)` to check by instance key (direct map lookup).\n\n@param instanceKey - The instance key to look up.\n@returns True if a skill with this exact instance key is loaded.\n\n@remarks Equivalent to Python's `has_skill(skill_identifier)`. Callers porting\n from Python should change `skill_manager.has_skill(key)` →\n `skillManager.hasSkillByKey(key)`.","file":"dist/skills/SkillManager.d.ts","line":121},{"name":"loadSkill","kind":"method","owner":"SkillManager","signature":["loadSkill(skillClass: typeof SkillBase, config?: SkillConfig): Promise<[boolean, string]>"],"doc":"Load a skill by providing the class constructor directly, bypassing the registry.\nThis is the TypeScript equivalent of Python's `load_skill(skill_name, skill_class, params)`\npath where a caller-provided `skill_class` is used instead of a registry lookup.\n\nOn a manager that belongs to an agent, the skill's tools, prompt sections,\nhints and global data are registered on that agent, as with\n`agent.addSkill()`.\n\n@param skillClass - The skill class constructor (a subclass of `SkillBase`).\n@param config - Optional configuration to pass to the skill constructor.\n@returns A tuple `[success, errorMessage]` matching Python's `load_skill` return\n contract. `errorMessage` is an empty string on success.\n\n@remarks Equivalent to Python's `load_skill(skill_name, skill_class=MySkillClass, params)`.\n\n@example\n```ts\nimport { SkillManager, SkillBase, type SkillToolDefinition } from '@signalwire/sdk';\n\nclass MyCustomSkill extends SkillBase {\n static override SKILL_NAME = 'my_custom';\n static override SKILL_DESCRIPTION = 'Example custom skill.';\n override getTools(): SkillToolDefinition[] {\n return [];\n }\n}\n\nconst manager = new SkillManager();\nconst [ok, err] = await manager.loadSkill(MyCustomSkill, { api_key: 'secret' });\nif (!ok) console.error(err);\n```","file":"dist/skills/SkillManager.d.ts","line":161},{"name":"loadSkillByName","kind":"method","owner":"SkillManager","signature":["loadSkillByName(skillName: string, config?: SkillConfig): Promise<[boolean, string]>"],"doc":"Load a skill by name from the global SkillRegistry, construct it, and add it.\nThis is the TypeScript equivalent of Python's `load_skill(skill_name)` path\nwhere `skill_class=None` triggers a registry lookup.\n\nOn a manager that belongs to an agent, the skill is registered on that\nagent, as with {@link loadSkill}.\n\n@param skillName - The registered skill name to look up in the SkillRegistry.\n@param config - Optional configuration to pass to the skill factory.\n@returns A tuple `[success, errorMessage]` matching Python's `load_skill` return\n contract. `errorMessage` is an empty string on success.\n\n@remarks Equivalent to Python's `load_skill(skill_name)` (registry path, where\n `skill_class=None`). Callers porting from Python should change\n `skill_manager.load_skill(name)` → `skillManager.loadSkillByName(name)`.","file":"dist/skills/SkillManager.d.ts","line":179},{"name":"listSkillKeys","kind":"method","owner":"SkillManager","signature":["listSkillKeys(): string[]"],"doc":"List the instance keys of all currently loaded skills.\nPython equivalent: `list_loaded_skills() -> List[str]` which returns\n`list(self.loaded_skills.keys())`.\n\nUse `listSkills()` for richer objects (name, instanceId, initialized).\nUse `listSkillKeys()` for a flat list of instance key strings.\n\n@returns Array of instance key strings.\n\n@remarks Equivalent to Python's `list_loaded_skills()`. Callers porting from\n Python should change `skill_manager.list_loaded_skills()` →\n `skillManager.listSkillKeys()`.","file":"dist/skills/SkillManager.d.ts","line":194},{"name":"getSkill","kind":"method","owner":"SkillManager","signature":["getSkill(keyOrId: string): SkillBase | undefined"],"doc":"Get a skill by its instance key or instance ID.\n@param keyOrId - The instance key or instance ID to look up.\n@returns The skill instance, or undefined if not found.","file":"dist/skills/SkillManager.d.ts","line":200},{"name":"listSkills","kind":"method","owner":"SkillManager","signature":["listSkills(): {\n name: string;\n instanceId: string;\n initialized: boolean;\n}[]"],"doc":"List all loaded skill instances with their name, ID, and initialization state.\n@returns Array of skill summary objects.","file":"dist/skills/SkillManager.d.ts","line":205},{"name":"getAllTools","kind":"method","owner":"SkillManager","signature":["getAllTools(): ReturnType<SkillBase['getTools']>"],"doc":"Aggregate tool definitions from all loaded skills.\n@returns Combined array of all skill tool definitions.","file":"dist/skills/SkillManager.d.ts","line":214},{"name":"getAllPromptSections","kind":"method","owner":"SkillManager","signature":["getAllPromptSections(): ReturnType<SkillBase['getPromptSections']>"],"doc":"Aggregate prompt sections from all loaded skills.\n@returns Combined array of all skill prompt sections.","file":"dist/skills/SkillManager.d.ts","line":219},{"name":"getAllHints","kind":"method","owner":"SkillManager","signature":["getAllHints(): string[]"],"doc":"Aggregate speech recognition hints from all loaded skills.\n@returns Combined array of all skill hint strings.","file":"dist/skills/SkillManager.d.ts","line":224},{"name":"getMergedGlobalData","kind":"method","owner":"SkillManager","signature":["getMergedGlobalData(): Record<string, unknown>"],"doc":"Merge global data from all loaded skills into a single object.\n@returns Combined global data (later skills override earlier ones on key conflicts).","file":"dist/skills/SkillManager.d.ts","line":229},{"name":"size","kind":"accessor","owner":"SkillManager","signature":["get size(): number"],"doc":"Get the number of currently loaded skill instances.\n@returns The count of loaded skills.","file":"dist/skills/SkillManager.d.ts","line":234},{"name":"getLoadedSkillEntries","kind":"method","owner":"SkillManager","signature":["getLoadedSkillEntries(): Array<{\n skillName: string;\n SkillClass: typeof SkillBase;\n config: SkillConfig;\n}>"],"doc":"Get metadata for all loaded skills, enabling ephemeral copy re-instantiation.\n@returns Array of entries containing skill name, class constructor, and config.","file":"dist/skills/SkillManager.d.ts","line":239},{"name":"clear","kind":"method","owner":"SkillManager","signature":["clear(): Promise<void>"],"doc":"Remove all skills and clean up.","file":"dist/skills/SkillManager.d.ts","line":247}]},"SkillName":{"name":"SkillName","kind":"type","exported":true,"signature":["type SkillName = 'api_ninjas_trivia' | 'ask_claude' | 'claude_skills' | 'custom_skills' | 'datasphere' | 'datasphere_serverless' | 'datetime' | 'google_maps' | 'info_gatherer' | 'joke' | 'math' | 'mcp_gateway' | 'native_vector_search' | 'play_background_file' | 'spider' | 'swml_transfer' | 'weather_api' | 'web_search' | 'wikipedia_search'"],"doc":"Built-in skill names as a typed, compile-time-checked closed set.\n\nThe 19 names below are exactly the `SKILL_NAME` declared by each built-in\nskill class in `src/skills/builtin/` (the same set\n{@link registerBuiltinSkills} locks into the global `SkillRegistry`).\n\n{@link AgentBase.addSkillByName} and {@link AgentBase.hasSkill} accept this\nunion OR any string (`SkillName | (string & {})`):\n\n - The union gives editor autocompletion for the built-in names.\n - The `string & {}` arm accepts any other string, so custom / third-party\n skill names work, as with the Python SDK (whose `add_skill` /\n `has_skill` take a bare `str`). It also means a typo in a call\n (`addSkillByName('datetiem')`) still compiles: `addSkillByName` then\n rejects at runtime because the name isn't registered. To have the\n compiler check a built-in name, type the value as `SkillName`.\n\nTypeScript erases these types, so the value passed at runtime is the same\nstring either way.\n\n@example\n```ts\nimport { AgentBase, type SkillName } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('datetime'); // autocompleted built-in\nagent.hasSkill('datetime'); // true\nconst name: SkillName = 'math'; // checked: 'mathh' is a compile error\nawait agent.addSkillByName(name);\n// await agent.addSkillByName('datetiem'); // compiles, rejects: not registered\n```","file":"dist/skills/SkillName.d.ts","line":33},"SkillNameOrString":{"name":"SkillNameOrString","kind":"type","exported":true,"signature":["type SkillNameOrString = SkillName | (string & {})"],"doc":"A skill-name parameter: one of the typed built-in {@link SkillName} values\n(autocompleted) or any other string (custom / third-party skills, and\nconsistency with Python's bare `str`). Because any string is accepted, a\nmisspelled built-in name isn't a compile error here.\n\nThe `(string & {})` arm preserves string literal autocompletion for the\nunion members while still widening to accept arbitrary strings; it is purely\na type-level annotation and has no runtime effect.","file":"dist/skills/SkillName.d.ts","line":44},"SkillPromptSection":{"name":"SkillPromptSection","kind":"interface","exported":true,"signature":["interface SkillPromptSection"],"doc":"A section of prompt content injected into the agent's system prompt by a skill.","file":"dist/skills/SkillBase.d.ts","line":105,"members":[{"name":"title","kind":"property","owner":"SkillPromptSection","signature":["title: string"],"doc":"Section heading displayed in the prompt.","file":"dist/skills/SkillBase.d.ts","line":107},{"name":"body","kind":"property","owner":"SkillPromptSection","signature":["body?: string"],"doc":"Optional body text for the section.","file":"dist/skills/SkillBase.d.ts","line":109},{"name":"bullets","kind":"property","owner":"SkillPromptSection","signature":["bullets?: string[]"],"doc":"Optional bullet points appended after the body.","file":"dist/skills/SkillBase.d.ts","line":111},{"name":"numbered","kind":"property","owner":"SkillPromptSection","signature":["numbered?: boolean"],"doc":"If true, render bullets as a numbered list instead of unordered.","file":"dist/skills/SkillBase.d.ts","line":113}]},"SkillRegistry":{"name":"SkillRegistry","kind":"class","exported":true,"signature":["class SkillRegistry"],"doc":"Global singleton registry for registering and instantiating skills.\n\nSkills can be registered programmatically via `register(SkillClass)`.\nMatches Python's `skill_registry` global (`skills/registry.py:481`).","file":"dist/skills/SkillRegistry.d.ts","line":46,"members":[{"name":"constructor","kind":"constructor","owner":"SkillRegistry","signature":["constructor()"],"doc":"","file":"dist/skills/SkillRegistry.d.ts","line":59},{"name":"getInstance","kind":"method","owner":"SkillRegistry","static":true,"signature":["static getInstance(): SkillRegistry"],"doc":"Get the global singleton instance, creating it on first access.\n@returns The shared SkillRegistry instance.","file":"dist/skills/SkillRegistry.d.ts","line":64},{"name":"resetInstance","kind":"method","owner":"SkillRegistry","static":true,"signature":["static resetInstance(): void"],"doc":"Reset the global singleton (for testing).","file":"dist/skills/SkillRegistry.d.ts","line":68},{"name":"register","kind":"method","owner":"SkillRegistry","signature":["register(SkillClass: typeof SkillBase): void"],"doc":"Register a skill class. The skill name is read from the class's static\n`SKILL_NAME`. Mirrors Python's `register_skill(skill_class)`\n(`skills/registry.py:132-194`) — including the schema-non-empty check\nand the protection against overwriting locked skills.\n\n@param SkillClass - A concrete subclass of `SkillBase` with a\n non-empty `SKILL_NAME`.","file":"dist/skills/SkillRegistry.d.ts","line":78},{"name":"lock","kind":"method","owner":"SkillRegistry","signature":["lock(names?: string[]): void"],"doc":"Lock one or more skill names, so they can't be overwritten, unregistered\nor cleared. `registerBuiltinSkills()` locks the built-in skills, so a\nbuilt-in can't be replaced by removing it and registering another class\nunder its name. If called with no arguments, locks all currently\nregistered skills.\n@param names - Skill names to lock; if omitted, all current names are locked.","file":"dist/skills/SkillRegistry.d.ts","line":87},{"name":"unregister","kind":"method","owner":"SkillRegistry","signature":["unregister(name: string): boolean"],"doc":"Unregister a skill by name, removing it from the registry. A locked skill\n(see {@link lock}) isn't removed.\n@param name - The skill name to unregister.\n@returns True if the skill was found and removed; false if it isn't\n registered or is locked.","file":"dist/skills/SkillRegistry.d.ts","line":95},{"name":"create","kind":"method","owner":"SkillRegistry","signature":["create(name: string, config?: SkillConfig): SkillBase | null"],"doc":"Create a new skill instance by looking up its class in the registry.\nMatches Python's `skill_manager.load_skill(name)` class-lookup + instantiate\nflow (`skill_manager.py:97`: `skill_instance = skill_class(self.agent, params)`).\n\n@param name - The registered skill name.\n@param config - Optional configuration to pass to the skill constructor.\n@returns A new skill instance, or null if the name is not registered.","file":"dist/skills/SkillRegistry.d.ts","line":105},{"name":"getSkillClass","kind":"method","owner":"SkillRegistry","signature":["getSkillClass(name: string): typeof SkillBase | undefined"],"doc":"Get the registered skill class by name. Matches Python's\n`get_skill_class(skill_name)` (`registry.py:196-203`).\n@param name - The registered skill name.\n@returns The skill class reference, or undefined if not registered.","file":"dist/skills/SkillRegistry.d.ts","line":112},{"name":"has","kind":"method","owner":"SkillRegistry","signature":["has(name: string): boolean"],"doc":"Check if a skill name is registered.\n@param name - The skill name to check.\n@returns True if the skill is registered.","file":"dist/skills/SkillRegistry.d.ts","line":118},{"name":"listRegistered","kind":"method","owner":"SkillRegistry","signature":["listRegistered(): string[]"],"doc":"List all registered skill names.\n@returns Array of registered skill name strings.","file":"dist/skills/SkillRegistry.d.ts","line":123},{"name":"listSkills","kind":"method","owner":"SkillRegistry","signature":["listSkills(): SkillSchemaInfo[]"],"doc":"List all registered skills with their full metadata. Matches Python's\n`list_skills()` shape (`registry.py:205-227`) plus TS-idiomatic\ncamelCase keys.\n@returns Array of skill metadata objects.","file":"dist/skills/SkillRegistry.d.ts","line":130},{"name":"addSearchPath","kind":"method","owner":"SkillRegistry","signature":["addSearchPath(path: string): void"],"doc":"Add a directory path to search during skill discovery.\n@param path - Absolute path to a directory containing skill files.","file":"dist/skills/SkillRegistry.d.ts","line":135},{"name":"addSkillDirectory","kind":"method","owner":"SkillRegistry","signature":["addSkillDirectory(path: string): void"],"doc":"Add a directory to search for skills.\n\nMirrors Python's\n`signalwire.skills.registry.SkillRegistry.add_skill_directory`\n(`registry.py:407-431`): validate that the path exists and is a\ndirectory, then append it (de-duplicated) to `externalPaths`, which\n{@link discoverAll} scans along with the search paths. Throws\n`Error` (the JS analog of Python's `ValueError`) for non-existent\npaths or non-directories. Distinct from `addSearchPath`, which\nsilently accepts anything; `addSkillDirectory` is the strict\nPython-equivalent surface and the recommended entry point for\nregistering third-party skill directories.\n\n@param path - Absolute or relative path to a directory containing\n skill subdirectories.\n@throws Error when the path doesn't exist or isn't a directory.","file":"dist/skills/SkillRegistry.d.ts","line":154},{"name":"getExternalPaths","kind":"method","owner":"SkillRegistry","signature":["getExternalPaths(): string[]"],"doc":"Returns a copy of the external skill directories registered via\n{@link addSkillDirectory}. The equivalent of Python's\n`_external_paths`.","file":"dist/skills/SkillRegistry.d.ts","line":160},{"name":"getSearchPaths","kind":"method","owner":"SkillRegistry","signature":["getSearchPaths(): string[]"],"doc":"Get all configured search paths for skill discovery.\n@returns Copy of the search paths array.","file":"dist/skills/SkillRegistry.d.ts","line":165},{"name":"discoverFromDirectory","kind":"method","owner":"SkillRegistry","signature":["discoverFromDirectory(dirPath: string): Promise<string[]>"],"doc":"Discover and register skills from a directory by importing each file.\nImports every `.ts` and `.js` file in the directory (not `.d.ts`), and\n`skill.ts`, or `skill.js` when there's no `skill.ts`, in each\nsubdirectory. Looks for SkillBase subclass exports and registers them.\n@param dirPath - Absolute path to the directory to scan.\n@returns Array of newly discovered skill names.","file":"dist/skills/SkillRegistry.d.ts","line":174},{"name":"discoverAll","kind":"method","owner":"SkillRegistry","signature":["discoverAll(): Promise<string[]>"],"doc":"Discover and register skills from every configured directory: the search\npaths ({@link addSearchPath}, `SIGNALWIRE_SKILL_PATHS`) and the\ndirectories added with {@link addSkillDirectory}, each once.\n@returns Array of all newly discovered skill names.","file":"dist/skills/SkillRegistry.d.ts","line":181},{"name":"getSkillSchema","kind":"method","owner":"SkillRegistry","signature":["getSkillSchema(name: string): SkillSchemaInfo | undefined"],"doc":"Get the combined schema info for a registered skill.\nMatches Python `get_all_skills_schema` per-skill shape\n(`registry.py:287-295`).\n@param name - The registered skill name to query.\n@returns The skill's schema info, or undefined if not found.","file":"dist/skills/SkillRegistry.d.ts","line":189},{"name":"getAllSkillsSchema","kind":"method","owner":"SkillRegistry","signature":["getAllSkillsSchema(): Record<string, SkillSchemaInfo>"],"doc":"Get combined schema info for all registered skills.\n@returns Record mapping skill names to their schema info.","file":"dist/skills/SkillRegistry.d.ts","line":194},{"name":"listAllSkillSources","kind":"method","owner":"SkillRegistry","signature":["listAllSkillSources(): Record<string, string[]>"],"doc":"Group registered skill names by source category. Matches Python's\n`list_all_skill_sources` (`skills/registry.py:436-478`).\n\nCurrent TS implementation treats every registered skill as \"registered\"\n(the only category that fits — filesystem-based discovery is optional\nand entry-points don't apply to Node the way they do to Python).\n\n@returns Record mapping source categories to arrays of skill names.","file":"dist/skills/SkillRegistry.d.ts","line":205},{"name":"size","kind":"accessor","owner":"SkillRegistry","signature":["get size(): number"],"doc":"Get the number of registered skills.\n@returns The count of registered skills.","file":"dist/skills/SkillRegistry.d.ts","line":210},{"name":"clear","kind":"method","owner":"SkillRegistry","signature":["clear(): void"],"doc":"Clear every registration except locked skills (see {@link lock}), which\nstay registered.","file":"dist/skills/SkillRegistry.d.ts","line":215}]},"SkillSchemaInfo":{"name":"SkillSchemaInfo","kind":"interface","exported":true,"signature":["interface SkillSchemaInfo"],"doc":"Metadata exposed for a registered skill. Shape matches Python's\n`SkillRegistry.list_skills()` / `get_all_skills_schema()` return values\n(`skills/registry.py:205-227`, `229-296`).","file":"dist/skills/SkillRegistry.d.ts","line":22,"members":[{"name":"name","kind":"property","owner":"SkillSchemaInfo","signature":["name: string"],"doc":"The skill's registered name (from `SkillBase.SKILL_NAME`).","file":"dist/skills/SkillRegistry.d.ts","line":24},{"name":"description","kind":"property","owner":"SkillSchemaInfo","signature":["description: string"],"doc":"Human-readable description (from `SkillBase.SKILL_DESCRIPTION`).","file":"dist/skills/SkillRegistry.d.ts","line":26},{"name":"version","kind":"property","owner":"SkillSchemaInfo","signature":["version: string"],"doc":"Semantic version string (from `SkillBase.SKILL_VERSION`).","file":"dist/skills/SkillRegistry.d.ts","line":28},{"name":"supportsMultipleInstances","kind":"property","owner":"SkillSchemaInfo","signature":["supportsMultipleInstances: boolean"],"doc":"Whether this skill supports multiple simultaneous instances.","file":"dist/skills/SkillRegistry.d.ts","line":30},{"name":"requiredEnvVars","kind":"property","owner":"SkillSchemaInfo","signature":["requiredEnvVars: string[]"],"doc":"Environment variables required by the skill.","file":"dist/skills/SkillRegistry.d.ts","line":32},{"name":"requiredPackages","kind":"property","owner":"SkillSchemaInfo","signature":["requiredPackages: string[]"],"doc":"NPM packages required by the skill.","file":"dist/skills/SkillRegistry.d.ts","line":34},{"name":"parameters","kind":"property","owner":"SkillSchemaInfo","signature":["parameters: Record<string, ParameterSchemaEntry>"],"doc":"Full parameter schema with types, defaults, and constraints.","file":"dist/skills/SkillRegistry.d.ts","line":36},{"name":"source","kind":"property","owner":"SkillSchemaInfo","signature":["source?: string"],"doc":"Optional source category for grouping (e.g., \"builtin\", \"external\").","file":"dist/skills/SkillRegistry.d.ts","line":38}]},"SkillToolDefinition":{"name":"SkillToolDefinition","kind":"interface","exported":true,"signature":["interface SkillToolDefinition"],"doc":"Definition of a SWAIG tool provided by a skill.","file":"dist/skills/SkillBase.d.ts","line":18,"members":[{"name":"name","kind":"property","owner":"SkillToolDefinition","signature":["name: string"],"doc":"Unique tool name used in SWAIG function registration.","file":"dist/skills/SkillBase.d.ts","line":20},{"name":"description","kind":"property","owner":"SkillToolDefinition","signature":["description: string"],"doc":"Human-readable description of what the tool does, shown to the AI.","file":"dist/skills/SkillBase.d.ts","line":22},{"name":"parameters","kind":"property","owner":"SkillToolDefinition","signature":["parameters?: Record<string, unknown>"],"doc":"Parameter schema for the tool, keyed by parameter name.","file":"dist/skills/SkillBase.d.ts","line":24},{"name":"handler","kind":"property","owner":"SkillToolDefinition","signature":["handler: SwaigHandler"],"doc":"Handler function invoked when the tool is called.","file":"dist/skills/SkillBase.d.ts","line":26},{"name":"secure","kind":"property","owner":"SkillToolDefinition","signature":["secure?: boolean"],"doc":"Whether the tool requires secure (authenticated) invocation.","file":"dist/skills/SkillBase.d.ts","line":28},{"name":"fillers","kind":"property","owner":"SkillToolDefinition","signature":["fillers?: Record<string, string[]>"],"doc":"Filler phrases spoken while the tool executes, keyed by language.","file":"dist/skills/SkillBase.d.ts","line":30},{"name":"required","kind":"property","owner":"SkillToolDefinition","signature":["required?: string[]"],"doc":"List of parameter names that are required.","file":"dist/skills/SkillBase.d.ts","line":32},{"name":"wait_for_fillers","kind":"property","owner":"SkillToolDefinition","signature":["wait_for_fillers?: boolean"],"doc":"If true, wait for any in-flight fillers to complete before executing the tool.","file":"dist/skills/SkillBase.d.ts","line":34},{"name":"skip_fillers","kind":"property","owner":"SkillToolDefinition","signature":["skip_fillers?: boolean"],"doc":"If true, suppress filler phrases while the tool executes.","file":"dist/skills/SkillBase.d.ts","line":36},{"name":"isHangupHook","kind":"property","owner":"SkillToolDefinition","signature":["isHangupHook?: boolean"],"doc":"When true, the SignalWire platform automatically invokes this tool when\nthe call ends (hangup), regardless of whether the AI explicitly calls it.\nEquivalent to Python's `is_hangup_hook=True` in `define_tool()`.\nThe flag is serialised as `\"is_hangup_hook\": true` in the SWAIG JSON.","file":"dist/skills/SkillBase.d.ts","line":43}]},"SpiderSkill":{"name":"SpiderSkill","kind":"class","exported":true,"signature":["class SpiderSkill extends SkillBase"],"doc":"Fast web scraping skill optimized for speed and token efficiency.\n\nMulti-instance capable. Port of the Python `SpiderSkill` with three tools:\n`scrape_url`, `crawl_site`, and `extract_structured_data`. Configuration\nmirrors the Python schema (delay, concurrent_requests, timeout, max_pages,\nmax_depth, extract_type, max_text_length, clean_text, selectors,\nfollow_patterns, user_agent, headers, follow_robots_txt, cache_enabled).\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('spider', { max_pages: 5, max_depth: 2 });\n```","file":"dist/skills/builtin/spider.d.ts","line":32,"members":[{"name":"SKILL_NAME","kind":"property","owner":"SpiderSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":33},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"SpiderSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":34},{"name":"SKILL_VERSION","kind":"property","owner":"SpiderSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":35},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"SpiderSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":36},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"SpiderSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":37},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"SpiderSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":38},{"name":"getParameterSchema","kind":"method","owner":"SpiderSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":53},{"name":"getInstanceKey","kind":"method","owner":"SpiderSkill","signature":["getInstanceKey(): string"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":73},{"name":"setup","kind":"method","owner":"SpiderSkill","signature":["setup(): Promise<boolean>"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":74},{"name":"getHints","kind":"method","owner":"SpiderSkill","signature":["getHints(): string[]"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":75},{"name":"cleanup","kind":"method","owner":"SpiderSkill","signature":["cleanup(): Promise<void>"],"doc":"","file":"dist/skills/builtin/spider.d.ts","line":76},{"name":"getTools","kind":"method","owner":"SpiderSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns Three tools: `scrape_url`, `crawl_site`, and `extract_structured_data`.","file":"dist/skills/builtin/spider.d.ts","line":78}],"bases":["SkillBase"]},"SslConfig":{"name":"SslConfig","kind":"class","exported":true,"signature":["class SslConfig"],"doc":"Manages SSL/TLS configuration sourced from explicit options or environment variables.","file":"dist/SslConfig.d.ts","line":27,"members":[{"name":"enabled","kind":"property","owner":"SslConfig","signature":["enabled: boolean"],"doc":"Whether SSL is enabled.","file":"dist/SslConfig.d.ts","line":29},{"name":"certPath","kind":"property","owner":"SslConfig","signature":["certPath: string | null"],"doc":"Filesystem path to the PEM certificate, or null if unset.","file":"dist/SslConfig.d.ts","line":31},{"name":"keyPath","kind":"property","owner":"SslConfig","signature":["keyPath: string | null"],"doc":"Filesystem path to the PEM private key, or null if unset.","file":"dist/SslConfig.d.ts","line":33},{"name":"domain","kind":"property","owner":"SslConfig","signature":["domain: string | null"],"doc":"Domain name for HSTS, or null if unset.","file":"dist/SslConfig.d.ts","line":35},{"name":"hsts","kind":"property","owner":"SslConfig","signature":["hsts: boolean"],"doc":"Whether HSTS headers should be emitted.","file":"dist/SslConfig.d.ts","line":37},{"name":"hstsMaxAge","kind":"property","owner":"SslConfig","signature":["hstsMaxAge: number"],"doc":"HSTS max-age value in seconds.","file":"dist/SslConfig.d.ts","line":39},{"name":"constructor","kind":"constructor","owner":"SslConfig","signature":["constructor(opts?: SslOptions)"],"doc":"Create an SslConfig, falling back to environment variables for any unset options.\n@param opts - Optional SSL configuration overrides.","file":"dist/SslConfig.d.ts","line":44},{"name":"isConfigured","kind":"method","owner":"SslConfig","signature":["isConfigured(): boolean"],"doc":"Check whether SSL is fully configured: enabled with both cert and key files present on disk.\n@returns True if SSL is enabled and both certificate and key files exist.","file":"dist/SslConfig.d.ts","line":49},{"name":"getCert","kind":"method","owner":"SslConfig","signature":["getCert(): string | null"],"doc":"Read the PEM certificate file from disk.\n@returns The certificate contents, or null if the file is missing.","file":"dist/SslConfig.d.ts","line":54},{"name":"getKey","kind":"method","owner":"SslConfig","signature":["getKey(): string | null"],"doc":"Read the PEM private key file from disk.\n@returns The key contents, or null if the file is missing.","file":"dist/SslConfig.d.ts","line":59},{"name":"getHstsHeader","kind":"method","owner":"SslConfig","signature":["getHstsHeader(): string | null"],"doc":"Build the Strict-Transport-Security header value.\n@returns The HSTS header string, or null if HSTS is disabled or SSL is off.","file":"dist/SslConfig.d.ts","line":64},{"name":"getServerOptions","kind":"method","owner":"SslConfig","signature":["getServerOptions(): {\n cert: string;\n key: string;\n} | null"],"doc":"Create the options object needed by Node.js `https.createServer()`.\n@returns An object with `cert` and `key` strings, or null if either file is missing.","file":"dist/SslConfig.d.ts","line":69},{"name":"hstsMiddleware","kind":"method","owner":"SslConfig","signature":["hstsMiddleware(): MiddlewareHandler"],"doc":"Return a Hono middleware that appends the HSTS header to every response.\n@returns A Hono-compatible middleware function.","file":"dist/SslConfig.d.ts","line":77}]},"SslOptions":{"name":"SslOptions","kind":"interface","exported":true,"signature":["interface SslOptions"],"doc":"Configuration options for SSL/TLS setup.","file":"dist/SslConfig.d.ts","line":12,"members":[{"name":"enabled","kind":"property","owner":"SslOptions","signature":["enabled?: boolean"],"doc":"Whether SSL is enabled.","file":"dist/SslConfig.d.ts","line":14},{"name":"certPath","kind":"property","owner":"SslOptions","signature":["certPath?: string"],"doc":"Filesystem path to the PEM-encoded certificate.","file":"dist/SslConfig.d.ts","line":16},{"name":"keyPath","kind":"property","owner":"SslOptions","signature":["keyPath?: string"],"doc":"Filesystem path to the PEM-encoded private key.","file":"dist/SslConfig.d.ts","line":18},{"name":"domain","kind":"property","owner":"SslOptions","signature":["domain?: string"],"doc":"Domain name used for HSTS headers.","file":"dist/SslConfig.d.ts","line":20},{"name":"hsts","kind":"property","owner":"SslOptions","signature":["hsts?: boolean"],"doc":"Whether to send HSTS headers; defaults to true.","file":"dist/SslConfig.d.ts","line":22},{"name":"hstsMaxAge","kind":"property","owner":"SslOptions","signature":["hstsMaxAge?: number"],"doc":"HSTS max-age in seconds; defaults to 31536000 (1 year).","file":"dist/SslConfig.d.ts","line":24}]},"StandaloneCollectAction":{"name":"StandaloneCollectAction","kind":"class","exported":true,"signature":["class StandaloneCollectAction extends Action"],"doc":"Async handle for a bare `calling.call.collect` action (no accompanying play).","file":"dist/relay/Action.d.ts","line":197,"members":[{"name":"constructor","kind":"constructor","owner":"StandaloneCollectAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":198},{"name":"stop","kind":"method","owner":"StandaloneCollectAction","signature":["stop(): Promise<CallingCollectStopResult>"],"doc":"Stop the collect operation before input is received.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":206},{"name":"startInputTimers","kind":"method","owner":"StandaloneCollectAction","signature":["startInputTimers(): Promise<CallingCollectStartInputTimersResult>"],"doc":"Start the collect input timers.\n\n@returns The platform's start_input_timers response.\n@throws {RelayError} When the command is rejected.","file":"dist/relay/Action.d.ts","line":213}],"bases":["Action"]},"Step":{"name":"Step","kind":"class","exported":true,"signature":["class Step"],"doc":"A single step within a context, with prompt content, criteria, function restrictions, and navigation rules.","file":"dist/ContextBuilder.d.ts","line":224,"members":[{"name":"name","kind":"property","owner":"Step","signature":["name: string"],"doc":"The unique name identifying this step within its context.","file":"dist/ContextBuilder.d.ts","line":226},{"name":"constructor","kind":"constructor","owner":"Step","signature":["constructor(name: string)"],"doc":"Creates a new Step.\n@param name - The unique step name.","file":"dist/ContextBuilder.d.ts","line":246},{"name":"setText","kind":"method","owner":"Step","signature":["setText(text: string): this"],"doc":"Sets raw text content for this step, mutually exclusive with POM sections.\n@param text - The raw prompt text.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":252},{"name":"addSection","kind":"method","owner":"Step","signature":["addSection(title: string, body: string): this"],"doc":"Adds a POM section with a body, mutually exclusive with raw text.\n@param title - The section heading.\n@param body - The section body text.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":259},{"name":"addBullets","kind":"method","owner":"Step","signature":["addBullets(title: string, bullets: string[]): this"],"doc":"Adds a POM section with bullet points, mutually exclusive with raw text.\n@param title - The section heading.\n@param bullets - The list of bullet point strings.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":266},{"name":"setStepCriteria","kind":"method","owner":"Step","signature":["setStepCriteria(criteria: string): this"],"doc":"Sets the criteria that must be met before this step is considered complete.\n@param criteria - A description of the completion criteria.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":272},{"name":"setFunctions","kind":"method","owner":"Step","signature":["setFunctions(functions: string | string[]): this"],"doc":"Set which non-internal functions are callable while this step is active.\n\nIMPORTANT — inheritance behavior:\n If you do NOT call this method, the step inherits whichever function\n set was active on the previous step (or the previous context's last\n step). The server-side runtime only resets the active set when a\n step explicitly declares its `functions` field. This is by design,\n but it is the most common source of bugs in multi-step agents:\n forgetting setFunctions() on a later step lets the previous step's\n tools leak through.\n\n Best practice: call setFunctions() explicitly on every step that\n should have a different toolset than the previous one.\n\nKeep the per-step active set small: LLM tool selection accuracy\ndegrades noticeably past ~7-8 simultaneously-active tools per call.\nUse per-step whitelisting to partition large tool collections.\n\nInternal functions (e.g. `startup_hook`, `hangup_hook`, `gather_submit`)\nare ALWAYS protected and cannot be deactivated by this whitelist. The\nnative navigation tools `next_step` and `change_context` are injected\nautomatically when validSteps/validContexts is set; they are not\naffected by this list and do not need to appear in it.\n\n@param functions - One of:\n - `string[]` — whitelist of function names allowed in this step.\n Functions not in the list become inactive.\n - `[]` — explicit disable-all (no user functions callable).\n - `\"none\"` — synonym for `[]`, same effect.\n@returns This step for chaining.\n\n@example\nstep.setFunctions(['lookup_account', 'check_balance']); // whitelist\nstep.setFunctions([]); // disable all\nstep.setFunctions('none'); // disable all (alt)","file":"dist/ContextBuilder.d.ts","line":310},{"name":"setValidSteps","kind":"method","owner":"Step","signature":["setValidSteps(steps: string[]): this"],"doc":"Sets which steps the AI may navigate to from this step.\n@param steps - List of allowed step names.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":316},{"name":"setValidContexts","kind":"method","owner":"Step","signature":["setValidContexts(contexts: string[]): this"],"doc":"Sets which contexts the AI may navigate to from this step.\n@param contexts - List of allowed context names.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":322},{"name":"setEnd","kind":"method","owner":"Step","signature":["setEnd(end: boolean): this"],"doc":"Mark this step as terminal for the step flow.\n\nIMPORTANT: `end=true` does NOT end the conversation or hang up the\ncall. It exits step mode entirely after this step executes — clearing\nthe steps list, current step index, validSteps, and validContexts.\nThe agent keeps running, but operates only under the base system\nprompt and the context-level prompt; no more step instructions are\ninjected and no more `next_step` tool is offered.\n\nTo actually end the call, call a hangup tool or define a hangup hook.\n\n@param end - True to exit step mode after this step.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":338},{"name":"setSkipUserTurn","kind":"method","owner":"Step","signature":["setSkipUserTurn(skip: boolean): this"],"doc":"Sets whether to skip waiting for user input when entering this step.\n@param skip - Whether to skip the user turn.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":344},{"name":"setSkipToNextStep","kind":"method","owner":"Step","signature":["setSkipToNextStep(skip: boolean): this"],"doc":"Sets whether to automatically advance to the next step after this one completes.\n@param skip - Whether to skip to the next step.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":350},{"name":"setGatherInfo","kind":"method","owner":"Step","signature":["setGatherInfo(opts?: {\n outputKey?: string;\n completionAction?: string;\n prompt?: string;\n isolated?: boolean;\n}): this"],"doc":"Initializes a gather info operation on this step for collecting structured data.\n\n`isolated` is the default for every question in this gather. When true, a\nquestion is asked with the sibling Q&A hidden from the model, so it must ask\nrather than derive the answer from an earlier one. A question's own\n`isolated` overrides this. The hidden turns remain in the call log.\n\n@param opts - Optional output key, completion action, prompt, and isolated-default configuration.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":362},{"name":"addGatherQuestion","kind":"method","owner":"Step","signature":["addGatherQuestion(opts: {\n key: string;\n question: string;\n type?: string;\n confirm?: boolean;\n prompt?: string;\n functions?: string[];\n isolated?: boolean;\n}): this"],"doc":"Add a question to this step's gather_info configuration.\nsetGatherInfo() must be called before this method.\n\nIMPORTANT — gather mode locks function access:\n While the model is asking gather questions, the runtime forcibly\n deactivates ALL of the step's other functions. The only callable\n tools during a gather question are:\n\n - `gather_submit` (the native answer-submission tool)\n - Whatever names you list in this question's `functions` option\n\n `next_step` and `change_context` are also filtered out — the model\n cannot navigate away until the gather completes. This is by design:\n it forces a tight ask → submit → next-question loop.\n\n If a question needs to call out to a tool (e.g. validate an email,\n geocode a ZIP), list that tool name in this question's `functions`.\n Functions listed here are active ONLY for this question.\n\n@param opts - Question configuration including key, question text, and optional\n type/confirm/prompt/functions/isolated. `isolated` overrides the gather's default\n for this one question: true hides the sibling Q&A while it is asked, false keeps\n it visible even in an isolated gather, omitted inherits the gather's setting.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":394},{"name":"getGatherInfo","kind":"method","owner":"Step","signature":["getGatherInfo(): GatherInfo | null"],"doc":"Returns the gather info for this step, if any.\n@internal","file":"dist/ContextBuilder.d.ts","line":407},{"name":"getValidSteps","kind":"method","owner":"Step","signature":["getValidSteps(): string[] | null"],"doc":"Returns the valid steps list for this step, if any.\n@internal","file":"dist/ContextBuilder.d.ts","line":412},{"name":"getStepValidContexts","kind":"method","owner":"Step","signature":["getStepValidContexts(): string[] | null"],"doc":"Returns the valid contexts list for this step, if any.\n@internal","file":"dist/ContextBuilder.d.ts","line":417},{"name":"getFunctions","kind":"method","owner":"Step","signature":["getFunctions(): string[] | null"],"doc":"Returns this step's function whitelist as an array of tool NAMES to\nvalidate, or null when there is nothing to validate. A string value\n(`'none'` and any other string) is a disable-all sentinel — NOT a tool\nname — so it yields null; only the array form is a real whitelist.\n@internal","file":"dist/ContextBuilder.d.ts","line":425},{"name":"clearSections","kind":"method","owner":"Step","signature":["clearSections(): this"],"doc":"Removes all POM sections and raw text from this step.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":430},{"name":"setResetSystemPrompt","kind":"method","owner":"Step","signature":["setResetSystemPrompt(systemPrompt: string): this"],"doc":"Sets the system prompt to use when resetting context at this step.\n@param systemPrompt - The replacement system prompt text.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":436},{"name":"setResetUserPrompt","kind":"method","owner":"Step","signature":["setResetUserPrompt(userPrompt: string): this"],"doc":"Sets the user prompt to use when resetting context at this step.\n@param userPrompt - The replacement user prompt text.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":442},{"name":"setResetConsolidate","kind":"method","owner":"Step","signature":["setResetConsolidate(consolidate: boolean): this"],"doc":"Sets whether to consolidate conversation history when resetting at this step.\n@param consolidate - Whether to consolidate.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":448},{"name":"setResetFullReset","kind":"method","owner":"Step","signature":["setResetFullReset(fullReset: boolean): this"],"doc":"Sets whether to perform a full conversation reset at this step.\n@param fullReset - Whether to fully reset.\n@returns This step for chaining.","file":"dist/ContextBuilder.d.ts","line":454},{"name":"setHistory","kind":"method","owner":"Step","signature":["setHistory(history: string): this"],"doc":"Control what the model still sees when this step is entered.\n\nThe mode applies at the moment this step is entered and governs\neverything that came before it. It does not affect this step's own\nturns, which accumulate fresh. Nothing is deleted from the call log.\n\n@param history - One of:\n - `\"keep\"`: clear nothing. Every prior step's instructions and\n dialogue stay visible to the model.\n - `\"default\"`: hide the prior step *instructions*, keep the\n user/assistant dialogue. This is the default when unset.\n - `\"hide\"`: hide the prior instructions *and* pull the prior dialogue\n out of the model's context. Pair it with a `${step_history.*}`\n reference in this step's text to choose exactly what comes back.\n@returns This step for chaining.\n@throws {Error} If `history` is not one of the three modes.","file":"dist/ContextBuilder.d.ts","line":473},{"name":"toDict","kind":"method","owner":"Step","signature":["toDict(): StepDict"],"doc":"Serializes this step to a plain object for SWML output.\n@returns A dictionary representation of this step.","file":"dist/ContextBuilder.d.ts","line":479},{"name":"toJSON","kind":"method","owner":"Step","signature":["toJSON(): StepDict"],"doc":"TS-native serialization hook so `JSON.stringify` emits the wire shape via\n{@link Step.toDict}. No Python counterpart.","file":"dist/ContextBuilder.d.ts","line":484}]},"StreamAction":{"name":"StreamAction","kind":"class","exported":true,"signature":["class StreamAction extends Action"],"doc":"Async handle for a `calling.call.stream` action (outbound media stream).","file":"dist/relay/Action.d.ts","line":239,"members":[{"name":"constructor","kind":"constructor","owner":"StreamAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":240},{"name":"stop","kind":"method","owner":"StreamAction","signature":["stop(): Promise<CallingStreamStopResult>"],"doc":"Stop the outbound stream.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":247}],"bases":["Action"]},"StreamEvent":{"name":"StreamEvent","kind":"class","exported":true,"signature":["class StreamEvent extends RelayEvent"],"doc":"`calling.call.stream` — outbound media stream state change (e.g. RTMP/WebSocket streaming).","file":"dist/relay/RelayEvent.d.ts","line":135,"members":[{"name":"controlId","kind":"property","owner":"StreamEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":136},{"name":"state","kind":"property","owner":"StreamEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":137},{"name":"url","kind":"property","owner":"StreamEvent","readonly":true,"signature":["readonly url: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":138},{"name":"name","kind":"property","owner":"StreamEvent","readonly":true,"signature":["readonly name: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":139},{"name":"constructor","kind":"constructor","owner":"StreamEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, url?: string, name?: string)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":140},{"name":"fromPayload","kind":"method","owner":"StreamEvent","static":true,"signature":["static fromPayload(payload: EventPayload): StreamEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":141}],"bases":["RelayEvent"]},"SubscribersResource":{"name":"SubscribersResource","kind":"class","exported":true,"signature":["class Subscribers extends FabricResource<SubscriberListResponse, SubscriberResponse, SubscriberRequest, SubscriberRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":121,"members":[{"name":"constructor","kind":"constructor","owner":"SubscribersResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":123},{"name":"create","kind":"method","owner":"SubscribersResource","signature":["create(body: SubscriberRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SubscriberResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":125},{"name":"update","kind":"method","owner":"SubscribersResource","signature":["update(id: string, body: SubscriberRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SubscriberResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":127},{"name":"listSipEndpoints","kind":"method","owner":"SubscribersResource","signature":["listSipEndpoints(fabric_subscriber_id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<SubscriberSipEndpointListResponse>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":128},{"name":"createSipEndpoint","kind":"method","owner":"SubscribersResource","signature":["createSipEndpoint(fabric_subscriber_id: string, username: string, password: string, options?: {\n caller_id?: string;\n send_as?: string;\n ciphers?: Ciphers[];\n codecs?: Codecs[];\n encryption?: Encryption;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<SubscriberSIPEndpoint>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":129},{"name":"getSipEndpoint","kind":"method","owner":"SubscribersResource","signature":["getSipEndpoint(fabric_subscriber_id: string, id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<SubscriberSIPEndpoint>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":137},{"name":"updateSipEndpoint","kind":"method","owner":"SubscribersResource","signature":["updateSipEndpoint(fabric_subscriber_id: string, id: string, options?: {\n username?: string;\n password?: string;\n caller_id?: string;\n send_as?: string;\n ciphers?: Ciphers[];\n codecs?: Codecs[];\n encryption?: Encryption;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<SubscriberSIPEndpoint>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":138},{"name":"deleteSipEndpoint","kind":"method","owner":"SubscribersResource","signature":["deleteSipEndpoint(fabric_subscriber_id: string, id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":148}],"bases":["FabricResource"]},"SummarizeOptions":{"name":"SummarizeOptions","kind":"interface","exported":true,"signature":["interface SummarizeOptions"],"doc":"Sampling / prompt options for {@link AIChatClient.summarize}.","file":"dist/ai-chat/AIChatClient.d.ts","line":152,"members":[{"name":"summaryPrompt","kind":"property","owner":"SummarizeOptions","signature":["summaryPrompt?: string"],"doc":"Custom prompt steering the summary (wire `summary_prompt`).","file":"dist/ai-chat/AIChatClient.d.ts","line":154},{"name":"temperature","kind":"property","owner":"SummarizeOptions","signature":["temperature?: number"],"doc":"Sampling temperature.","file":"dist/ai-chat/AIChatClient.d.ts","line":156},{"name":"topP","kind":"property","owner":"SummarizeOptions","signature":["topP?: number"],"doc":"Nucleus-sampling top-p.","file":"dist/ai-chat/AIChatClient.d.ts","line":158},{"name":"frequencyPenalty","kind":"property","owner":"SummarizeOptions","signature":["frequencyPenalty?: number"],"doc":"Frequency penalty.","file":"dist/ai-chat/AIChatClient.d.ts","line":160},{"name":"presencePenalty","kind":"property","owner":"SummarizeOptions","signature":["presencePenalty?: number"],"doc":"Presence penalty.","file":"dist/ai-chat/AIChatClient.d.ts","line":162},{"name":"maxTokens","kind":"property","owner":"SummarizeOptions","signature":["maxTokens?: number"],"doc":"Max tokens for the summary.","file":"dist/ai-chat/AIChatClient.d.ts","line":164}]},"SummaryCallback":{"name":"SummaryCallback","kind":"type","exported":true,"signature":["type SummaryCallback = (summary: PostPromptData | null, rawData: PostPrompt) => void | Promise<void>"],"doc":"Callback invoked when a post-prompt summary is received at the end of a call.\n@param summary - Parsed summary object, or null if extraction failed.\n@param rawData - The full raw post-prompt payload.","file":"dist/types.d.ts","line":177},"SummaryError":{"name":"SummaryError","kind":"class","exported":true,"signature":["class SummaryError extends AIChatError"],"doc":"Summary generation failed. `summarize` returns EXACTLY ONE of `{summary}`\n(success) or `{error}` (generation failed), and the failure rides the JSON-RPC\n*success* envelope — not an `error` object — so it never reaches the error-code\nmapping. Surfaced here so a failed summary can't masquerade as an empty string.\n`code` is `null` (no JSON-RPC code).","file":"dist/ai-chat/AIChatClient.d.ts","line":81,"members":[{"name":"constructor","kind":"constructor","owner":"SummaryError","signature":["constructor(code: number | null, message: string)"],"doc":"","file":"dist/ai-chat/AIChatClient.d.ts","line":82}],"bases":["AIChatError"]},"SurveyAgent":{"name":"SurveyAgent","kind":"class","exported":true,"signature":["class SurveyAgent extends AgentBase"],"doc":"Prefab agent that conducts surveys with branching logic, answer scoring, and conditional question flow.\n\nEach survey question declares its response type (rating, yes/no, open text, etc.), an optional\nset of conditional follow-ups, and a scoring map. The agent walks the question tree, tallies a\ntotal score, and exposes the full response map at call end via `onSummary()`.\n\n@example Customer satisfaction survey\n```ts\nimport { SurveyAgent } from '@signalwire/sdk';\n\nconst agent = new SurveyAgent({\n surveyName: 'CSAT',\n brandName: 'Acme Co',\n questions: [\n { id: 'q1', text: 'How satisfied were you with our service?', type: 'rating', scale: 5 },\n { id: 'q2', text: 'Would you recommend us to a friend?', type: 'yes_no' },\n { id: 'q3', text: 'Anything else you want to share?', type: 'open_ended' },\n ],\n});\n\nawait agent.serve({ port: 3000 });\n```","file":"dist/prefabs/SurveyAgent.d.ts","line":94,"members":[{"name":"surveyName","kind":"property","owner":"SurveyAgent","signature":["surveyName: string"],"doc":"Human-readable survey name.","file":"dist/prefabs/SurveyAgent.d.ts","line":96},{"name":"questions","kind":"property","owner":"SurveyAgent","signature":["questions: SurveyQuestion[]"],"doc":"The configured survey questions (public, matching Python).","file":"dist/prefabs/SurveyAgent.d.ts","line":98},{"name":"brandName","kind":"property","owner":"SurveyAgent","signature":["brandName: string"],"doc":"Brand/company name used in prompts.","file":"dist/prefabs/SurveyAgent.d.ts","line":100},{"name":"maxRetries","kind":"property","owner":"SurveyAgent","signature":["maxRetries: number"],"doc":"Maximum number of times to retry invalid answers.","file":"dist/prefabs/SurveyAgent.d.ts","line":102},{"name":"introduction","kind":"property","owner":"SurveyAgent","signature":["introduction: string"],"doc":"Opening message before the first question.","file":"dist/prefabs/SurveyAgent.d.ts","line":104},{"name":"conclusion","kind":"property","owner":"SurveyAgent","signature":["conclusion: string"],"doc":"Closing message shown when the survey completes.","file":"dist/prefabs/SurveyAgent.d.ts","line":106},{"name":"constructor","kind":"constructor","owner":"SurveyAgent","signature":["constructor(config: SurveyConfig)"],"doc":"Create a SurveyAgent with the specified questions and callbacks.\n@param config - Configuration including questions, messages, and completion callback.","file":"dist/prefabs/SurveyAgent.d.ts","line":115},{"name":"defineTools","kind":"method","owner":"SurveyAgent","protected":true,"signature":["protected defineTools(): void"],"doc":"Register SWAIG tools:\n - Tools matching the Python SDK: `validate_response`, `log_response`\n - TS-specific session tools: `answer_question`, `get_current_question`, `get_survey_progress`","file":"dist/prefabs/SurveyAgent.d.ts","line":133},{"name":"validateResponse","kind":"method","owner":"SurveyAgent","signature":["validateResponse(args: Record<string, unknown>, _rawData: Record<string, unknown>): FunctionResult"],"doc":"SWAIG handler for `validate_response`: check whether a response satisfies a\nquestion's type/constraints. Mirrors Python `SurveyAgent.validate_response`.","file":"dist/prefabs/SurveyAgent.d.ts","line":138},{"name":"logResponse","kind":"method","owner":"SurveyAgent","signature":["logResponse(args: Record<string, unknown>, rawData: Record<string, unknown>): FunctionResult"],"doc":"SWAIG handler for `log_response`: record a validated response on the per-call\nsession. Mirrors Python `SurveyAgent.log_response`.","file":"dist/prefabs/SurveyAgent.d.ts","line":143},{"name":"onSummary","kind":"method","owner":"SurveyAgent","signature":["onSummary(summary: Record<string, unknown> | string | null, rawData: PostPrompt): void | Promise<void>"],"doc":"Process the survey results summary returned at the end of a call.\nMirrors Python `on_summary`: structured (dict-like) summaries are logged\nas JSON; unstructured summaries are logged verbatim.\n\nThe parameter type widens the base `AgentBase.onSummary` signature to\naccept string payloads as well, matching Python's `isinstance(summary, dict)`\nbranch even though the current framework only surfaces object summaries.\n\nThe summary marks the end of the call, so this also drops the call's\nper-call survey state. A subclass that overrides this hook should call\n`super.onSummary(summary, rawData)`; otherwise the state is dropped after\nthe call has been idle for an hour.","file":"dist/prefabs/SurveyAgent.d.ts","line":158}],"bases":["AgentBase"]},"SurveyConfig":{"name":"SurveyConfig","kind":"interface","exported":true,"signature":["interface SurveyConfig"],"doc":"Configuration for the {@link SurveyAgent}.","file":"dist/prefabs/SurveyAgent.d.ts","line":48,"members":[{"name":"surveyName","kind":"property","owner":"SurveyConfig","signature":["surveyName: string"],"doc":"Human-readable survey name, used in prompts and global data.","file":"dist/prefabs/SurveyAgent.d.ts","line":50},{"name":"questions","kind":"property","owner":"SurveyConfig","signature":["questions: SurveyQuestion[]"],"doc":"Ordered list of survey questions.","file":"dist/prefabs/SurveyAgent.d.ts","line":52},{"name":"introduction","kind":"property","owner":"SurveyConfig","signature":["introduction?: string"],"doc":"Opening message before the first question (matches Python `introduction`).","file":"dist/prefabs/SurveyAgent.d.ts","line":54},{"name":"conclusion","kind":"property","owner":"SurveyConfig","signature":["conclusion?: string"],"doc":"Message after the survey is complete (matches Python `conclusion`).","file":"dist/prefabs/SurveyAgent.d.ts","line":56},{"name":"brandName","kind":"property","owner":"SurveyConfig","signature":["brandName?: string"],"doc":"Brand or company name the agent represents (matches Python `brand_name`).","file":"dist/prefabs/SurveyAgent.d.ts","line":58},{"name":"maxRetries","kind":"property","owner":"SurveyConfig","signature":["maxRetries?: number"],"doc":"Maximum number of times to retry invalid answers. Defaults to 2.","file":"dist/prefabs/SurveyAgent.d.ts","line":60},{"name":"name","kind":"property","owner":"SurveyConfig","signature":["name?: string"],"doc":"Agent display name (defaults to `\"survey\"`).","file":"dist/prefabs/SurveyAgent.d.ts","line":62},{"name":"route","kind":"property","owner":"SurveyConfig","signature":["route?: string"],"doc":"HTTP route for this agent (defaults to `\"/survey\"`).","file":"dist/prefabs/SurveyAgent.d.ts","line":64},{"name":"onComplete","kind":"property","owner":"SurveyConfig","signature":["onComplete?: (responses: Record<string, unknown>, score: number) => void | Promise<void>"],"doc":"Callback fired when the survey is finished.","file":"dist/prefabs/SurveyAgent.d.ts","line":66},{"name":"agentOptions","kind":"property","owner":"SurveyConfig","signature":["agentOptions?: Partial<AgentOptions>"],"doc":"Additional AgentBase options forwarded to super().","file":"dist/prefabs/SurveyAgent.d.ts","line":68}]},"SurveyQuestion":{"name":"SurveyQuestion","kind":"interface","exported":true,"signature":["interface SurveyQuestion"],"doc":"A single survey question consumed by {@link SurveyAgent}.","file":"dist/prefabs/SurveyAgent.d.ts","line":14,"members":[{"name":"id","kind":"property","owner":"SurveyQuestion","signature":["id: string"],"doc":"Unique question identifier.","file":"dist/prefabs/SurveyAgent.d.ts","line":16},{"name":"text","kind":"property","owner":"SurveyQuestion","signature":["text: string"],"doc":"The question text to ask the caller.","file":"dist/prefabs/SurveyAgent.d.ts","line":18},{"name":"type","kind":"property","owner":"SurveyQuestion","signature":["type: 'multiple_choice' | 'open_ended' | 'rating' | 'yes_no'"],"doc":"Question type determines validation and display.","file":"dist/prefabs/SurveyAgent.d.ts","line":20},{"name":"options","kind":"property","owner":"SurveyQuestion","signature":["options?: string[]"],"doc":"Options for multiple_choice questions.","file":"dist/prefabs/SurveyAgent.d.ts","line":22},{"name":"scale","kind":"property","owner":"SurveyQuestion","signature":["scale?: number"],"doc":"For `rating` questions, the upper bound of the scale (1..scale).\nDefaults to 5 (matching the Python prefab) when unspecified.","file":"dist/prefabs/SurveyAgent.d.ts","line":27},{"name":"required","kind":"property","owner":"SurveyQuestion","signature":["required?: boolean"],"doc":"Whether the question requires an answer. Defaults to `true`.\nMirrors the Python `required` flag on each question dict.","file":"dist/prefabs/SurveyAgent.d.ts","line":32},{"name":"nextQuestion","kind":"property","owner":"SurveyQuestion","signature":["nextQuestion?: string | Record<string, string>"],"doc":"Next question ID after this one.\n- string: always go to that question\n- Record<string, string>: map from answer value to next question ID\n- undefined: proceed to next question in array order","file":"dist/prefabs/SurveyAgent.d.ts","line":39},{"name":"points","kind":"property","owner":"SurveyQuestion","signature":["points?: number | Record<string, number>"],"doc":"Points awarded for answers.\n- number: fixed points for any answer\n- Record<string, number>: points per specific answer value","file":"dist/prefabs/SurveyAgent.d.ts","line":45}]},"SwaigArgument":{"name":"SwaigArgument","kind":"interface","exported":true,"signature":["interface SwaigArgument"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":1,"members":[{"name":"parsed","kind":"property","owner":"SwaigArgument","signature":["parsed?: unknown[]"],"doc":"JSON objects parsed from the model's argument string (always an array, possibly empty).","file":"dist/SwaigContracts.generated.d.ts","line":3},{"name":"raw","kind":"property","owner":"SwaigArgument","signature":["raw?: string"],"doc":"The original argument string.","file":"dist/SwaigContracts.generated.d.ts","line":5},{"name":"substituted","kind":"property","owner":"SwaigArgument","signature":["substituted?: string"],"doc":"The argument string with JSON blocks replaced.","file":"dist/SwaigContracts.generated.d.ts","line":7}]},"SwaigFunction":{"name":"SwaigFunction","kind":"class","exported":true,"signature":["class SwaigFunction"],"doc":"A SWAIG function — exactly the same concept as a \"tool\" in native\nOpenAI / Anthropic tool calling.\n\nEach SwaigFunction is rendered, on every LLM turn, into the OpenAI\ntool schema:\n\n```json\n{\n \"type\": \"function\",\n \"function\": {\n \"name\": \"<this.name>\",\n \"description\": \"<this.description>\",\n \"parameters\": { \"type\": \"object\", \"properties\": { ... } }\n }\n}\n```\n\nThe `name`, `description`, and every per-parameter `description` inside\n`parameters` are **read by the model** and directly determine whether\nthe model picks this tool when a matching user request comes in.\nThey are prompt engineering, not developer comments.","file":"dist/SwaigFunction.d.ts","line":174,"members":[{"name":"name","kind":"property","owner":"SwaigFunction","signature":["name: string"],"doc":"Unique name — read by the LLM; use snake_case verbs.","file":"dist/SwaigFunction.d.ts","line":176},{"name":"handler","kind":"property","owner":"SwaigFunction","signature":["handler: SwaigHandler"],"doc":"The handler function called when the tool is invoked.","file":"dist/SwaigFunction.d.ts","line":178},{"name":"description","kind":"property","owner":"SwaigFunction","signature":["description: string"],"doc":"LLM-facing description. Tells the model WHEN to call this tool.\nA vague description is the #1 cause of \"model has the tool but\ndoesn't call it\" failures.","file":"dist/SwaigFunction.d.ts","line":184},{"name":"parameters","kind":"property","owner":"SwaigFunction","signature":["parameters: Record<string, unknown>"],"doc":"JSON Schema properties describing the tool's parameters. Each\nproperty's `description` field is ALSO LLM-facing — it tells the\nmodel HOW to extract that argument from the user's utterance.","file":"dist/SwaigFunction.d.ts","line":190},{"name":"secure","kind":"property","owner":"SwaigFunction","signature":["secure: boolean"],"doc":"Whether this tool requires session token authentication.","file":"dist/SwaigFunction.d.ts","line":192},{"name":"fillers","kind":"property","owner":"SwaigFunction","signature":["fillers?: Record<string, string[]>"],"doc":"Language-keyed filler phrases spoken while the tool executes.","file":"dist/SwaigFunction.d.ts","line":194},{"name":"waitFile","kind":"property","owner":"SwaigFunction","signature":["waitFile?: string"],"doc":"Audio file URL to play while waiting for the tool to complete.","file":"dist/SwaigFunction.d.ts","line":196},{"name":"waitFileLoops","kind":"property","owner":"SwaigFunction","signature":["waitFileLoops?: number"],"doc":"Number of times to loop the wait file.","file":"dist/SwaigFunction.d.ts","line":198},{"name":"webhookUrl","kind":"property","owner":"SwaigFunction","signature":["webhookUrl?: string"],"doc":"External webhook URL; set when the tool is externally hosted.","file":"dist/SwaigFunction.d.ts","line":200},{"name":"required","kind":"property","owner":"SwaigFunction","signature":["required: string[]"],"doc":"List of required parameter names.","file":"dist/SwaigFunction.d.ts","line":202},{"name":"extraFields","kind":"property","owner":"SwaigFunction","signature":["extraFields: Record<string, unknown>"],"doc":"Additional fields included in the SWAIG definition output.","file":"dist/SwaigFunction.d.ts","line":204},{"name":"isTypedHandler","kind":"property","owner":"SwaigFunction","signature":["isTypedHandler: boolean"],"doc":"Whether this tool uses a typed handler with named parameters.","file":"dist/SwaigFunction.d.ts","line":206},{"name":"isExternal","kind":"property","owner":"SwaigFunction","signature":["isExternal: boolean"],"doc":"Whether this tool is externally hosted (has a webhookUrl).","file":"dist/SwaigFunction.d.ts","line":208},{"name":"onError","kind":"property","owner":"SwaigFunction","signature":["onError?: SwaigErrorHandler"],"doc":"Per-tool error hook; see {@link SwaigErrorHandler}.","file":"dist/SwaigFunction.d.ts","line":210},{"name":"errorMessage","kind":"property","owner":"SwaigFunction","signature":["errorMessage?: string"],"doc":"Per-tool user-facing error message override.","file":"dist/SwaigFunction.d.ts","line":212},{"name":"constructor","kind":"constructor","owner":"SwaigFunction","signature":["constructor(opts: SwaigFunctionOptions)"],"doc":"Create a new SwaigFunction.\n\n@param opts - Configuration options for the SWAIG function.\n Use `opts.extraFields` to pass any additional SWAIG-only fields\n (e.g. `meta_data_token`, `web_hook_auth_user`, `web_hook_auth_password`).\n This mirrors the Python constructor's `**extra_swaig_fields` kwargs:\n both are merged directly into the serialized SWAIG definition, so the\n wire format is identical — only the call-site syntax differs.","file":"dist/SwaigFunction.d.ts","line":223},{"name":"validateArgs","kind":"method","owner":"SwaigFunction","signature":["validateArgs(args: Record<string, unknown>): [boolean, string[]]"],"doc":"Validate arguments against the parameter JSON schema using full\nJSON Schema Draft-7 validation (via ajv).\n\nMirrors Python's `validate_args` which tries `jsonschema_rs` (Rust-based\nDraft-7 validator) then falls back to `jsonschema` (pure Python Draft-7).\nAll JSON Schema constraint keywords are honoured: `required`, `type`,\n`minLength`, `maxLength`, `pattern`, `format`, `minimum`, `maximum`,\n`enum`, `anyOf`, `oneOf`, `$ref`, nested object/array validation, etc.\n\nIf the schema has no properties, validation is skipped and the args are\nconsidered valid — matching Python's early-return path.\n\n@param args - Arguments to validate.\n@returns A tuple of `[isValid, errors]`. When no validation is needed\n (empty schema), returns `[true, []]`.","file":"dist/SwaigFunction.d.ts","line":242},{"name":"execute","kind":"method","owner":"SwaigFunction","signature":["execute(args: Record<string, unknown>, rawData?: SwaigRequest, agentOnError?: SwaigErrorHandler): Promise<SwaigResultDict>"],"doc":"Invoke the handler with the given arguments and return a serialized result.\n@param args - Parsed arguments from the AI.\n@param rawData - The full raw request payload.\n@returns A serialized result dictionary suitable for the SWAIG response.","file":"dist/SwaigFunction.d.ts","line":249},{"name":"toSwaig","kind":"method","owner":"SwaigFunction","signature":["toSwaig(baseUrl: string, token?: string, callId?: string): Record<string, unknown>"],"doc":"Serialize this function to the SWAIG wire format for inclusion in SWML.\n@param baseUrl - The base URL of the agent server.\n@param token - Optional session token for secure functions.\n@param callId - Optional call ID for secure function URLs.\n@returns A SWAIG function definition object.","file":"dist/SwaigFunction.d.ts","line":264}]},"SwaigFunctionOptions":{"name":"SwaigFunctionOptions","kind":"interface","exported":true,"signature":["interface SwaigFunctionOptions"],"doc":"Configuration options for creating a SwaigFunction.","file":"dist/SwaigFunction.d.ts","line":85,"members":[{"name":"name","kind":"property","owner":"SwaigFunctionOptions","signature":["name: string"],"doc":"Unique name used to register and invoke this tool.","file":"dist/SwaigFunction.d.ts","line":87},{"name":"handler","kind":"property","owner":"SwaigFunctionOptions","signature":["handler: SwaigHandler"],"doc":"The handler function called when the tool is invoked.","file":"dist/SwaigFunction.d.ts","line":89},{"name":"description","kind":"property","owner":"SwaigFunctionOptions","signature":["description: string"],"doc":"Human-readable description of what the tool does, shown to the AI.","file":"dist/SwaigFunction.d.ts","line":91},{"name":"parameters","kind":"property","owner":"SwaigFunctionOptions","signature":["parameters?: Record<string, unknown>"],"doc":"JSON Schema properties describing the tool's parameters.","file":"dist/SwaigFunction.d.ts","line":93},{"name":"secure","kind":"property","owner":"SwaigFunctionOptions","signature":["secure?: boolean"],"doc":"Whether this tool requires session token authentication.\n\n**Defaults to `true` — secure by default.** A tool registered without an\nexplicit `secure` requires SWAIG token validation, and its rendered SWML\nwebhook carries a per-tool `__token`. Pass `secure: false` only to\ndeliberately expose a tool on the unauthenticated shared webhook URL.\n\n**Python equivalent:** `define_tool(..., secure: bool = True)` — every\nuser-facing entry point in the reference (`ToolMixin.define_tool`,\n`ToolRegistry.define_tool`, the `@AgentBase.tool()` decorator) defaults\n`secure=True`.","file":"dist/SwaigFunction.d.ts","line":107},{"name":"fillers","kind":"property","owner":"SwaigFunctionOptions","signature":["fillers?: Record<string, string[]>"],"doc":"Language-keyed filler phrases spoken while the tool executes.","file":"dist/SwaigFunction.d.ts","line":109},{"name":"waitFile","kind":"property","owner":"SwaigFunctionOptions","signature":["waitFile?: string"],"doc":"Audio file URL to play while waiting for the tool to complete.","file":"dist/SwaigFunction.d.ts","line":111},{"name":"waitFileLoops","kind":"property","owner":"SwaigFunctionOptions","signature":["waitFileLoops?: number"],"doc":"Number of times to loop the wait file.","file":"dist/SwaigFunction.d.ts","line":113},{"name":"webhookUrl","kind":"property","owner":"SwaigFunctionOptions","signature":["webhookUrl?: string"],"doc":"External webhook URL; makes this an externally-hosted tool.","file":"dist/SwaigFunction.d.ts","line":115},{"name":"required","kind":"property","owner":"SwaigFunctionOptions","signature":["required?: string[]"],"doc":"List of required parameter names.","file":"dist/SwaigFunction.d.ts","line":117},{"name":"extraFields","kind":"property","owner":"SwaigFunctionOptions","signature":["extraFields?: Record<string, unknown>"],"doc":"Additional fields to merge directly into the SWAIG function definition.\n\n**Python equivalent:** `**extra_swaig_fields` kwargs on the constructor.\nIn Python these are passed as bare keyword arguments and merged directly\ninto the output dict via `function_def.update(self.extra_swaig_fields)`.\nIn TypeScript the same fields are collected under this single options key\nand merged identically in `toSwaig()` — the wire format is identical.\n\n@example\n```typescript\n// Python: SWAIGFunction(..., meta_data_token=\"abc\", web_hook_auth_user=\"u\")\nnew SwaigFunction({\n ...,\n extraFields: { meta_data_token: 'abc', web_hook_auth_user: 'u' },\n});\n```","file":"dist/SwaigFunction.d.ts","line":136},{"name":"isTypedHandler","kind":"property","owner":"SwaigFunctionOptions","signature":["isTypedHandler?: boolean"],"doc":"Whether this tool uses a typed handler with named parameters.","file":"dist/SwaigFunction.d.ts","line":138},{"name":"onError","kind":"property","owner":"SwaigFunctionOptions","signature":["onError?: SwaigErrorHandler"],"doc":"Per-tool error hook. Invoked when this tool's handler throws, before the\ndefault error response is produced. See {@link SwaigErrorHandler}.","file":"dist/SwaigFunction.d.ts","line":143},{"name":"errorMessage","kind":"property","owner":"SwaigFunctionOptions","signature":["errorMessage?: string"],"doc":"Per-tool override for the user-facing message returned when the handler\nthrows and no {@link onError} hook supplies a response. Defaults to\n{@link DEFAULT_SWAIG_ERROR_MESSAGE}.","file":"dist/SwaigFunction.d.ts","line":149}]},"SwaigHandler":{"name":"SwaigHandler","kind":"type","exported":true,"signature":["type SwaigHandler = (args: Record<string, unknown>, rawData: SwaigRequest, agent?: AgentBase) => FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string>"],"doc":"Handler function for a SWAIG tool invocation.\n@param args - Parsed arguments extracted by the AI from user speech.\n@param rawData - The full raw request payload from SignalWire.\n@param agent - The agent running the call. With a dynamic config callback\n set, this is the request's configured copy, so the handler sees what the\n callback configured (the reference passes it as `self`). Undefined when a\n caller runs {@link SwaigFunction.execute} directly.\n@returns A FunctionResult, a plain object with a response key, a string, or a Promise of any of these.","file":"dist/SwaigFunction.d.ts","line":54},"SwaigRequest":{"name":"SwaigRequest","kind":"interface","exported":true,"signature":["interface SwaigRequest"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":10,"members":[{"name":"ai_session_id","kind":"property","owner":"SwaigRequest","signature":["ai_session_id?: string"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":12},{"name":"app_name","kind":"property","owner":"SwaigRequest","signature":["app_name?: string"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":14},{"name":"args","kind":"property","owner":"SwaigRequest","signature":["args?: string"],"doc":"added **only on the data_map path** (`if (sh->data_map)`, `actions.c:2198`). `args` is `argument.parsed[0]` promoted to the top level (`actions.c:2206`); `input` is a shallow self-duplicate of the post_data (`actions.c:2211`). The webhook-URL path does not add these.","file":"dist/SwaigContracts.generated.d.ts","line":16},{"name":"argument","kind":"property","owner":"SwaigRequest","signature":["argument?: SwaigArgument"],"doc":"","file":"dist/SwaigContracts.generated.d.ts","line":17},{"name":"argument_desc","kind":"property","owner":"SwaigRequest","signature":["argument_desc?: Record<string, unknown>"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":19},{"name":"call_id","kind":"property","owner":"SwaigRequest","signature":["call_id?: string"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":21},{"name":"call_log","kind":"property","owner":"SwaigRequest","signature":["call_log?: unknown[]"],"doc":"only if `swaig_post_conversation` is set (`actions.c:2134`). `call_log` is redacted when `redact_prompt` is enabled (`actions.c:2137`); `raw_call_log` is the full transcript (`actions.c:2139`).","file":"dist/SwaigContracts.generated.d.ts","line":23},{"name":"caller_id_name","kind":"property","owner":"SwaigRequest","signature":["caller_id_name?: string"],"doc":"only if the caller-ID channel vars are set (`actions.c:2051`/`2055`). The source channel var for `caller_id_num` is `caller_id_number` — the JSON key is renamed to `caller_id_num`.","file":"dist/SwaigContracts.generated.d.ts","line":25},{"name":"caller_id_num","kind":"property","owner":"SwaigRequest","signature":["caller_id_num?: string"],"doc":"only if the caller-ID channel vars are set (`actions.c:2051`/`2055`). The source channel var for `caller_id_num` is `caller_id_number` — the JSON key is renamed to `caller_id_num`.","file":"dist/SwaigContracts.generated.d.ts","line":27},{"name":"channel_active","kind":"property","owner":"SwaigRequest","signature":["channel_active?: boolean"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":29},{"name":"channel_offhook","kind":"property","owner":"SwaigRequest","signature":["channel_offhook?: boolean"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":31},{"name":"channel_ready","kind":"property","owner":"SwaigRequest","signature":["channel_ready?: boolean"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":33},{"name":"content_disposition","kind":"property","owner":"SwaigRequest","signature":["content_disposition?: 'SWAIG Function'"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":35},{"name":"content_type","kind":"property","owner":"SwaigRequest","signature":["content_type?: 'text/swaig'"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":37},{"name":"conversation_id","kind":"property","owner":"SwaigRequest","signature":["conversation_id?: string"],"doc":"only if configured (`actions.c:2077`).","file":"dist/SwaigContracts.generated.d.ts","line":39},{"name":"description","kind":"property","owner":"SwaigRequest","signature":["description?: string"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":41},{"name":"error_reason","kind":"property","owner":"SwaigRequest","signature":["error_reason?: string"],"doc":"only on a hangup-hook/error invocation when `fatal_error_reason` is set (`actions.c:2063-2065`). See CLAUDE.md \"Fatal Error Recovery Flow\".","file":"dist/SwaigContracts.generated.d.ts","line":43},{"name":"fatal_error","kind":"property","owner":"SwaigRequest","signature":["fatal_error?: boolean"],"doc":"only on a hangup-hook/error invocation when `fatal_error_reason` is set (`actions.c:2063-2065`). See CLAUDE.md \"Fatal Error Recovery Flow\".","file":"dist/SwaigContracts.generated.d.ts","line":45},{"name":"function","kind":"property","owner":"SwaigRequest","signature":["function?: string"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":47},{"name":"global_data","kind":"property","owner":"SwaigRequest","signature":["global_data?: Record<string, unknown>"],"doc":"only if global data exists (`actions.c:2016`).","file":"dist/SwaigContracts.generated.d.ts","line":49},{"name":"input","kind":"property","owner":"SwaigRequest","signature":["input?: string"],"doc":"added **only on the data_map path** (`if (sh->data_map)`, `actions.c:2198`). `args` is `argument.parsed[0]` promoted to the top level (`actions.c:2206`); `input` is a shallow self-duplicate of the post_data (`actions.c:2211`). The webhook-URL path does not add these.","file":"dist/SwaigContracts.generated.d.ts","line":51},{"name":"meta_data","kind":"property","owner":"SwaigRequest","signature":["meta_data?: Record<string, unknown>"],"doc":"only if the function has a `meta_data_token` (`actions.c:2085-2093`). `meta_data` is that token's metadata store (empty object if none).","file":"dist/SwaigContracts.generated.d.ts","line":53},{"name":"meta_data_token","kind":"property","owner":"SwaigRequest","signature":["meta_data_token?: string"],"doc":"only if the function has a `meta_data_token` (`actions.c:2085-2093`). `meta_data` is that token's metadata store (empty object if none).","file":"dist/SwaigContracts.generated.d.ts","line":55},{"name":"project_id","kind":"property","owner":"SwaigRequest","signature":["project_id?: string"],"doc":"only if the `signalwire_project_id` / `signalwire_space_id` channel vars are set (`actions.c:2040`/`2044`).","file":"dist/SwaigContracts.generated.d.ts","line":57},{"name":"raw_call_log","kind":"property","owner":"SwaigRequest","signature":["raw_call_log?: unknown[]"],"doc":"only if `swaig_post_conversation` is set (`actions.c:2134`). `call_log` is redacted when `redact_prompt` is enabled (`actions.c:2137`); `raw_call_log` is the full transcript (`actions.c:2139`).","file":"dist/SwaigContracts.generated.d.ts","line":59},{"name":"space_id","kind":"property","owner":"SwaigRequest","signature":["space_id?: string"],"doc":"only if the `signalwire_project_id` / `signalwire_space_id` channel vars are set (`actions.c:2040`/`2044`).","file":"dist/SwaigContracts.generated.d.ts","line":61},{"name":"version","kind":"property","owner":"SwaigRequest","signature":["version?: '2.0'"],"doc":"Always present.","file":"dist/SwaigContracts.generated.d.ts","line":63}]},"SwmlBuilder":{"name":"SwmlBuilder","kind":"class","exported":true,"signature":["class SwmlBuilder"],"doc":"Builds SWML documents composed of verb instructions organized into named sections.\n\nVerb methods (`.answer()`, `.play()`, `.hangup()`, `.transfer()`, etc.) are\nauto-installed from the bundled SWML schema and all return `this` for fluent chaining.\n\nMost users don't instantiate `SwmlBuilder` directly — `AgentBase` uses it internally\nand exposes higher-level helpers. Use this class directly for `SWMLService` (non-AI\ncall flows) or to hand-craft SWML returned from a route handler.\n\n@example Simple SWML document\n```ts\nimport { SwmlBuilder } from '@signalwire/sdk';\n\nconst swml = new SwmlBuilder()\n .answer()\n .play({ url: 'https://cdn.example.com/greeting.mp3' })\n .hangup()\n .build();\n\n// swml is JSON ready to return from a SignalWire webhook.\n```\n\n@see {@link SWMLService} — HTTP service that serves a built SWML document\n@see {@link AgentBase} — for AI-driven call flows","file":"dist/SwmlBuilder.d.ts","line":76,"members":[{"name":"service","kind":"property","owner":"SwmlBuilder","readonly":true,"signature":["readonly service?: SWMLServiceLike"],"doc":"The `SWMLService` this builder belongs to — the reference's public\n`self.service` (`core/swml_builder.py:57`) — or `undefined` for a standalone\nbuilder.\n\nIn the reference the builder DELEGATES document construction to the service, so\nthe service is a required constructor argument. TS inverts the ownership (the\nbuilder holds its own document and `SWMLService` holds the builder), which is why\nit is optional here. The read-back is the same: a caller holding the builder can\nreach the service that owns it.","file":"dist/SwmlBuilder.d.ts","line":93},{"name":"constructor","kind":"constructor","owner":"SwmlBuilder","signature":["constructor(opts?: SwmlBuilderOptions)"],"doc":"Creates a new SwmlBuilder.\n@param opts - Optional configuration.\n - `initialDocument`: inject an existing document (mirrors Python SDK's `SWMLService` injection pattern).\n - `enableValidation`: explicit override for verb schema validation (falls back to env var).\n - `schemaPath`: load SWML schema from a custom JSON file instead of the bundled one.","file":"dist/SwmlBuilder.d.ts","line":101},{"name":"document","kind":"accessor","owner":"SwmlBuilder","signature":["get document(): {\n version: string;\n sections: Record<string, unknown[]>;\n}"],"doc":"Public read-only accessor for the underlying SWML document.\n\n(Not the reference's `service` — that is the SWMLService back-reference, exposed\nas {@link service}. This is the document the builder is assembling, which the\nreference reaches through `self.service`.)","file":"dist/SwmlBuilder.d.ts","line":112},{"name":"setValidation","kind":"method","owner":"SwmlBuilder","signature":["setValidation(enabled: boolean): void"],"doc":"Enable or disable verb schema validation at runtime.\nMatches the Python `schema_validation` constructor parameter on AgentBase.\n@param enabled - True to enable validation, false to disable.","file":"dist/SwmlBuilder.d.ts","line":121},{"name":"getSchemaUtils","kind":"method","owner":"SwmlBuilder","static":true,"signature":["static getSchemaUtils(): SchemaUtils"],"doc":"Get or create the shared SchemaUtils singleton.\nExposed for use by the type generator and tests.","file":"dist/SwmlBuilder.d.ts","line":127},{"name":"reset","kind":"method","owner":"SwmlBuilder","signature":["reset(): this"],"doc":"Resets the document to an empty SWML structure.\n@returns this for fluent chaining.","file":"dist/SwmlBuilder.d.ts","line":138},{"name":"addVerb","kind":"method","owner":"SwmlBuilder","signature":["addVerb(verbName: string, config: unknown, opts?: {\n skipValidation?: boolean;\n}): void"],"doc":"Appends a verb to the main section.\nValidates the verb config against the schema when validation is enabled.\n@param verbName - The SWML verb name (e.g., \"answer\", \"ai\").\n@param config - The verb's configuration payload.\n@param opts - When `opts.skipValidation` is true, the config is appended\n WITHOUT schema validation. Used by AgentBase for the internally-assembled\n `ai` verb, whose config is built from already-typed builder inputs and may\n carry real, server-accepted SWML that the bundled schema does not yet model\n (e.g. `multilingual`, `SWAIG.mcp_servers`, per-language engine/model/fillers,\n `debug_webhook_url`). Validating it against the closed schema would raise on\n those legitimate features — the strict-render contract is about rejecting\n MISSHAPEN direct `addVerb` input (unknown verb, misspelled/unknown key,\n wrong type), NOT about second-guessing trusted internal assembly. The\n direct/public `addVerb` path stays fully strict.","file":"dist/SwmlBuilder.d.ts","line":155},{"name":"addVerbToSection","kind":"method","owner":"SwmlBuilder","signature":["addVerbToSection(sectionName: string, verbName: string, config: unknown, opts?: {\n skipValidation?: boolean;\n}): void"],"doc":"Appends a verb to a named section, creating the section if it does not exist.\n\nValidates exactly as {@link addVerb} does. The reference validates at BOTH\nadd-verb sites (`core/swml_service.py:558` and `:635`, each raising\n`SchemaValidationError`); this path previously appended without validating, so a\nmisshapen or unknown verb reached a non-main section silently.\n\n@param sectionName - The target section name.\n@param verbName - The SWML verb name.\n@param config - The verb's configuration payload.\n@param opts - When `opts.skipValidation` is true, append without validating\n (same trusted-internal-assembly escape hatch as {@link addVerb}).\n@throws {SchemaValidationError} When validation is enabled and the config does\n not satisfy the verb's schema (or the verb is unknown).","file":"dist/SwmlBuilder.d.ts","line":174},{"name":"say","kind":"method","owner":"SwmlBuilder","signature":["say(text: string, opts?: {\n voice?: string;\n language?: string;\n gender?: TtsGender;\n volume?: number;\n}): this"],"doc":"Add a 'play' verb with say: prefix for text-to-speech.\nConvenience wrapper matching Python SDK's `say()` method.\n\n@param text - Text to speak.\n@param opts - Optional TTS parameters (voice, language, gender, volume).\n@returns this for fluent chaining.","file":"dist/SwmlBuilder.d.ts","line":185},{"name":"addSection","kind":"method","owner":"SwmlBuilder","signature":["addSection(sectionName: string): this"],"doc":"Creates a new empty named section in the document.\nIf the section already exists, this is a no-op.\nMatches Python SDK's `add_section(section_name)`.\n\n@param sectionName - The name of the section to create.\n@returns this for fluent chaining.","file":"dist/SwmlBuilder.d.ts","line":199},{"name":"build","kind":"method","owner":"SwmlBuilder","signature":["build(): Record<string, unknown>"],"doc":"Build and return the SWML document as a dictionary/object. Canonical name,\nmatching Python's `SWMLBuilder.build()`.\n\n@returns The document with version and sections.","file":"dist/SwmlBuilder.d.ts","line":206},{"name":"render","kind":"method","owner":"SwmlBuilder","signature":["render(): string"],"doc":"Build and render the SWML document as a JSON string. Canonical name,\nmatching Python's `SWMLBuilder.render()`.\n\n@returns The JSON-encoded SWML document.","file":"dist/SwmlBuilder.d.ts","line":213},{"name":"answer","kind":"method","owner":"SwmlBuilder","signature":["answer(config?: {\n /** Maximum duration in seconds for the call. Defaults to `14400` seconds (4 hours). */\n max_duration?: number; /** Comma-separated string of codecs to offer. Valid codecs are: PCMU, PCMA, G722, G729, AMR-WB, OPUS, VP8, H264. */\n codecs?: string; /** Username to use for SIP authentication. */\n username?: string; /** Password to use for SIP authentication. */\n password?: string;\n}): this"],"doc":"Answer incoming call and set an optional maximum duration.","file":"dist/SwmlVerbMethods.generated.d.ts","line":39},{"name":"ai","kind":"method","owner":"SwmlBuilder","signature":["ai(config?: AiVerbConfig): this"],"doc":"Creates an AI agent that conducts voice conversations using automatic speech recognition (ASR), large language models (LLMs), and text-to-speech (TTS) synthesis. The agent processes caller speech in real-time, generates contextually appropriate responses, and can execute custom functions to interact with external systems through SignalWire AI Gateway (SWAIG).","file":"dist/SwmlVerbMethods.generated.d.ts","line":47},{"name":"amazon_bedrock","kind":"method","owner":"SwmlBuilder","signature":["amazon_bedrock(config?: unknown): this"],"doc":"Creates a new Bedrock AI Agent","file":"dist/SwmlVerbMethods.generated.d.ts","line":49},{"name":"cond","kind":"method","owner":"SwmlBuilder","signature":["cond(config?: Record<string, unknown>): this"],"doc":"Execute a sequence of instructions depending on the value of a JavaScript condition.","file":"dist/SwmlVerbMethods.generated.d.ts","line":51},{"name":"connect","kind":"method","owner":"SwmlBuilder","signature":["connect(config: Record<string, unknown>): this"],"doc":"Dial a SIP URI or phone number.","file":"dist/SwmlVerbMethods.generated.d.ts","line":53},{"name":"denoise","kind":"method","owner":"SwmlBuilder","signature":["denoise(config?: Record<string, unknown>): this"],"doc":"Start noise reduction. You can stop it at any time using `stop_denoise`.","file":"dist/SwmlVerbMethods.generated.d.ts","line":55},{"name":"enter_queue","kind":"method","owner":"SwmlBuilder","signature":["enter_queue(config?: unknown): this"],"doc":"Place the current call in a named queue where it will wait to be connected to an available agent or resource. While waiting, callers will hear music or custom audio. When an agent connects to the queue (using the connect method), the caller and agent are bridged together. After the bridge completes, execution continues with the SWML script specified in transfer_after_bridge.","file":"dist/SwmlVerbMethods.generated.d.ts","line":57},{"name":"execute","kind":"method","owner":"SwmlBuilder","signature":["execute(config: {\n /** Specifies what to execute. The value can be one of: - `<section_name>` - section in the current document to execute - A URL (http or https) that returns a SWML document - Sends HTTP POST - An inline SWML document (as a JSON string) */\n dest: string; /** Named parameters to send to section or URL */\n params?: Record<string, unknown>; /** User-defined metadata, ignored by SignalWire */\n meta?: Record<string, unknown>; /** The list of SWML instructions to be executed when the executed section or URL returns */\n on_return?: unknown[]; /** Action to take based on the result of the call. This will run once the peer leg of the call has ended. Will use the switch method when the return_value is an object, and will use the cond method when the return_value is an array. */\n result?: unknown[];\n}): this"],"doc":"Execute a specified section or URL as a subroutine, and upon completion, return to the current document. Use the return statement to pass any return values or objects back to the current document.","file":"dist/SwmlVerbMethods.generated.d.ts","line":59},{"name":"goto","kind":"method","owner":"SwmlBuilder","signature":["goto(config: {\n /** Mark any point of the SWML section with a label so that goto can jump to it. */\n label: string; /** A JavaScript condition that determines whether to perform the jump. If the condition evaluates to true, the jump is executed. If omitted, the jump is unconditional. */\n when?: string; /** The maximum number of times to perform the jump. Must be a number between 1 and 100. Default `100`. */\n max?: number;\n}): this"],"doc":"Jump to a label within the current section, optionally based on a condition. The goto method will only navigate to a label within the same section.","file":"dist/SwmlVerbMethods.generated.d.ts","line":68},{"name":"label","kind":"method","owner":"SwmlBuilder","signature":["label(value: string): this"],"doc":"Mark any point of the SWML section with a label so that goto can jump to it.","file":"dist/SwmlVerbMethods.generated.d.ts","line":75},{"name":"live_transcribe","kind":"method","owner":"SwmlBuilder","signature":["live_transcribe(config: {\n /** The action to perform during live transcription. */\n action: unknown;\n}): this"],"doc":"Start live transcription of the call. The transcription will be sent to the specified webhook URL.","file":"dist/SwmlVerbMethods.generated.d.ts","line":77},{"name":"ai_sidecar","kind":"method","owner":"SwmlBuilder","signature":["ai_sidecar(config: {\n /** Operator prompt — POM object, plain string, or {file: path}. */\n prompt: Record<string, unknown>; /** BCP-47 conversation language. Required. */\n lang: string; /** LLM model for sidecar tick + close-time summaries. */\n model?: string; /** Both legs are required for sidecar mode. */\n direction?: string[]; /** Which leg is the customer (turn-end trigger source). */\n customer_role?: string; /** Webhook URL for transcribe events AND sidecar events. */\n url?: string; /** SWAIG functions and MCP servers. */\n SWAIG?: unknown; /** SWAIG permission overrides — pass-through to mod_openai. */\n permissions?: Record<string, unknown>; /** Initial sidecar global_data. */\n global_data?: Record<string, unknown>; /** Speech-recognition hints biasing ASR toward specific terms. */\n hints?: string[]; /** Tunable knobs (idle_timeout_ms, ai_summary, etc.) — pass-through to mod_openai which validates them strictly. New tunables only land here. */\n params?: Record<string, unknown>; /** Reserved for future runtime sub-actions. */\n action?: unknown;\n}): this"],"doc":"Start ai_sidecar mode — live_transcribe with an LLM/SWAIG/MCP loop on top.","file":"dist/SwmlVerbMethods.generated.d.ts","line":82},{"name":"live_translate","kind":"method","owner":"SwmlBuilder","signature":["live_translate(config: {\n /** The action to perform during live translation. */\n action: unknown;\n}): this"],"doc":"Start live translation of the call. The translation will be sent to the specified webhook URL.","file":"dist/SwmlVerbMethods.generated.d.ts","line":98},{"name":"hangup","kind":"method","owner":"SwmlBuilder","signature":["hangup(config?: {\n reason?: string;\n}): this"],"doc":"End the call with an optional reason.","file":"dist/SwmlVerbMethods.generated.d.ts","line":103},{"name":"join_room","kind":"method","owner":"SwmlBuilder","signature":["join_room(config: {\n /** Name of the room to join. Allowed characters: A-Z, a-z, 0-9, underscore, and hyphen. */\n name: string;\n}): this"],"doc":"Join a RELAY room. If the room doesn't exist, it creates a new room.","file":"dist/SwmlVerbMethods.generated.d.ts","line":107},{"name":"join_conference","kind":"method","owner":"SwmlBuilder","signature":["join_conference(config?: unknown): this"],"doc":"Join an ad-hoc audio conference started on either the SignalWire or Compatibility API. This method allows you to connect the current call to a named conference where multiple participants can communicate simultaneously.","file":"dist/SwmlVerbMethods.generated.d.ts","line":112},{"name":"play","kind":"method","owner":"SwmlBuilder","signature":["play(config?: PlayVerbConfig): this"],"doc":"Play file(s), ringtones, speech or silence.","file":"dist/SwmlVerbMethods.generated.d.ts","line":114},{"name":"prompt","kind":"method","owner":"SwmlBuilder","signature":["prompt(config: {\n /** URL or array of URLs to play. Allowed URLs are: http:// or https:// - audio file to GET ring:[duration:]<country code> - ring tone to play. For example: ring:us to play single ring or ring:20.0:us to play ring for 20 seconds. say:<text to speak> - Sentence to say silence: <duration> - seconds of silence to play */\n play: unknown[]; /** Volume level for the audio file. Default is `0`. Valid range is -40 to 40. */\n volume?: number; /** The voice to use for the text to speech. */\n say_voice?: string; /** The language to use for the text to speech. */\n say_language?: string; /** The gender to use for the text to speech. */\n say_gender?: 'male' | 'female'; /** Number of digits to collect. Default is `1`. */\n max_digits?: number; /** Digits that terminate digit collection. Default is not set. */\n terminators?: string; /** Time in seconds to wait for next digit. Default is `5.0` seconds. */\n digit_timeout?: number; /** Time in seconds to wait for start of input. Default is `5.0` seconds. */\n initial_timeout?: number; /** Max time in seconds to wait for speech result. */\n speech_timeout?: number; /** Time in seconds to wait for end of speech utterance. */\n speech_end_timeout?: number; /** Language to detect speech in. */\n speech_language?: string; /** Expected words or phrases to help the speech recognition. */\n speech_hints?: string[] | unknown[]; /** The engine that is selected for speech recognition. The engine must support the specified language. [Deepgram|Google| etc...] Default is not set (SignalWire picks the engine). */\n speech_engine?: string; /** http or https URL to deliver prompt status events */\n status_url?: string;\n}): this"],"doc":"Play a prompt and wait for input. The input can be received either as digits from the keypad, or from speech, or both depending on what parameters are set. By default, only digit input is enabled. To enable speech input, set at least one speech parameter. To enable both digit and speech input, set at least one parameter for each.","file":"dist/SwmlVerbMethods.generated.d.ts","line":116},{"name":"receive_fax","kind":"method","owner":"SwmlBuilder","signature":["receive_fax(config?: {\n /** http or https URL to deliver receive_fax status events */\n status_url?: string;\n}): this"],"doc":"Receive a fax being delivered to this call.","file":"dist/SwmlVerbMethods.generated.d.ts","line":135},{"name":"record","kind":"method","owner":"SwmlBuilder","signature":["record(config?: {\n /** If true, record in stereo. Default is `false`. */\n stereo?: boolean; /** The format to record in. Can be `wav`, `mp3`, or `mp4`. Default is `\"wav\"`. */\n format?: 'wav' | 'mp3' | 'mp4'; /** Direction of the audio to record: \"speak\" for what party says, \"listen\" for what party hears. Default is `\"speak\"`. */\n direction?: 'speak' | 'listen'; /** String of digits that will stop the recording when pressed. Default is `\"#\"`. */\n terminators?: string; /** Play a beep before recording. Default is `false`. */\n beep?: boolean; /** How sensitive the recording voice activity detector is to background noise. A larger value is more sensitive. Allowed values from 0.0 to 100.0. Default is `44.0`. */\n input_sensitivity?: number; /** Time in seconds to wait for the start of speech. Default is `4.0` seconds. */\n initial_timeout?: number; /** Time in seconds to wait in silence before ending the recording. Default is `5.0` seconds. */\n end_silence_timeout?: number; /** Maximum length of the recording in seconds. */\n max_length?: number; /** URL to send recording status events to. */\n status_url?: string;\n}): this"],"doc":"Record the call audio in the foreground, pausing further SWML execution until recording ends. Use this, for example, to record voicemails. To record calls in the background in a non-blocking fashion, use the record_call method.","file":"dist/SwmlVerbMethods.generated.d.ts","line":140},{"name":"record_call","kind":"method","owner":"SwmlBuilder","signature":["record_call(config?: {\n /** Identifier for this recording, to use with `stop_call_record`. */\n control_id?: string; /** If `true`, record in stereo. Default is `false`. */\n stereo?: boolean; /** The format to record in. It can be `wav`, `mp3`, or `mp4`. Default is `\"wav\"`. */\n format?: 'wav' | 'mp3' | 'mp4'; /** Direction of the audio to record: \"speak\" for what party says, \"listen\" for what party hears, \"both\" for what the party hears and says. Default is `\"both\"`. */\n direction?: 'speak' | 'listen' | 'both'; /** String of digits that will stop the recording when pressed. Default is `\"\"` (empty). */\n terminators?: string; /** Play a beep before recording. Default is `false`. */\n beep?: boolean; /** How sensitive the recording voice activity detector is to background noise. A larger value is more sensitive. Allowed values from 0.0 to 100.0. Default is `44.0`. */\n input_sensitivity?: number; /** Time in seconds to wait for the start of speech. Default is `0.0` seconds. */\n initial_timeout?: number; /** Time in seconds to wait in silence before ending the recording. Default is `0.0` seconds. */\n end_silence_timeout?: number; /** Maximum length of the recording in seconds. */\n max_length?: number; /** http or https URL to deliver record_call status events */\n status_url?: string;\n}): this"],"doc":"Record call in the background. Unlike the record method, the record_call method will start the recording and continue executing the SWML script while allowing the recording to happen in the background. To stop call recordings started with record_call, use the stop_record_call method.","file":"dist/SwmlVerbMethods.generated.d.ts","line":154},{"name":"request","kind":"method","owner":"SwmlBuilder","signature":["request(config: {\n /** URL to send the HTTPS request to. Authentication can also be set in the URL in the format of username:password@url. */\n url: string; /** The HTTP method to be used for the request. Can be `GET`, `POST`, `PUT`, or `DELETE`. */\n method: 'GET' | 'POST' | 'PUT' | 'DELETE'; /** Object containing HTTP headers to set. Valid header values are Accept, Authorization, Content-Type, Range, and custom X- headers. */\n headers?: Record<string, unknown>; /** Request body. Content-Type header should be explicitly set, but if not set, the most likely type will be set based on the first non-whitespace character. */\n body?: string | Record<string, unknown>; /** Maximum time in seconds to wait for a response. Default is `0` (no timeout). */\n timeout?: number; /** Maximum time in seconds to wait for a connection. Default is `0` (no timeout). */\n connect_timeout?: number; /** Store parsed JSON response as variables. Default is `false`. */\n save_variables?: boolean;\n}): this"],"doc":"Send a GET, POST, PUT, or DELETE request to a remote URL.","file":"dist/SwmlVerbMethods.generated.d.ts","line":169},{"name":"return","kind":"method","owner":"SwmlBuilder","signature":["return(config?: unknown): this"],"doc":"Return a value from an execute call or exit the script. The value can be any type.","file":"dist/SwmlVerbMethods.generated.d.ts","line":180},{"name":"send_digits","kind":"method","owner":"SwmlBuilder","signature":["send_digits(config: {\n /** The digits to send. Valid values are 0123456789*#ABCDWw. Character W is a 1 second delay, and w is a 500ms delay. */\n digits: string;\n}): this"],"doc":"Send digit presses as DTMF tones.","file":"dist/SwmlVerbMethods.generated.d.ts","line":182},{"name":"send_fax","kind":"method","owner":"SwmlBuilder","signature":["send_fax(config: {\n /** URL to the PDF document to fax. */\n document: string; /** Header text to include on the fax. */\n header_info?: string; /** Station identity to report. Default is the calling party's caller ID number. */\n identity?: string; /** http or https URL to deliver send_fax status events */\n status_url?: string;\n}): this"],"doc":"Send a fax.","file":"dist/SwmlVerbMethods.generated.d.ts","line":187},{"name":"send_sms","kind":"method","owner":"SwmlBuilder","signature":["send_sms(config: Record<string, unknown> | number): this"],"doc":"Send an outbound SMS or MMS message to a PSTN phone number.","file":"dist/SwmlVerbMethods.generated.d.ts","line":195},{"name":"set","kind":"method","owner":"SwmlBuilder","signature":["set(config?: Record<string, unknown>): this"],"doc":"Set script variables to the specified values. Accepts an object mapping variable names to values. Variables set using set can be removed using unset.","file":"dist/SwmlVerbMethods.generated.d.ts","line":197},{"name":"sleep","kind":"method","owner":"SwmlBuilder","signature":["sleep(durationOrConfig: number | {\n duration: number;\n}): this"],"doc":"Pause execution for a specified duration.","file":"dist/SwmlVerbMethods.generated.d.ts","line":199},{"name":"sip_refer","kind":"method","owner":"SwmlBuilder","signature":["sip_refer(config: {\n /** The SIP URI to send the REFER to. */\n to_uri: string; /** The HTTP or HTTPS URL to send status callback events to. */\n status_url?: string; /** Username to use for SIP authentication. */\n username?: string; /** Password to use for SIP authentication. */\n password?: string;\n}): this"],"doc":"Send SIP REFER to a SIP call.","file":"dist/SwmlVerbMethods.generated.d.ts","line":203},{"name":"stop_denoise","kind":"method","owner":"SwmlBuilder","signature":["stop_denoise(config?: Record<string, unknown>): this"],"doc":"Stop noise reduction that was started with denoise.","file":"dist/SwmlVerbMethods.generated.d.ts","line":211},{"name":"stop_record_call","kind":"method","owner":"SwmlBuilder","signature":["stop_record_call(config?: {\n /** Identifier for the recording to stop. If not set, the last recording started will be stopped. */\n control_id?: string;\n}): this"],"doc":"Stop an active background recording.","file":"dist/SwmlVerbMethods.generated.d.ts","line":213},{"name":"stop_tap","kind":"method","owner":"SwmlBuilder","signature":["stop_tap(config?: {\n /** ID of the tap to stop. If not set, it will shut off the most recent tap session. */\n control_id?: string;\n}): this"],"doc":"Stop an active tap stream.","file":"dist/SwmlVerbMethods.generated.d.ts","line":218},{"name":"switch","kind":"method","owner":"SwmlBuilder","signature":["switch(config: {\n /** Name of the variable whose value needs to be compared. */\n variable: string; /** Object of key-mapped values to array of SWML methods to execute. */\n case: Record<string, unknown>; /** Array of SWML methods to execute if no cases match. */\n default?: unknown[];\n}): this"],"doc":"Execute different instructions based on a variable's value.","file":"dist/SwmlVerbMethods.generated.d.ts","line":223},{"name":"tap","kind":"method","owner":"SwmlBuilder","signature":["tap(config: {\n /** Destination of the tap media stream: rtp://IP:port, ws://example.com, or wss://example.com. */\n uri: string; /** Identifier for this tap to use with `stop_tap`. */\n control_id?: string; /** Direction of the audio to tap: `speak` for what party says, `listen` for what party hears, `both` for what party hears and says. Default is `\"speak\"`. */\n direction?: 'speak' | 'listen' | 'both'; /** Codec to use for the tap media stream. Possible Values: [`PCMU`, `PCMA`] Default is `\"PCMU\"`. */\n codec?: 'PCMU' | 'PCMA'; /** If `uri` is a `rtp://` this will set the packetization time of the media in milliseconds. Default is `20` milliseconds. */\n rtp_ptime?: number; /** http or https URL to deliver tap status events */\n status_url?: string;\n}): this"],"doc":"Start background call tap. Media is streamed over Websocket or RTP to customer controlled URI.","file":"dist/SwmlVerbMethods.generated.d.ts","line":230},{"name":"transfer","kind":"method","owner":"SwmlBuilder","signature":["transfer(config: {\n /** Specifies where to transfer to. The value can be one of: - <section_name> - section in the SWML document to jump to - A URL (http or https) - URL to fetch next document from. Sends HTTP POST. Authentication can also be set in the URL in the format of username:password@url. - An inline SWML document (as a JSON string) */\n dest: string; /** Named parameters to send to transfer destination. Accepts an object mapping variable names to values. Default is not set. */\n params?: Record<string, unknown>; /** User data, ignored by SignalWire. Accepts an object mapping variable names to values. Default is not set. */\n meta?: Record<string, unknown>;\n}): this"],"doc":"Transfer the execution of the script to a different SWML section, URL, or Relay application. Once the transfer is complete, the script will continue executing SWML from the new location.","file":"dist/SwmlVerbMethods.generated.d.ts","line":240},{"name":"unset","kind":"method","owner":"SwmlBuilder","signature":["unset(config: Record<string, unknown> | number): this"],"doc":"Unset specified variables. The variables may have been set using the set method or as a byproduct of other statements or methods. Accepts a single variable name as a string or an array of variable names.","file":"dist/SwmlVerbMethods.generated.d.ts","line":247},{"name":"pay","kind":"method","owner":"SwmlBuilder","signature":["pay(config: {\n /** The URL to make POST requests with all the gathered payment details. This URL is used to process the final payment transaction and return the results through the response. Visit https://developer.signalwire.com/swml/methods/pay/payment_connector_url for more important information. */\n payment_connector_url: string; /** The amount to charge against payment method passed in the request. `Float` value with no currency prefix passed as string. */\n charge_amount?: string; /** Uses the ISO 4217 currency code of the charge amount. */\n currency?: string; /** Custom description of the payment provided in the request. */\n description?: string; /** The method of how to collect the payment details. Currently only `dtmf` mode is supported. */\n input?: 'dtmf'; /** Language to use for prompts being played to the caller by the `pay` method. */\n language?: string; /** Number of times the `pay` method will retry to collect payment details. */\n max_attempts?: number; /** The minimum length of the postal code the user must enter. */\n min_postal_code_length?: number; /** Array of parameter objects to pass to your payment processor. The parameters are user-defined key-value pairs. */\n parameters?: unknown[]; /** Indicates the payment method which is going to be used in this payment request. Currently only `credit-card` is supported. */\n payment_method?: 'credit-card'; /** Takes `true`, `false` or real postalcode (if it's known beforehand) to let pay method know whether to prompt for postal code. Default is `true`. */\n postal_code?: boolean | string; /** Array of prompt objects for customizing the audio prompts during different stages of the payment process. */\n prompts?: unknown[]; /** Takes true or false to let pay method know whether to prompt for security code. */\n security_code?: boolean; /** The URL to send requests for each status change during the payment process. See https://developer.signalwire.com/swml/methods/pay#status_url_request_body for more important information. */\n status_url?: string; /** Limit in seconds that pay method waits for the caller to press another digit before moving on to validate the digits captured. */\n timeout?: number; /** Whether the payment is a one off payment or re-occurring. Allowed values: - `one-time` - `reusable` */\n token_type?: 'one-time' | 'reusable'; /** List of payment cards allowed to use in the requested payment process separated by space. Allowed values: - `visa` - `mastercard` - `amex` - `maestro` - `discover` - `jcb` - `diners-club` */\n valid_card_types?: string; /** Text-to-speech voice to use. Please refer to https://developer.signalwire.com/voice/getting-started/voice-and-languages for more information. */\n voice?: string;\n}): this"],"doc":"Enables secure payment processing during voice calls. When implemented, it manages the entire payment flow including data collection, validation, and processing through your configured payment gateway.","file":"dist/SwmlVerbMethods.generated.d.ts","line":249},{"name":"detect_machine","kind":"method","owner":"SwmlBuilder","signature":["detect_machine(config?: {\n /** If `true`, stops detection on beep / end of voicemail greeting. Default `false`. */\n detect_message_end?: boolean; /** Comma-separated string of detectors to enable. Valid values: `amd`, `fax`. */\n detectors?: string; /** How long to wait for voice to finish. Default `1.0`. */\n end_silence_timeout?: number; /** How long to wait for initial voice before giving up. Default `4.5`. */\n initial_timeout?: number; /** How long to wait for voice to finish before firing READY event. Default is `end_silence_timeout`. */\n machine_ready_timeout?: number; /** The number of seconds of ongoing voice activity required to classify as MACHINE. Default `1.25`. */\n machine_voice_threshold?: number; /** The minimum number of words that must be detected in a single utterance before classifying the call as MACHINE. Default `6`. */\n machine_words_threshold?: number; /** The http(s) URL to deliver detector events to. */\n status_url?: string; /** The max time to run detector. Default `30.0` seconds. */\n timeout?: number; /** The tone to detect, will only receive remote side tone. Default `CED`. */\n tone?: 'CED' | 'CNG'; /** If false, the detector will run asynchronously and status_url must be set. If true, the detector will wait for detection to complete before moving to the next SWML instruction. Default is `true`. */\n wait?: boolean;\n}): this"],"doc":"A detection method that combines AMD (Answering Machine Detection) and fax detection. Detect whether the user on the other end of the call is a machine (fax, voicemail, etc.) or a human. The detection result(s) will be sent to the specified status_url as a POST request and will also be saved in the detect_result variable.","file":"dist/SwmlVerbMethods.generated.d.ts","line":271},{"name":"user_event","kind":"method","owner":"SwmlBuilder","signature":["user_event(config: {\n event: Record<string, unknown>;\n}): this"],"doc":"Allows the user to set and send events to the connected client on the call. This is useful for triggering actions on the client side. Commonly used with the [browser-sdk](https://developer.signalwire.com/sdks/reference/browser-sdk/SignalWire%20Client/). The event object can be any valid JSON object. Any key-value pair in the object is sent to the client as an event type called `user_event`.","file":"dist/SwmlVerbMethods.generated.d.ts","line":286}]},"SwmlBuilderOptions":{"name":"SwmlBuilderOptions","kind":"interface","exported":true,"signature":["interface SwmlBuilderOptions"],"doc":"Options for constructing a SwmlBuilder.","file":"dist/SwmlBuilder.d.ts","line":14,"members":[{"name":"initialDocument","kind":"property","owner":"SwmlBuilderOptions","signature":["initialDocument?: {\n version?: string;\n sections?: Record<string, unknown[]>;\n}"],"doc":"An initial SWML document to seed the builder with, enabling document injection.\n When provided, the builder uses this document instead of creating an empty one.\n This mirrors the Python SDK's pattern of injecting an SWMLService instance.","file":"dist/SwmlBuilder.d.ts","line":18},{"name":"enableValidation","kind":"property","owner":"SwmlBuilderOptions","signature":["enableValidation?: boolean"],"doc":"When false, disables verb schema validation.\n Defaults to true unless `SWML_SKIP_SCHEMA_VALIDATION=true` is set in the environment.","file":"dist/SwmlBuilder.d.ts","line":24},{"name":"schemaPath","kind":"property","owner":"SwmlBuilderOptions","signature":["schemaPath?: string"],"doc":"Optional path to a custom SWML schema JSON file. When set, the builder uses\n a per-instance SchemaUtils loaded from this path instead of the bundled schema.\n Mirrors Python's `schema_path` constructor parameter on `SWMLService`/`AgentBase`.","file":"dist/SwmlBuilder.d.ts","line":28},{"name":"service","kind":"property","owner":"SwmlBuilderOptions","signature":["service?: SWMLServiceLike"],"doc":"The `SWMLService` this builder belongs to, kept as a public back-reference\n ({@link SwmlBuilder.service}). The reference's `SWMLBuilder(service)` takes it as\n its sole constructor argument and keeps it as public `self.service`. Omit for a\n standalone builder (the common case — a builder used to hand-craft SWML has no\n service).","file":"dist/SwmlBuilder.d.ts","line":34}]},"SwmlRequestCall":{"name":"SwmlRequestCall","kind":"interface","exported":true,"signature":["interface SwmlRequestCall"],"doc":"The call object embedded in a dynamic-SWML request.","file":"dist/PlatformContracts.generated.d.ts","line":83,"members":[{"name":"call_id","kind":"property","owner":"SwmlRequestCall","signature":["call_id: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":84},{"name":"node_id","kind":"property","owner":"SwmlRequestCall","signature":["node_id?: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":85},{"name":"segment_id","kind":"property","owner":"SwmlRequestCall","signature":["segment_id?: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":86},{"name":"project_id","kind":"property","owner":"SwmlRequestCall","signature":["project_id: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":87},{"name":"space_id","kind":"property","owner":"SwmlRequestCall","signature":["space_id: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":88},{"name":"call_state","kind":"property","owner":"SwmlRequestCall","signature":["call_state?: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":89},{"name":"direction","kind":"property","owner":"SwmlRequestCall","signature":["direction?: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":90},{"name":"type","kind":"property","owner":"SwmlRequestCall","signature":["type?: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":91},{"name":"from","kind":"property","owner":"SwmlRequestCall","signature":["from?: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":92},{"name":"to","kind":"property","owner":"SwmlRequestCall","signature":["to?: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":93},{"name":"from_number","kind":"property","owner":"SwmlRequestCall","signature":["from_number?: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":94},{"name":"to_number","kind":"property","owner":"SwmlRequestCall","signature":["to_number?: string"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":95},{"name":"headers","kind":"property","owner":"SwmlRequestCall","signature":["headers?: Record<string, unknown>[]"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":96}]},"SwmlRequestData":{"name":"SwmlRequestData","kind":"interface","exported":true,"signature":["interface SwmlRequestData"],"doc":"Body POSTed to a dynamic-SWML request handler.","file":"dist/PlatformContracts.generated.d.ts","line":72,"members":[{"name":"call","kind":"property","owner":"SwmlRequestData","signature":["call?: SwmlRequestCall"],"doc":"","file":"dist/PlatformContracts.generated.d.ts","line":73},{"name":"vars","kind":"property","owner":"SwmlRequestData","signature":["vars?: Record<string, unknown>"],"doc":"SWML variables.","file":"dist/PlatformContracts.generated.d.ts","line":75},{"name":"envs","kind":"property","owner":"SwmlRequestData","signature":["envs?: Record<string, unknown>"],"doc":"Environment values.","file":"dist/PlatformContracts.generated.d.ts","line":77},{"name":"params","kind":"property","owner":"SwmlRequestData","signature":["params?: Record<string, unknown>"],"doc":"Request params (query/body merge).","file":"dist/PlatformContracts.generated.d.ts","line":79}]},"SwmlScripts":{"name":"SwmlScripts","kind":"class","exported":true,"signature":["class SwmlScripts extends FabricResource<SwmlScriptListResponse, SwmlScriptResponse, SwmlScriptCreateRequest, SwmlScriptUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":150,"members":[{"name":"constructor","kind":"constructor","owner":"SwmlScripts","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":152},{"name":"create","kind":"method","owner":"SwmlScripts","signature":["create(body: SwmlScriptCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SwmlScriptResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":154},{"name":"update","kind":"method","owner":"SwmlScripts","signature":["update(id: string, body: SwmlScriptUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SwmlScriptResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":156}],"bases":["FabricResource"]},"SwmlTransferSkill":{"name":"SwmlTransferSkill","kind":"class","exported":true,"signature":["class SwmlTransferSkill extends SkillBase"],"doc":"Transfer calls between agents based on pattern matching.\n\nMulti-instance capable (distinguished by `tool_name`).\nAccepts either Python-style `transfers` config (regex → per-entry config)\nor TypeScript-style `patterns` array of named destinations.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\n// Python-style: a regular expression per destination\nawait agent.addSkillByName('swml_transfer', {\n transfers: {\n '/sales|pricing/i': { url: 'https://example.com/sales-agent' },\n '/support/i': { address: '+15553334444', message: 'Connecting you to support.' },\n },\n});\n// Or named destinations, matched by name\nawait agent.addSkillByName('swml_transfer', {\n tool_name: 'transfer_to_team',\n patterns: [\n { name: 'billing', destination: '+15551112222', description: 'Billing department' },\n { name: 'support', destination: 'sip:support@example.com' },\n ],\n});\n```","file":"dist/skills/builtin/swml_transfer.d.ts","line":42,"members":[{"name":"SKILL_NAME","kind":"property","owner":"SwmlTransferSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":43},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"SwmlTransferSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":44},{"name":"SKILL_VERSION","kind":"property","owner":"SwmlTransferSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":45},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"SwmlTransferSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":46},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"SwmlTransferSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":47},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"SwmlTransferSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":48},{"name":"getParameterSchema","kind":"method","owner":"SwmlTransferSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":49},{"name":"getInstanceKey","kind":"method","owner":"SwmlTransferSkill","signature":["getInstanceKey(): string"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":60},{"name":"setup","kind":"method","owner":"SwmlTransferSkill","signature":["setup(): Promise<boolean>"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":61},{"name":"getHints","kind":"method","owner":"SwmlTransferSkill","signature":["getHints(): string[]"],"doc":"","file":"dist/skills/builtin/swml_transfer.d.ts","line":62},{"name":"getTools","kind":"method","owner":"SwmlTransferSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A `transfer_call` tool, plus `list_transfer_destinations` when patterns are configured.","file":"dist/skills/builtin/swml_transfer.d.ts","line":64}],"bases":["SkillBase"]},"SwmlWebhooks":{"name":"SwmlWebhooks","kind":"class","exported":true,"signature":["class SwmlWebhooks extends FabricResource<SWMLWebhookListResponse, SWMLWebhookResponse, SWMLWebhookCreateRequest, SWMLWebhookUpdateRequest>"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":158,"members":[{"name":"constructor","kind":"constructor","owner":"SwmlWebhooks","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":159},{"name":"create","kind":"method","owner":"SwmlWebhooks","signature":["create(body: SWMLWebhookCreateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SWMLWebhookResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":161},{"name":"update","kind":"method","owner":"SwmlWebhooks","signature":["update(id: string, body: SWMLWebhookUpdateRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<SWMLWebhookResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/fabric.resources.generated.d.ts","line":163}],"bases":["FabricResource"]},"TAP_CODECS":{"name":"TAP_CODECS","kind":"variable","exported":true,"signature":["const TAP_CODECS: readonly [\"PCMU\", \"PCMA\"]"],"doc":"Tap media codec for the SWAIG `tap` verb — Tier-1 closed set\n(`function_result.py:1218`). The 2-value SWAIG tap codec, distinct from the\n7-value RELAY connect/stream codec superset (never reuse). Used by\n{@link ParameterSchema.codec}.","file":"dist/ParameterSchema.d.ts","line":98},"TAP_DIRECTIONS":{"name":"TAP_DIRECTIONS","kind":"variable","exported":true,"signature":["const TAP_DIRECTIONS: readonly [\"speak\", \"listen\", \"both\"]"],"doc":"Tap direction for the SWAIG `tap` verb — Tier-1 closed set\n(`function_result.py:1370`): `speak`, `listen` or `both`, as the engine accepts. Used by\n{@link ParameterSchema.tapDirection}.","file":"dist/ParameterSchema.d.ts","line":89},"TWILIO_COMPAT_SIGNATURE_HEADER":{"name":"TWILIO_COMPAT_SIGNATURE_HEADER","kind":"variable","exported":true,"signature":["const TWILIO_COMPAT_SIGNATURE_HEADER"],"doc":"","file":"dist/WebhookMiddleware.d.ts","line":35},"TapAction":{"name":"TapAction","kind":"class","exported":true,"signature":["class TapAction extends Action"],"doc":"Async handle for a `calling.call.tap` action (media mirroring).","file":"dist/relay/Action.d.ts","line":228,"members":[{"name":"constructor","kind":"constructor","owner":"TapAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":229},{"name":"stop","kind":"method","owner":"TapAction","signature":["stop(): Promise<CallingTapStopResult>"],"doc":"Stop the media tap.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":236}],"bases":["Action"]},"TapCodec":{"name":"TapCodec","kind":"type","exported":true,"signature":["type TapCodec = (typeof TAP_CODECS)[number]"],"doc":"A single {@link TAP_CODECS} value.","file":"dist/ParameterSchema.d.ts","line":100},"TapDirection":{"name":"TapDirection","kind":"type","exported":true,"signature":["type TapDirection = (typeof TAP_DIRECTIONS)[number]"],"doc":"A single {@link TAP_DIRECTIONS} value.","file":"dist/ParameterSchema.d.ts","line":91},"TapEvent":{"name":"TapEvent","kind":"class","exported":true,"signature":["class TapEvent extends RelayEvent"],"doc":"`calling.call.tap` — media tap state change (audio mirror to an external endpoint).","file":"dist/relay/RelayEvent.d.ts","line":126,"members":[{"name":"controlId","kind":"property","owner":"TapEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":127},{"name":"state","kind":"property","owner":"TapEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":128},{"name":"tap","kind":"property","owner":"TapEvent","readonly":true,"signature":["readonly tap: EventPayload"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":129},{"name":"device","kind":"property","owner":"TapEvent","readonly":true,"signature":["readonly device: Device"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":130},{"name":"constructor","kind":"constructor","owner":"TapEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, tap?: EventPayload, device?: Device)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":131},{"name":"fromPayload","kind":"method","owner":"TapEvent","static":true,"signature":["static fromPayload(payload: EventPayload): TapEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":132}],"bases":["RelayEvent"]},"TranscribeAction":{"name":"TranscribeAction","kind":"class","exported":true,"signature":["class TranscribeAction extends Action"],"doc":"Async handle for a `calling.call.transcribe` action (real-time transcription).","file":"dist/relay/Action.d.ts","line":261,"members":[{"name":"constructor","kind":"constructor","owner":"TranscribeAction","signature":["constructor(call: CallLike, controlId: string)"],"doc":"","file":"dist/relay/Action.d.ts","line":262},{"name":"stop","kind":"method","owner":"TranscribeAction","signature":["stop(): Promise<Record<string, unknown>>"],"doc":"Stop the transcription.\n\n@returns The platform's stop response.\n@throws {RelayError} When the stop command is rejected.","file":"dist/relay/Action.d.ts","line":269}],"bases":["Action"]},"TranscribeEvent":{"name":"TranscribeEvent","kind":"class","exported":true,"signature":["class TranscribeEvent extends RelayEvent"],"doc":"`calling.call.transcribe` — transcription state change and final URL/duration when finished.","file":"dist/relay/RelayEvent.d.ts","line":204,"members":[{"name":"controlId","kind":"property","owner":"TranscribeEvent","readonly":true,"signature":["readonly controlId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":205},{"name":"state","kind":"property","owner":"TranscribeEvent","readonly":true,"signature":["readonly state: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":206},{"name":"url","kind":"property","owner":"TranscribeEvent","readonly":true,"signature":["readonly url: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":207},{"name":"recordingId","kind":"property","owner":"TranscribeEvent","readonly":true,"signature":["readonly recordingId: string"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":208},{"name":"duration","kind":"property","owner":"TranscribeEvent","readonly":true,"signature":["readonly duration: number"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":209},{"name":"size","kind":"property","owner":"TranscribeEvent","readonly":true,"signature":["readonly size: number"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":210},{"name":"constructor","kind":"constructor","owner":"TranscribeEvent","signature":["constructor(eventType: string, params: EventPayload, callId?: string, timestamp?: number, controlId?: string, state?: string, url?: string, recordingId?: string, duration?: number, size?: number)"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":211},{"name":"fromPayload","kind":"method","owner":"TranscribeEvent","static":true,"signature":["static fromPayload(payload: EventPayload): TranscribeEvent"],"doc":"","file":"dist/relay/RelayEvent.d.ts","line":212}],"bases":["RelayEvent"]},"TtsGender":{"name":"TtsGender","kind":"type","exported":true,"signature":["type TtsGender = 'male' | 'female'"],"doc":"Text-to-speech voice gender for {@link ../relay/Call.Call.playTTS} /\n{@link ../relay/Call.Call.promptTTS} (`gender` option). The SignalWire\nplatform recognises `\"male\"` and `\"female\"`.","file":"dist/relay/closedSets.d.ts","line":34},"TypedToolHandler":{"name":"TypedToolHandler","kind":"type","exported":true,"signature":["type TypedToolHandler = (...args: never[]) => FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string>"],"doc":"A typed SWAIG tool handler: a function the SDK introspects and wraps so it\nreceives the AI-extracted arguments as *named positional parameters* (any\narity, optionally with a trailing `rawData` record) rather than the raw\n`(args, rawData)` pair of {@link SwaigHandler}.\n\nThis is the precise replacement for the bare `Function` type at the\ntyped-tool sites: it constrains the value to a *callable whose return is a\nvalid SWAIG result* (a {@link FunctionResult}, a `{ response }`-style record,\nor a string — sync or async), which `Function` does not — so a non-callable,\nor a callable returning `void`/`boolean`/etc., is now a compile-time error.\n\nParameters are `...args: never[]` rather than `...unknown[]`: the handler's\nreal parameters are user-named with arbitrary types (`(city: string, days =\n5) => …`) and are recovered from `fn.toString()` by {@link inferSchema}, so\nthe type must accept *any* concrete positional list. Under\n`strictFunctionTypes`, `never[]` makes the parameter position accept any\nfunction (every param type is a supertype of `never`) while still pinning the\nreturn type — exactly \"callable returning a SWAIG result, params don't\nmatter\". (`...unknown[]` would wrongly REJECT a `(city: string) => …` handler,\ndefeating the purpose.)","file":"dist/TypeInference.d.ts","line":32},"ValidationResult":{"name":"ValidationResult","kind":"interface","exported":true,"signature":["interface ValidationResult"],"doc":"Result of validating a SWML document.","file":"dist/SchemaUtils.d.ts","line":9,"members":[{"name":"valid","kind":"property","owner":"ValidationResult","signature":["valid: boolean"],"doc":"Whether the document passed all validation checks.","file":"dist/SchemaUtils.d.ts","line":11},{"name":"errors","kind":"property","owner":"ValidationResult","signature":["errors: string[]"],"doc":"List of human-readable error messages; empty when valid.","file":"dist/SchemaUtils.d.ts","line":13}]},"VerbHandlerRegistry":{"name":"VerbHandlerRegistry","kind":"class","exported":true,"signature":["class VerbHandlerRegistry"],"doc":"Registry for SWML verb handlers.\n\nThis class maintains a registry of handlers for special SWML verbs\nand provides methods for accessing and using them. The \"ai\" verb handler\n({@link AIVerbHandler}) is registered automatically on construction.\n\n@example\n```ts\nconst registry = new VerbHandlerRegistry();\n\n// The \"ai\" handler is already registered\nregistry.hasHandler('ai'); // true\n\n// Register a custom handler\nregistry.registerHandler(new MyCustomVerbHandler());\n\n// Look up a handler\nconst handler = registry.getHandler('ai');\nif (handler) {\n const [valid, errors] = handler.validateConfig(config);\n}\n```","file":"dist/SWMLHandler.d.ts","line":138,"members":[{"name":"constructor","kind":"constructor","owner":"VerbHandlerRegistry","signature":["constructor()"],"doc":"Initialize the registry with default handlers.","file":"dist/SWMLHandler.d.ts","line":141},{"name":"registerHandler","kind":"method","owner":"VerbHandlerRegistry","signature":["registerHandler(handler: SWMLVerbHandler): void"],"doc":"Register a new verb handler, replacing any existing handler for the same verb name.\n@param handler - The handler to register.","file":"dist/SWMLHandler.d.ts","line":146},{"name":"getHandler","kind":"method","owner":"VerbHandlerRegistry","signature":["getHandler(verbName: string): SWMLVerbHandler | undefined"],"doc":"Get the handler for a specific verb.\n@param verbName - The name of the verb (e.g. \"ai\").\n@returns The handler if found, or `undefined` otherwise.","file":"dist/SWMLHandler.d.ts","line":152},{"name":"hasHandler","kind":"method","owner":"VerbHandlerRegistry","signature":["hasHandler(verbName: string): boolean"],"doc":"Check if a handler exists for a specific verb.\n@param verbName - The name of the verb.\n@returns `true` if a handler is registered for the verb, `false` otherwise.","file":"dist/SWMLHandler.d.ts","line":158}]},"VerifiedCallersResource":{"name":"VerifiedCallersResource","kind":"class","exported":true,"signature":["class VerifiedCallers extends CrudResource<VerifiedCallerIDListResponse, VerifiedCallerIDResponse, CreateVerifiedCallerIDRequest, UpdateVerifiedCallerIDRequest>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":157,"members":[{"name":"constructor","kind":"constructor","owner":"VerifiedCallersResource","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":159},{"name":"create","kind":"method","owner":"VerifiedCallersResource","signature":["create(body: CreateVerifiedCallerIDRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<VerifiedCallerIDResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":161},{"name":"update","kind":"method","owner":"VerifiedCallersResource","signature":["update(id: string, body: UpdateVerifiedCallerIDRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<VerifiedCallerIDResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":163},{"name":"redialVerification","kind":"method","owner":"VerifiedCallersResource","signature":["redialVerification(id: string, requestOptions?: RequestOptionsInit): Promise<VerifiedCallerIDResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":164},{"name":"submitVerification","kind":"method","owner":"VerifiedCallersResource","signature":["submitVerification(id: string, verification_code: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<VerifiedCallerIDResponse>"],"doc":"","file":"dist/rest/namespaces/relay-rest.resources.generated.d.ts","line":165}],"bases":["CrudResource"]},"VideoConferenceTokens":{"name":"VideoConferenceTokens","kind":"class","exported":true,"signature":["class VideoConferenceTokens extends BaseResource"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":8,"members":[{"name":"constructor","kind":"constructor","owner":"VideoConferenceTokens","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":9},{"name":"get","kind":"method","owner":"VideoConferenceTokens","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ConferenceToken>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":10},{"name":"reset","kind":"method","owner":"VideoConferenceTokens","signature":["reset(id: string, requestOptions?: RequestOptionsInit): Promise<ConferenceToken>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":11}],"bases":["BaseResource"]},"VideoConferences":{"name":"VideoConferences","kind":"class","exported":true,"signature":["class VideoConferences extends CrudResource<ListConferencesResponse, Conference, CreateConferenceRequest, UpdateConferenceRequest>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":13,"members":[{"name":"constructor","kind":"constructor","owner":"VideoConferences","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":15},{"name":"create","kind":"method","owner":"VideoConferences","signature":["create(body: CreateConferenceRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<Conference>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":17},{"name":"update","kind":"method","owner":"VideoConferences","signature":["update(id: string, body: UpdateConferenceRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<Conference>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":19},{"name":"listConferenceTokens","kind":"method","owner":"VideoConferences","signature":["listConferenceTokens(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ListConferenceTokensResponse>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":20},{"name":"listStreams","kind":"method","owner":"VideoConferences","signature":["listStreams(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ListStreamsResponse>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":21},{"name":"createStream","kind":"method","owner":"VideoConferences","signature":["createStream(id: string, url: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<Stream>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":22}],"bases":["CrudResource"]},"VideoNamespace":{"name":"VideoNamespace","kind":"class","exported":true,"signature":["class VideoNamespace"],"doc":"Generated `client.video` namespace container.","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":63,"members":[{"name":"conferences","kind":"property","owner":"VideoNamespace","readonly":true,"signature":["readonly conferences: VideoConferences"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":64},{"name":"conferenceTokens","kind":"property","owner":"VideoNamespace","readonly":true,"signature":["readonly conferenceTokens: VideoConferenceTokens"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":65},{"name":"roomRecordings","kind":"property","owner":"VideoNamespace","readonly":true,"signature":["readonly roomRecordings: VideoRoomRecordings"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":66},{"name":"rooms","kind":"property","owner":"VideoNamespace","readonly":true,"signature":["readonly rooms: VideoRooms"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":67},{"name":"roomSessions","kind":"property","owner":"VideoNamespace","readonly":true,"signature":["readonly roomSessions: VideoRoomSessions"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":68},{"name":"roomTokens","kind":"property","owner":"VideoNamespace","readonly":true,"signature":["readonly roomTokens: VideoRoomTokens"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":69},{"name":"streams","kind":"property","owner":"VideoNamespace","readonly":true,"signature":["readonly streams: VideoStreams"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":70},{"name":"constructor","kind":"constructor","owner":"VideoNamespace","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":71}]},"VideoRoomRecordings":{"name":"VideoRoomRecordings","kind":"class","exported":true,"signature":["class VideoRoomRecordings extends BaseResource"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":26,"members":[{"name":"constructor","kind":"constructor","owner":"VideoRoomRecordings","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":27},{"name":"list","kind":"method","owner":"VideoRoomRecordings","signature":["list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ListRoomRecordingsResponse>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":28},{"name":"get","kind":"method","owner":"VideoRoomRecordings","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<RoomRecording>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":29},{"name":"delete","kind":"method","owner":"VideoRoomRecordings","signature":["delete(id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":30},{"name":"listEvents","kind":"method","owner":"VideoRoomRecordings","signature":["listEvents(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ListRoomRecordingEventsResponse>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":31}],"bases":["BaseResource"]},"VideoRoomSessions":{"name":"VideoRoomSessions","kind":"class","exported":true,"signature":["class VideoRoomSessions extends ReadResource<ListRoomSessionsResponse, RoomSessionSummary>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":33,"members":[{"name":"constructor","kind":"constructor","owner":"VideoRoomSessions","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":34},{"name":"listEvents","kind":"method","owner":"VideoRoomSessions","signature":["listEvents(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ListRoomSessionEventsResponse>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":35},{"name":"listMembers","kind":"method","owner":"VideoRoomSessions","signature":["listMembers(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ListRoomSessionMembersResponse>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":36},{"name":"listRecordings","kind":"method","owner":"VideoRoomSessions","signature":["listRecordings(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ListRoomSessionRecordingsResponse>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":37}],"bases":["ReadResource"]},"VideoRoomTokens":{"name":"VideoRoomTokens","kind":"class","exported":true,"signature":["class VideoRoomTokens extends BaseResource"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":39,"members":[{"name":"constructor","kind":"constructor","owner":"VideoRoomTokens","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":40},{"name":"create","kind":"method","owner":"VideoRoomTokens","signature":["create(room_name: string, options?: {\n user_name?: string;\n permissions?: RoomTokenPermission[];\n join_from?: string;\n join_until?: string;\n remove_at?: string;\n remove_after_seconds_elapsed?: number;\n join_audio_muted?: boolean;\n join_video_muted?: boolean;\n auto_create_room?: boolean;\n enable_room_previews?: boolean;\n room_display_name?: string;\n end_room_session_on_leave?: boolean;\n join_as?: JoinAsType;\n media_allowed?: MediaAllowedType;\n room_meta?: Record<string, Record<string, unknown>>;\n meta?: Record<string, Record<string, unknown>>;\n sync_audio_video?: boolean;\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<RoomTokenResponse>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":41}],"bases":["BaseResource"]},"VideoRooms":{"name":"VideoRooms","kind":"class","exported":true,"signature":["class VideoRooms extends CrudResource<ListRoomsResponse, RoomResponse, CreateRoomRequest, UpdateRoomRequest>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":62,"members":[{"name":"constructor","kind":"constructor","owner":"VideoRooms","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":64},{"name":"create","kind":"method","owner":"VideoRooms","signature":["create(body: CreateRoomRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<RoomResponse>"],"doc":"Create — typed request body plus an `extras` escape hatch for fields not yet typed.","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":66},{"name":"update","kind":"method","owner":"VideoRooms","signature":["update(id: string, body: UpdateRoomRequest, extras?: Record<string, unknown>, requestOptions?: RequestOptionsInit): Promise<RoomResponse>"],"doc":"Update — typed request body plus an `extras` escape hatch.","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":68},{"name":"listStreams","kind":"method","owner":"VideoRooms","signature":["listStreams(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<ListStreamsResponse>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":69},{"name":"createStream","kind":"method","owner":"VideoRooms","signature":["createStream(id: string, url: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<Stream>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":70}],"bases":["CrudResource"]},"VideoStreams":{"name":"VideoStreams","kind":"class","exported":true,"signature":["class VideoStreams extends BaseResource"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":74,"members":[{"name":"constructor","kind":"constructor","owner":"VideoStreams","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":75},{"name":"get","kind":"method","owner":"VideoStreams","signature":["get(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<Stream>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":76},{"name":"update","kind":"method","owner":"VideoStreams","signature":["update(id: string, url: string, options?: {\n extras?: Record<string, unknown>;\n}, requestOptions?: RequestOptionsInit): Promise<Stream>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":77},{"name":"delete","kind":"method","owner":"VideoStreams","signature":["delete(id: string, requestOptions?: RequestOptionsInit): Promise<Record<string, unknown>>"],"doc":"","file":"dist/rest/namespaces/video.resources.generated.d.ts","line":80}],"bases":["BaseResource"]},"VoiceLogs":{"name":"VoiceLogs","kind":"class","exported":true,"signature":["class VoiceLogs extends ReadResource<LogListResponse, VoiceLog>"],"doc":"","file":"dist/rest/namespaces/voice.resources.generated.d.ts","line":6,"members":[{"name":"constructor","kind":"constructor","owner":"VoiceLogs","signature":["constructor(http: HttpClient)"],"doc":"","file":"dist/rest/namespaces/voice.resources.generated.d.ts","line":7},{"name":"listEvents","kind":"method","owner":"VoiceLogs","signature":["listEvents(id: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<LogEventsListResponse>"],"doc":"","file":"dist/rest/namespaces/voice.resources.generated.d.ts","line":8}],"bases":["ReadResource"]},"WeatherApiSkill":{"name":"WeatherApiSkill","kind":"class","exported":true,"signature":["class WeatherApiSkill extends SkillBase"],"doc":"Fetches current weather data from OpenWeatherMap for any location worldwide.\n\nNeeds an OpenWeatherMap API key (obtainable at openweathermap.org), passed\nas `api_key` or set in the `WEATHER_API_KEY` environment variable; setup\nfails without one. The `api_key` config value takes precedence over the\nenvironment variable when both are set. Supports metric, imperial, and\nstandard temperature units via the `units` config option, with Fahrenheit\n(`imperial`) as the default, as in Python.\n\n**Provider note:** The Python reference SDK uses WeatherAPI.com\n(`api.weatherapi.com/v1/current.json`). This TypeScript skill uses\nOpenWeatherMap (`api.openweathermap.org/data/2.5/weather`), a deliberate\nchoice recorded in PORT_BEHAVIORAL_NOTES.md. These providers use different\nAPI key formats — a WeatherAPI.com key will NOT work here. Obtain an\nOpenWeatherMap key at https://openweathermap.org/api.\n\n**Unit aliases:** For migration compatibility with the Python SDK the `units`\nconfig also accepts `\"fahrenheit\"` (normalized to `\"imperial\"`) and\n`\"celsius\"` (normalized to `\"metric\"`).\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\n// The key comes from WEATHER_API_KEY:\nawait agent.addSkillByName('weather_api', { units: 'metric' });\n// or pass it explicitly:\nawait agent.addSkillByName('weather_api', { api_key: process.env.OPENWEATHERMAP_KEY });\n```","file":"dist/skills/builtin/weather_api.d.ts","line":41,"members":[{"name":"SKILL_NAME","kind":"property","owner":"WeatherApiSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/weather_api.d.ts","line":42},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"WeatherApiSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/weather_api.d.ts","line":43},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"WeatherApiSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/weather_api.d.ts","line":44},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"WeatherApiSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/weather_api.d.ts","line":45},{"name":"setup","kind":"method","owner":"WeatherApiSkill","signature":["setup(): Promise<boolean>"],"doc":"Validates that an API key is available either via inline config or the\n`WEATHER_API_KEY` environment variable. Fails fast (returns `false`) when\nneither source provides a key — matching Python SDK behaviour where\n`_validate_config()` raises on construction when `api_key` is absent.\n@returns `true` if a key is present, `false` otherwise.","file":"dist/skills/builtin/weather_api.d.ts","line":53},{"name":"getParameterSchema","kind":"method","owner":"WeatherApiSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/weather_api.d.ts","line":54},{"name":"getTools","kind":"method","owner":"WeatherApiSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A single weather tool (configurable name) that fetches current weather for a location.","file":"dist/skills/builtin/weather_api.d.ts","line":62}],"bases":["SkillBase"]},"WebSearchSkill":{"name":"WebSearchSkill","kind":"class","exported":true,"signature":["class WebSearchSkill extends SkillBase"],"doc":"Searches the web using the Google Custom Search JSON API.\n\nTier 3 built-in skill. Credentials can be supplied via the `api_key` and\n`search_engine_id` params or `GOOGLE_SEARCH_API_KEY` /\n`GOOGLE_SEARCH_ENGINE_ID` (legacy: `GOOGLE_SEARCH_CX`) environment variables.\n\nThe handler mirrors Python's `search_and_scrape_best` pipeline: fetches\n`oversample_factor × num_results` candidates from Google, scrapes each\nresult page (SSRF-guarded, cheerio-based text extraction), scores for\nquality (length + query relevance + boilerplate penalty), deduplicates by\ndomain, and returns the top `num_results` above `min_quality_score` with\nfull page content. If every scrape fails or falls below the threshold the\nhandler falls back to raw API snippets so the agent still has something\nto say.\n\nSupported config: `tool_name`, `num_results`, `no_results_message`,\n`safe_search`, `delay`, `max_content_length`, `oversample_factor`,\n`min_quality_score`, `response_prefix`, `response_postfix`, and the\nlatency-control params `per_page_timeout`, `overall_deadline`,\n`parallel_scrape`, `snippets_only` (Python skill.py commits 51101da +\n295745b). When the overall deadline fires or no scraped page meets the\nquality threshold, the handler falls back to formatting the CSE snippets.\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('web_search', {\n api_key: process.env.GOOGLE_SEARCH_API_KEY,\n search_engine_id: process.env.GOOGLE_CSE_ID,\n num_results: 3,\n});\n```","file":"dist/skills/builtin/web_search.d.ts","line":71,"members":[{"name":"REQUIRED_PACKAGES","kind":"property","owner":"WebSearchSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/web_search.d.ts","line":72},{"name":"SKILL_NAME","kind":"property","owner":"WebSearchSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/web_search.d.ts","line":73},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"WebSearchSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/web_search.d.ts","line":74},{"name":"SKILL_VERSION","kind":"property","owner":"WebSearchSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/web_search.d.ts","line":75},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"WebSearchSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/web_search.d.ts","line":76},{"name":"SUPPORTS_MULTIPLE_INSTANCES","kind":"property","owner":"WebSearchSkill","static":true,"signature":["static SUPPORTS_MULTIPLE_INSTANCES: boolean"],"doc":"","file":"dist/skills/builtin/web_search.d.ts","line":77},{"name":"getParameterSchema","kind":"method","owner":"WebSearchSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/web_search.d.ts","line":78},{"name":"setup","kind":"method","owner":"WebSearchSkill","signature":["setup(): Promise<boolean>"],"doc":"Validate required credentials before the skill becomes active.\n\nMirrors Python's `setup()` (skill.py:559-600) which checks `api_key` and\n`search_engine_id` and returns `False` (logging an error) if either is\nabsent. In the TS SDK credentials may also arrive via environment variables\n(`GOOGLE_SEARCH_API_KEY` / `GOOGLE_SEARCH_ENGINE_ID` or the legacy alias\n`GOOGLE_SEARCH_CX`), so both config params and env vars are checked.\n@returns `true` if all required credentials are present, `false` otherwise.","file":"dist/skills/builtin/web_search.d.ts","line":94},{"name":"getInstanceKey","kind":"method","owner":"WebSearchSkill","signature":["getInstanceKey(): string"],"doc":"Instance key for the SkillManager. Includes the configured\n`search_engine_id` (or `\"default\"`) and `tool_name` (or `\"web_search\"`)\nto match Python's `\"{SKILL_NAME}_{search_engine_id}_{tool_name}\"` scheme.","file":"dist/skills/builtin/web_search.d.ts","line":100},{"name":"getGlobalData","kind":"method","owner":"WebSearchSkill","signature":["getGlobalData(): Record<string, unknown>"],"doc":"Global data injected into the agent's SWML context (mirrors Python).","file":"dist/skills/builtin/web_search.d.ts","line":102},{"name":"getTools","kind":"method","owner":"WebSearchSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A single tool (named via `tool_name`) that performs a Google\n Custom Search and returns formatted results.","file":"dist/skills/builtin/web_search.d.ts","line":109}],"bases":["SkillBase"]},"WebService":{"name":"WebService","kind":"class","exported":true,"signature":["class WebService"],"doc":"Static file serving service with HTTP API.\n\nProvides configurable static file hosting with per-route directory mounting,\nextension filtering, file size limits, HTTP Basic Auth, CORS, directory\nbrowsing, and optional SSL/TLS. Mirrors the Python SDK's `WebService` class.\n\nUseful when an agent or prefab needs to serve supporting assets (prompts, audio\nfiles, images) from the same process without running a separate nginx or CDN.\n\nEvery route but `/health` requires HTTP Basic Authentication, and `start()`\nrefuses to run until credentials are configured: the `basicAuth` option, the\nconfig file's `security.auth.basic`, or `SWML_BASIC_AUTH_USER` /\n`SWML_BASIC_AUTH_PASSWORD`.\n\n@example Serve a directory of audio files\n```ts\nimport { WebService } from '@signalwire/sdk';\n\nconst web = new WebService({\n port: 8080,\n directories: { '/audio': './public/audio' },\n basicAuth: ['audio', process.env['AUDIO_PASSWORD'] ?? ''],\n allowedExtensions: ['.mp3', '.wav'],\n});\n\nawait web.start();\n// GET http://host:8080/audio/greeting.mp3\n```","file":"dist/WebService.d.ts","line":76,"members":[{"name":"port","kind":"property","owner":"WebService","readonly":true,"signature":["readonly port: number"],"doc":"Port the service binds to.","file":"dist/WebService.d.ts","line":78},{"name":"enableDirectoryBrowsing","kind":"property","owner":"WebService","readonly":true,"signature":["readonly enableDirectoryBrowsing: boolean"],"doc":"Whether directory listings are enabled.","file":"dist/WebService.d.ts","line":80},{"name":"maxFileSize","kind":"property","owner":"WebService","readonly":true,"signature":["readonly maxFileSize: number"],"doc":"Maximum file size in bytes that will be served.","file":"dist/WebService.d.ts","line":82},{"name":"enableCors","kind":"property","owner":"WebService","readonly":true,"signature":["readonly enableCors: boolean"],"doc":"Whether CORS is enabled.","file":"dist/WebService.d.ts","line":84},{"name":"allowedExtensions","kind":"property","owner":"WebService","readonly":true,"signature":["readonly allowedExtensions: string[] | null"],"doc":"Allowlist of file extensions, or null to allow all (subject to blocklist).","file":"dist/WebService.d.ts","line":86},{"name":"blockedExtensions","kind":"property","owner":"WebService","readonly":true,"signature":["readonly blockedExtensions: string[]"],"doc":"Blocklist of file extensions and file names.","file":"dist/WebService.d.ts","line":88},{"name":"directories","kind":"property","owner":"WebService","readonly":true,"signature":["readonly directories: Record<string, string>"],"doc":"Map of URL route prefixes to local directory paths.","file":"dist/WebService.d.ts","line":90},{"name":"constructor","kind":"constructor","owner":"WebService","signature":["constructor(options?: WebServiceOptions)"],"doc":"Create a WebService.\n@param options - Configuration options for the service.","file":"dist/WebService.d.ts","line":104},{"name":"addDirectory","kind":"method","owner":"WebService","signature":["addDirectory(route: string, directory: string): void"],"doc":"Add a new directory to serve at a URL route prefix. Works before or after\nthe service starts; the route serves from the next request.\n@param route - URL prefix (e.g. '/docs').\n@param directory - Local directory path to serve.\n@throws If the directory does not exist or is not a directory.","file":"dist/WebService.d.ts","line":112},{"name":"removeDirectory","kind":"method","owner":"WebService","signature":["removeDirectory(route: string): void"],"doc":"Stop serving a directory. The route stops responding at once, including\non a running service.\n@param route - The URL route prefix to remove.","file":"dist/WebService.d.ts","line":118},{"name":"getApp","kind":"method","owner":"WebService","signature":["getApp(): Hono"],"doc":"Get the Hono application for mounting or testing.\n@returns The configured Hono app.","file":"dist/WebService.d.ts","line":123},{"name":"sslConfig","kind":"accessor","owner":"WebService","signature":["get sslConfig(): SslConfig"],"doc":"The SSL/TLS configuration for this service.\n\nMirrors the Python SDK's `security` attribute (`SecurityConfig`), which\nexposes SSL settings for post-construction inspection. In the Python SDK\n`SecurityConfig` also covers CORS origins, HSTS, allowed hosts, and rate\nlimiting; in this SDK those concerns are configured via their own\nconstructor options (`enableCors`, `ssl`, etc.) and Hono middleware rather\nthan a single combined object.\n\n@returns The `SslConfig` instance used by this service.","file":"dist/WebService.d.ts","line":136},{"name":"start","kind":"method","owner":"WebService","signature":["start(host?: string, port?: number, sslCert?: string, sslKey?: string): Promise<void>"],"doc":"Start the HTTP(S) service.\n\nWhen `SWAIG_CLI_MODE=true` is set in the environment, the call is a\nno-op so config can be inspected without binding a port.\n\n@throws If no basic-auth credentials are configured (the `basicAuth`\n option, the config file's `security.auth.basic`, or\n `SWML_BASIC_AUTH_USER` / `SWML_BASIC_AUTH_PASSWORD`).\n\n@param host - Bind address. Defaults to `'0.0.0.0'`.\n@param port - Port override. Defaults to `this.port`.\n@param sslCert - Path to SSL certificate file (overrides `SslConfig`).\n@param sslKey - Path to SSL key file (overrides `SslConfig`).\n@returns Resolves once the server has begun listening.","file":"dist/WebService.d.ts","line":153},{"name":"stop","kind":"method","owner":"WebService","signature":["stop(): void"],"doc":"Stop the service and release resources.","file":"dist/WebService.d.ts","line":157}]},"WebServiceOptions":{"name":"WebServiceOptions","kind":"interface","exported":true,"signature":["interface WebServiceOptions"],"doc":"Configuration options for WebService.","file":"dist/WebService.d.ts","line":12,"members":[{"name":"port","kind":"property","owner":"WebServiceOptions","signature":["port?: number"],"doc":"Port to bind to. Default: 8002.","file":"dist/WebService.d.ts","line":14},{"name":"directories","kind":"property","owner":"WebServiceOptions","signature":["directories?: Record<string, string>"],"doc":"Map of URL route prefixes to local directory paths. Default: {}.","file":"dist/WebService.d.ts","line":16},{"name":"basicAuth","kind":"property","owner":"WebServiceOptions","signature":["basicAuth?: [string, string]"],"doc":"Basic auth credentials as [username, password]. Default: the config file's\n`security.auth.basic`, then `SWML_BASIC_AUTH_USER` / `SWML_BASIC_AUTH_PASSWORD`.\nEvery route but `/health` requires them. Without a password from any of\nthese (an empty one doesn't count), the service generates one that is\nnever shown, so it refuses every request, and `start()` throws.","file":"dist/WebService.d.ts","line":24},{"name":"configFile","kind":"property","owner":"WebServiceOptions","signature":["configFile?: string"],"doc":"Path to a JSON config file. Default: none.","file":"dist/WebService.d.ts","line":26},{"name":"enableDirectoryBrowsing","kind":"property","owner":"WebServiceOptions","signature":["enableDirectoryBrowsing?: boolean"],"doc":"Serve directory listings and fall back to index.html. Default: false.","file":"dist/WebService.d.ts","line":28},{"name":"allowedExtensions","kind":"property","owner":"WebServiceOptions","signature":["allowedExtensions?: string[]"],"doc":"Allowlist of file extensions (e.g. ['.html', '.css']). Default: all allowed.","file":"dist/WebService.d.ts","line":30},{"name":"blockedExtensions","kind":"property","owner":"WebServiceOptions","signature":["blockedExtensions?: string[]"],"doc":"Blocklist of file extensions or names. An entry is also refused as the\nname of any directory on the path below the mount. Whatever this holds, a\npath with a component below the mount that starts with a dot, other than\n`.well-known`, is never served.\nDefault: ['.env', '.git', '.gitignore', '.key', '.pem', '.crt', '.pyc', '__pycache__', '.DS_Store', '.swp']","file":"dist/WebService.d.ts","line":38},{"name":"maxFileSize","kind":"property","owner":"WebServiceOptions","signature":["maxFileSize?: number"],"doc":"Maximum file size in bytes. Default: 104857600 (100 MB).","file":"dist/WebService.d.ts","line":40},{"name":"enableCors","kind":"property","owner":"WebServiceOptions","signature":["enableCors?: boolean"],"doc":"Enable CORS. Default: true.","file":"dist/WebService.d.ts","line":42},{"name":"ssl","kind":"property","owner":"WebServiceOptions","signature":["ssl?: SslOptions"],"doc":"SSL/TLS configuration options.","file":"dist/WebService.d.ts","line":44}]},"WebhookRejection":{"name":"WebhookRejection","kind":"type","exported":true,"signature":["type WebhookRejection = [number, Record<string, string>, string]"],"doc":"A rejection response as a framework-free triple:\n``[statusCode, responseHeaders, responseBody]``. Cross-port shape of the\ndecomposed webhook-validation decision (Python's\n``webhook_middleware.validate`` return, dotnet's\n``WebhookValidationMiddleware.Validate``, Rack/PSGI ``[status, headers, body]``).","file":"dist/WebhookMiddleware.d.ts","line":43},"WebhookValidationOptions":{"name":"WebhookValidationOptions","kind":"interface","exported":true,"signature":["interface WebhookValidationOptions"],"doc":"Options for {@link webhookValidationMiddleware}.","file":"dist/WebhookMiddleware.d.ts","line":86,"members":[{"name":"signingKey","kind":"property","owner":"WebhookValidationOptions","signature":["signingKey: string"],"doc":"The customer's Signing Key. Required; passing an empty string throws at\nconstruction time (it's a programming error, not a runtime failure).","file":"dist/WebhookMiddleware.d.ts","line":91},{"name":"trustProxy","kind":"property","owner":"WebhookValidationOptions","signature":["trustProxy?: boolean"],"doc":"When true, honor ``X-Forwarded-Proto`` / ``X-Forwarded-Host`` headers\nwhen reconstructing the URL. Default false — proxy headers are spoofable,\nso opt in only when you control the proxy.","file":"dist/WebhookMiddleware.d.ts","line":97}]},"WikipediaSearchSkill":{"name":"WikipediaSearchSkill","kind":"class","exported":true,"signature":["class WikipediaSearchSkill extends SkillBase"],"doc":"Searches Wikipedia for article summaries and extracts.\n\nTier 3 built-in skill with no external API key required. The configured\n`num_results` drives how many articles are aggregated; `no_results_message`\ncustomizes the fallback text (supports `{query}` interpolation).\n\n@example\n```ts\nimport { AgentBase } from '@signalwire/sdk';\nconst agent = new AgentBase({ name: 'demo', route: '/' });\nawait agent.addSkillByName('wikipedia_search', { num_results: 2 });\n```","file":"dist/skills/builtin/wikipedia_search.d.ts","line":24,"members":[{"name":"SKILL_NAME","kind":"property","owner":"WikipediaSearchSkill","static":true,"signature":["static SKILL_NAME: string"],"doc":"","file":"dist/skills/builtin/wikipedia_search.d.ts","line":25},{"name":"SKILL_DESCRIPTION","kind":"property","owner":"WikipediaSearchSkill","static":true,"signature":["static SKILL_DESCRIPTION: string"],"doc":"","file":"dist/skills/builtin/wikipedia_search.d.ts","line":26},{"name":"SKILL_VERSION","kind":"property","owner":"WikipediaSearchSkill","static":true,"signature":["static SKILL_VERSION: string"],"doc":"","file":"dist/skills/builtin/wikipedia_search.d.ts","line":27},{"name":"REQUIRED_PACKAGES","kind":"property","owner":"WikipediaSearchSkill","static":true,"signature":["static REQUIRED_PACKAGES: readonly string[]"],"doc":"","file":"dist/skills/builtin/wikipedia_search.d.ts","line":28},{"name":"REQUIRED_ENV_VARS","kind":"property","owner":"WikipediaSearchSkill","static":true,"signature":["static REQUIRED_ENV_VARS: readonly string[]"],"doc":"","file":"dist/skills/builtin/wikipedia_search.d.ts","line":29},{"name":"numResults","kind":"property","owner":"WikipediaSearchSkill","signature":["numResults: number"],"doc":"Resolved `num_results` value (populated in `setup()`).\nPublic to mirror Python's `self.num_results` — accessible to subclasses\nand external test code inspecting skill state.","file":"dist/skills/builtin/wikipedia_search.d.ts","line":35},{"name":"noResultsMessage","kind":"property","owner":"WikipediaSearchSkill","protected":true,"signature":["protected noResultsMessage: string"],"doc":"Resolved `no_results_message` template (populated in `setup()`).\nProtected to mirror Python's `self.no_results_message` public visibility\nwithin the class hierarchy.","file":"dist/skills/builtin/wikipedia_search.d.ts","line":41},{"name":"getParameterSchema","kind":"method","owner":"WikipediaSearchSkill","static":true,"signature":["static getParameterSchema(): Record<string, ParameterSchemaEntry>"],"doc":"","file":"dist/skills/builtin/wikipedia_search.d.ts","line":42},{"name":"setup","kind":"method","owner":"WikipediaSearchSkill","signature":["setup(): Promise<boolean>"],"doc":"Extract config values into instance state. Enforces `num_results >= 1`\n(matching Python `skill.py:_setup` `max(1, ...)` floor). The schema's\n`max: 5` handles the upper bound at validation time — no runtime clamp\nhere, so callers passing larger values get the raw value as in Python.","file":"dist/skills/builtin/wikipedia_search.d.ts","line":49},{"name":"getTools","kind":"method","owner":"WikipediaSearchSkill","signature":["getTools(): SkillToolDefinition[]"],"doc":"@returns A `search_wiki` tool that fetches article summaries from Wikipedia.","file":"dist/skills/builtin/wikipedia_search.d.ts","line":51},{"name":"searchWiki","kind":"method","owner":"WikipediaSearchSkill","signature":["searchWiki(query: string): Promise<string>"],"doc":"Search Wikipedia and return a formatted text summary.\n\nMirrors the Python `search_wiki()` public entry point so the logic can be\ntested and reused outside the SWAIG handler. Uses `num_results` to decide\nhow many articles to aggregate.\n\n@param query - Plain-text search term.\n@returns Formatted text ready for display to the caller.","file":"dist/skills/builtin/wikipedia_search.d.ts","line":62}],"bases":["SkillBase"]},"_GeneratedResourceTree":{"name":"_GeneratedResourceTree","kind":"class","exported":false,"signature":["class _GeneratedResourceTree"],"doc":"Generated resource wiring for `RestClient` (flat resources + namespace\ncontainers). The hand `RestClient` extends this and calls `_wireResources`\nafter constructing the HTTP layer; it keeps only the non-spec-derivable bits\n(auth, HTTP construction).","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":79,"members":[{"name":"addresses","kind":"property","owner":"_GeneratedResourceTree","signature":["addresses: Addresses"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":80},{"name":"calling","kind":"property","owner":"_GeneratedResourceTree","signature":["calling: Calling"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":81},{"name":"chat","kind":"property","owner":"_GeneratedResourceTree","signature":["chat: Chat"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":82},{"name":"importedNumbers","kind":"property","owner":"_GeneratedResourceTree","signature":["importedNumbers: ImportedNumbers"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":83},{"name":"lookup","kind":"property","owner":"_GeneratedResourceTree","signature":["lookup: Lookup"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":84},{"name":"messages","kind":"property","owner":"_GeneratedResourceTree","signature":["messages: Messages"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":85},{"name":"mfa","kind":"property","owner":"_GeneratedResourceTree","signature":["mfa: Mfa"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":86},{"name":"numberGroups","kind":"property","owner":"_GeneratedResourceTree","signature":["numberGroups: NumberGroups"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":87},{"name":"phoneNumbers","kind":"property","owner":"_GeneratedResourceTree","signature":["phoneNumbers: PhoneNumbers"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":88},{"name":"projects","kind":"property","owner":"_GeneratedResourceTree","signature":["projects: Projects"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":89},{"name":"pubsub","kind":"property","owner":"_GeneratedResourceTree","signature":["pubsub: PubSub"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":90},{"name":"queues","kind":"property","owner":"_GeneratedResourceTree","signature":["queues: Queues"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":91},{"name":"recordings","kind":"property","owner":"_GeneratedResourceTree","signature":["recordings: Recordings"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":92},{"name":"shortCodes","kind":"property","owner":"_GeneratedResourceTree","signature":["shortCodes: ShortCodes"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":93},{"name":"sipProfile","kind":"property","owner":"_GeneratedResourceTree","signature":["sipProfile: SipProfile"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":94},{"name":"verifiedCallers","kind":"property","owner":"_GeneratedResourceTree","signature":["verifiedCallers: VerifiedCallers"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":95},{"name":"datasphere","kind":"property","owner":"_GeneratedResourceTree","signature":["datasphere: DatasphereNamespace"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":96},{"name":"fabric","kind":"property","owner":"_GeneratedResourceTree","signature":["fabric: FabricNamespace"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":97},{"name":"logs","kind":"property","owner":"_GeneratedResourceTree","signature":["logs: LogsNamespace"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":98},{"name":"project","kind":"property","owner":"_GeneratedResourceTree","signature":["project: ProjectNamespace"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":99},{"name":"registry","kind":"property","owner":"_GeneratedResourceTree","signature":["registry: RegistryNamespace"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":100},{"name":"video","kind":"property","owner":"_GeneratedResourceTree","signature":["video: VideoNamespace"],"doc":"","file":"dist/rest/namespaces/_client_tree_generated.d.ts","line":101}]},"addSkillDirectory":{"name":"addSkillDirectory","kind":"function","exported":true,"signature":["function addSkillDirectory(path: string): void"],"doc":"Register a directory to search for additional skill modules.\n\nEquivalent to Python's `add_skill_directory(path)`. Proxies to\n`SkillRegistry.addSearchPath()`. Callers who want on-disk dynamic\ndiscovery can pair this with `SkillRegistry.discoverFromDirectory()`.\n\n@param path - Absolute path to a directory containing skill files.","file":"dist/index.d.ts","line":206},"createBedrockAgent":{"name":"createBedrockAgent","kind":"function","exported":true,"signature":["function createBedrockAgent(config?: BedrockAgentConfig): BedrockAgent"],"doc":"Factory function that creates and returns a new BedrockAgent.\n@param config - Configuration for the Bedrock agent.\n@returns A configured BedrockAgent instance.","file":"dist/agents/BedrockAgent.d.ts","line":161},"createDeferred":{"name":"createDeferred","kind":"function","exported":true,"signature":["function createDeferred<T>(): Deferred<T>"],"doc":"Create a {@link Deferred} with externalised `resolve` / `reject` and a\n`settled` flag.\n\nThe returned object exposes the promise plus its resolve and reject\nfunctions so callers outside the executor can settle it. Later calls to\n`resolve` or `reject` are idempotent.\n\n@typeParam T - Resolution value type of the wrapped promise.\n@returns A fresh `Deferred<T>` in pending state.","file":"dist/relay/Deferred.d.ts","line":32},"createExpressionTool":{"name":"createExpressionTool","kind":"function","exported":true,"signature":["function createExpressionTool(opts: {\n name: string;\n patterns: Record<string, [string, FunctionResult]>;\n parameters?: Record<string, {\n type?: string;\n description?: string;\n required?: boolean;\n }>;\n}): DataMap"],"doc":"Create a DataMap tool that evaluates expressions against patterns without making HTTP calls.\n@param opts - Configuration including name, pattern-result pairs, and optional parameters.\n@returns A configured DataMap instance ready for registration.","file":"dist/DataMap.d.ts","line":376},"createSimpleApiTool":{"name":"createSimpleApiTool","kind":"function","exported":true,"signature":["function createSimpleApiTool(opts: {\n name: string;\n url: string;\n responseTemplate: string;\n parameters?: Record<string, {\n type?: string;\n description?: string;\n required?: boolean;\n }>;\n method?: string;\n headers?: Record<string, string>;\n body?: Record<string, unknown>;\n errorKeys?: string[];\n}): DataMap"],"doc":"Create a DataMap tool that calls a single API endpoint and formats the response.\n\n`url` reads the arguments as `${args.name}`. `responseTemplate` becomes\nthe webhook's output, which reads the response's fields from the root,\nsuch as `${current.temp_f}`, and the arguments as `${input.args.name}`.\n`body` is set as the webhook's params (see {@link DataMap.body}), so a\ntool with a body is sent as a POST. `method` defaults to `GET`; headers\nare sent as written.\n@param opts - Configuration including name, URL, response template, and optional parameters.\n@returns A configured DataMap instance ready for registration.","file":"dist/DataMap.d.ts","line":357},"createSimpleContext":{"name":"createSimpleContext","kind":"function","exported":true,"signature":["function createSimpleContext(name?: string): Context"],"doc":"Creates a standalone Context instance without a ContextBuilder.\n@param name - The context name (defaults to \"default\").\n@returns A new Context instance.","file":"dist/ContextBuilder.d.ts","line":844},"createTypedHandlerWrapper":{"name":"createTypedHandlerWrapper","kind":"function","exported":true,"signature":["function createTypedHandlerWrapper(fn: TypedToolHandler, paramNames: string[], hasRawData: boolean): SwaigHandler"],"doc":"Create a wrapper function that adapts a typed handler to the standard\n`(args, rawData) => result` SWAIG handler signature.\n\nThe wrapper extracts named parameters from the args dict and passes them\nas positional arguments to the original function.\n\n@param fn - The typed handler whose parameters match `paramNames` in order.\n@param paramNames - Ordered list of parameter names extracted from `fn`,\n produced by {@link inferSchema}.\n@param hasRawData - When `true`, the raw-data record is appended as the\n final positional argument to mirror the old-style handler shape.\n@returns A {@link SwaigHandler} suitable for registration with\n {@link AgentBase.defineTool}.","file":"dist/TypeInference.d.ts","line":107},"declaredCapabilities":{"name":"declaredCapabilities","kind":"function","exported":true,"signature":["function declaredCapabilities(bodyParams: unknown): ReadonlySet<string>"],"doc":"The capability names the client declared as truthy.\n\nAccepts either a whole SWML request body or already-extracted user\nvariables, so it works from a dynamic config callback and from a tool\nhandler alike.\n\n@param bodyParams - A SWML request body, or a user variables object.\n@returns The declared names; empty when nothing was declared, the payload\n was malformed, or the client isn't a browser at all.\n\n@example\n```ts\nif (declaredCapabilities(body).has('display_content')) {\n agent.promptAddSection('Screen', { body: 'You can show the caller content.' });\n}\n```","file":"dist/capabilities.d.ts","line":57},"defineSkillTool":{"name":"defineSkillTool","kind":"function","exported":true,"signature":["function defineSkillTool<const P extends ToolParameters = ToolParameters, const R extends readonly PropertyKey[] = []>(toolDef: Omit<SkillToolDefinition, 'parameters' | 'required' | 'handler'> & {\n parameters?: P;\n required?: R;\n handler: (args: ToolArgs<P, R>, rawData: SwaigRequest, agent?: AgentBase) => FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string>;\n}): SkillToolDefinition"],"doc":"Build a {@link SkillToolDefinition} whose `handler` args are *inferred* from\nits `parameters` schema + `required` list — the `getTools()`-level counterpart\nto {@link ../SWMLService.SWMLService.defineTool}'s typed-tool inference.\n\nA skill returns its tools as a plain `SkillToolDefinition[]`, and that\ninterface types `handler` as the loose {@link SwaigHandler} (`args:\nRecord<string, unknown>`) — so a hand-written entry's handler sees untyped\nargs and must reach for `args['query'] as string`. Wrapping the entry in\n`defineSkillTool` captures `parameters` (`P`) and `required` (`R`) via `const`\ntype parameters and feeds them through {@link ToolArgs}, so the handler's\n`args` is precise: a `required` string prop is `args.query: string`, an `enum`\nprop narrows to its literal union, optional props are `?`. It then erases the\ntyped handler back to {@link SwaigHandler} at a single boundary and returns an\nordinary `SkillToolDefinition`, so the result drops straight into a\n`getTools()` array with no other change.\n\nThe inferred `args` is a **compile-time authoring convenience only** — at\nruntime `args` is still whatever JSON the model extracted, so a handler that\ncares (most do, since the model can emit an empty/typeless value even for a\n`required` param) keeps its defensive `typeof`/`.trim()` narrowing. The wire\noutput is byte-identical to the equivalent hand-written entry (drift/emission\nunaffected); this is purely an author-side type gain.\n\n@example\n```ts\nimport { SkillBase, defineSkillTool, FunctionResult, type SkillToolDefinition } from '@signalwire/sdk';\n\nclass WikiSkill extends SkillBase {\n static override SKILL_NAME = 'wiki';\n static override SKILL_DESCRIPTION = 'Search Wikipedia.';\n\n override getTools(): SkillToolDefinition[] {\n return [\n defineSkillTool({\n name: 'search_wiki',\n description: 'Search Wikipedia for a topic',\n parameters: { query: { type: 'string', description: 'The search term' } },\n required: ['query'],\n handler: async (args) => {\n // args.query is `string` (required) — no cast needed\n if (!args.query.trim()) return new FunctionResult('Provide a query.');\n return new FunctionResult(await this.searchWiki(args.query.trim()));\n },\n }),\n ];\n }\n\n private async searchWiki(query: string): Promise<string> {\n return `results for ${query}`;\n }\n}\n```","file":"dist/skills/SkillBase.d.ts","line":99},"dialogueTurns":{"name":"dialogueTurns","kind":"function","exported":true,"signature":["function dialogueTurns(callLog: unknown, opts?: {\n roles?: readonly string[];\n dropEcho?: string | null;\n}): DialogueTurn[]"],"doc":"The real dialogue from a call log: turns in `roles` with content, dropping\nentries that carry `tool_calls`.\n\n`dropEcho` is for one engine behavior: the chat engine appends its own\npost-prompt output to `call_log` as a bare `role: assistant` turn with no\n`tool_calls`, indistinguishable from real speech by role. It's identifiable\nonly by content (identical to `post_prompt_data.raw`), which is what this\ncompares against. The voice engine sends the same thing as a\n`summarize_conversation` tool call, which the `tool_calls` check removes.\n\n@param callLog - The log (`call_log`, `raw_call_log` or `raw_messages`).\n@param opts - `roles` to keep (default {@link DIALOGUE_ROLES}); `dropEcho`,\n exact content to treat as the summary echo and drop.\n@returns The turns, in order.","file":"dist/PostPrompt.d.ts","line":94},"filterSensitiveHeaders":{"name":"filterSensitiveHeaders","kind":"function","exported":true,"signature":["function filterSensitiveHeaders(headers: Record<string, string>): Record<string, string>"],"doc":"Return a copy of `headers` with sensitive entries (authorization, cookie, etc.) removed.\n@param headers - Original header record.\n@returns A new record with sensitive headers removed.","file":"dist/SecurityUtils.d.ts","line":22},"getAllowedEnvPrefixes":{"name":"getAllowedEnvPrefixes","kind":"function","exported":true,"signature":["function getAllowedEnvPrefixes(): string[]"],"doc":"Get the current global allowed env var prefixes.\n@returns A copy of the current prefix list.","file":"dist/DataMap.d.ts","line":28},"getExecutionMode":{"name":"getExecutionMode","kind":"function","exported":true,"signature":["function getExecutionMode(): string"],"doc":"Detect the execution environment, matching the Python SDK's `get_execution_mode()`.\n@returns the environment name: 'cgi' | 'lambda' | 'google_cloud_function' |\n 'azure_function' | 'server'.","file":"dist/Logger.d.ts","line":33},"getLogger":{"name":"getLogger","kind":"function","exported":true,"signature":["function getLogger(name: string): Logger"],"doc":"Create or retrieve a cached Logger instance with the given name.\n@param name - Logger name shown in log output.\n@returns A Logger instance (cached by name).","file":"dist/Logger.d.ts","line":137},"hasCapability":{"name":"hasCapability","kind":"function","exported":true,"signature":["function hasCapability(bodyParams: unknown, name: string): boolean"],"doc":"Whether the client declared `name` as truthy.\n@param bodyParams - A SWML request body, or a user variables object.\n@param name - Capability name, e.g. `display_content`.\n@returns True only when explicitly declared truthy.","file":"dist/capabilities.d.ts","line":64},"inferSchema":{"name":"inferSchema","kind":"function","exported":true,"signature":["function inferSchema(fn: IntrospectableFn): InferredSchema | null"],"doc":"Infer a JSON Schema from a function's parameters.\n\nExtracts parameter names and infers JSON Schema types from default-value\nliterals:\n\n- Number literals → `\"integer\"` (whole numbers) or `\"number\"` (decimals)\n- String literals → `\"string\"`\n- Boolean literals → `\"boolean\"`\n- No default → `\"string\"` (and the parameter is marked required)\n\n@param fn - The function to inspect. Arrow functions, regular functions, and\n method shorthand all work. Typed as {@link IntrospectableFn} because only\n the parameter list is read — the handler's return is irrelevant to schema\n inference (a {@link TypedToolHandler} satisfies this).\n@returns An {@link InferredSchema} describing the parameters, or `null` when\n the function looks like an old-style `(args, rawData)` SWAIG handler (in\n which case no inference is attempted).","file":"dist/TypeInference.d.ts","line":91},"isCallStateTerminal":{"name":"isCallStateTerminal","kind":"function","exported":true,"signature":["function isCallStateTerminal(state: CallState | string): boolean"],"doc":"True when `state` is a terminal {@link CallState} — i.e. the call has reached\n`ended` and will emit no further state transitions. Accepts any string (the\nvalue off the wire), so it is safe to call on a raw `call_state` field — a\nwire-reading predicate widens its *parameter*, never the stored field.\n\n@param state - A call state (typed {@link CallState} or any wire string).\n@returns `true` iff `state === 'ended'`.","file":"dist/relay/closedSets.d.ts","line":91},"isDialStateTerminal":{"name":"isDialStateTerminal","kind":"function","exported":true,"signature":["function isDialStateTerminal(state: DialState | string): boolean"],"doc":"True when `state` is a terminal {@link DialState} — i.e. the outbound dial\nhas resolved (`answered` or `failed`) and will emit no further dial\nprogress. Accepts any string (the value off the wire).\n\n@param state - A dial state (typed {@link DialState} or any wire string).\n@returns `true` iff `state` is `answered` or `failed`.","file":"dist/relay/closedSets.d.ts","line":100},"isMessageStateTerminal":{"name":"isMessageStateTerminal","kind":"function","exported":true,"signature":["function isMessageStateTerminal(state: MessageState | string): boolean"],"doc":"True when `state` is a terminal {@link MessageState} — i.e. the message has\nreached a final delivery outcome (`delivered`, `undelivered`, or `failed`)\nand will emit no further `messaging.state` events. Accepts any string (the\nvalue off the wire), matching the runtime `MESSAGE_TERMINAL_STATES` check in\n{@link ../relay/Message.Message}.\n\n@param state - A message state (typed {@link MessageState} or any wire string).\n@returns `true` iff `state` is `delivered`, `undelivered`, or `failed`.","file":"dist/relay/closedSets.d.ts","line":111},"isServerlessMode":{"name":"isServerlessMode","kind":"function","exported":true,"signature":["function isServerlessMode(): boolean"],"doc":"Whether the current process is running in a serverless environment\n(anything other than a long-lived ``server`` runtime).\n\nPython equivalent: ``signalwire.utils.is_serverless_mode``.","file":"dist/SecurityUtils.d.ts","line":100},"listSkills":{"name":"listSkills","kind":"function","exported":true,"signature":["function listSkills(): _SkillSchemaInfo[]"],"doc":"List metadata for all registered skills.\n\nEquivalent to Python's `list_skills()` — proxies to the singleton\n{@link SkillRegistry}. Python's version returns a plain dict keyed by\nskill name; this returns an array of {@link _SkillSchemaInfo} entries\n(the TS shape is richer and includes the name field).\n\n@returns Array of skill metadata entries.","file":"dist/index.d.ts","line":178},"listSkillsWithParams":{"name":"listSkillsWithParams","kind":"function","exported":true,"signature":["function listSkillsWithParams(): Record<string, _SkillSchemaInfo>"],"doc":"Get full schema for all registered skills, including parameter metadata.\n\nEquivalent to Python's `list_skills_with_params()`. Useful for GUI\nconfiguration tools, API documentation, and programmatic skill discovery.\n\n@returns Map of skill name to {@link _SkillSchemaInfo | schema info}.","file":"dist/index.d.ts","line":187},"livewire":{"name":"livewire","kind":"namespace","exported":true,"signature":["namespace livewire"],"doc":"LiveWire: LiveKit-compatible agents powered by SignalWire.\n\nProvides the same class and function names as @livekit/agents-js, so\ndevelopers can change their import path and run on SignalWire. SignalWire's\ncontrol plane runs STT, TTS, VAD, LLM orchestration and call control. The\npipeline options LiveWire ignores are accepted, and each logs a message\nonce, so existing code keeps compiling.","file":"dist/livewire/index.d.ts","line":1,"contents":["livewire.tool","livewire.handoff","livewire.defineAgent","livewire.runApp","livewire.tips","livewire.NoopTracker","livewire.globalNoop","livewire.VoiceOptions","livewire.FunctionTool","livewire.Agent","livewire.RunContext","livewire.AgentSession","livewire.AgentHandoff","livewire.StopResponse","livewire.ToolError","livewire.JobProcess","livewire.Room","livewire.JobContext","livewire.AgentDefinition","livewire.WorkerOptions","livewire.ServerOptions","livewire.AgentServer","livewire.plugins","livewire.inference","livewire.voice","livewire.ChatContext","livewire.llm","livewire.cli","livewire.printBanner","livewire.printTip","livewire.banner"]},"livewire.Agent":{"name":"livewire.Agent","kind":"class","exported":true,"signature":["class Agent<UserData = unknown>"],"doc":"Mirrors a LiveKit `voice.Agent`, and holds instructions and tool definitions.\n\nThe `stt`, `tts`, `vad`, `turnDetection` and `mcpServers` options are accepted\nfor API compatibility and ignored, because SignalWire's control plane runs the\nAI pipeline. Each one logs a message once. `llm` sets the model, and\n`allowInterruptions` and the endpointing delays map to AI params when\n{@link AgentSession.start} builds the agent.\n\n`tools` takes an object keyed by tool name, as LiveKit agents-js does, or\nan array of tools that each have a `name`, as the Python SDK does.\n\n@example Minimal LiveKit-compatible agent\n```ts\nimport { livewire } from '@signalwire/sdk';\n\nconst timeTool = livewire.tool({\n description: 'Return the current time.',\n execute: () => new Date().toISOString(),\n});\n\nconst agent = new livewire.Agent({\n instructions: 'You are a friendly helper.',\n tools: { time: timeTool },\n});\n\nconst session = new livewire.AgentSession();\nawait session.start({ agent });\n```","file":"dist/livewire/index.d.ts","line":92,"members":[{"name":"instructions","kind":"property","owner":"livewire.Agent","signature":["instructions: string"],"doc":"System instructions passed through to the SignalWire AI prompt.","file":"dist/livewire/index.d.ts","line":94},{"name":"tools","kind":"property","owner":"livewire.Agent","signature":["tools: Record<string, FunctionTool>"],"doc":"Registered tools keyed by name. Mutated by {@link updateTools}.","file":"dist/livewire/index.d.ts","line":96},{"name":"userData","kind":"property","owner":"livewire.Agent","signature":["userData?: UserData"],"doc":"Arbitrary per-session user data passed to tool handlers via {@link RunContext.userData}.","file":"dist/livewire/index.d.ts","line":98},{"name":"constructor","kind":"constructor","owner":"livewire.Agent","signature":["constructor(options?: {\n instructions?: string;\n tools?: FunctionTool[] | Record<string, FunctionTool>;\n userData?: UserData;\n chatCtx?: unknown;\n stt?: unknown;\n tts?: unknown;\n llm?: unknown;\n vad?: unknown;\n turnDetection?: unknown;\n mcpServers?: unknown;\n allowInterruptions?: boolean;\n minEndpointingDelay?: number;\n maxEndpointingDelay?: number;\n})"],"doc":"","file":"dist/livewire/index.d.ts","line":108},{"name":"session","kind":"accessor","owner":"livewire.Agent","signature":["get session(): AgentSession<UserData> | undefined","set session(value: AgentSession<UserData> | undefined)"],"doc":"The currently-bound {@link AgentSession}, or `undefined` until {@link AgentSession.start} is called.","file":"dist/livewire/index.d.ts","line":124},{"name":"onEnter","kind":"method","owner":"livewire.Agent","signature":["onEnter(): Promise<void>"],"doc":"LiveKit lifecycle hook, kept for API compatibility. LiveWire doesn't call\nit, so an override doesn't run. The default does nothing.","file":"dist/livewire/index.d.ts","line":130},{"name":"onExit","kind":"method","owner":"livewire.Agent","signature":["onExit(): Promise<void>"],"doc":"LiveKit lifecycle hook, kept for API compatibility. LiveWire doesn't call\nit, so an override doesn't run. The default does nothing.","file":"dist/livewire/index.d.ts","line":135},{"name":"onUserTurnCompleted","kind":"method","owner":"livewire.Agent","signature":["onUserTurnCompleted(_turnCtx?: unknown, _newMessage?: unknown): Promise<void>"],"doc":"LiveKit lifecycle hook, kept for API compatibility. LiveWire doesn't call\nit, so an override doesn't run. The default does nothing.\n\n@param _turnCtx - Turn context (LiveKit shape; passed through opaquely).\n@param _newMessage - Newly-captured user message.","file":"dist/livewire/index.d.ts","line":143},{"name":"sttNode","kind":"method","owner":"livewire.Agent","signature":["sttNode(_audio?: unknown, _modelSettings?: unknown): Promise<void>"],"doc":"LiveKit-compatible STT node. Does nothing on SignalWire, where the control\nplane handles speech recognition. Logs a message once.\n\n@param _audio - Audio input (ignored).\n@param _modelSettings - Model settings (ignored).","file":"dist/livewire/index.d.ts","line":151},{"name":"llmNode","kind":"method","owner":"livewire.Agent","signature":["llmNode(_chatCtx?: unknown, _tools?: unknown, _modelSettings?: unknown): Promise<void>"],"doc":"LiveKit-compatible LLM node. Does nothing on SignalWire, where the control\nplane handles LLM inference. Logs a message once.\n\n@param _chatCtx - Chat context (ignored).\n@param _tools - Tool list (ignored).\n@param _modelSettings - Model settings (ignored).","file":"dist/livewire/index.d.ts","line":160},{"name":"ttsNode","kind":"method","owner":"livewire.Agent","signature":["ttsNode(_text?: unknown, _modelSettings?: unknown): Promise<void>"],"doc":"LiveKit-compatible TTS node. Does nothing on SignalWire, where the control\nplane handles text-to-speech. Logs a message once.\n\n@param _text - Text to synthesise (ignored).\n@param _modelSettings - Model settings (ignored).","file":"dist/livewire/index.d.ts","line":168},{"name":"updateInstructions","kind":"method","owner":"livewire.Agent","signature":["updateInstructions(instructions: string): Promise<void>"],"doc":"Replace the agent's instructions.\n\nThis changes the `Agent` object only. A session that has already started\nkeeps the prompt it built; {@link AgentSession.updateAgent} replaces that\nprompt.\n\n@param instructions - New system-instructions string for the agent.","file":"dist/livewire/index.d.ts","line":178},{"name":"updateTools","kind":"method","owner":"livewire.Agent","signature":["updateTools(tools: FunctionTool[] | Record<string, FunctionTool>): Promise<void>"],"doc":"Replace the agent's tool list.\n\nReplaces the current tool record with one built from the given tools.\nThis changes the `Agent` object only: tools are registered when\n{@link AgentSession.start} runs, so a session that has already started\nkeeps its tools.\n\n@param tools - An array of {@link FunctionTool} definitions, each keyed\n by its `name`, or an object keyed by tool name (the LiveKit agents-js\n shape), whose keys become the tool names.","file":"dist/livewire/index.d.ts","line":191}]},"livewire.AgentDefinition":{"name":"livewire.AgentDefinition","kind":"interface","exported":true,"signature":["interface AgentDefinition"],"doc":"A LiveKit-compatible agent definition: a required `entry` callback and an\noptional `prewarm` hook. The `prewarm` return value is ignored.","file":"dist/livewire/index.d.ts","line":480,"members":[{"name":"entry","kind":"property","owner":"livewire.AgentDefinition","signature":["entry: (ctx: JobContext) => Promise<void>"],"doc":"Main callback invoked with a {@link JobContext} when the agent runs.","file":"dist/livewire/index.d.ts","line":482},{"name":"prewarm","kind":"property","owner":"livewire.AgentDefinition","signature":["prewarm?: (proc: JobProcess) => unknown"],"doc":"Optional prewarm callback invoked with a {@link JobProcess} before `entry`.","file":"dist/livewire/index.d.ts","line":484}]},"livewire.AgentHandoff":{"name":"livewire.AgentHandoff","kind":"class","exported":true,"signature":["class AgentHandoff"],"doc":"A handoff to another agent. LiveWire doesn't act on it; see {@link handoff}.","file":"dist/livewire/index.d.ts","line":391,"members":[{"name":"agent","kind":"property","owner":"livewire.AgentHandoff","signature":["agent: Agent"],"doc":"Target agent that should take over the conversation.","file":"dist/livewire/index.d.ts","line":393},{"name":"returns","kind":"property","owner":"livewire.AgentHandoff","signature":["returns?: string"],"doc":"Optional return value surfaced when the handoff completes.","file":"dist/livewire/index.d.ts","line":395}]},"livewire.AgentServer":{"name":"livewire.AgentServer","kind":"class","exported":true,"signature":["class AgentServer"],"doc":"Mirrors a LiveKit AgentServer: registers an entry function for\n{@link runApp}.\n\nUsage:\n const server = new AgentServer();\n server.setupFnc = async (proc) => { ... };\n\n // Bare decorator usage:\n server.rtcSession(myEntryFn);\n\n // Parameterized decorator usage:\n server.rtcSession({ agentName: 'myAgent' })(myEntryFn);\n\n cli.runApp(server);","file":"dist/livewire/index.d.ts","line":564,"members":[{"name":"setupFnc","kind":"property","owner":"livewire.AgentServer","signature":["setupFnc?: (proc: JobProcess) => void"],"doc":"Optional prewarm hook, called before the entry function. Mirrors Python's `setup_fnc`.","file":"dist/livewire/index.d.ts","line":566},{"name":"constructor","kind":"constructor","owner":"livewire.AgentServer","signature":["constructor(_opts?: unknown)"],"doc":"","file":"dist/livewire/index.d.ts","line":571},{"name":"rtcSession","kind":"method","owner":"livewire.AgentServer","signature":["rtcSession(fnOrOpts?: ((ctx: JobContext) => Promise<void>) | {\n agentName?: string;\n type?: string;\n onRequest?: ((...args: unknown[]) => unknown) | null;\n onSessionEnd?: ((...args: unknown[]) => unknown) | null;\n}, opts?: {\n agentName?: string;\n type?: string;\n onRequest?: ((...args: unknown[]) => unknown) | null;\n onSessionEnd?: ((...args: unknown[]) => unknown) | null;\n}): ((fn: (ctx: JobContext) => Promise<void>) => (ctx: JobContext) => Promise<void>) | void"],"doc":"Decorator that registers the session entrypoint.\n\nSupports both bare and parameterized usage:\n server.rtcSession(fn) // bare\n server.rtcSession(fn, { agentName: 'x' }) // with opts, explicit fn\n server.rtcSession({ agentName: 'x' })(fn) // parameterized decorator\n @server.rtcSession // decorator (bare)\n @server.rtcSession({ agentName: 'x' }) // decorator (parameterized)","file":"dist/livewire/index.d.ts","line":582}]},"livewire.AgentSession":{"name":"livewire.AgentSession","kind":"class","exported":true,"signature":["class AgentSession<UserData = unknown>"],"doc":"Mirrors a LiveKit `AgentSession`, and binds an {@link Agent} to SignalWire.\n\nCall {@link AgentSession.start} with an `Agent` to build an internal\n{@link AgentBase}. The `stt`, `tts`, `vad`, `turnDetection` and `mcpServers`\noptions are accepted for API compatibility and ignored; each logs a message\nonce. `llm`, `allowInterruptions` and the endpointing delays map to AI\nparams. `minInterruptionDuration` and `preemptiveGeneration` are stored and\nnot used.","file":"dist/livewire/index.d.ts","line":231,"members":[{"name":"constructor","kind":"constructor","owner":"livewire.AgentSession","signature":["constructor(options?: {\n stt?: unknown;\n tts?: unknown;\n llm?: unknown;\n vad?: unknown;\n turnDetection?: unknown;\n tools?: FunctionTool[] | Record<string, FunctionTool>;\n mcpServers?: unknown;\n userData?: UserData;\n allowInterruptions?: boolean;\n minInterruptionDuration?: number;\n minEndpointingDelay?: number;\n maxEndpointingDelay?: number;\n maxToolSteps?: number;\n preemptiveGeneration?: boolean;\n})"],"doc":"","file":"dist/livewire/index.d.ts","line":246},{"name":"start","kind":"method","owner":"livewire.AgentSession","signature":["start(params: {\n agent: Agent<UserData>;\n room?: unknown;\n record?: boolean;\n}): Promise<void>"],"doc":"Start the session by binding the agent to a new {@link AgentBase}, and map\nLiveKit-style options onto SignalWire AI params.\n\nThe `AgentBase` gets the agent's instructions as its prompt, and a tool for\neach entry in the agent's and the session's tool lists. The `llm` value,\na model name or an LLM plugin object such as `plugins.OpenAILLM` whose\n`model` is used, sets the `model` param, with any `provider/` prefix\nremoved.\n`allowInterruptions: false` sets the `enable_barge` param to `false`, which\nturns barge-in off. The minimum and\nmaximum endpointing delays, in seconds, set `end_of_speech_timeout` and\n`attention_timeout` in milliseconds. Text queued with {@link say} becomes\nan \"Initial Greeting\" prompt section.\n\nThis method doesn't start an HTTP server. Called from an entry function\nthat {@link runApp} runs, it hands the built `AgentBase` to that job, and\n`runApp()` serves it once the entry function returns. {@link getSwAgent}\nreturns the built `AgentBase`.\n\n@param params - Start parameters.\n@param params.agent - The {@link Agent} to bind.\n@param params.room - LiveKit room placeholder; ignored on SignalWire.\n@param params.record - Call-recording flag placeholder; ignored on SignalWire.\n@returns Resolves once the underlying `AgentBase` has been built.","file":"dist/livewire/index.d.ts","line":288},{"name":"say","kind":"method","owner":"livewire.AgentSession","signature":["say(text: string): void"],"doc":"Add text to the agent's prompt, for the model to use in what it says.\n\nThe text isn't spoken verbatim. Before {@link start}, it's queued and added\nas an \"Initial Greeting\" prompt section at start time. After start, it's\nadded as a \"Say\" prompt section.\n\n@param text - Text to add to the prompt.","file":"dist/livewire/index.d.ts","line":302},{"name":"generateReply","kind":"method","owner":"livewire.AgentSession","signature":["generateReply(options?: {\n instructions?: string;\n}): void"],"doc":"Add instructions for the agent's reply to its prompt.\n\nAfter {@link start}, `options.instructions` is added as an \"Initial\nGreeting\" prompt section. Before start, or without instructions, the call\ndoes nothing. It doesn't make the agent speak by itself.\n\n@param options - Generation options.\n@param options.instructions - Instructions added as a prompt section.","file":"dist/livewire/index.d.ts","line":313},{"name":"interrupt","kind":"method","owner":"livewire.AgentSession","signature":["interrupt(): void"],"doc":"Interrupt current speech. Does nothing on SignalWire, where the control\nplane handles barge-in. Logs a message once.","file":"dist/livewire/index.d.ts","line":320},{"name":"updateAgent","kind":"method","owner":"livewire.AgentSession","signature":["updateAgent(agent: Agent<UserData>): void"],"doc":"Swap the {@link Agent} bound to this session.\n\nKeeps the underlying `AgentBase` and replaces its prompt with the new\nagent's instructions. The new agent's tools aren't registered; the tools\nfrom {@link start} stay.\n\n@param agent - Replacement agent.","file":"dist/livewire/index.d.ts","line":330},{"name":"userData","kind":"accessor","owner":"livewire.AgentSession","signature":["get userData(): UserData","set userData(val: UserData)"],"doc":"Current per-session user data. Set by the constructor or via the setter.","file":"dist/livewire/index.d.ts","line":332},{"name":"history","kind":"accessor","owner":"livewire.AgentSession","signature":["get history(): Array<Record<string, string>>"],"doc":"Conversation history, kept for API compatibility. LiveWire doesn't record\nturns, so the array stays empty.","file":"dist/livewire/index.d.ts","line":338},{"name":"getSwAgent","kind":"method","owner":"livewire.AgentSession","signature":["getSwAgent(): AgentBase | undefined"],"doc":"Return the underlying SignalWire {@link AgentBase}, for tests and for code\nthat needs the full SignalWire API.\n\n@returns The wrapped `AgentBase`, or `undefined` before {@link start}.","file":"dist/livewire/index.d.ts","line":345}]},"livewire.ChatContext":{"name":"livewire.ChatContext","kind":"class","exported":true,"signature":["class ChatContext"],"doc":"Minimal `ChatContext` matching LiveKit's `ChatContext`.","file":"dist/livewire/index.d.ts","line":699,"members":[{"name":"messages","kind":"property","owner":"livewire.ChatContext","signature":["messages: Array<Record<string, string>>"],"doc":"Ordered chat messages, each `{ role, content }`.","file":"dist/livewire/index.d.ts","line":701},{"name":"append","kind":"method","owner":"livewire.ChatContext","signature":["append(options: {\n role?: string;\n text?: string;\n}): this"],"doc":"Append a chat message.\n\n@param options - Message content.\n@param options.role - Speaker role (`\"user\"`, `\"assistant\"`, or `\"system\"`).\n Defaults to `\"user\"`.\n@param options.text - Message text. Defaults to `\"\"`.\n@returns This instance for chaining.","file":"dist/livewire/index.d.ts","line":711}]},"livewire.FunctionTool":{"name":"livewire.FunctionTool","kind":"interface","exported":true,"signature":["interface FunctionTool"],"doc":"A tool definition that can be registered on an {@link Agent}.","file":"dist/livewire/index.d.ts","line":50,"members":[{"name":"name","kind":"property","owner":"livewire.FunctionTool","signature":["name: string"],"doc":"Tool name. Set from the key when the tool is passed in a name-keyed `tools` object.","file":"dist/livewire/index.d.ts","line":52},{"name":"description","kind":"property","owner":"livewire.FunctionTool","signature":["description: string"],"doc":"Human-readable description shown to the LLM.","file":"dist/livewire/index.d.ts","line":54},{"name":"parameters","kind":"property","owner":"livewire.FunctionTool","signature":["parameters?: Record<string, unknown>"],"doc":"JSON schema (or Zod schema passthrough) for the tool's parameters.","file":"dist/livewire/index.d.ts","line":56},{"name":"execute","kind":"property","owner":"livewire.FunctionTool","signature":["execute: (params: unknown, context: {\n ctx: RunContext;\n}) => unknown"],"doc":"Handler invoked by the platform when the LLM calls this tool.","file":"dist/livewire/index.d.ts","line":58}]},"livewire.JobContext":{"name":"livewire.JobContext","kind":"class","exported":true,"signature":["class JobContext"],"doc":"Mirrors a LiveKit `JobContext`, passed to the entry function that\n{@link runApp} calls.","file":"dist/livewire/index.d.ts","line":443,"members":[{"name":"room","kind":"property","owner":"livewire.JobContext","signature":["room: Room"],"doc":"Placeholder {@link Room} (see class docs).","file":"dist/livewire/index.d.ts","line":445},{"name":"proc","kind":"property","owner":"livewire.JobContext","signature":["proc: JobProcess"],"doc":"A {@link JobProcess}. `runApp()` creates it separately from the one passed to prewarm.","file":"dist/livewire/index.d.ts","line":447},{"name":"constructor","kind":"constructor","owner":"livewire.JobContext","signature":["constructor()"],"doc":"","file":"dist/livewire/index.d.ts","line":453},{"name":"connect","kind":"method","owner":"livewire.JobContext","signature":["connect(): Promise<void>"],"doc":"Connect to the platform. Does nothing on SignalWire, where the platform\nconnects when it requests the agent's SWML. Logs a message once.\n\n@returns Resolves immediately.","file":"dist/livewire/index.d.ts","line":460},{"name":"waitForParticipant","kind":"method","owner":"livewire.JobContext","signature":["waitForParticipant(options?: {\n identity?: string;\n}): Promise<{\n identity: string;\n}>"],"doc":"Wait for a participant to join. On SignalWire it returns a stub\nparticipant at once.\n\n@param options - Participant match options.\n@param options.identity - Requested identity; echoed back in the stub.\n Defaults to `\"caller\"`.\n@returns A stub participant `{ identity }` record.","file":"dist/livewire/index.d.ts","line":470}]},"livewire.JobProcess":{"name":"livewire.JobProcess","kind":"class","exported":true,"signature":["class JobProcess"],"doc":"Mirrors a LiveKit `JobProcess`, passed to the prewarm hook.\n\nSignalWire has no worker processes to prewarm, so this class holds only\nthe LiveKit-compatible `userData` object.","file":"dist/livewire/index.d.ts","line":425,"members":[{"name":"userData","kind":"property","owner":"livewire.JobProcess","signature":["userData: Record<string, unknown>"],"doc":"Mutable object for data passed between callbacks.","file":"dist/livewire/index.d.ts","line":427}]},"livewire.NoopTracker":{"name":"livewire.NoopTracker","kind":"class","exported":true,"signature":["class NoopTracker"],"doc":"NoopTracker ensures each informational message is logged at most once,\npreventing spam when the same noop path is exercised repeatedly.","file":"dist/livewire/index.d.ts","line":24,"members":[{"name":"once","kind":"method","owner":"livewire.NoopTracker","signature":["once(key: string, message: string): void"],"doc":"Log the given message the first time this key is seen.\n\n@param key - Dedup key. Subsequent calls with the same key are silent.\n@param message - Message to write to stderr on first occurrence.","file":"dist/livewire/index.d.ts","line":32},{"name":"hasLogged","kind":"method","owner":"livewire.NoopTracker","signature":["hasLogged(key: string): boolean"],"doc":"Expose whether a key has been logged (for testing).","file":"dist/livewire/index.d.ts","line":34},{"name":"reset","kind":"method","owner":"livewire.NoopTracker","signature":["reset(): void"],"doc":"Reset all tracked keys (for testing).","file":"dist/livewire/index.d.ts","line":36}]},"livewire.Room":{"name":"livewire.Room","kind":"class","exported":true,"signature":["class Room"],"doc":"Stub `Room`. SignalWire doesn't use the LiveKit room abstraction.\n\nIt exists for API compatibility, so LiveKit-shaped code compiles. Its only\nattribute is a constant name.","file":"dist/livewire/index.d.ts","line":435,"members":[{"name":"name","kind":"property","owner":"livewire.Room","readonly":true,"signature":["readonly name: string"],"doc":"Always `\"livewire-room\"`; SignalWire has no per-call room identity.","file":"dist/livewire/index.d.ts","line":437}]},"livewire.RunContext":{"name":"livewire.RunContext","kind":"class","exported":true,"signature":["class RunContext<UserData = unknown>"],"doc":"Mirrors a LiveKit `RunContext`. Tool handlers receive one as `context.ctx`,\nand read the session and its user data from it.","file":"dist/livewire/index.d.ts","line":197,"members":[{"name":"session","kind":"property","owner":"livewire.RunContext","signature":["session?: AgentSession<UserData>"],"doc":"The owning {@link AgentSession}, when one is bound.","file":"dist/livewire/index.d.ts","line":199},{"name":"speechHandle","kind":"property","owner":"livewire.RunContext","signature":["speechHandle?: unknown"],"doc":"Opaque speech-turn handle (LiveKit shape; passed through untouched).","file":"dist/livewire/index.d.ts","line":201},{"name":"functionCall","kind":"property","owner":"livewire.RunContext","signature":["functionCall?: unknown"],"doc":"Opaque function-call descriptor (LiveKit shape; passed through untouched).","file":"dist/livewire/index.d.ts","line":203},{"name":"constructor","kind":"constructor","owner":"livewire.RunContext","signature":["constructor(session?: AgentSession<UserData>, options?: {\n speechHandle?: unknown;\n functionCall?: unknown;\n})"],"doc":"@param session - Owning session, when available.\n@param options - Optional pass-through values.\n@param options.speechHandle - Opaque LiveKit speech handle.\n@param options.functionCall - Opaque LiveKit function-call descriptor.","file":"dist/livewire/index.d.ts","line":210},{"name":"userData","kind":"accessor","owner":"livewire.RunContext","signature":["get userData(): UserData"],"doc":"Per-session user data, or an empty object when no session is bound.\n\n@returns The {@link AgentSession.userData} payload cast to `UserData`.","file":"dist/livewire/index.d.ts","line":219}]},"livewire.ServerOptions":{"name":"livewire.ServerOptions","kind":"class","exported":true,"signature":["class ServerOptions"],"doc":"Stub class mirroring LiveKit's `ServerOptions`.\n\nAccepts any configuration, for source compatibility with LiveKit code.\nSignalWire ignores these settings.","file":"dist/livewire/index.d.ts","line":544,"members":[{"name":"constructor","kind":"constructor","owner":"livewire.ServerOptions","signature":["constructor(_opts?: unknown)"],"doc":"@param _opts - LiveKit-shaped server options (ignored).","file":"dist/livewire/index.d.ts","line":546}]},"livewire.StopResponse":{"name":"livewire.StopResponse","kind":"class","exported":true,"signature":["class StopResponse extends Error"],"doc":"LiveKit's signal that a tool shouldn't trigger another LLM reply. LiveWire\ndoesn't handle it specially: a tool that throws it gets the SDK's generic\ntool error response, like any other exception.","file":"dist/livewire/index.d.ts","line":402,"members":[{"name":"constructor","kind":"constructor","owner":"livewire.StopResponse","signature":["constructor(message?: string)"],"doc":"@param message - Optional error message. Defaults to `\"StopResponse\"`.","file":"dist/livewire/index.d.ts","line":406}],"bases":["Error"]},"livewire.ToolError":{"name":"livewire.ToolError","kind":"class","exported":true,"signature":["class ToolError extends Error"],"doc":"LiveKit's error for a failed tool. LiveWire doesn't handle it specially: a\ntool that throws it gets the SDK's generic tool error response, and the\nmessage isn't sent to the model.","file":"dist/livewire/index.d.ts","line":413,"members":[{"name":"constructor","kind":"constructor","owner":"livewire.ToolError","signature":["constructor(message: string)"],"doc":"@param message - Error message (logged; not sent to the model).","file":"dist/livewire/index.d.ts","line":417}],"bases":["Error"]},"livewire.VoiceOptions":{"name":"livewire.VoiceOptions","kind":"interface","exported":true,"signature":["interface VoiceOptions"],"doc":"Voice configuration options passed through to the SignalWire AI config.","file":"dist/livewire/index.d.ts","line":41,"members":[{"name":"voice","kind":"property","owner":"livewire.VoiceOptions","signature":["voice: string"],"doc":"TTS voice identifier (e.g. `\"en-US-Standard-A\"`).","file":"dist/livewire/index.d.ts","line":43},{"name":"engine","kind":"property","owner":"livewire.VoiceOptions","signature":["engine: string"],"doc":"TTS engine identifier (e.g. `\"google\"`, `\"elevenlabs\"`).","file":"dist/livewire/index.d.ts","line":45},{"name":"language","kind":"property","owner":"livewire.VoiceOptions","signature":["language: string"],"doc":"BCP-47 language code (e.g. `\"en-US\"`).","file":"dist/livewire/index.d.ts","line":47}]},"livewire.WorkerOptions":{"name":"livewire.WorkerOptions","kind":"class","exported":true,"signature":["class WorkerOptions"],"doc":"Stub class mirroring LiveKit's `WorkerOptions`.\n\nAccepts any configuration, for source compatibility with LiveKit code.\nSignalWire ignores these settings.","file":"dist/livewire/index.d.ts","line":534,"members":[{"name":"constructor","kind":"constructor","owner":"livewire.WorkerOptions","signature":["constructor(_opts?: unknown)"],"doc":"@param _opts - LiveKit-shaped worker options (ignored).","file":"dist/livewire/index.d.ts","line":536}]},"livewire.banner":{"name":"livewire.banner","kind":"variable","exported":true,"signature":["const banner"],"doc":"","file":"dist/livewire/index.d.ts","line":11},"livewire.cli":{"name":"livewire.cli","kind":"variable","exported":true,"signature":["const cli: {\n runApp: typeof runApp;\n}"],"doc":"LiveKit cli namespace equivalent.","file":"dist/livewire/index.d.ts","line":724},"livewire.defineAgent":{"name":"livewire.defineAgent","kind":"function","exported":true,"signature":["function defineAgent(agent: AgentDefinition): AgentDefinition"],"doc":"Mirrors `@livekit/agents.defineAgent()`.\n\nPackages an entry function, and an optional prewarm hook, for\n{@link runApp}. It returns its argument unchanged.\n\n@param agent - Entry and (optional) prewarm functions.\n@param agent.entry - Main callback invoked with a {@link JobContext} when\n the agent runs.\n@param agent.prewarm - Optional prewarm callback invoked with a\n {@link JobProcess} before `entry`.\n@returns The same object.","file":"dist/livewire/index.d.ts","line":499},"livewire.globalNoop":{"name":"livewire.globalNoop","kind":"variable","exported":true,"signature":["const globalNoop: NoopTracker"],"doc":"","file":"dist/livewire/index.d.ts","line":38},"livewire.handoff":{"name":"livewire.handoff","kind":"function","exported":true,"signature":["function handoff(options: {\n agent: Agent;\n returns?: string;\n}): AgentHandoff"],"doc":"Create an {@link AgentHandoff} descriptor, for LiveKit API compatibility.\n\nLiveWire doesn't act on a returned descriptor: the session keeps its agent.\nTo switch agents, call {@link AgentSession.updateAgent}.\n\n@param options - Handoff parameters.\n@param options.agent - Agent to transfer control to.\n@param options.returns - Optional string returned to the current agent when\n the handoff completes.\n@returns A handoff descriptor that can be returned from a tool handler.","file":"dist/livewire/index.d.ts","line":386},"livewire.inference":{"name":"livewire.inference","kind":"namespace","exported":true,"signature":["namespace livewire.inference"],"doc":"","file":"dist/livewire/index.d.ts","line":657,"contents":["livewire.inference.STT","livewire.inference.LLM","livewire.inference.TTS"]},"livewire.inference.LLM":{"name":"livewire.inference.LLM","kind":"class","exported":true,"signature":["class LLM"],"doc":"LiveKit inference-LLM stub. Captures the model name; runs no inference\nlocally. Passed as the `llm` option, it sets the `model` AI param.","file":"dist/livewire/index.d.ts","line":672,"members":[{"name":"model","kind":"property","owner":"livewire.inference.LLM","signature":["model: string"],"doc":"Model identifier captured from the constructor.","file":"dist/livewire/index.d.ts","line":674},{"name":"constructor","kind":"constructor","owner":"livewire.inference.LLM","signature":["constructor(model?: string, _opts?: unknown)"],"doc":"@param model - Model identifier (captured).\n@param _opts - Additional options (ignored).","file":"dist/livewire/index.d.ts","line":679}]},"livewire.inference.STT":{"name":"livewire.inference.STT","kind":"class","exported":true,"signature":["class STT"],"doc":"LiveKit inference-STT stub. Captures the model name; runs no inference locally.","file":"dist/livewire/index.d.ts","line":659,"members":[{"name":"model","kind":"property","owner":"livewire.inference.STT","signature":["model: string"],"doc":"Model identifier captured from the constructor.","file":"dist/livewire/index.d.ts","line":661},{"name":"constructor","kind":"constructor","owner":"livewire.inference.STT","signature":["constructor(model?: string, _opts?: unknown)"],"doc":"@param model - Model identifier (captured).\n@param _opts - Additional options (ignored).","file":"dist/livewire/index.d.ts","line":666}]},"livewire.inference.TTS":{"name":"livewire.inference.TTS","kind":"class","exported":true,"signature":["class TTS"],"doc":"LiveKit inference-TTS stub. Captures the model name; runs no inference locally.","file":"dist/livewire/index.d.ts","line":682,"members":[{"name":"model","kind":"property","owner":"livewire.inference.TTS","signature":["model: string"],"doc":"Model identifier captured from the constructor.","file":"dist/livewire/index.d.ts","line":684},{"name":"constructor","kind":"constructor","owner":"livewire.inference.TTS","signature":["constructor(model?: string, _opts?: unknown)"],"doc":"@param model - Model identifier (captured).\n@param _opts - Additional options (ignored).","file":"dist/livewire/index.d.ts","line":689}]},"livewire.llm":{"name":"livewire.llm","kind":"variable","exported":true,"signature":["const llm: {\n tool: typeof tool;\n handoff: typeof handoff;\n ToolError: typeof ToolError;\n ChatContext: typeof ChatContext;\n}"],"doc":"LiveKit llm namespace equivalent.","file":"dist/livewire/index.d.ts","line":717},"livewire.plugins":{"name":"livewire.plugins","kind":"namespace","exported":true,"signature":["namespace livewire.plugins"],"doc":"","file":"dist/livewire/index.d.ts","line":606,"contents":["livewire.plugins.DeepgramSTT","livewire.plugins.OpenAILLM","livewire.plugins.CartesiaTTS","livewire.plugins.ElevenLabsTTS","livewire.plugins.SileroVAD"]},"livewire.plugins.CartesiaTTS":{"name":"livewire.plugins.CartesiaTTS","kind":"class","exported":true,"signature":["class CartesiaTTS"],"doc":"LiveKit Cartesia-TTS plugin stub. Does nothing on SignalWire.","file":"dist/livewire/index.d.ts","line":626,"members":[{"name":"constructor","kind":"constructor","owner":"livewire.plugins.CartesiaTTS","signature":["constructor(_opts?: unknown)"],"doc":"@param _opts - Cartesia options (ignored).","file":"dist/livewire/index.d.ts","line":628}]},"livewire.plugins.DeepgramSTT":{"name":"livewire.plugins.DeepgramSTT","kind":"class","exported":true,"signature":["class DeepgramSTT"],"doc":"LiveKit Deepgram-STT plugin stub. Does nothing on SignalWire.","file":"dist/livewire/index.d.ts","line":608,"members":[{"name":"constructor","kind":"constructor","owner":"livewire.plugins.DeepgramSTT","signature":["constructor(_opts?: unknown)"],"doc":"@param _opts - Deepgram options (ignored).","file":"dist/livewire/index.d.ts","line":610}]},"livewire.plugins.ElevenLabsTTS":{"name":"livewire.plugins.ElevenLabsTTS","kind":"class","exported":true,"signature":["class ElevenLabsTTS"],"doc":"LiveKit ElevenLabs-TTS plugin stub. Does nothing on SignalWire.","file":"dist/livewire/index.d.ts","line":631,"members":[{"name":"constructor","kind":"constructor","owner":"livewire.plugins.ElevenLabsTTS","signature":["constructor(_opts?: unknown)"],"doc":"@param _opts - ElevenLabs options (ignored).","file":"dist/livewire/index.d.ts","line":633}]},"livewire.plugins.OpenAILLM":{"name":"livewire.plugins.OpenAILLM","kind":"class","exported":true,"signature":["class OpenAILLM"],"doc":"LiveKit OpenAI-LLM plugin stub.\n\nCaptures the `model` string. Passed as the `llm` option of\n`AgentSession` or `Agent`, it sets the `model` AI param. Other options\nare ignored.","file":"dist/livewire/index.d.ts","line":619,"members":[{"name":"model","kind":"property","owner":"livewire.plugins.OpenAILLM","signature":["model: string"],"doc":"Model identifier captured from the constructor options.","file":"dist/livewire/index.d.ts","line":621},{"name":"constructor","kind":"constructor","owner":"livewire.plugins.OpenAILLM","signature":["constructor(_opts?: unknown)"],"doc":"@param _opts - OpenAI options. `_opts.model` is captured; everything else ignored.","file":"dist/livewire/index.d.ts","line":623}]},"livewire.plugins.SileroVAD":{"name":"livewire.plugins.SileroVAD","kind":"class","exported":true,"signature":["class SileroVAD"],"doc":"LiveKit Silero-VAD plugin stub. Does nothing on SignalWire.","file":"dist/livewire/index.d.ts","line":636,"members":[{"name":"constructor","kind":"constructor","owner":"livewire.plugins.SileroVAD","signature":["constructor(_opts?: Record<string, unknown>)"],"doc":"@param _opts - Silero VAD options (ignored).","file":"dist/livewire/index.d.ts","line":638},{"name":"load","kind":"method","owner":"livewire.plugins.SileroVAD","static":true,"signature":["static load(): SileroVAD"],"doc":"Load a Silero VAD model.\n\nDoes nothing on SignalWire: returns a new stub instance, and logs a\nmessage to stderr once.\n\n@returns A new `SileroVAD` stub.","file":"dist/livewire/index.d.ts","line":647}]},"livewire.printBanner":{"name":"livewire.printBanner","kind":"function","exported":true,"signature":["function printBanner(): void"],"doc":"Print the ASCII banner to stderr, using ANSI cyan when stderr is a TTY.","file":"dist/livewire/index.d.ts","line":13},"livewire.printTip":{"name":"livewire.printTip","kind":"function","exported":true,"signature":["function printTip(): void"],"doc":"","file":"dist/livewire/index.d.ts","line":19},"livewire.runApp":{"name":"livewire.runApp","kind":"function","exported":true,"signature":["function runApp(options: AgentServer | AgentDefinition | ((ctx: JobContext) => unknown) | {\n agent?: AgentDefinition;\n} | undefined): void"],"doc":"Mirrors `cli.runApp()` from `@livekit/agents-js`.\n\nIt takes these steps:\n\n1. Prints the LiveWire banner\n2. Runs the prewarm callback, if any, with a new {@link JobProcess}\n3. Creates a new {@link JobContext}\n4. Prints a random tip\n5. Calls the entry function with the context\n6. When the entry function resolves, serves the `AgentBase` of the last\n {@link AgentSession} the entry function started, by calling its\n `serve()`. The server listens on `PORT` (default 3000), with the route\n `/`, and runs until the process exits.\n\nIt accepts an object `{ entry, prewarm? }`, a bare entry function, or an\n{@link AgentServer} instance. Errors from the entry function are written to\nstderr, as is a message when the entry function starts no session.\n\nWhen `SWAIG_CLI_MODE=true` is set as `runApp()` is called (the `swaig-test`\nCLI sets it while it imports an agent file), the entry function runs and\nnothing is served.\n\n@param options - Agent descriptor, entry function, or `AgentServer`.","file":"dist/livewire/index.d.ts","line":525},"livewire.tips":{"name":"livewire.tips","kind":"variable","exported":true,"signature":["const tips: string[]"],"doc":"\"Did you know?\" tips. `runApp()` prints one, chosen at random, to stderr.\nExported for tests; edit the list to change what's displayed.","file":"dist/livewire/index.d.ts","line":18},"livewire.tool":{"name":"livewire.tool","kind":"function","exported":true,"signature":["function tool<P = unknown>(options: {\n description: string;\n parameters?: unknown;\n execute: (params: P, context: {\n ctx: RunContext;\n }) => unknown;\n}): FunctionTool"],"doc":"Create a tool definition. Mirrors `llm.tool()` from `@livekit/agents-js`.\n\nThe returned tool has an empty `name`. It gets its name from its key when\nyou add it to an agent's `tools` object (see the {@link Agent} example), or\nfrom the `name` you set when you pass `tools` as an array.\n\n`parameters` is stored as given and sent as the tool's SWAIG parameters, so\npass a JSON Schema object. A Zod schema isn't converted to JSON Schema.\n\nThe handler's return value becomes the tool result: a `FunctionResult` as is,\na string as the response text, and any other value as JSON text.\n\n@typeParam P - Parameter type passed into `execute`.\n@param options - Tool configuration.\n@param options.description - Human-readable tool description exposed to the LLM.\n@param options.parameters - JSON Schema object describing the tool's inputs.\n@param options.execute - Handler invoked when the LLM calls the tool.\n@returns A {@link FunctionTool} ready to be attached to an agent.","file":"dist/livewire/index.d.ts","line":367},"livewire.voice":{"name":"livewire.voice","kind":"variable","exported":true,"signature":["const voice: {\n Agent: typeof Agent;\n AgentSession: typeof AgentSession;\n AgentSessionEventTypes: Record<string, string>;\n}"],"doc":"LiveKit voice namespace equivalent.","file":"dist/livewire/index.d.ts","line":693},"normalizePostPrompt":{"name":"normalizePostPrompt","kind":"function","exported":true,"signature":["function normalizePostPrompt(body: unknown): NormalizedPostPrompt"],"doc":"Normalize a post-prompt body from either engine. Never throws; a body it\ncan't make sense of yields a result with empty fields.\n@param body - The complete post-prompt request body.\n@returns The normalized leg.\n\n@example\n```ts\nconst leg = normalizePostPrompt(rawData);\nif (leg.dialogue.length) store(leg.conversationId, leg.medium, leg.summary, leg.dialogue);\n```","file":"dist/PostPrompt.d.ts","line":110},"paginate":{"name":"paginate","kind":"function","exported":true,"signature":["function paginate<T>(http: HttpClient, path: string, params?: QueryParams, dataKey?: string, requestOptions?: RequestOptionsInit): AsyncGenerator<T, void, undefined>"],"doc":"Async generator that yields items across paginated API responses.\n\nHandles both relay REST (`links.next`) and LAML (`next_page_uri`) pagination\nstyles transparently.\n\n@typeParam T - Element type yielded.\n@param http - {@link HttpClient} instance used to fetch each page.\n@param path - Initial API path (absolute URL or path relative to `http.baseUrl`).\n@param params - Query parameters applied to the first request only.\n Subsequent pages use the server-supplied next-page URL unchanged.\n@param dataKey - Key on each response containing the array of items.\n Defaults to `\"data\"`.\n@param requestOptions - Per-request transport envelope forwarded to EVERY\n page fetch (mirrors Python's `_pagination.py`, which forwards\n `request_options` on each page). Timeout/retry/abort apply to every page.\n@returns An async iterable that yields one `T` per call until exhausted.","file":"dist/rest/pagination.d.ts","line":27},"paginateAll":{"name":"paginateAll","kind":"function","exported":true,"signature":["function paginateAll<T>(http: HttpClient, path: string, params?: QueryParams, dataKey?: string): Promise<T[]>"],"doc":"Collect all paginated items into an array.\n\nConvenience wrapper around {@link paginate} for callers who want the full\nlist. Beware: loads every page into memory — for very large result sets,\niterate via `paginate()` directly.\n\n@typeParam T - Element type collected.\n@param http - {@link HttpClient} instance used to fetch each page.\n@param path - Initial API path.\n@param params - Query parameters applied to the first request.\n@param dataKey - Key on each response containing the array of items.\n Defaults to `\"data\"`.\n@returns A flat array of every item across all pages.","file":"dist/rest/pagination.d.ts","line":43},"paramSchema":{"name":"paramSchema","kind":"function","exported":true,"signature":["function paramSchema(): ParameterSchema"],"doc":"Create a new {@link ParameterSchema} builder — the idiomatic entry point.\n\n@returns A fresh, empty builder.\n\n@example\n```ts\nconst params = paramSchema()\n .string('service', 'The service to look up')\n .codec('media_codec', 'Audio codec for the tap')\n .required('service')\n .build();\n```","file":"dist/ParameterSchema.d.ts","line":306},"parseEvent":{"name":"parseEvent","kind":"function","exported":true,"signature":["function parseEvent(payload: EventPayload): RelayEvent"],"doc":"Parse a raw signalwire.event params dict into a typed event object.","file":"dist/relay/RelayEvent.d.ts","line":284},"parseFunctionParams":{"name":"parseFunctionParams","kind":"function","exported":true,"signature":["function parseFunctionParams(source: string): ParsedParam[]"],"doc":"Parse function parameter names and default values from source code.\n\nHandles arrow functions, regular functions, and method shorthand.\n\n@param source - The function source text, typically from `fn.toString()`.\n@returns An array of `{ name, defaultValue? }` records in declaration order.\n Returns an empty array if no parameter list is present.","file":"dist/TypeInference.d.ts","line":71},"parsePostPromptData":{"name":"parsePostPromptData","kind":"function","exported":true,"signature":["function parsePostPromptData(data: unknown): Record<string, unknown>"],"doc":"`post_prompt_data` as a plain object, whichever shape it arrived in. Never\nthrows: a malformed summary degrades to `{}` rather than failing the request\nthat delivered it.\n@param data - The `post_prompt_data` value from a post-prompt body.\n@returns The summary object, or `{}` when there's nothing usable.","file":"dist/PostPrompt.d.ts","line":77},"redactUrl":{"name":"redactUrl","kind":"function","exported":true,"signature":["function redactUrl(url: string): string"],"doc":"Redact credentials embedded in a URL (e.g. `https://user:secret@host` -> `https://user:****@host`).\nMasks the password of every URL in the string, including one with an empty\nuser (`http://:secret@host`). Returns the string unchanged if no credentials\nare present.\n@param url - The URL string (or a message containing URLs) to redact.\n@returns The string with each URL's password replaced by `****`.","file":"dist/SecurityUtils.d.ts","line":31},"registerBuiltinSkills":{"name":"registerBuiltinSkills","kind":"function","exported":true,"signature":["function registerBuiltinSkills(): void"],"doc":"Register all built-in skills with the global SkillRegistry singleton.\nThis is the 17 Python-reference skills plus two TS-specific helper skills\n(custom_skills, ask_claude; see PORT_ADDITIONS.md).\nMatches Python's auto-discovery pattern (`skills/registry.py`) which finds\nSkillBase subclasses in the skills directory and registers them by class\nreference. Skips registration for any skill name already present.","file":"dist/skills/builtin/index.d.ts","line":33},"registerSkill":{"name":"registerSkill","kind":"function","exported":true,"signature":["function registerSkill(skillClass: typeof _SkillBase): void"],"doc":"Register a custom skill class with the global {@link SkillRegistry}.\n\nEquivalent to Python's `register_skill(skill_class)`. Allows third-party\ncode to register skills directly, bypassing the built-in directory scan.\n\n@param skillClass - Skill class to register (a subclass of {@link SkillBase}).","file":"dist/index.d.ts","line":196},"resetLoggingConfiguration":{"name":"resetLoggingConfiguration","kind":"function","exported":true,"signature":["function resetLoggingConfiguration(): void"],"doc":"Reset all logging settings to their environment-variable-based defaults.","file":"dist/Logger.d.ts","line":77},"restClient":{"name":"restClient","kind":"function","exported":true,"signature":["function restClient(opts?: _ClientOptions): _RestClient"],"doc":"Construct a {@link _RestClient | RestClient} instance.\n\nEquivalent to Python's top-level `signalwire.RestClient(*args, **kwargs)`\nfactory — a thin wrapper that lazy-imports `signalwire.rest.RestClient`\nand instantiates it. The TS class is also exported directly at module\nscope (`new RestClient(...)`); this function offers the same factory-call\nstyle as Python for users porting code across the two SDKs.\n\nNote: TypeScript exports the class `RestClient` at the same name from\n`./rest/index.js`. The function below is named `restClient` (camelCase)\nto avoid shadowing the class — use either `new RestClient(opts)` or\n`restClient(opts)`; both construct the same client.\n\nThe declared signature is the idiomatic TS form: a single, fully-typed\noptions object. This gives real compile-time safety on the credential\nfields, unlike Python's untyped `(*args, **kwargs)`. For back-compat,\nthe legacy `restClient([], { project, token, host })` call form (a leading\npositional array followed by the options) is still accepted at runtime.\n\n@param opts - Credentials/configuration. When omitted, reads\n `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`, and\n `SIGNALWIRE_SPACE` from the environment.\n@returns A new {@link _RestClient} instance bound to the supplied (or\n environment-derived) credentials.\n\n@example\n```ts\nimport { restClient } from '@signalwire/sdk';\n\nconst client = restClient({ project: 'p', token: 't', host: 'h.signalwire.com' });\n\n// Or using env vars:\nconst env = restClient(); // reads env vars\n```","file":"dist/index.d.ts","line":167},"safeAssign":{"name":"safeAssign","kind":"function","exported":true,"signature":["function safeAssign<T extends Record<string, unknown>>(target: T, source: Record<string, unknown>): T"],"doc":"Copy properties from `source` to `target`, filtering out prototype-pollution keys.\nDrop-in replacement for `Object.assign(target, source)` where `source` is untrusted.\n@param target - The object to assign into.\n@param source - The object to copy properties from.\n@returns The target object.","file":"dist/SecurityUtils.d.ts","line":16},"setAllowedEnvPrefixes":{"name":"setAllowedEnvPrefixes","kind":"function","exported":true,"signature":["function setAllowedEnvPrefixes(prefixes: string[]): void"],"doc":"Set the global allowed env var prefixes for `${ENV.*}` expansion.\n\nThis is the default list for every DataMap that has no list of its own\n(see {@link DataMap.setAllowedEnvPrefixes}), read when each DataMap's\n`toSwaigFunction()` runs. Only variables whose names start with one of\nthese prefixes are expanded; any other `${ENV.NAME}` becomes an empty\nstring. The default is `['SIGNALWIRE_', 'SWML_', 'SW_']`.\n\nExpanded values are written into the SWML document, so the list limits\nwhich variables a template can publish there. An empty array allows every\nvariable and removes that protection.\n\n@param prefixes - Array of prefix strings to allow.","file":"dist/DataMap.d.ts","line":23},"setGlobalLogColor":{"name":"setGlobalLogColor","kind":"function","exported":true,"signature":["function setGlobalLogColor(enabled: boolean): void"],"doc":"Enable or disable ANSI color codes in text-format output.\n@param enabled - True to enable colors, false to disable.","file":"dist/Logger.d.ts","line":62},"setGlobalLogFormat":{"name":"setGlobalLogFormat","kind":"function","exported":true,"signature":["function setGlobalLogFormat(format: LogFormat): void"],"doc":"Set the output format for all loggers.\n@param format - Either 'text' (human-readable) or 'json' (structured).","file":"dist/Logger.d.ts","line":57},"setGlobalLogLevel":{"name":"setGlobalLogLevel","kind":"function","exported":true,"signature":["function setGlobalLogLevel(level: LogLevel): void"],"doc":"Set the minimum log level for all loggers.\n\nTakes a {@link LogLevel} (`'debug' | 'info' | 'warn' | 'error'`) — the\nclosed, port-owned set (the keys of the internal severity table). It is\ndeveloper input with no Python counterpart and no open-ended wire/reference\nsource, so the parameter is typed closed: editor autocompletion plus a typo\nsuch as `'debgu'` is a compile-time error rather than a silent no-op. (The\nenv-var path, `SIGNALWIRE_LOG_LEVEL`, is necessarily untyped and still\ntolerates an arbitrary string defensively at runtime.)\n\n@param level - The minimum severity level to emit.","file":"dist/Logger.d.ts","line":47},"setGlobalLogStream":{"name":"setGlobalLogStream","kind":"function","exported":true,"signature":["function setGlobalLogStream(stream: LogStream): void"],"doc":"Set the output stream for all loggers.\n@param stream - Either 'stdout' (default) or 'stderr'.","file":"dist/Logger.d.ts","line":67},"stripControlChars":{"name":"stripControlChars","kind":"function","exported":true,"signature":["function stripControlChars<T extends Record<string, unknown>>(data: T): T"],"doc":"Strip control characters from all string values in a data record to prevent\nlog injection attacks. Mirrors Python SDK's `strip_control_chars` structlog\nprocessor. Processes nested objects and arrays recursively.\n\n@param data - The record whose string values should be sanitized.\n@returns A shallow copy of `data` with control characters removed from strings.","file":"dist/Logger.d.ts","line":86},"stripJsonFence":{"name":"stripJsonFence","kind":"function","exported":true,"signature":["function stripJsonFence(text: string): string"],"doc":"Unwrap ```` ```json ... ``` ```` fencing. The chat engine hands the model's\nanswer back verbatim, fence and all, where the voice engine parses it first.\n@param text - The text to unwrap.\n@returns The text without a surrounding code fence.","file":"dist/PostPrompt.d.ts","line":69},"suppressAllLogs":{"name":"suppressAllLogs","kind":"function","exported":true,"signature":["function suppressAllLogs(suppress?: boolean): void"],"doc":"Suppress or unsuppress all log output globally.\n@param suppress - True to suppress, false to restore (default true).","file":"dist/Logger.d.ts","line":52},"userVariables":{"name":"userVariables","kind":"function","exported":true,"signature":["function userVariables(bodyParams: unknown): Record<string, unknown>"],"doc":"The user variables from a SWML request body (`vars.userVariables`), or `{}`.\n\nThey're nested two levels down, which is easy to get wrong silently: a\nmissing level yields an empty object, and every later check reports \"not\ndeclared\".\n\n@param bodyParams - The SWML request body.\n@returns The user variables, or an empty object.","file":"dist/capabilities.d.ts","line":38},"validate":{"name":"validate","kind":"function","exported":true,"signature":["function validate(method: string, url: string, headers: Record<string, string>, body: string, signingKey: string): WebhookRejection | null"],"doc":"Framework-free webhook-validation decision core.\n\nThis is the language-neutral heart every SignalWire SDK exposes at the same\ncanonical path (``signalwire.core.security.webhook_middleware.validate``): it\ntakes the decomposed request primitives (no framework Request/Response\nobjects) and returns either ``null`` (the request is authentic — let it\nthrough) or a ``[status, headers, body]`` rejection triple the caller writes\nback verbatim. The {@link webhookValidationMiddleware} Hono adapter is a thin\nwrapper over this: it reads the raw body + headers off the Hono context, calls\n``validate``, and turns a non-null triple into a ``c.text(...)`` response.\n\nBehavior mirrors the SignalWire webhook signature-validation contract:\n\n - A valid ``X-SignalWire-Sha256-Signature`` (HMAC-SHA256) → ``null`` (pass).\n This stronger header is checked first; when it is missing or doesn't\n match, the SHA-1 header decides.\n - Missing ``X-SignalWire-Signature`` (or the ``X-Twilio-Signature`` alias)\n → reject ``[403, {}, 'Forbidden']`` (never throws for a missing header).\n - Bad signature → reject ``[403, {}, 'Forbidden']``.\n - Valid signature → ``null`` (pass).\n - Missing / empty ``signingKey`` → throws (a programming error, not a\n validation failure — matches ``validateWebhookSignature``).\n\nThe rejection body carries no detail about which scheme or branch failed —\nthe validator MUST NOT leak that.\n\n@param method The HTTP method (informational; the signature does not cover it).\n@param url The full public URL SignalWire POSTed to (scheme, host, optional\n port, path, query) — reconstruct proxy/tunnel URLs before calling.\n@param headers The request headers as a plain string→string map. Looked up\n case-insensitively for the signature header.\n@param body The raw request body as a UTF-8 string, BEFORE any JSON/form parse.\n@param signingKey The customer's Signing Key from the Dashboard.\n@returns ``null`` when the request is authentic; a ``[status, headers, body]``\n triple to send back when it is not.\n@throws Error when ``signingKey`` is missing / empty.","file":"dist/WebhookMiddleware.d.ts","line":82},"validateRequest":{"name":"validateRequest","kind":"function","exported":true,"signature":["function validateRequest(signingKey: string, signature: string, url: string, paramsOrRawBody: string | Record<string, unknown> | Array<[string, unknown]> | null | undefined): boolean"],"doc":"Legacy ``@signalwire/compatibility-api`` drop-in entry point.\n\nIf ``paramsOrRawBody`` is a string, delegates to\n{@link validateWebhookSignature} (Scheme A then Scheme B with parsed form).\n\nIf it's a record, Map, or list of [key, value] tuples, treats it as\npre-parsed form params and runs Scheme B directly (with URL port\nnormalization and optional bodySHA256 fallback).\n\nThe parameter type matches Python's\n``Union[str, Mapping[str, Any], List[Tuple[str, Any]], None]`` for\na consistent cross-SDK signature. ``Map<string, unknown>`` is also\naccepted at runtime for ergonomic TS usage.\n\n@param signingKey Customer's Signing Key. Empty / null throws Error.\n@param signature Header value. Missing / empty returns false.\n@param url Full URL SignalWire POSTed to.\n@param paramsOrRawBody String raw body OR pre-parsed form params.\n@returns true on match, false otherwise.\n@throws Error when ``signingKey`` is missing.\n@throws TypeError when ``paramsOrRawBody`` is neither a string nor a\n record/Map/array of tuples (e.g. a plain number).","file":"dist/WebhookValidator.d.ts","line":92},"validateUrl":{"name":"validateUrl","kind":"function","exported":true,"signature":["function validateUrl(url: string, allowPrivate?: boolean): Promise<boolean>"],"doc":"Validate that a URL is safe to fetch (not pointing to private/internal resources).\n\nMatches Python's `validate_url(url, allow_private=False) -> bool` — returns `true`\nif the URL is safe, `false` otherwise (never throws).\n\n@param url - The URL to validate.\n@param allowPrivate - When true, allow private IP ranges (default false).\n@returns `true` if the URL is safe to fetch, `false` otherwise.","file":"dist/SecurityUtils.d.ts","line":93},"validateWebhookSignature":{"name":"validateWebhookSignature","kind":"function","exported":true,"signature":["function validateWebhookSignature(signingKey: string, signature: string, url: string, rawBody: string): boolean"],"doc":"Validate a SignalWire webhook signature against both schemes (A then B).\n\n@param signingKey The customer's Signing Key from the Dashboard. Empty / null\n throws ``Error`` — that's a programming error, not a validation failure.\n@param signature The ``X-SignalWire-Signature`` header value (or\n ``X-Twilio-Signature`` for cXML compat). Missing / empty returns ``false``\n without throwing.\n@param url The full URL SignalWire POSTed to (scheme, host, optional port,\n path, query). Must match what the platform saw — see the URL reconstruction\n rules in SignalWire's webhook signing documentation.\n@param rawBody The raw request body bytes as a UTF-8 string, BEFORE any\n JSON / form parsing. Must be a string — passing a parsed object throws\n ``TypeError``.\n@returns ``true`` if the signature matches either Scheme A (hex JSON) or\n Scheme B (base64 form, with port-normalization variants and optional\n bodySHA256 fallback). ``false`` otherwise.\n@throws Error when ``signingKey`` is missing / empty.\n@throws TypeError when ``rawBody`` is not a string.","file":"dist/WebhookValidator.d.ts","line":44},"validateWebhookSignatureSha256":{"name":"validateWebhookSignatureSha256","kind":"function","exported":true,"signature":["function validateWebhookSignatureSha256(signingKey: string, signature: string, url: string, rawBody: string): boolean"],"doc":"Validate the SHA-256 webhook signature (Scheme A with a stronger hash).\n\nSignalWire sends ``X-SignalWire-Sha256-Signature`` alongside the SHA-1\n``X-SignalWire-Signature`` on signed webhooks. Its message is the same as\nScheme A, hashed with SHA-256:\n\n hex(HMAC-SHA256(signingKey, url + rawBody))\n\nOnly Scheme A (RELAY, SWML and JSON webhooks) is defined for this header; the\ncXML/form Scheme B stays on SHA-1 (see {@link validateWebhookSignature}).\n\n@param signingKey - The customer's Signing Key. Empty throws.\n@param signature - The ``X-SignalWire-Sha256-Signature`` header value\n (64-character lowercase hex). Missing or empty returns ``false``.\n@param url - The full public URL SignalWire POSTed to, exactly as the\n platform saw it when it computed the signature.\n@param rawBody - The raw request body, before any parsing.\n@returns ``true`` if the SHA-256 signature matches.\n@throws Error when ``signingKey`` is missing / empty.\n@throws TypeError when ``rawBody`` is not a string.","file":"dist/WebhookValidator.d.ts","line":67},"webhookValidationMiddleware":{"name":"webhookValidationMiddleware","kind":"function","exported":true,"signature":["function webhookValidationMiddleware(opts: WebhookValidationOptions): MiddlewareHandler"],"doc":"Build a Hono middleware that enforces SignalWire webhook signature\nvalidation.\n\nThe middleware:\n\n 1. Captures the raw body (``await c.req.text()``) BEFORE any other\n consumer reads the stream. The string is stashed at ``c.set('rawBody')``\n so the downstream handler can re-parse without re-reading the stream.\n 2. Pulls the ``X-SignalWire-Sha256-Signature`` header and the\n ``X-SignalWire-Signature`` header (or the ``X-Twilio-Signature`` alias).\n 3. Reconstructs the public URL (``SWML_PROXY_URL_BASE`` env > forwarded\n headers when ``trustProxy`` > raw request URL).\n 4. Calls {@link validateWebhookSignature}.\n 5. On any failure: responds 403 with no body detail (would leak which\n branch failed). Does NOT call ``next()``.\n 6. On success: ``next()``.\n\n@throws Error at construction time if ``signingKey`` is empty.","file":"dist/WebhookMiddleware.d.ts","line":119},"withTimeout":{"name":"withTimeout","kind":"function","exported":true,"signature":["function withTimeout<T>(promise: Promise<T>, ms: number, label?: string): Promise<T>"],"doc":"Race a promise against a timeout.\n\n@typeParam T - Resolution value type of the input promise.\n@param promise - Promise to race against the timeout.\n@param ms - Timeout in milliseconds.\n@param label - Label used in the timeout error message. Defaults to\n `\"Operation\"`.\n@returns A new promise that resolves with `promise`'s value if it settles\n before the timeout, and rejects with a timeout `Error` otherwise.","file":"dist/relay/Deferred.d.ts","line":44}}}
|