@signalwire/sdk 2.0.1 → 2.0.2
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 +1019 -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
|
@@ -1,474 +0,0 @@
|
|
|
1
|
-
# Call Methods Reference
|
|
2
|
-
|
|
3
|
-
A `Call` object represents a live phone call. You get one from `@client.on_call` (inbound) or `client.dial()` (outbound).
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
| Property | Type | Description |
|
|
8
|
-
|----------|------|-------------|
|
|
9
|
-
| `call_id` | `str` | Unique call identifier |
|
|
10
|
-
| `node_id` | `str` | Server node handling the call |
|
|
11
|
-
| `state` | `str` | Current state: `created`, `ringing`, `answered`, `ending`, `ended` |
|
|
12
|
-
| `direction` | `str` | `inbound` or `outbound` |
|
|
13
|
-
| `tag` | `str` | Correlation tag |
|
|
14
|
-
| `device` | `dict` | Device info (type, params) |
|
|
15
|
-
| `segment_id` | `str` | Segment identifier |
|
|
16
|
-
|
|
17
|
-
## Actions: Blocking vs Fire-and-Forget
|
|
18
|
-
|
|
19
|
-
Methods like `play()`, `record()`, `detect()`, etc. return **Action** objects. The `await call.play(...)` itself only waits for the server to accept the command — the actual operation runs asynchronously on the server. You choose how to handle completion:
|
|
20
|
-
|
|
21
|
-
### Wait inline (blocking)
|
|
22
|
-
|
|
23
|
-
```python
|
|
24
|
-
action = await call.play([{"type": "tts", "params": {"text": "Hello"}}])
|
|
25
|
-
await action.wait() # blocks until playback finishes
|
|
26
|
-
# execution continues only after play is done
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
### Fire and forget (background)
|
|
30
|
-
|
|
31
|
-
```python
|
|
32
|
-
action = await call.play([{"type": "tts", "params": {"text": "Hello"}}])
|
|
33
|
-
# don't call action.wait() — continue immediately while audio plays
|
|
34
|
-
await call.send_digits("1234")
|
|
35
|
-
|
|
36
|
-
# check later if needed
|
|
37
|
-
if action.is_done:
|
|
38
|
-
print(f"Play result: {action.result}")
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Fire with callback
|
|
42
|
-
|
|
43
|
-
```python
|
|
44
|
-
# Sync callback
|
|
45
|
-
action = await call.play(
|
|
46
|
-
[{"type": "tts", "params": {"text": "Hello"}}],
|
|
47
|
-
on_completed=lambda event: print(f"Done: {event.params}"),
|
|
48
|
-
)
|
|
49
|
-
# continues immediately; callback fires when playback finishes
|
|
50
|
-
|
|
51
|
-
# Async callback
|
|
52
|
-
async def on_recording_done(event):
|
|
53
|
-
print(f"Recording URL: {event.params.get('url')}")
|
|
54
|
-
await call.hangup()
|
|
55
|
-
|
|
56
|
-
action = await call.record(on_completed=on_recording_done)
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
The `on_completed` callback is available on all action-based methods: `play`, `record`, `play_and_collect`, `collect`, `detect`, `pay`, `send_fax`, `receive_fax`, `tap`, `stream`, `transcribe`, and `ai`. It accepts both sync and async functions. Errors in callbacks are caught and logged, never crash the event loop. The callback also fires when the call is gone (404/410).
|
|
60
|
-
|
|
61
|
-
### Action methods summary
|
|
62
|
-
|
|
63
|
-
| Method | Returns |
|
|
64
|
-
|--------|---------|
|
|
65
|
-
| `action.wait(timeout=None)` | Blocks until the action completes, returns the terminal `RelayEvent` |
|
|
66
|
-
| `action.is_done` | `True` if the action has completed |
|
|
67
|
-
| `action.result` | The terminal `RelayEvent` (or `None` if not done) |
|
|
68
|
-
| `action.completed` | `True` if the action reached a terminal state |
|
|
69
|
-
| `action.stop()` | Stop the operation on the server |
|
|
70
|
-
|
|
71
|
-
Some actions also have `pause()`, `resume()`, and `volume()`.
|
|
72
|
-
|
|
73
|
-
## Lifecycle
|
|
74
|
-
|
|
75
|
-
### `answer(**kwargs) -> dict`
|
|
76
|
-
|
|
77
|
-
Answer an inbound call.
|
|
78
|
-
|
|
79
|
-
```python
|
|
80
|
-
await call.answer()
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
### `hangup(reason="hangup") -> dict`
|
|
84
|
-
|
|
85
|
-
End the call.
|
|
86
|
-
|
|
87
|
-
```python
|
|
88
|
-
await call.hangup()
|
|
89
|
-
await call.hangup(reason="busy")
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### `pass_() -> dict`
|
|
93
|
-
|
|
94
|
-
Decline control, returning the call to routing.
|
|
95
|
-
|
|
96
|
-
```python
|
|
97
|
-
await call.pass_()
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
## Audio Playback
|
|
101
|
-
|
|
102
|
-
### `play(media, *, volume=None, direction=None, loop=None, control_id=None) -> PlayAction`
|
|
103
|
-
|
|
104
|
-
Play audio. Returns a `PlayAction` with `stop()`, `pause()`, `resume()`, `volume()`, and `wait()`.
|
|
105
|
-
|
|
106
|
-
```python
|
|
107
|
-
# TTS
|
|
108
|
-
action = await call.play([{"type": "tts", "params": {"text": "Hello!"}}])
|
|
109
|
-
await action.wait()
|
|
110
|
-
|
|
111
|
-
# Audio file
|
|
112
|
-
action = await call.play([{"type": "audio", "params": {"url": "https://example.com/sound.mp3"}}])
|
|
113
|
-
|
|
114
|
-
# Silence
|
|
115
|
-
action = await call.play([{"type": "silence", "params": {"duration": 2}}])
|
|
116
|
-
|
|
117
|
-
# Ringtone
|
|
118
|
-
action = await call.play([{"type": "ringtone", "params": {"name": "us"}}])
|
|
119
|
-
|
|
120
|
-
# Control playback
|
|
121
|
-
await action.pause()
|
|
122
|
-
await action.resume()
|
|
123
|
-
await action.volume(-3.0)
|
|
124
|
-
await action.stop()
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
## Recording
|
|
128
|
-
|
|
129
|
-
### `record(audio=None, *, control_id=None) -> RecordAction`
|
|
130
|
-
|
|
131
|
-
Record the call. Returns a `RecordAction` with `stop()`, `pause()`, `resume()`, and `wait()`.
|
|
132
|
-
|
|
133
|
-
```python
|
|
134
|
-
action = await call.record(audio={"format": "wav", "stereo": True, "direction": "both"})
|
|
135
|
-
# ... later ...
|
|
136
|
-
await action.stop()
|
|
137
|
-
event = await action.wait()
|
|
138
|
-
print(f"Recording URL: {event.params.get('url')}")
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
## Input Collection
|
|
142
|
-
|
|
143
|
-
### `play_and_collect(media, collect, *, volume=None, control_id=None) -> CollectAction`
|
|
144
|
-
|
|
145
|
-
Play audio and collect DTMF or speech input. Returns a `CollectAction`.
|
|
146
|
-
|
|
147
|
-
```python
|
|
148
|
-
action = await call.play_and_collect(
|
|
149
|
-
[{"type": "tts", "params": {"text": "Press 1 for sales, 2 for support."}}],
|
|
150
|
-
{"digits": {"max": 1, "digit_timeout": 5.0}},
|
|
151
|
-
)
|
|
152
|
-
event = await action.wait()
|
|
153
|
-
digit = event.params.get("result", {}).get("params", {}).get("digits", "")
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
### `collect(*, digits=None, speech=None, ..., control_id=None) -> StandaloneCollectAction`
|
|
157
|
-
|
|
158
|
-
Collect input without playing audio.
|
|
159
|
-
|
|
160
|
-
```python
|
|
161
|
-
action = await call.collect(
|
|
162
|
-
digits={"max": 4, "terminators": "#"},
|
|
163
|
-
speech={"language": "en-US"},
|
|
164
|
-
partial_results=True,
|
|
165
|
-
)
|
|
166
|
-
event = await action.wait()
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
## Bridging
|
|
170
|
-
|
|
171
|
-
### `connect(devices, *, ringback=None, tag=None, max_duration=None, max_price_per_minute=None, status_url=None) -> dict`
|
|
172
|
-
|
|
173
|
-
Bridge the call to another destination.
|
|
174
|
-
|
|
175
|
-
```python
|
|
176
|
-
await call.connect(
|
|
177
|
-
[[{"type": "phone", "params": {"to_number": "+15551234567", "from_number": "+15559876543"}}]],
|
|
178
|
-
ringback=[{"type": "ringtone", "params": {"name": "us"}}],
|
|
179
|
-
)
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
### `disconnect() -> dict`
|
|
183
|
-
|
|
184
|
-
Unbridge a connected call.
|
|
185
|
-
|
|
186
|
-
```python
|
|
187
|
-
await call.disconnect()
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
## DTMF
|
|
191
|
-
|
|
192
|
-
### `send_digits(digits, *, control_id=None) -> dict`
|
|
193
|
-
|
|
194
|
-
Send DTMF tones.
|
|
195
|
-
|
|
196
|
-
```python
|
|
197
|
-
await call.send_digits("1234#")
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
## Detection
|
|
201
|
-
|
|
202
|
-
### `detect(detect, *, timeout=None, control_id=None) -> DetectAction`
|
|
203
|
-
|
|
204
|
-
Detect machine, fax, or digits.
|
|
205
|
-
|
|
206
|
-
```python
|
|
207
|
-
action = await call.detect({"type": "machine"}, timeout=30.0)
|
|
208
|
-
event = await action.wait()
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
## SIP Refer
|
|
212
|
-
|
|
213
|
-
### `refer(device, *, status_url=None) -> dict`
|
|
214
|
-
|
|
215
|
-
Transfer via SIP REFER.
|
|
216
|
-
|
|
217
|
-
```python
|
|
218
|
-
await call.refer({"type": "sip", "params": {"to": "sip:user@example.com"}})
|
|
219
|
-
```
|
|
220
|
-
|
|
221
|
-
## Transfer
|
|
222
|
-
|
|
223
|
-
### `transfer(dest) -> dict`
|
|
224
|
-
|
|
225
|
-
Transfer call control to another RELAY app or SWML script.
|
|
226
|
-
|
|
227
|
-
```python
|
|
228
|
-
await call.transfer("https://example.com/swml-endpoint")
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
## Fax
|
|
232
|
-
|
|
233
|
-
### `send_fax(document, *, identity=None, header_info=None, control_id=None) -> FaxAction`
|
|
234
|
-
|
|
235
|
-
```python
|
|
236
|
-
action = await call.send_fax("https://example.com/document.pdf", identity="+15551234567")
|
|
237
|
-
event = await action.wait()
|
|
238
|
-
```
|
|
239
|
-
|
|
240
|
-
### `receive_fax(*, control_id=None) -> FaxAction`
|
|
241
|
-
|
|
242
|
-
```python
|
|
243
|
-
action = await call.receive_fax()
|
|
244
|
-
event = await action.wait()
|
|
245
|
-
```
|
|
246
|
-
|
|
247
|
-
## Tap (Media Interception)
|
|
248
|
-
|
|
249
|
-
### `tap(tap, device, *, control_id=None) -> TapAction`
|
|
250
|
-
|
|
251
|
-
Intercept call media and stream to an RTP endpoint.
|
|
252
|
-
|
|
253
|
-
```python
|
|
254
|
-
action = await call.tap(
|
|
255
|
-
{"type": "audio", "params": {"direction": "both"}},
|
|
256
|
-
{"type": "rtp", "params": {"addr": "192.168.1.100", "port": 5000}},
|
|
257
|
-
)
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
## Streaming
|
|
261
|
-
|
|
262
|
-
### `stream(url, *, name=None, codec=None, track=None, control_id=None, ...) -> StreamAction`
|
|
263
|
-
|
|
264
|
-
Stream call audio to a WebSocket endpoint.
|
|
265
|
-
|
|
266
|
-
```python
|
|
267
|
-
action = await call.stream(
|
|
268
|
-
"wss://example.com/audio",
|
|
269
|
-
name="my_stream",
|
|
270
|
-
codec="PCMU",
|
|
271
|
-
track="inbound_track",
|
|
272
|
-
)
|
|
273
|
-
# Stop streaming
|
|
274
|
-
await action.stop()
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
## Payment
|
|
278
|
-
|
|
279
|
-
### `pay(payment_connector_url, *, control_id=None, charge_amount=None, currency=None, ...) -> PayAction`
|
|
280
|
-
|
|
281
|
-
Collect a payment via DTMF.
|
|
282
|
-
|
|
283
|
-
```python
|
|
284
|
-
action = await call.pay(
|
|
285
|
-
"https://pay.example.com",
|
|
286
|
-
charge_amount="25.99",
|
|
287
|
-
currency="usd",
|
|
288
|
-
input_method="dtmf",
|
|
289
|
-
)
|
|
290
|
-
event = await action.wait()
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
## Conference
|
|
294
|
-
|
|
295
|
-
### `join_conference(name, *, muted=None, beep=None, max_participants=None, record=None, ...) -> dict`
|
|
296
|
-
|
|
297
|
-
```python
|
|
298
|
-
await call.join_conference("my_conference", muted=False, beep="onEnter")
|
|
299
|
-
```
|
|
300
|
-
|
|
301
|
-
### `leave_conference(conference_id) -> dict`
|
|
302
|
-
|
|
303
|
-
```python
|
|
304
|
-
await call.leave_conference("conf-123")
|
|
305
|
-
```
|
|
306
|
-
|
|
307
|
-
## Hold
|
|
308
|
-
|
|
309
|
-
### `hold() -> dict` / `unhold() -> dict`
|
|
310
|
-
|
|
311
|
-
```python
|
|
312
|
-
await call.hold()
|
|
313
|
-
# ... later ...
|
|
314
|
-
await call.unhold()
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
## Denoise
|
|
318
|
-
|
|
319
|
-
### `denoise() -> dict` / `denoise_stop() -> dict`
|
|
320
|
-
|
|
321
|
-
```python
|
|
322
|
-
await call.denoise()
|
|
323
|
-
# ... later ...
|
|
324
|
-
await call.denoise_stop()
|
|
325
|
-
```
|
|
326
|
-
|
|
327
|
-
## Transcription
|
|
328
|
-
|
|
329
|
-
### `transcribe(*, control_id=None, status_url=None) -> TranscribeAction`
|
|
330
|
-
|
|
331
|
-
```python
|
|
332
|
-
action = await call.transcribe(status_url="https://example.com/transcription")
|
|
333
|
-
# ... later ...
|
|
334
|
-
await action.stop()
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
## Live Transcribe / Translate
|
|
338
|
-
|
|
339
|
-
### `live_transcribe(action_obj) -> dict`
|
|
340
|
-
|
|
341
|
-
```python
|
|
342
|
-
await call.live_transcribe({"start": {"language": "en-US"}})
|
|
343
|
-
```
|
|
344
|
-
|
|
345
|
-
### `live_translate(action_obj, *, status_url=None) -> dict`
|
|
346
|
-
|
|
347
|
-
```python
|
|
348
|
-
await call.live_translate({"start": {"source": "en-US", "target": "es"}})
|
|
349
|
-
```
|
|
350
|
-
|
|
351
|
-
## Echo
|
|
352
|
-
|
|
353
|
-
### `echo(*, timeout=None, status_url=None) -> dict`
|
|
354
|
-
|
|
355
|
-
Echo audio back to the caller (useful for testing).
|
|
356
|
-
|
|
357
|
-
```python
|
|
358
|
-
await call.echo(timeout=30.0)
|
|
359
|
-
```
|
|
360
|
-
|
|
361
|
-
## AI Agent
|
|
362
|
-
|
|
363
|
-
### `ai(*, control_id=None, prompt=None, SWAIG=None, ai_params=None, ...) -> AIAction`
|
|
364
|
-
|
|
365
|
-
Start an AI agent session on the call.
|
|
366
|
-
|
|
367
|
-
```python
|
|
368
|
-
action = await call.ai(
|
|
369
|
-
prompt={"text": "You are a helpful support agent."},
|
|
370
|
-
SWAIG={"functions": [...]},
|
|
371
|
-
ai_params={"end_of_speech_timeout": 3000},
|
|
372
|
-
)
|
|
373
|
-
event = await action.wait()
|
|
374
|
-
```
|
|
375
|
-
|
|
376
|
-
### `amazon_bedrock(*, prompt=None, SWAIG=None, ...) -> dict`
|
|
377
|
-
|
|
378
|
-
Connect to an Amazon Bedrock AI agent.
|
|
379
|
-
|
|
380
|
-
### `ai_message(*, message_text=None, role=None, ...) -> dict`
|
|
381
|
-
|
|
382
|
-
Send a message to an active AI session.
|
|
383
|
-
|
|
384
|
-
### `ai_hold(*, timeout=None, prompt=None) -> dict` / `ai_unhold(*, prompt=None) -> dict`
|
|
385
|
-
|
|
386
|
-
Put an AI session on/off hold.
|
|
387
|
-
|
|
388
|
-
## Rooms
|
|
389
|
-
|
|
390
|
-
### `join_room(name, *, status_url=None) -> dict`
|
|
391
|
-
|
|
392
|
-
```python
|
|
393
|
-
await call.join_room("my_room")
|
|
394
|
-
```
|
|
395
|
-
|
|
396
|
-
### `leave_room() -> dict`
|
|
397
|
-
|
|
398
|
-
```python
|
|
399
|
-
await call.leave_room()
|
|
400
|
-
```
|
|
401
|
-
|
|
402
|
-
## Queue
|
|
403
|
-
|
|
404
|
-
### `queue_enter(queue_name, *, control_id=None, status_url=None) -> dict`
|
|
405
|
-
|
|
406
|
-
```python
|
|
407
|
-
await call.queue_enter("support")
|
|
408
|
-
```
|
|
409
|
-
|
|
410
|
-
### `queue_leave(queue_name, *, control_id=None, queue_id=None, status_url=None) -> dict`
|
|
411
|
-
|
|
412
|
-
```python
|
|
413
|
-
await call.queue_leave("support", queue_id="q-123")
|
|
414
|
-
```
|
|
415
|
-
|
|
416
|
-
## Digit Bindings
|
|
417
|
-
|
|
418
|
-
### `bind_digit(digits, bind_method, *, bind_params=None, realm=None, max_triggers=None) -> dict`
|
|
419
|
-
|
|
420
|
-
Bind a DTMF sequence to trigger a RELAY method.
|
|
421
|
-
|
|
422
|
-
```python
|
|
423
|
-
await call.bind_digit(
|
|
424
|
-
"*1",
|
|
425
|
-
"calling.play",
|
|
426
|
-
bind_params={"play": [{"type": "tts", "params": {"text": "You pressed star-1"}}]},
|
|
427
|
-
)
|
|
428
|
-
```
|
|
429
|
-
|
|
430
|
-
### `clear_digit_bindings(*, realm=None) -> dict`
|
|
431
|
-
|
|
432
|
-
```python
|
|
433
|
-
await call.clear_digit_bindings()
|
|
434
|
-
```
|
|
435
|
-
|
|
436
|
-
## User Events
|
|
437
|
-
|
|
438
|
-
### `user_event(*, event=None, **kwargs) -> dict`
|
|
439
|
-
|
|
440
|
-
Send a custom event.
|
|
441
|
-
|
|
442
|
-
```python
|
|
443
|
-
await call.user_event(event="order_placed", order_id="12345")
|
|
444
|
-
```
|
|
445
|
-
|
|
446
|
-
## Event Handling
|
|
447
|
-
|
|
448
|
-
### `on(event_type, handler)`
|
|
449
|
-
|
|
450
|
-
Register an event listener on this call.
|
|
451
|
-
|
|
452
|
-
```python
|
|
453
|
-
def on_play(event):
|
|
454
|
-
print(f"Play state: {event.params.get('state')}")
|
|
455
|
-
|
|
456
|
-
call.on("calling.call.play", on_play)
|
|
457
|
-
```
|
|
458
|
-
|
|
459
|
-
### `wait_for(event_type, predicate=None, timeout=None) -> RelayEvent`
|
|
460
|
-
|
|
461
|
-
Wait for a specific event.
|
|
462
|
-
|
|
463
|
-
```python
|
|
464
|
-
event = await call.wait_for("calling.call.play", timeout=30.0)
|
|
465
|
-
```
|
|
466
|
-
|
|
467
|
-
### `wait_for_ended(timeout=None) -> RelayEvent`
|
|
468
|
-
|
|
469
|
-
Wait for the call to end.
|
|
470
|
-
|
|
471
|
-
```python
|
|
472
|
-
event = await call.wait_for_ended()
|
|
473
|
-
print(f"End reason: {event.params.get('end_reason')}")
|
|
474
|
-
```
|
|
@@ -1,142 +0,0 @@
|
|
|
1
|
-
# RelayClient Reference
|
|
2
|
-
|
|
3
|
-
## Constructor
|
|
4
|
-
|
|
5
|
-
```python
|
|
6
|
-
RelayClient(
|
|
7
|
-
project: str = None, # SIGNALWIRE_PROJECT_ID
|
|
8
|
-
token: str = None, # SIGNALWIRE_API_TOKEN
|
|
9
|
-
jwt_token: str = None, # SIGNALWIRE_JWT_TOKEN
|
|
10
|
-
host: str = None, # SIGNALWIRE_SPACE (default: relay.signalwire.com)
|
|
11
|
-
contexts: list[str] = None, # Topics to subscribe to
|
|
12
|
-
max_active_calls: int = None, # RELAY_MAX_ACTIVE_CALLS (default: 1000)
|
|
13
|
-
)
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
Authentication requires either `project` + `token` (legacy) or `jwt_token` (faster, no server roundtrip). All parameters fall back to their corresponding environment variables.
|
|
17
|
-
|
|
18
|
-
## Methods
|
|
19
|
-
|
|
20
|
-
### `run()`
|
|
21
|
-
|
|
22
|
-
Blocking entry point. Connects, authenticates, and runs the event loop with auto-reconnect until interrupted.
|
|
23
|
-
|
|
24
|
-
```python
|
|
25
|
-
client.run()
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
### `connect()` / `disconnect()`
|
|
29
|
-
|
|
30
|
-
Manual lifecycle control for use in async code.
|
|
31
|
-
|
|
32
|
-
```python
|
|
33
|
-
await client.connect()
|
|
34
|
-
# ... use client ...
|
|
35
|
-
await client.disconnect()
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Also supports async context manager:
|
|
39
|
-
|
|
40
|
-
```python
|
|
41
|
-
async with RelayClient(contexts=["default"]) as client:
|
|
42
|
-
...
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
### `on_call(handler)`
|
|
46
|
-
|
|
47
|
-
Decorator to register the inbound call handler. The handler receives a `Call` object.
|
|
48
|
-
|
|
49
|
-
```python
|
|
50
|
-
@client.on_call
|
|
51
|
-
async def handle(call):
|
|
52
|
-
await call.answer()
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### `dial(devices, *, tag=None, max_duration=None, dial_timeout=None) -> Call`
|
|
56
|
-
|
|
57
|
-
Place an outbound call. Returns a `Call` once the remote party answers.
|
|
58
|
-
|
|
59
|
-
- `devices` -- nested list of device objects (serial/parallel dial)
|
|
60
|
-
- `tag` -- optional correlation tag (auto-generated if omitted)
|
|
61
|
-
- `max_duration` -- max call duration in minutes
|
|
62
|
-
- `dial_timeout` -- seconds to wait before raising `TimeoutError` (default: 120)
|
|
63
|
-
|
|
64
|
-
```python
|
|
65
|
-
call = await client.dial([
|
|
66
|
-
[{"type": "phone", "params": {"to_number": "+15551234567", "from_number": "+15559876543"}}]
|
|
67
|
-
])
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### `on_message(handler)`
|
|
71
|
-
|
|
72
|
-
Decorator to register the inbound message handler. The handler receives a `Message` object.
|
|
73
|
-
|
|
74
|
-
```python
|
|
75
|
-
@client.on_message
|
|
76
|
-
async def handle(message):
|
|
77
|
-
print(f"SMS from {message.from_number}: {message.body}")
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
### `send_message(*, to_number, from_number, body=None, media=None, ...) -> Message`
|
|
81
|
-
|
|
82
|
-
Send an outbound SMS/MMS. Returns a `Message` that tracks delivery state.
|
|
83
|
-
|
|
84
|
-
```python
|
|
85
|
-
message = await client.send_message(
|
|
86
|
-
to_number="+15552222222",
|
|
87
|
-
from_number="+15551111111",
|
|
88
|
-
body="Hello!",
|
|
89
|
-
)
|
|
90
|
-
event = await message.wait() # block until delivered/failed
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
See [Messaging](messaging.md) for full details.
|
|
94
|
-
|
|
95
|
-
### `execute(method, params) -> dict`
|
|
96
|
-
|
|
97
|
-
Send a raw JSON-RPC request. Used internally by Call methods, but available for custom commands.
|
|
98
|
-
|
|
99
|
-
### `receive(contexts) / unreceive(contexts)`
|
|
100
|
-
|
|
101
|
-
Dynamically subscribe to or unsubscribe from contexts after connecting.
|
|
102
|
-
|
|
103
|
-
```python
|
|
104
|
-
await client.receive(["new-context"])
|
|
105
|
-
await client.unreceive(["old-context"])
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
## Properties
|
|
109
|
-
|
|
110
|
-
| Property | Type | Description |
|
|
111
|
-
|----------|------|-------------|
|
|
112
|
-
| `relay_protocol` | `str` | Server-assigned protocol string from connect response |
|
|
113
|
-
| `project` | `str` | Project ID |
|
|
114
|
-
| `host` | `str` | Relay host |
|
|
115
|
-
| `contexts` | `list[str]` | Initial contexts |
|
|
116
|
-
|
|
117
|
-
## Connection Behavior
|
|
118
|
-
|
|
119
|
-
- **Auto-reconnect**: On connection loss, the client reconnects with exponential backoff (1s to 30s).
|
|
120
|
-
- **Ping/pong**: Client sends periodic pings and monitors server pings. After 3 consecutive failures, the connection is force-closed and reconnected.
|
|
121
|
-
- **Request queueing**: Requests made while disconnected are queued and sent after re-authentication.
|
|
122
|
-
- **Authorization state**: The server sends encrypted auth state via events. On reconnect, this is sent back for fast re-authentication without a full auth roundtrip.
|
|
123
|
-
- **Server disconnect**: The server can request a graceful disconnect (e.g. during deployment). The client auto-reconnects afterward.
|
|
124
|
-
|
|
125
|
-
## Concurrency
|
|
126
|
-
|
|
127
|
-
Each inbound call handler runs as an independent `asyncio.Task`, so multiple calls are handled concurrently. The `max_active_calls` parameter (default: 1000) caps concurrent calls to prevent unbounded memory growth.
|
|
128
|
-
|
|
129
|
-
For multiple WebSocket connections in one process, set `RELAY_MAX_CONNECTIONS` (default: 1).
|
|
130
|
-
|
|
131
|
-
## Error Handling
|
|
132
|
-
|
|
133
|
-
```python
|
|
134
|
-
from signalwire_agents.relay import RelayError
|
|
135
|
-
|
|
136
|
-
try:
|
|
137
|
-
await call.play([...])
|
|
138
|
-
except RelayError as e:
|
|
139
|
-
print(f"Error {e.code}: {e.message}")
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
`RelayError` is raised when the server returns a non-2xx response code. Errors 404 and 410 (call gone) are silently swallowed by Call methods since the call no longer exists.
|