@signalwire/sdk 2.0.1 → 2.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/AgentBase.d.ts +1045 -0
- package/dist/AgentBase.js +2375 -0
- package/dist/AgentBase.js.map +1 -0
- package/dist/AgentServer.d.ts +146 -0
- package/dist/AgentServer.js +388 -0
- package/dist/AgentServer.js.map +1 -0
- package/dist/AuthHandler.d.ts +127 -0
- package/dist/AuthHandler.js +212 -0
- package/dist/AuthHandler.js.map +1 -0
- package/dist/ConfigLoader.d.ts +170 -0
- package/dist/ConfigLoader.js +393 -0
- package/dist/ConfigLoader.js.map +1 -0
- package/dist/ContextBuilder.d.ts +652 -0
- package/dist/ContextBuilder.js +1115 -0
- package/dist/ContextBuilder.js.map +1 -0
- package/dist/DataMap.d.ts +271 -0
- package/dist/DataMap.js +430 -0
- package/dist/DataMap.js.map +1 -0
- package/dist/FunctionResult.d.ts +481 -0
- package/dist/FunctionResult.js +775 -0
- package/dist/FunctionResult.js.map +1 -0
- package/dist/Logger.d.ts +113 -0
- package/dist/Logger.js +320 -0
- package/dist/Logger.js.map +1 -0
- package/dist/PomBuilder.d.ts +208 -0
- package/dist/PomBuilder.js +409 -0
- package/dist/PomBuilder.js.map +1 -0
- package/dist/PromptManager.d.ts +85 -0
- package/dist/PromptManager.js +108 -0
- package/dist/PromptManager.js.map +1 -0
- package/dist/SWMLHandler.d.ts +159 -0
- package/dist/SWMLHandler.js +229 -0
- package/dist/SWMLHandler.js.map +1 -0
- package/dist/SWMLService.d.ts +326 -0
- package/dist/SWMLService.js +610 -0
- package/dist/SWMLService.js.map +1 -0
- package/dist/SchemaUtils.d.ts +108 -0
- package/dist/SchemaUtils.js +317 -0
- package/dist/SchemaUtils.js.map +1 -0
- package/dist/SecurityUtils.d.ts +60 -0
- package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
- package/dist/SecurityUtils.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +119 -0
- package/dist/ServerlessAdapter.js +188 -0
- package/dist/ServerlessAdapter.js.map +1 -0
- package/dist/SessionManager.d.ts +142 -0
- package/dist/SessionManager.js +260 -0
- package/dist/SessionManager.js.map +1 -0
- package/dist/SslConfig.d.ts +77 -0
- package/dist/SslConfig.js +100 -0
- package/dist/SslConfig.js.map +1 -0
- package/dist/SwaigFunction.d.ts +159 -0
- package/dist/SwaigFunction.js +209 -0
- package/dist/SwaigFunction.js.map +1 -0
- package/dist/SwmlBuilder.d.ts +165 -0
- package/dist/SwmlBuilder.js +247 -0
- package/dist/SwmlBuilder.js.map +1 -0
- package/dist/SwmlVerbMethods.generated.d.ts +254 -0
- package/dist/SwmlVerbMethods.generated.js +9 -0
- package/dist/SwmlVerbMethods.generated.js.map +1 -0
- package/dist/TypeInference.d.ts +71 -0
- package/dist/TypeInference.js +164 -0
- package/dist/TypeInference.js.map +1 -0
- package/dist/WebService.d.ts +148 -0
- package/dist/WebService.js +532 -0
- package/dist/WebService.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +22 -0
- package/dist/cli/agent-loader.js +144 -0
- package/dist/cli/agent-loader.js.map +1 -0
- package/dist/cli/mock-data.d.ts +37 -0
- package/dist/cli/mock-data.js +80 -0
- package/dist/cli/mock-data.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +32 -0
- package/dist/cli/swaig-test.js +418 -0
- package/dist/cli/swaig-test.js.map +1 -0
- package/dist/generateVerbTypes.d.ts +11 -0
- package/dist/generateVerbTypes.js +265 -0
- package/dist/generateVerbTypes.js.map +1 -0
- package/{src/index.ts → dist/index.d.ts} +13 -100
- package/dist/index.js +152 -0
- package/dist/index.js.map +1 -0
- package/dist/livewire/index.d.ts +653 -0
- package/dist/livewire/index.js +992 -0
- package/dist/livewire/index.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +89 -0
- package/dist/prefabs/ConciergeAgent.js +245 -0
- package/dist/prefabs/ConciergeAgent.js.map +1 -0
- package/dist/prefabs/FAQBotAgent.d.ts +113 -0
- package/dist/prefabs/FAQBotAgent.js +329 -0
- package/dist/prefabs/FAQBotAgent.js.map +1 -0
- package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
- package/dist/prefabs/InfoGathererAgent.js +287 -0
- package/dist/prefabs/InfoGathererAgent.js.map +1 -0
- package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
- package/dist/prefabs/ReceptionistAgent.js +303 -0
- package/dist/prefabs/ReceptionistAgent.js.map +1 -0
- package/dist/prefabs/SurveyAgent.d.ts +148 -0
- package/dist/prefabs/SurveyAgent.js +540 -0
- package/dist/prefabs/SurveyAgent.js.map +1 -0
- package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
- package/dist/prefabs/index.js +14 -0
- package/dist/prefabs/index.js.map +1 -0
- package/dist/relay/Action.d.ts +258 -0
- package/dist/relay/Action.js +402 -0
- package/dist/relay/Action.js.map +1 -0
- package/dist/relay/Call.d.ts +697 -0
- package/dist/relay/Call.js +1062 -0
- package/dist/relay/Call.js.map +1 -0
- package/dist/relay/Deferred.d.ts +44 -0
- package/dist/relay/Deferred.js +69 -0
- package/dist/relay/Deferred.js.map +1 -0
- package/dist/relay/Message.d.ts +103 -0
- package/dist/relay/Message.js +169 -0
- package/dist/relay/Message.js.map +1 -0
- package/dist/relay/RelayClient.d.ts +302 -0
- package/dist/relay/RelayClient.js +1026 -0
- package/dist/relay/RelayClient.js.map +1 -0
- package/dist/relay/RelayError.d.ts +15 -0
- package/dist/relay/RelayError.js +20 -0
- package/dist/relay/RelayError.js.map +1 -0
- package/dist/relay/RelayEvent.d.ts +254 -0
- package/dist/relay/RelayEvent.js +509 -0
- package/dist/relay/RelayEvent.js.map +1 -0
- package/dist/relay/constants.d.ts +90 -0
- package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
- package/dist/relay/constants.js.map +1 -0
- package/dist/relay/index.d.ts +16 -0
- package/dist/relay/index.js +18 -0
- package/dist/relay/index.js.map +1 -0
- package/dist/relay/types.d.ts +142 -0
- package/dist/relay/types.js +5 -0
- package/dist/relay/types.js.map +1 -0
- package/dist/rest/HttpClient.d.ts +80 -0
- package/dist/rest/HttpClient.js +148 -0
- package/dist/rest/HttpClient.js.map +1 -0
- package/dist/rest/RestError.d.ts +30 -0
- package/dist/rest/RestError.js +39 -0
- package/dist/rest/RestError.js.map +1 -0
- package/dist/rest/base/BaseResource.d.ts +24 -0
- package/dist/rest/base/BaseResource.js +29 -0
- package/dist/rest/base/BaseResource.js.map +1 -0
- package/dist/rest/base/CrudResource.d.ts +68 -0
- package/dist/rest/base/CrudResource.js +82 -0
- package/dist/rest/base/CrudResource.js.map +1 -0
- package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
- package/dist/rest/base/CrudWithAddresses.js +25 -0
- package/dist/rest/base/CrudWithAddresses.js.map +1 -0
- package/dist/rest/index.d.ts +131 -0
- package/{src/rest/index.ts → dist/rest/index.js} +101 -136
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +46 -0
- package/dist/rest/namespaces/addresses.js +55 -0
- package/dist/rest/namespaces/addresses.js.map +1 -0
- package/dist/rest/namespaces/calling.d.ts +382 -0
- package/dist/rest/namespaces/calling.js +478 -0
- package/dist/rest/namespaces/calling.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +22 -0
- package/dist/rest/namespaces/chat.js +26 -0
- package/dist/rest/namespaces/chat.js.map +1 -0
- package/dist/rest/namespaces/compat.d.ts +585 -0
- package/dist/rest/namespaces/compat.js +735 -0
- package/dist/rest/namespaces/compat.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +66 -0
- package/dist/rest/namespaces/datasphere.js +77 -0
- package/dist/rest/namespaces/datasphere.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +282 -0
- package/dist/rest/namespaces/fabric.js +373 -0
- package/dist/rest/namespaces/fabric.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
- package/dist/rest/namespaces/imported-numbers.js +26 -0
- package/dist/rest/namespaces/imported-numbers.js.map +1 -0
- package/dist/rest/namespaces/logs.d.ts +105 -0
- package/dist/rest/namespaces/logs.js +133 -0
- package/dist/rest/namespaces/logs.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +29 -0
- package/dist/rest/namespaces/lookup.js +32 -0
- package/dist/rest/namespaces/lookup.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +46 -0
- package/dist/rest/namespaces/mfa.js +54 -0
- package/dist/rest/namespaces/mfa.js.map +1 -0
- package/dist/rest/namespaces/number-groups.d.ts +49 -0
- package/dist/rest/namespaces/number-groups.js +58 -0
- package/dist/rest/namespaces/number-groups.js.map +1 -0
- package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
- package/dist/rest/namespaces/phone-numbers.js +67 -0
- package/dist/rest/namespaces/phone-numbers.js.map +1 -0
- package/dist/rest/namespaces/project.d.ts +46 -0
- package/dist/rest/namespaces/project.js +56 -0
- package/dist/rest/namespaces/project.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +22 -0
- package/dist/rest/namespaces/pubsub.js +26 -0
- package/dist/rest/namespaces/pubsub.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +42 -0
- package/dist/rest/namespaces/queues.js +49 -0
- package/dist/rest/namespaces/queues.js.map +1 -0
- package/dist/rest/namespaces/recordings.d.ts +38 -0
- package/dist/rest/namespaces/recordings.js +45 -0
- package/dist/rest/namespaces/recordings.js.map +1 -0
- package/dist/rest/namespaces/registry.d.ts +141 -0
- package/dist/rest/namespaces/registry.js +178 -0
- package/dist/rest/namespaces/registry.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +39 -0
- package/dist/rest/namespaces/short-codes.js +46 -0
- package/dist/rest/namespaces/short-codes.js.map +1 -0
- package/dist/rest/namespaces/sip-profile.d.ts +28 -0
- package/dist/rest/namespaces/sip-profile.js +34 -0
- package/dist/rest/namespaces/sip-profile.js.map +1 -0
- package/dist/rest/namespaces/verified-callers.d.ts +33 -0
- package/dist/rest/namespaces/verified-callers.js +39 -0
- package/dist/rest/namespaces/verified-callers.js.map +1 -0
- package/dist/rest/namespaces/video.d.ts +235 -0
- package/dist/rest/namespaces/video.js +297 -0
- package/dist/rest/namespaces/video.js.map +1 -0
- package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
- package/dist/rest/pagination.js +78 -0
- package/dist/rest/pagination.js.map +1 -0
- package/dist/rest/types.d.ts +54 -0
- package/dist/rest/types.js +5 -0
- package/dist/rest/types.js.map +1 -0
- package/dist/skills/SkillBase.d.ts +404 -0
- package/dist/skills/SkillBase.js +471 -0
- package/dist/skills/SkillBase.js.map +1 -0
- package/dist/skills/SkillManager.d.ts +195 -0
- package/dist/skills/SkillManager.js +378 -0
- package/dist/skills/SkillManager.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +176 -0
- package/dist/skills/SkillRegistry.js +310 -0
- package/dist/skills/SkillRegistry.js.map +1 -0
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
- package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
- package/dist/skills/builtin/ask_claude.d.ts +37 -0
- package/dist/skills/builtin/ask_claude.js +162 -0
- package/dist/skills/builtin/ask_claude.js.map +1 -0
- package/dist/skills/builtin/claude_skills.d.ts +75 -0
- package/dist/skills/builtin/claude_skills.js +753 -0
- package/dist/skills/builtin/claude_skills.js.map +1 -0
- package/dist/skills/builtin/custom_skills.d.ts +79 -0
- package/dist/skills/builtin/custom_skills.js +227 -0
- package/dist/skills/builtin/custom_skills.js.map +1 -0
- package/dist/skills/builtin/datasphere.d.ts +73 -0
- package/dist/skills/builtin/datasphere.js +350 -0
- package/dist/skills/builtin/datasphere.js.map +1 -0
- package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
- package/dist/skills/builtin/datasphere_serverless.js +291 -0
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
- package/dist/skills/builtin/datetime.d.ts +40 -0
- package/dist/skills/builtin/datetime.js +118 -0
- package/dist/skills/builtin/datetime.js.map +1 -0
- package/dist/skills/builtin/google_maps.d.ts +48 -0
- package/dist/skills/builtin/google_maps.js +470 -0
- package/dist/skills/builtin/google_maps.js.map +1 -0
- package/dist/skills/builtin/index.d.ts +31 -0
- package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
- package/dist/skills/builtin/index.js.map +1 -0
- package/dist/skills/builtin/info_gatherer.d.ts +115 -0
- package/dist/skills/builtin/info_gatherer.js +328 -0
- package/dist/skills/builtin/info_gatherer.js.map +1 -0
- package/dist/skills/builtin/joke.d.ts +41 -0
- package/dist/skills/builtin/joke.js +156 -0
- package/dist/skills/builtin/joke.js.map +1 -0
- package/dist/skills/builtin/math.d.ts +39 -0
- package/dist/skills/builtin/math.js +119 -0
- package/dist/skills/builtin/math.js.map +1 -0
- package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
- package/dist/skills/builtin/mcp_gateway.js +574 -0
- package/dist/skills/builtin/mcp_gateway.js.map +1 -0
- package/dist/skills/builtin/native_vector_search.d.ts +128 -0
- package/dist/skills/builtin/native_vector_search.js +752 -0
- package/dist/skills/builtin/native_vector_search.js.map +1 -0
- package/dist/skills/builtin/play_background_file.d.ts +59 -0
- package/dist/skills/builtin/play_background_file.js +274 -0
- package/dist/skills/builtin/play_background_file.js.map +1 -0
- package/dist/skills/builtin/spider.d.ts +91 -0
- package/dist/skills/builtin/spider.js +758 -0
- package/dist/skills/builtin/spider.js.map +1 -0
- package/dist/skills/builtin/swml_transfer.d.ts +66 -0
- package/dist/skills/builtin/swml_transfer.js +475 -0
- package/dist/skills/builtin/swml_transfer.js.map +1 -0
- package/dist/skills/builtin/weather_api.d.ts +59 -0
- package/dist/skills/builtin/weather_api.js +196 -0
- package/dist/skills/builtin/weather_api.js.map +1 -0
- package/dist/skills/builtin/web_search.d.ts +160 -0
- package/dist/skills/builtin/web_search.js +894 -0
- package/dist/skills/builtin/web_search.js.map +1 -0
- package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
- package/dist/skills/builtin/wikipedia_search.js +241 -0
- package/dist/skills/builtin/wikipedia_search.js.map +1 -0
- package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
- package/dist/skills/index.js +10 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/types.d.ts +118 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +7 -1
- package/.github/workflows/publish.yml +0 -27
- package/.github/workflows/test.yml +0 -17
- package/CLAUDE.md +0 -112
- package/docs/MIGRATION-2.0.md +0 -81
- package/docs/agent-guide.md +0 -869
- package/docs/agent_guide.md +0 -1026
- package/docs/api-reference.md +0 -2420
- package/docs/api_reference.md +0 -1301
- package/docs/architecture.md +0 -843
- package/docs/cli-guide.md +0 -579
- package/docs/cli_guide.md +0 -448
- package/docs/cloud_functions_guide.md +0 -474
- package/docs/configuration.md +0 -422
- package/docs/contexts-guide.md +0 -787
- package/docs/contexts_guide.md +0 -511
- package/docs/datamap-guide.md +0 -1141
- package/docs/datamap_guide.md +0 -595
- package/docs/llm_parameters.md +0 -239
- package/docs/mcp_gateway_reference.md +0 -648
- package/docs/mcp_integration.md +0 -108
- package/docs/prefabs-guide.md +0 -800
- package/docs/sdk_features.md +0 -477
- package/docs/security.md +0 -436
- package/docs/serverless-guide.md +0 -513
- package/docs/skills-guide.md +0 -857
- package/docs/skills-system.md +0 -301
- package/docs/skills_parameter_schema.md +0 -392
- package/docs/skills_system.md +0 -467
- package/docs/swaig-reference.md +0 -1627
- package/docs/swaig_reference.md +0 -910
- package/docs/swml_service_guide.md +0 -600
- package/docs/third_party_skills.md +0 -533
- package/docs/web_service.md +0 -677
- package/examples/README.md +0 -131
- package/examples/advanced-datamap.ts +0 -100
- package/examples/advanced-dynamic-config.ts +0 -70
- package/examples/auto-vivified.ts +0 -94
- package/examples/call-flow.ts +0 -63
- package/examples/comprehensive-dynamic.ts +0 -125
- package/examples/contexts-steps.ts +0 -65
- package/examples/custom-path.ts +0 -45
- package/examples/datamap-tools.ts +0 -55
- package/examples/datasphere-multi-instance.ts +0 -63
- package/examples/datasphere-serverless-env.ts +0 -68
- package/examples/datasphere-webhook-env.ts +0 -66
- package/examples/datasphere.ts +0 -37
- package/examples/declarative.ts +0 -100
- package/examples/dynamic-config.ts +0 -54
- package/examples/dynamic-info-gatherer.ts +0 -69
- package/examples/dynamic-swml-service.ts +0 -67
- package/examples/gather-info.ts +0 -71
- package/examples/gather-per-question-functions-demo.ts +0 -140
- package/examples/joke-agent.ts +0 -34
- package/examples/kubernetes-agent.ts +0 -45
- package/examples/llm-params.ts +0 -69
- package/examples/mcp-agent.ts +0 -84
- package/examples/mcp-gateway.ts +0 -35
- package/examples/multi-agent.ts +0 -73
- package/examples/multi-endpoint.ts +0 -79
- package/examples/pom-prompt.ts +0 -71
- package/examples/prefab-concierge.ts +0 -47
- package/examples/prefab-faq.ts +0 -54
- package/examples/prefab-info-gatherer.ts +0 -33
- package/examples/prefab-receptionist.ts +0 -36
- package/examples/prefab-survey.ts +0 -68
- package/examples/record-call.ts +0 -67
- package/examples/relay-demo.ts +0 -33
- package/examples/room-and-sip.ts +0 -94
- package/examples/serverless-lambda.ts +0 -35
- package/examples/session-state.ts +0 -83
- package/examples/simple-agent.ts +0 -36
- package/examples/simple-static.ts +0 -29
- package/examples/skills-demo.ts +0 -38
- package/examples/step-function-inheritance-demo.ts +0 -124
- package/examples/swaig-features.ts +0 -187
- package/examples/swml-service-routing.ts +0 -66
- package/examples/swml-service.ts +0 -38
- package/examples/tap.ts +0 -68
- package/examples/verb-methods.ts +0 -45
- package/examples/web-search-multi-instance.ts +0 -72
- package/examples/web-search.ts +0 -38
- package/examples/wikipedia.ts +0 -36
- package/livewire/README.md +0 -140
- package/livewire/docs/migration-guide.md +0 -228
- package/livewire/examples/livewire-basic-agent.ts +0 -74
- package/livewire/examples/livewire-handoff.ts +0 -197
- package/livewire/examples/livewire-multi-tool.ts +0 -117
- package/relay/README.md +0 -70
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
- package/relay/docs/call-methods.md +0 -474
- package/relay/docs/client-reference.md +0 -142
- package/relay/docs/events.md +0 -134
- package/relay/docs/getting-started.md +0 -134
- package/relay/docs/guide.md +0 -306
- package/relay/docs/messaging.md +0 -182
- package/relay/examples/relay-inbound.ts +0 -66
- package/relay/examples/relay-messaging.ts +0 -71
- package/relay/examples/relay-outbound.ts +0 -76
- package/rest/README.md +0 -95
- package/rest/docs/calling.md +0 -273
- package/rest/docs/client-reference.md +0 -107
- package/rest/docs/compat.md +0 -204
- package/rest/docs/fabric.md +0 -183
- package/rest/docs/getting-started.md +0 -110
- package/rest/docs/guide.md +0 -351
- package/rest/docs/namespaces.md +0 -285
- package/rest/examples/rest-10dlc-registration.ts +0 -161
- package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
- package/rest/examples/rest-calling-play-and-record.ts +0 -91
- package/rest/examples/rest-client.ts +0 -65
- package/rest/examples/rest-compat-laml.ts +0 -210
- package/rest/examples/rest-datasphere-search.ts +0 -82
- package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
- package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
- package/rest/examples/rest-manage-resources.ts +0 -65
- package/rest/examples/rest-phone-number-management.ts +0 -197
- package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
- package/rest/examples/rest-video-rooms.ts +0 -186
- package/src/AgentBase.ts +0 -2598
- package/src/AgentServer.ts +0 -442
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1181
- package/src/DataMap.ts +0 -477
- package/src/FunctionResult.ts +0 -903
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -467
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -749
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -240
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -283
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -199
- package/src/WebService.ts +0 -641
- package/src/cli/agent-loader.ts +0 -166
- package/src/cli/mock-data.ts +0 -111
- package/src/cli/swaig-test.ts +0 -452
- package/src/generateVerbTypes.ts +0 -322
- package/src/livewire/index.ts +0 -1252
- package/src/prefabs/ConciergeAgent.ts +0 -309
- package/src/prefabs/FAQBotAgent.ts +0 -415
- package/src/prefabs/InfoGathererAgent.ts +0 -379
- package/src/prefabs/ReceptionistAgent.ts +0 -395
- package/src/prefabs/SurveyAgent.ts +0 -671
- package/src/relay/Action.ts +0 -482
- package/src/relay/Call.ts +0 -1270
- package/src/relay/Deferred.ts +0 -94
- package/src/relay/Message.ts +0 -199
- package/src/relay/RelayClient.ts +0 -1185
- package/src/relay/RelayError.ts +0 -20
- package/src/relay/RelayEvent.ts +0 -944
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -164
- package/src/rest/RestError.ts +0 -45
- package/src/rest/base/BaseResource.ts +0 -32
- package/src/rest/base/CrudResource.ts +0 -98
- package/src/rest/base/CrudWithAddresses.ts +0 -37
- package/src/rest/namespaces/addresses.ts +0 -64
- package/src/rest/namespaces/calling.ts +0 -534
- package/src/rest/namespaces/chat.ts +0 -31
- package/src/rest/namespaces/compat.ts +0 -812
- package/src/rest/namespaces/datasphere.ts +0 -88
- package/src/rest/namespaces/fabric.ts +0 -417
- package/src/rest/namespaces/imported-numbers.ts +0 -31
- package/src/rest/namespaces/logs.ts +0 -151
- package/src/rest/namespaces/lookup.ts +0 -38
- package/src/rest/namespaces/mfa.ts +0 -61
- package/src/rest/namespaces/number-groups.ts +0 -68
- package/src/rest/namespaces/phone-numbers.ts +0 -76
- package/src/rest/namespaces/project.ts +0 -65
- package/src/rest/namespaces/pubsub.ts +0 -31
- package/src/rest/namespaces/queues.ts +0 -58
- package/src/rest/namespaces/recordings.ts +0 -53
- package/src/rest/namespaces/registry.ts +0 -200
- package/src/rest/namespaces/short-codes.ts +0 -54
- package/src/rest/namespaces/sip-profile.ts +0 -40
- package/src/rest/namespaces/verified-callers.ts +0 -46
- package/src/rest/namespaces/video.ts +0 -332
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -582
- package/src/skills/SkillManager.ts +0 -419
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
- package/src/skills/builtin/ask_claude.ts +0 -246
- package/src/skills/builtin/claude_skills.ts +0 -983
- package/src/skills/builtin/custom_skills.ts +0 -327
- package/src/skills/builtin/datasphere.ts +0 -447
- package/src/skills/builtin/datasphere_serverless.ts +0 -347
- package/src/skills/builtin/datetime.ts +0 -137
- package/src/skills/builtin/google_maps.ts +0 -656
- package/src/skills/builtin/info_gatherer.ts +0 -415
- package/src/skills/builtin/joke.ts +0 -196
- package/src/skills/builtin/math.ts +0 -149
- package/src/skills/builtin/mcp_gateway.ts +0 -685
- package/src/skills/builtin/native_vector_search.ts +0 -910
- package/src/skills/builtin/play_background_file.ts +0 -367
- package/src/skills/builtin/spider.ts +0 -874
- package/src/skills/builtin/swml_transfer.ts +0 -645
- package/src/skills/builtin/weather_api.ts +0 -255
- package/src/skills/builtin/web_search.ts +0 -1083
- package/src/skills/builtin/wikipedia_search.ts +0 -304
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
package/docs/swaig_reference.md
DELETED
|
@@ -1,910 +0,0 @@
|
|
|
1
|
-
# FunctionResult Reference
|
|
2
|
-
|
|
3
|
-
Complete API reference for the `FunctionResult` class in the SignalWire AI Agents TypeScript SDK.
|
|
4
|
-
|
|
5
|
-
SWAIG (SignalWire AI Gateway) is the platform's AI tool-calling system -- it connects the AI's decisions to actions like call transfers, SMS, recordings, and API calls, with native access to the media stack. This document provides a complete reference for all methods available in the `FunctionResult` class.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## Table of Contents
|
|
10
|
-
|
|
11
|
-
- [Overview](#overview)
|
|
12
|
-
- [Core Methods](#core-methods)
|
|
13
|
-
- [constructor](#constructor)
|
|
14
|
-
- [setResponse](#setresponse)
|
|
15
|
-
- [setPostProcess](#setpostprocess)
|
|
16
|
-
- [addAction](#addaction)
|
|
17
|
-
- [addActions](#addactions)
|
|
18
|
-
- [toDict](#todict)
|
|
19
|
-
- [Call Control](#call-control)
|
|
20
|
-
- [connect](#connect)
|
|
21
|
-
- [swmlTransfer](#swmltransfer)
|
|
22
|
-
- [hangup](#hangup)
|
|
23
|
-
- [hold](#hold)
|
|
24
|
-
- [waitForUser](#waitforuser)
|
|
25
|
-
- [stop](#stop)
|
|
26
|
-
- [Audio](#audio)
|
|
27
|
-
- [say](#say)
|
|
28
|
-
- [playBackgroundFile](#playbackgroundfile)
|
|
29
|
-
- [stopBackgroundFile](#stopbackgroundfile)
|
|
30
|
-
- [Speech](#speech)
|
|
31
|
-
- [addDynamicHints](#adddynamichints)
|
|
32
|
-
- [clearDynamicHints](#cleardynamichints)
|
|
33
|
-
- [setEndOfSpeechTimeout](#setendofspeechtimeout)
|
|
34
|
-
- [setSpeechEventTimeout](#setspeecheventtimeout)
|
|
35
|
-
- [Data Management](#data-management)
|
|
36
|
-
- [updateGlobalData](#updateglobaldata)
|
|
37
|
-
- [removeGlobalData](#removeglobaldata)
|
|
38
|
-
- [setMetadata](#setmetadata)
|
|
39
|
-
- [removeMetadata](#removemetadata)
|
|
40
|
-
- [SWML Actions](#swml-actions)
|
|
41
|
-
- [executeSwml](#executeswml)
|
|
42
|
-
- [switchContext](#switchcontext)
|
|
43
|
-
- [swmlChangeStep](#swmlchangestep)
|
|
44
|
-
- [swmlChangeContext](#swmlchangecontext)
|
|
45
|
-
- [swmlUserEvent](#swmluserevent)
|
|
46
|
-
- [Function Control](#function-control)
|
|
47
|
-
- [toggleFunctions](#togglefunctions)
|
|
48
|
-
- [enableFunctionsOnTimeout](#enablefunctionsontimeout)
|
|
49
|
-
- [updateSettings](#updatesettings)
|
|
50
|
-
- [User Input and History](#user-input-and-history)
|
|
51
|
-
- [simulateUserInput](#simulateuserinput)
|
|
52
|
-
- [enableExtensiveData](#enableextensivedata)
|
|
53
|
-
- [replaceInHistory](#replaceinhistory)
|
|
54
|
-
- [Communication](#communication)
|
|
55
|
-
- [sendSms](#sendsms)
|
|
56
|
-
- [recordCall](#recordcall)
|
|
57
|
-
- [stopRecordCall](#stoprecordcall)
|
|
58
|
-
- [tap](#tap)
|
|
59
|
-
- [stopTap](#stoptap)
|
|
60
|
-
- [Rooms and Conferencing](#rooms-and-conferencing)
|
|
61
|
-
- [joinRoom](#joinroom)
|
|
62
|
-
- [sipRefer](#siprefer)
|
|
63
|
-
- [joinConference](#joinconference)
|
|
64
|
-
- [RPC](#rpc)
|
|
65
|
-
- [executeRpc](#executerpc)
|
|
66
|
-
- [rpcDial](#rpcdial)
|
|
67
|
-
- [rpcAiMessage](#rpcaimessage)
|
|
68
|
-
- [rpcAiUnhold](#rpcaiunhold)
|
|
69
|
-
- [Payments](#payments)
|
|
70
|
-
- [pay](#pay)
|
|
71
|
-
- [createPaymentPrompt (static)](#createpaymentprompt-static)
|
|
72
|
-
- [createPaymentAction (static)](#createpaymentaction-static)
|
|
73
|
-
- [createPaymentParameter (static)](#createpaymentparameter-static)
|
|
74
|
-
- [Fluent Chaining](#fluent-chaining)
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
## Overview
|
|
79
|
-
|
|
80
|
-
`FunctionResult` is the return type for SWAIG tool handlers. It carries two pieces of information back to the SignalWire AI engine:
|
|
81
|
-
|
|
82
|
-
1. **Response text** -- A string the AI uses as the tool's output. The AI reads this text and incorporates it into its conversation with the caller.
|
|
83
|
-
2. **Actions** -- An ordered list of structured commands (hangup, connect, play audio, send SMS, etc.) that the platform executes as side effects.
|
|
84
|
-
|
|
85
|
-
When a tool handler runs, it constructs a `FunctionResult`, optionally adds actions, and returns it. The SDK serializes it via `toDict()` and sends it back to SignalWire.
|
|
86
|
-
|
|
87
|
-
### Basic usage
|
|
88
|
-
|
|
89
|
-
```typescript
|
|
90
|
-
import { AgentBase, FunctionResult } from '@signalwire/sdk';
|
|
91
|
-
|
|
92
|
-
const agent = new AgentBase({ name: 'my-agent', basicAuth: ['user', 'pass'] });
|
|
93
|
-
|
|
94
|
-
agent.defineTool({
|
|
95
|
-
name: 'transfer_call',
|
|
96
|
-
description: 'Transfer the caller to a human agent',
|
|
97
|
-
parameters: {},
|
|
98
|
-
handler: () => {
|
|
99
|
-
return new FunctionResult('Transferring you now.')
|
|
100
|
-
.connect('+15551234567');
|
|
101
|
-
},
|
|
102
|
-
});
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
### How serialization works
|
|
106
|
-
|
|
107
|
-
When the handler returns, the SDK calls `toDict()` to produce a plain object:
|
|
108
|
-
|
|
109
|
-
```typescript
|
|
110
|
-
const result = new FunctionResult('Done').hangup();
|
|
111
|
-
console.log(result.toDict());
|
|
112
|
-
// { response: "Done", action: [{ hangup: true }] }
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
If both `response` and `action` are empty, `toDict()` returns `{ response: "Action completed." }` as a fallback so the AI always receives a valid response.
|
|
116
|
-
|
|
117
|
-
### Properties
|
|
118
|
-
|
|
119
|
-
| Property | Type | Description |
|
|
120
|
-
|---------------|-----------------------------|--------------------------------------------------------------|
|
|
121
|
-
| `response` | `string` | Text returned to the AI engine. |
|
|
122
|
-
| `action` | `Record<string, unknown>[]` | Ordered list of action objects to execute. |
|
|
123
|
-
| `postProcess` | `boolean` | When `true`, actions execute after the AI formulates its reply. |
|
|
124
|
-
|
|
125
|
-
---
|
|
126
|
-
|
|
127
|
-
## Core Methods
|
|
128
|
-
|
|
129
|
-
### constructor
|
|
130
|
-
|
|
131
|
-
Create a new `FunctionResult`.
|
|
132
|
-
|
|
133
|
-
```typescript
|
|
134
|
-
constructor(response?: string, postProcess?: boolean)
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
| Parameter | Type | Default | Description |
|
|
138
|
-
|---------------|-----------|---------|------------------------------------------------|
|
|
139
|
-
| `response` | `string` | `''` | Initial response text for the AI. |
|
|
140
|
-
| `postProcess` | `boolean` | `false` | Whether actions should be post-processed. |
|
|
141
|
-
|
|
142
|
-
**Returns:** A new `FunctionResult` instance.
|
|
143
|
-
|
|
144
|
-
```typescript
|
|
145
|
-
// Empty result (will serialize as "Action completed.")
|
|
146
|
-
const r1 = new FunctionResult();
|
|
147
|
-
|
|
148
|
-
// With response text
|
|
149
|
-
const r2 = new FunctionResult('Order placed successfully.');
|
|
150
|
-
|
|
151
|
-
// With post-processing enabled
|
|
152
|
-
const r3 = new FunctionResult('Processing payment...', true);
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
---
|
|
156
|
-
|
|
157
|
-
### setResponse
|
|
158
|
-
|
|
159
|
-
Set or replace the response text.
|
|
160
|
-
|
|
161
|
-
```typescript
|
|
162
|
-
setResponse(response: string): this
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
```typescript
|
|
166
|
-
const result = new FunctionResult()
|
|
167
|
-
.setResponse('Your balance is $42.50');
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
---
|
|
171
|
-
|
|
172
|
-
### setPostProcess
|
|
173
|
-
|
|
174
|
-
Enable or disable post-processing of actions. When enabled, actions execute **after** the AI has formulated its spoken response.
|
|
175
|
-
|
|
176
|
-
```typescript
|
|
177
|
-
setPostProcess(postProcess: boolean): this
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
```typescript
|
|
181
|
-
const result = new FunctionResult('Goodbye!')
|
|
182
|
-
.setPostProcess(true)
|
|
183
|
-
.hangup();
|
|
184
|
-
// The AI says "Goodbye!" first, then the hangup executes.
|
|
185
|
-
```
|
|
186
|
-
|
|
187
|
-
---
|
|
188
|
-
|
|
189
|
-
### addAction
|
|
190
|
-
|
|
191
|
-
Append a single named action to the action list.
|
|
192
|
-
|
|
193
|
-
```typescript
|
|
194
|
-
addAction(name: string, data: unknown): this
|
|
195
|
-
```
|
|
196
|
-
|
|
197
|
-
```typescript
|
|
198
|
-
const result = new FunctionResult('Done')
|
|
199
|
-
.addAction('custom_action', { key: 'value' });
|
|
200
|
-
// action: [{ custom_action: { key: "value" } }]
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
---
|
|
204
|
-
|
|
205
|
-
### addActions
|
|
206
|
-
|
|
207
|
-
Append multiple action objects at once.
|
|
208
|
-
|
|
209
|
-
```typescript
|
|
210
|
-
addActions(actions: Record<string, unknown>[]): this
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
```typescript
|
|
214
|
-
const result = new FunctionResult('Multi-step')
|
|
215
|
-
.addActions([
|
|
216
|
-
{ say: 'Step one complete.' },
|
|
217
|
-
{ say: 'Step two complete.' },
|
|
218
|
-
{ hangup: true },
|
|
219
|
-
]);
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
---
|
|
223
|
-
|
|
224
|
-
### toDict
|
|
225
|
-
|
|
226
|
-
Serialize the result to a plain object for the SWAIG response wire format.
|
|
227
|
-
|
|
228
|
-
```typescript
|
|
229
|
-
toDict(): Record<string, unknown>
|
|
230
|
-
```
|
|
231
|
-
|
|
232
|
-
**Behavior:**
|
|
233
|
-
|
|
234
|
-
- If `response` is non-empty, it is included as `response`.
|
|
235
|
-
- If `action` has entries, they are included as `action`.
|
|
236
|
-
- If `postProcess` is `true` and there are actions, `post_process: true` is included.
|
|
237
|
-
- If both `response` and `action` are empty, the result falls back to `{ response: "Action completed." }`.
|
|
238
|
-
|
|
239
|
-
```typescript
|
|
240
|
-
const result = new FunctionResult('Hello').say('Welcome!');
|
|
241
|
-
console.log(result.toDict());
|
|
242
|
-
// { response: "Hello", action: [{ say: "Welcome!" }] }
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
---
|
|
246
|
-
|
|
247
|
-
## Call Control
|
|
248
|
-
|
|
249
|
-
### connect
|
|
250
|
-
|
|
251
|
-
Connect (transfer) the call to another destination using SWML.
|
|
252
|
-
|
|
253
|
-
```typescript
|
|
254
|
-
connect(destination: string, final?: boolean, fromAddr?: string): this
|
|
255
|
-
```
|
|
256
|
-
|
|
257
|
-
| Parameter | Type | Default | Description |
|
|
258
|
-
|---------------|-----------|---------|----------------------------------------------------------|
|
|
259
|
-
| `destination` | `string` | -- | Phone number or SIP URI to connect to. |
|
|
260
|
-
| `final` | `boolean` | `true` | If `true`, the AI session ends after the transfer. |
|
|
261
|
-
| `fromAddr` | `string` | -- | Optional caller ID for the outbound leg. |
|
|
262
|
-
|
|
263
|
-
```typescript
|
|
264
|
-
// Simple transfer
|
|
265
|
-
const result = new FunctionResult('Connecting you to support.')
|
|
266
|
-
.connect('+15559876543');
|
|
267
|
-
|
|
268
|
-
// Transfer with custom caller ID, non-final
|
|
269
|
-
const result2 = new FunctionResult('Warm transfer initiated.')
|
|
270
|
-
.connect('sip:support@company.com', false, '+15551234567');
|
|
271
|
-
```
|
|
272
|
-
|
|
273
|
-
---
|
|
274
|
-
|
|
275
|
-
### swmlTransfer
|
|
276
|
-
|
|
277
|
-
Transfer the call using a complete SWML document.
|
|
278
|
-
|
|
279
|
-
```typescript
|
|
280
|
-
swmlTransfer(swml: string | Record<string, unknown>): this
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
```typescript
|
|
284
|
-
const swmlDoc = {
|
|
285
|
-
version: '1.0.0',
|
|
286
|
-
sections: { main: [{ connect: { to: '+15559876543' } }] },
|
|
287
|
-
};
|
|
288
|
-
const result = new FunctionResult('Transferring.').swmlTransfer(swmlDoc);
|
|
289
|
-
```
|
|
290
|
-
|
|
291
|
-
---
|
|
292
|
-
|
|
293
|
-
### hangup
|
|
294
|
-
|
|
295
|
-
Hang up the call.
|
|
296
|
-
|
|
297
|
-
```typescript
|
|
298
|
-
hangup(): this
|
|
299
|
-
```
|
|
300
|
-
|
|
301
|
-
```typescript
|
|
302
|
-
const result = new FunctionResult('Goodbye!').hangup();
|
|
303
|
-
// action: [{ hangup: true }]
|
|
304
|
-
```
|
|
305
|
-
|
|
306
|
-
---
|
|
307
|
-
|
|
308
|
-
### hold
|
|
309
|
-
|
|
310
|
-
Place the call on hold.
|
|
311
|
-
|
|
312
|
-
```typescript
|
|
313
|
-
hold(timeout?: number): this
|
|
314
|
-
```
|
|
315
|
-
|
|
316
|
-
| Parameter | Type | Default | Description |
|
|
317
|
-
|-----------|----------|---------|---------------------------------------|
|
|
318
|
-
| `timeout` | `number` | -- | Hold duration in seconds (0-900). |
|
|
319
|
-
|
|
320
|
-
```typescript
|
|
321
|
-
const result = new FunctionResult('Please hold.')
|
|
322
|
-
.hold(60);
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
---
|
|
326
|
-
|
|
327
|
-
### waitForUser
|
|
328
|
-
|
|
329
|
-
Wait for user input before continuing the AI conversation.
|
|
330
|
-
|
|
331
|
-
```typescript
|
|
332
|
-
waitForUser(opts?: Record<string, unknown>): this
|
|
333
|
-
```
|
|
334
|
-
|
|
335
|
-
```typescript
|
|
336
|
-
const result = new FunctionResult('Take your time, I am here when you are ready.')
|
|
337
|
-
.waitForUser();
|
|
338
|
-
```
|
|
339
|
-
|
|
340
|
-
---
|
|
341
|
-
|
|
342
|
-
### stop
|
|
343
|
-
|
|
344
|
-
Stop the AI session.
|
|
345
|
-
|
|
346
|
-
```typescript
|
|
347
|
-
stop(): this
|
|
348
|
-
```
|
|
349
|
-
|
|
350
|
-
```typescript
|
|
351
|
-
const result = new FunctionResult('Session ending.').stop();
|
|
352
|
-
```
|
|
353
|
-
|
|
354
|
-
---
|
|
355
|
-
|
|
356
|
-
## Audio
|
|
357
|
-
|
|
358
|
-
### say
|
|
359
|
-
|
|
360
|
-
Speak text via TTS.
|
|
361
|
-
|
|
362
|
-
```typescript
|
|
363
|
-
say(text: string): this
|
|
364
|
-
```
|
|
365
|
-
|
|
366
|
-
```typescript
|
|
367
|
-
const result = new FunctionResult('Processing.')
|
|
368
|
-
.say('Your request has been submitted.');
|
|
369
|
-
```
|
|
370
|
-
|
|
371
|
-
---
|
|
372
|
-
|
|
373
|
-
### playBackgroundFile
|
|
374
|
-
|
|
375
|
-
Play an audio file in the background during the call.
|
|
376
|
-
|
|
377
|
-
```typescript
|
|
378
|
-
playBackgroundFile(url: string, wait?: boolean): this
|
|
379
|
-
```
|
|
380
|
-
|
|
381
|
-
```typescript
|
|
382
|
-
const result = new FunctionResult('Playing music.')
|
|
383
|
-
.playBackgroundFile('https://cdn.example.com/hold-music.mp3');
|
|
384
|
-
```
|
|
385
|
-
|
|
386
|
-
---
|
|
387
|
-
|
|
388
|
-
### stopBackgroundFile
|
|
389
|
-
|
|
390
|
-
Stop the currently playing background audio.
|
|
391
|
-
|
|
392
|
-
```typescript
|
|
393
|
-
stopBackgroundFile(): this
|
|
394
|
-
```
|
|
395
|
-
|
|
396
|
-
```typescript
|
|
397
|
-
const result = new FunctionResult('Music stopped.')
|
|
398
|
-
.stopBackgroundFile();
|
|
399
|
-
```
|
|
400
|
-
|
|
401
|
-
---
|
|
402
|
-
|
|
403
|
-
## Speech
|
|
404
|
-
|
|
405
|
-
### addDynamicHints
|
|
406
|
-
|
|
407
|
-
Add speech recognition hints at runtime.
|
|
408
|
-
|
|
409
|
-
```typescript
|
|
410
|
-
addDynamicHints(hints: string[]): this
|
|
411
|
-
```
|
|
412
|
-
|
|
413
|
-
```typescript
|
|
414
|
-
const result = new FunctionResult('I see you mentioned ACME Corp.')
|
|
415
|
-
.addDynamicHints(['ACME', 'Widget Pro', 'Widget Basic']);
|
|
416
|
-
```
|
|
417
|
-
|
|
418
|
-
---
|
|
419
|
-
|
|
420
|
-
### clearDynamicHints
|
|
421
|
-
|
|
422
|
-
Remove all dynamic speech hints.
|
|
423
|
-
|
|
424
|
-
```typescript
|
|
425
|
-
clearDynamicHints(): this
|
|
426
|
-
```
|
|
427
|
-
|
|
428
|
-
---
|
|
429
|
-
|
|
430
|
-
### setEndOfSpeechTimeout
|
|
431
|
-
|
|
432
|
-
Set the end-of-speech timeout in milliseconds.
|
|
433
|
-
|
|
434
|
-
```typescript
|
|
435
|
-
setEndOfSpeechTimeout(ms: number): this
|
|
436
|
-
```
|
|
437
|
-
|
|
438
|
-
---
|
|
439
|
-
|
|
440
|
-
### setSpeechEventTimeout
|
|
441
|
-
|
|
442
|
-
Set the speech event timeout in milliseconds.
|
|
443
|
-
|
|
444
|
-
```typescript
|
|
445
|
-
setSpeechEventTimeout(ms: number): this
|
|
446
|
-
```
|
|
447
|
-
|
|
448
|
-
---
|
|
449
|
-
|
|
450
|
-
## Data Management
|
|
451
|
-
|
|
452
|
-
### updateGlobalData
|
|
453
|
-
|
|
454
|
-
Merge key-value pairs into the shared global data store.
|
|
455
|
-
|
|
456
|
-
```typescript
|
|
457
|
-
updateGlobalData(data: Record<string, unknown>): this
|
|
458
|
-
```
|
|
459
|
-
|
|
460
|
-
```typescript
|
|
461
|
-
const result = new FunctionResult('Account verified.')
|
|
462
|
-
.updateGlobalData({ verified: true, customer_id: '12345' });
|
|
463
|
-
// action: [{ set_global_data: { verified: true, customer_id: "12345" } }]
|
|
464
|
-
```
|
|
465
|
-
|
|
466
|
-
---
|
|
467
|
-
|
|
468
|
-
### removeGlobalData
|
|
469
|
-
|
|
470
|
-
Remove keys from the global data store.
|
|
471
|
-
|
|
472
|
-
```typescript
|
|
473
|
-
removeGlobalData(keys: string[]): this
|
|
474
|
-
```
|
|
475
|
-
|
|
476
|
-
```typescript
|
|
477
|
-
const result = new FunctionResult('Cleared.')
|
|
478
|
-
.removeGlobalData(['temp_token', 'session_flag']);
|
|
479
|
-
```
|
|
480
|
-
|
|
481
|
-
---
|
|
482
|
-
|
|
483
|
-
### setMetadata
|
|
484
|
-
|
|
485
|
-
Set call metadata.
|
|
486
|
-
|
|
487
|
-
```typescript
|
|
488
|
-
setMetadata(data: Record<string, unknown>): this
|
|
489
|
-
```
|
|
490
|
-
|
|
491
|
-
```typescript
|
|
492
|
-
const result = new FunctionResult('Metadata set.')
|
|
493
|
-
.setMetadata({ category: 'billing', priority: 'high' });
|
|
494
|
-
```
|
|
495
|
-
|
|
496
|
-
---
|
|
497
|
-
|
|
498
|
-
### removeMetadata
|
|
499
|
-
|
|
500
|
-
Remove keys from call metadata.
|
|
501
|
-
|
|
502
|
-
```typescript
|
|
503
|
-
removeMetadata(keys: string[]): this
|
|
504
|
-
```
|
|
505
|
-
|
|
506
|
-
---
|
|
507
|
-
|
|
508
|
-
## SWML Actions
|
|
509
|
-
|
|
510
|
-
### executeSwml
|
|
511
|
-
|
|
512
|
-
Execute arbitrary SWML content.
|
|
513
|
-
|
|
514
|
-
```typescript
|
|
515
|
-
executeSwml(swml: string | Record<string, unknown>, transfer?: boolean): this
|
|
516
|
-
```
|
|
517
|
-
|
|
518
|
-
```typescript
|
|
519
|
-
// Execute SWML as a string
|
|
520
|
-
const result = new FunctionResult('Executing.')
|
|
521
|
-
.executeSwml('{"version":"1.0.0","sections":{"main":[{"say":"Hello"}]}}');
|
|
522
|
-
|
|
523
|
-
// Execute SWML as an object
|
|
524
|
-
const swmlDoc = { version: '1.0.0', sections: { main: [{ say: 'Hello' }] } };
|
|
525
|
-
const result2 = new FunctionResult('Executing.').executeSwml(swmlDoc, true);
|
|
526
|
-
```
|
|
527
|
-
|
|
528
|
-
---
|
|
529
|
-
|
|
530
|
-
### switchContext
|
|
531
|
-
|
|
532
|
-
Switch the AI context with optional prompt changes.
|
|
533
|
-
|
|
534
|
-
```typescript
|
|
535
|
-
switchContext(opts: Record<string, unknown>): this
|
|
536
|
-
```
|
|
537
|
-
|
|
538
|
-
```typescript
|
|
539
|
-
const result = new FunctionResult('Switching to billing.')
|
|
540
|
-
.switchContext({
|
|
541
|
-
systemPrompt: 'You are now a billing specialist.',
|
|
542
|
-
context: 'billing',
|
|
543
|
-
});
|
|
544
|
-
```
|
|
545
|
-
|
|
546
|
-
---
|
|
547
|
-
|
|
548
|
-
### swmlChangeStep
|
|
549
|
-
|
|
550
|
-
Navigate to a specific step within the current context.
|
|
551
|
-
|
|
552
|
-
```typescript
|
|
553
|
-
swmlChangeStep(step: string): this
|
|
554
|
-
```
|
|
555
|
-
|
|
556
|
-
```typescript
|
|
557
|
-
const result = new FunctionResult('Moving to verification.')
|
|
558
|
-
.swmlChangeStep('verify_identity');
|
|
559
|
-
```
|
|
560
|
-
|
|
561
|
-
---
|
|
562
|
-
|
|
563
|
-
### swmlChangeContext
|
|
564
|
-
|
|
565
|
-
Navigate to a different context, optionally starting at a specific step.
|
|
566
|
-
|
|
567
|
-
```typescript
|
|
568
|
-
swmlChangeContext(context: string, step?: string): this
|
|
569
|
-
```
|
|
570
|
-
|
|
571
|
-
```typescript
|
|
572
|
-
const result = new FunctionResult('Transferring to support.')
|
|
573
|
-
.swmlChangeContext('support', 'initial_triage');
|
|
574
|
-
```
|
|
575
|
-
|
|
576
|
-
---
|
|
577
|
-
|
|
578
|
-
### swmlUserEvent
|
|
579
|
-
|
|
580
|
-
Fire a user event.
|
|
581
|
-
|
|
582
|
-
```typescript
|
|
583
|
-
swmlUserEvent(event: Record<string, unknown>): this
|
|
584
|
-
```
|
|
585
|
-
|
|
586
|
-
---
|
|
587
|
-
|
|
588
|
-
## Function Control
|
|
589
|
-
|
|
590
|
-
### toggleFunctions
|
|
591
|
-
|
|
592
|
-
Enable or disable specific SWAIG functions.
|
|
593
|
-
|
|
594
|
-
```typescript
|
|
595
|
-
toggleFunctions(toggles: Record<string, boolean>): this
|
|
596
|
-
```
|
|
597
|
-
|
|
598
|
-
```typescript
|
|
599
|
-
const result = new FunctionResult('Payment mode activated.')
|
|
600
|
-
.toggleFunctions({
|
|
601
|
-
process_payment: true,
|
|
602
|
-
browse_products: false,
|
|
603
|
-
});
|
|
604
|
-
// action: [{ toggle_functions: [{ function: "process_payment", active: true }, ...] }]
|
|
605
|
-
```
|
|
606
|
-
|
|
607
|
-
---
|
|
608
|
-
|
|
609
|
-
### enableFunctionsOnTimeout
|
|
610
|
-
|
|
611
|
-
Re-enable functions after a specified timeout.
|
|
612
|
-
|
|
613
|
-
```typescript
|
|
614
|
-
enableFunctionsOnTimeout(functions: string[], timeout: number): this
|
|
615
|
-
```
|
|
616
|
-
|
|
617
|
-
---
|
|
618
|
-
|
|
619
|
-
### updateSettings
|
|
620
|
-
|
|
621
|
-
Update AI settings dynamically.
|
|
622
|
-
|
|
623
|
-
```typescript
|
|
624
|
-
updateSettings(settings: Record<string, unknown>): this
|
|
625
|
-
```
|
|
626
|
-
|
|
627
|
-
---
|
|
628
|
-
|
|
629
|
-
## User Input and History
|
|
630
|
-
|
|
631
|
-
### simulateUserInput
|
|
632
|
-
|
|
633
|
-
Inject simulated user input into the conversation.
|
|
634
|
-
|
|
635
|
-
```typescript
|
|
636
|
-
simulateUserInput(text: string): this
|
|
637
|
-
```
|
|
638
|
-
|
|
639
|
-
---
|
|
640
|
-
|
|
641
|
-
### enableExtensiveData
|
|
642
|
-
|
|
643
|
-
Enable extensive data in the SWAIG request payload.
|
|
644
|
-
|
|
645
|
-
```typescript
|
|
646
|
-
enableExtensiveData(): this
|
|
647
|
-
```
|
|
648
|
-
|
|
649
|
-
---
|
|
650
|
-
|
|
651
|
-
### replaceInHistory
|
|
652
|
-
|
|
653
|
-
Replace text in the conversation history.
|
|
654
|
-
|
|
655
|
-
```typescript
|
|
656
|
-
replaceInHistory(search: string, replace: string): this
|
|
657
|
-
```
|
|
658
|
-
|
|
659
|
-
---
|
|
660
|
-
|
|
661
|
-
## Communication
|
|
662
|
-
|
|
663
|
-
### sendSms
|
|
664
|
-
|
|
665
|
-
Send an SMS or MMS message.
|
|
666
|
-
|
|
667
|
-
```typescript
|
|
668
|
-
sendSms(opts: { to: string; from: string; body: string; media?: string[] }): this
|
|
669
|
-
```
|
|
670
|
-
|
|
671
|
-
```typescript
|
|
672
|
-
const result = new FunctionResult('SMS sent.')
|
|
673
|
-
.sendSms({
|
|
674
|
-
to: '+15551234567',
|
|
675
|
-
from: '+15559876543',
|
|
676
|
-
body: 'Your appointment is confirmed for tomorrow at 2pm.',
|
|
677
|
-
});
|
|
678
|
-
```
|
|
679
|
-
|
|
680
|
-
---
|
|
681
|
-
|
|
682
|
-
### recordCall
|
|
683
|
-
|
|
684
|
-
Start recording the call.
|
|
685
|
-
|
|
686
|
-
```typescript
|
|
687
|
-
recordCall(opts?: { format?: string; stereo?: boolean }): this
|
|
688
|
-
```
|
|
689
|
-
|
|
690
|
-
```typescript
|
|
691
|
-
const result = new FunctionResult('Recording started.')
|
|
692
|
-
.recordCall({ format: 'mp4', stereo: true });
|
|
693
|
-
```
|
|
694
|
-
|
|
695
|
-
---
|
|
696
|
-
|
|
697
|
-
### stopRecordCall
|
|
698
|
-
|
|
699
|
-
Stop an active call recording.
|
|
700
|
-
|
|
701
|
-
```typescript
|
|
702
|
-
stopRecordCall(): this
|
|
703
|
-
```
|
|
704
|
-
|
|
705
|
-
---
|
|
706
|
-
|
|
707
|
-
### tap
|
|
708
|
-
|
|
709
|
-
Start call tapping (media stream).
|
|
710
|
-
|
|
711
|
-
```typescript
|
|
712
|
-
tap(opts: Record<string, unknown>): this
|
|
713
|
-
```
|
|
714
|
-
|
|
715
|
-
```typescript
|
|
716
|
-
const result = new FunctionResult('Tapping started.')
|
|
717
|
-
.tap({
|
|
718
|
-
uri: 'wss://analytics.example.com/stream',
|
|
719
|
-
direction: 'both',
|
|
720
|
-
});
|
|
721
|
-
```
|
|
722
|
-
|
|
723
|
-
---
|
|
724
|
-
|
|
725
|
-
### stopTap
|
|
726
|
-
|
|
727
|
-
Stop call tapping.
|
|
728
|
-
|
|
729
|
-
```typescript
|
|
730
|
-
stopTap(): this
|
|
731
|
-
```
|
|
732
|
-
|
|
733
|
-
---
|
|
734
|
-
|
|
735
|
-
## Rooms and Conferencing
|
|
736
|
-
|
|
737
|
-
### joinRoom
|
|
738
|
-
|
|
739
|
-
Join a video room.
|
|
740
|
-
|
|
741
|
-
```typescript
|
|
742
|
-
joinRoom(opts: Record<string, unknown>): this
|
|
743
|
-
```
|
|
744
|
-
|
|
745
|
-
```typescript
|
|
746
|
-
const result = new FunctionResult('Joining room.')
|
|
747
|
-
.joinRoom({ name: 'meeting-room-1' });
|
|
748
|
-
```
|
|
749
|
-
|
|
750
|
-
---
|
|
751
|
-
|
|
752
|
-
### sipRefer
|
|
753
|
-
|
|
754
|
-
Perform a SIP REFER transfer.
|
|
755
|
-
|
|
756
|
-
```typescript
|
|
757
|
-
sipRefer(to: string): this
|
|
758
|
-
```
|
|
759
|
-
|
|
760
|
-
---
|
|
761
|
-
|
|
762
|
-
### joinConference
|
|
763
|
-
|
|
764
|
-
Join a conference.
|
|
765
|
-
|
|
766
|
-
```typescript
|
|
767
|
-
joinConference(opts: Record<string, unknown>): this
|
|
768
|
-
```
|
|
769
|
-
|
|
770
|
-
```typescript
|
|
771
|
-
const result = new FunctionResult('Joining conference.')
|
|
772
|
-
.joinConference({ name: 'team-standup' });
|
|
773
|
-
```
|
|
774
|
-
|
|
775
|
-
---
|
|
776
|
-
|
|
777
|
-
## RPC
|
|
778
|
-
|
|
779
|
-
### executeRpc
|
|
780
|
-
|
|
781
|
-
Execute a JSON-RPC method call.
|
|
782
|
-
|
|
783
|
-
```typescript
|
|
784
|
-
executeRpc(method: string, params?: Record<string, unknown>): this
|
|
785
|
-
```
|
|
786
|
-
|
|
787
|
-
---
|
|
788
|
-
|
|
789
|
-
### rpcDial
|
|
790
|
-
|
|
791
|
-
RPC-based dialing.
|
|
792
|
-
|
|
793
|
-
```typescript
|
|
794
|
-
rpcDial(opts: Record<string, unknown>): this
|
|
795
|
-
```
|
|
796
|
-
|
|
797
|
-
---
|
|
798
|
-
|
|
799
|
-
### rpcAiMessage
|
|
800
|
-
|
|
801
|
-
Inject an AI message via RPC.
|
|
802
|
-
|
|
803
|
-
```typescript
|
|
804
|
-
rpcAiMessage(message: string): this
|
|
805
|
-
```
|
|
806
|
-
|
|
807
|
-
---
|
|
808
|
-
|
|
809
|
-
### rpcAiUnhold
|
|
810
|
-
|
|
811
|
-
Unhold the call via RPC.
|
|
812
|
-
|
|
813
|
-
```typescript
|
|
814
|
-
rpcAiUnhold(): this
|
|
815
|
-
```
|
|
816
|
-
|
|
817
|
-
---
|
|
818
|
-
|
|
819
|
-
## Payments
|
|
820
|
-
|
|
821
|
-
### pay
|
|
822
|
-
|
|
823
|
-
Initiate a payment collection flow.
|
|
824
|
-
|
|
825
|
-
```typescript
|
|
826
|
-
pay(opts: Record<string, unknown>): this
|
|
827
|
-
```
|
|
828
|
-
|
|
829
|
-
```typescript
|
|
830
|
-
const result = new FunctionResult('Starting payment.')
|
|
831
|
-
.pay({
|
|
832
|
-
prompts: FunctionResult.createPaymentPrompt({
|
|
833
|
-
cardNumber: 'Please enter your card number.',
|
|
834
|
-
expirationDate: 'What is the expiration date?',
|
|
835
|
-
securityCode: 'What is the CVV?',
|
|
836
|
-
}),
|
|
837
|
-
action: FunctionResult.createPaymentAction({
|
|
838
|
-
url: 'https://payments.example.com/charge',
|
|
839
|
-
method: 'POST',
|
|
840
|
-
}),
|
|
841
|
-
parameters: FunctionResult.createPaymentParameter({
|
|
842
|
-
currency: 'USD',
|
|
843
|
-
amount: 99.99,
|
|
844
|
-
}),
|
|
845
|
-
});
|
|
846
|
-
```
|
|
847
|
-
|
|
848
|
-
---
|
|
849
|
-
|
|
850
|
-
### createPaymentPrompt (static)
|
|
851
|
-
|
|
852
|
-
Create a payment prompt configuration object.
|
|
853
|
-
|
|
854
|
-
```typescript
|
|
855
|
-
static createPaymentPrompt(opts: PaymentPrompt): string
|
|
856
|
-
```
|
|
857
|
-
|
|
858
|
-
---
|
|
859
|
-
|
|
860
|
-
### createPaymentAction (static)
|
|
861
|
-
|
|
862
|
-
Create a payment action configuration object.
|
|
863
|
-
|
|
864
|
-
```typescript
|
|
865
|
-
static createPaymentAction(opts: PaymentAction): Record<string, unknown>
|
|
866
|
-
```
|
|
867
|
-
|
|
868
|
-
---
|
|
869
|
-
|
|
870
|
-
### createPaymentParameter (static)
|
|
871
|
-
|
|
872
|
-
Create a payment parameter configuration object.
|
|
873
|
-
|
|
874
|
-
```typescript
|
|
875
|
-
static createPaymentParameter(opts: PaymentParameter): Record<string, unknown>
|
|
876
|
-
```
|
|
877
|
-
|
|
878
|
-
---
|
|
879
|
-
|
|
880
|
-
## Fluent Chaining
|
|
881
|
-
|
|
882
|
-
All action methods return `this`, enabling method chaining:
|
|
883
|
-
|
|
884
|
-
```typescript
|
|
885
|
-
const result = new FunctionResult('Processing your request.')
|
|
886
|
-
.updateGlobalData({ step: 'payment' })
|
|
887
|
-
.toggleFunctions({ browse_products: false, process_payment: true })
|
|
888
|
-
.say('I am now processing your payment.')
|
|
889
|
-
.setPostProcess(true);
|
|
890
|
-
```
|
|
891
|
-
|
|
892
|
-
Actions are serialized in the order they are added. The platform executes them sequentially.
|
|
893
|
-
|
|
894
|
-
```typescript
|
|
895
|
-
// This results in: say first, then hangup
|
|
896
|
-
const result = new FunctionResult('Goodbye!')
|
|
897
|
-
.say('Thank you for calling.')
|
|
898
|
-
.setPostProcess(true)
|
|
899
|
-
.hangup();
|
|
900
|
-
|
|
901
|
-
console.log(result.toDict());
|
|
902
|
-
// {
|
|
903
|
-
// response: "Goodbye!",
|
|
904
|
-
// action: [
|
|
905
|
-
// { say: "Thank you for calling." },
|
|
906
|
-
// { hangup: true }
|
|
907
|
-
// ],
|
|
908
|
-
// post_process: true
|
|
909
|
-
// }
|
|
910
|
-
```
|