@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/relay/docs/messaging.md
DELETED
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
# Messaging
|
|
2
|
-
|
|
3
|
-
Send and receive SMS/MMS messages through the RELAY client.
|
|
4
|
-
|
|
5
|
-
## Sending Messages
|
|
6
|
-
|
|
7
|
-
Use `client.send_message()` to send an outbound SMS or MMS.
|
|
8
|
-
|
|
9
|
-
```python
|
|
10
|
-
message = await client.send_message(
|
|
11
|
-
to_number="+15552222222",
|
|
12
|
-
from_number="+15551111111",
|
|
13
|
-
body="Hello from SignalWire!",
|
|
14
|
-
)
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
### Wait for delivery
|
|
18
|
-
|
|
19
|
-
```python
|
|
20
|
-
message = await client.send_message(
|
|
21
|
-
to_number="+15552222222",
|
|
22
|
-
from_number="+15551111111",
|
|
23
|
-
body="Hello!",
|
|
24
|
-
)
|
|
25
|
-
event = await message.wait() # blocks until delivered/failed
|
|
26
|
-
print(f"Final state: {message.state}")
|
|
27
|
-
if message.reason:
|
|
28
|
-
print(f"Reason: {message.reason}")
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
### Fire and forget
|
|
32
|
-
|
|
33
|
-
```python
|
|
34
|
-
message = await client.send_message(
|
|
35
|
-
to_number="+15552222222",
|
|
36
|
-
from_number="+15551111111",
|
|
37
|
-
body="Hello!",
|
|
38
|
-
)
|
|
39
|
-
# don't call message.wait() — continue immediately
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Callback on completion
|
|
43
|
-
|
|
44
|
-
```python
|
|
45
|
-
message = await client.send_message(
|
|
46
|
-
to_number="+15552222222",
|
|
47
|
-
from_number="+15551111111",
|
|
48
|
-
body="Hello!",
|
|
49
|
-
on_completed=lambda event: print(f"Delivery: {event.params.get('message_state')}"),
|
|
50
|
-
)
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
### MMS (media messages)
|
|
54
|
-
|
|
55
|
-
```python
|
|
56
|
-
message = await client.send_message(
|
|
57
|
-
to_number="+15552222222",
|
|
58
|
-
from_number="+15551111111",
|
|
59
|
-
body="Check this out!",
|
|
60
|
-
media=["https://example.com/image.jpg"],
|
|
61
|
-
)
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### All parameters
|
|
65
|
-
|
|
66
|
-
```python
|
|
67
|
-
message = await client.send_message(
|
|
68
|
-
to_number="+15552222222", # required — E.164 format
|
|
69
|
-
from_number="+15551111111", # required — E.164 format
|
|
70
|
-
body="Message text", # required if no media
|
|
71
|
-
media=["https://..."], # required if no body
|
|
72
|
-
context="my_context", # context for state events (default: relay protocol)
|
|
73
|
-
tags=["vip", "support"], # optional tags for searching in UI
|
|
74
|
-
region="us", # optional origination region
|
|
75
|
-
on_completed=callback_fn, # optional completion callback
|
|
76
|
-
)
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
## Receiving Messages
|
|
80
|
-
|
|
81
|
-
Register a handler with `@client.on_message` to receive inbound SMS/MMS.
|
|
82
|
-
|
|
83
|
-
```python
|
|
84
|
-
from signalwire_agents.relay import RelayClient
|
|
85
|
-
|
|
86
|
-
client = RelayClient(
|
|
87
|
-
project="your-project-id",
|
|
88
|
-
token="your-api-token",
|
|
89
|
-
host="example.signalwire.com",
|
|
90
|
-
contexts=["default"],
|
|
91
|
-
)
|
|
92
|
-
|
|
93
|
-
@client.on_message
|
|
94
|
-
async def handle_message(message):
|
|
95
|
-
print(f"From: {message.from_number}")
|
|
96
|
-
print(f"To: {message.to_number}")
|
|
97
|
-
print(f"Body: {message.body}")
|
|
98
|
-
if message.media:
|
|
99
|
-
print(f"Media: {message.media}")
|
|
100
|
-
|
|
101
|
-
# Reply back
|
|
102
|
-
await client.send_message(
|
|
103
|
-
to_number=message.from_number,
|
|
104
|
-
from_number=message.to_number,
|
|
105
|
-
body=f"You said: {message.body}",
|
|
106
|
-
)
|
|
107
|
-
|
|
108
|
-
client.run()
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
## Message Object
|
|
112
|
-
|
|
113
|
-
### Properties
|
|
114
|
-
|
|
115
|
-
| Property | Type | Description |
|
|
116
|
-
|----------|------|-------------|
|
|
117
|
-
| `message_id` | `str` | Unique message identifier |
|
|
118
|
-
| `context` | `str` | Context the message belongs to |
|
|
119
|
-
| `direction` | `str` | `inbound` or `outbound` |
|
|
120
|
-
| `from_number` | `str` | Sender phone number (E.164) |
|
|
121
|
-
| `to_number` | `str` | Recipient phone number (E.164) |
|
|
122
|
-
| `body` | `str` | Text body of the message |
|
|
123
|
-
| `media` | `list[str]` | Media URLs (MMS) |
|
|
124
|
-
| `segments` | `int` | Number of message segments |
|
|
125
|
-
| `state` | `str` | Current message state |
|
|
126
|
-
| `reason` | `str` | Failure reason (on `undelivered` or `failed`) |
|
|
127
|
-
| `tags` | `list[str]` | Tags attached to the message |
|
|
128
|
-
| `is_done` | `bool` | `True` if message reached a terminal state |
|
|
129
|
-
| `result` | `RelayEvent` | Terminal event (or `None` if not done) |
|
|
130
|
-
|
|
131
|
-
### Methods
|
|
132
|
-
|
|
133
|
-
| Method | Description |
|
|
134
|
-
|--------|-------------|
|
|
135
|
-
| `await message.wait(timeout=None)` | Block until terminal state. Returns the terminal `RelayEvent`. |
|
|
136
|
-
| `message.on(handler)` | Register a listener for state change events. |
|
|
137
|
-
|
|
138
|
-
### Message States
|
|
139
|
-
|
|
140
|
-
Outbound messages progress through these states:
|
|
141
|
-
|
|
142
|
-
| State | Description |
|
|
143
|
-
|-------|-------------|
|
|
144
|
-
| `queued` | Message accepted and queued for sending |
|
|
145
|
-
| `initiated` | Sending has started |
|
|
146
|
-
| `sent` | Message sent to carrier |
|
|
147
|
-
| `delivered` | Message delivered to recipient (terminal) |
|
|
148
|
-
| `undelivered` | Delivery failed (terminal) — check `reason` |
|
|
149
|
-
| `failed` | Message failed to send (terminal) — check `reason` |
|
|
150
|
-
|
|
151
|
-
Inbound messages always arrive with state `received`.
|
|
152
|
-
|
|
153
|
-
## Event Types
|
|
154
|
-
|
|
155
|
-
| Event | Description |
|
|
156
|
-
|-------|-------------|
|
|
157
|
-
| `MessageReceiveEvent` | Inbound message received |
|
|
158
|
-
| `MessageStateEvent` | Outbound message state change |
|
|
159
|
-
|
|
160
|
-
```python
|
|
161
|
-
from signalwire_agents.relay import MessageReceiveEvent, MessageStateEvent
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
## Combining Calls and Messages
|
|
165
|
-
|
|
166
|
-
The same `RelayClient` handles both calls and messages:
|
|
167
|
-
|
|
168
|
-
```python
|
|
169
|
-
client = RelayClient(project="...", token="...", contexts=["default"])
|
|
170
|
-
|
|
171
|
-
@client.on_call
|
|
172
|
-
async def handle_call(call):
|
|
173
|
-
await call.answer()
|
|
174
|
-
await call.play([{"type": "tts", "params": {"text": "Hello!"}}])
|
|
175
|
-
await call.hangup()
|
|
176
|
-
|
|
177
|
-
@client.on_message
|
|
178
|
-
async def handle_message(message):
|
|
179
|
-
print(f"SMS from {message.from_number}: {message.body}")
|
|
180
|
-
|
|
181
|
-
client.run()
|
|
182
|
-
```
|
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* RELAY Inbound Call Example
|
|
3
|
-
*
|
|
4
|
-
* Answers inbound calls, plays a TTS greeting, collects digits, and hangs up.
|
|
5
|
-
*
|
|
6
|
-
* Required env vars:
|
|
7
|
-
* SIGNALWIRE_PROJECT_ID - Your SignalWire project ID
|
|
8
|
-
* SIGNALWIRE_API_TOKEN - Your SignalWire API token
|
|
9
|
-
* SIGNALWIRE_SPACE - Your SignalWire space (e.g. example.signalwire.com)
|
|
10
|
-
*
|
|
11
|
-
* Usage:
|
|
12
|
-
* npx tsx relay/examples/relay-inbound.ts
|
|
13
|
-
*/
|
|
14
|
-
|
|
15
|
-
import { RelayClient, Call, CALL_STATE_ENDED } from '../../src/relay/index.js';
|
|
16
|
-
|
|
17
|
-
const client = new RelayClient({
|
|
18
|
-
contexts: ['office'],
|
|
19
|
-
});
|
|
20
|
-
|
|
21
|
-
client.onCall(async (call: Call) => {
|
|
22
|
-
console.log(`Inbound call from ${JSON.stringify(call.device)}`);
|
|
23
|
-
|
|
24
|
-
// Answer the call
|
|
25
|
-
await call.answer();
|
|
26
|
-
console.log('Call answered');
|
|
27
|
-
|
|
28
|
-
// Play a greeting
|
|
29
|
-
const playAction = await call.play([
|
|
30
|
-
{ type: 'tts', text: 'Hello! Welcome to the SignalWire RELAY demo.' },
|
|
31
|
-
]);
|
|
32
|
-
await playAction.wait();
|
|
33
|
-
console.log('Greeting played');
|
|
34
|
-
|
|
35
|
-
// Collect digits
|
|
36
|
-
const collectAction = await call.playAndCollect(
|
|
37
|
-
[{ type: 'tts', text: 'Please enter your 4-digit PIN followed by the pound sign.' }],
|
|
38
|
-
{
|
|
39
|
-
digits: { max: 4, terminators: '#', digit_timeout: 5 },
|
|
40
|
-
initial_timeout: 10,
|
|
41
|
-
},
|
|
42
|
-
);
|
|
43
|
-
|
|
44
|
-
const collectEvent = await collectAction.wait();
|
|
45
|
-
const result = collectEvent.params.result as Record<string, unknown> | undefined;
|
|
46
|
-
if (result) {
|
|
47
|
-
const digitParams = result.params as Record<string, unknown> | undefined;
|
|
48
|
-
console.log(`Collected digits: ${digitParams?.digits ?? 'none'}`);
|
|
49
|
-
|
|
50
|
-
await (await call.play([
|
|
51
|
-
{ type: 'tts', text: `You entered ${digitParams?.digits ?? 'nothing'}. Thank you!` },
|
|
52
|
-
])).wait();
|
|
53
|
-
} else {
|
|
54
|
-
await (await call.play([
|
|
55
|
-
{ type: 'tts', text: 'No input received. Goodbye!' },
|
|
56
|
-
])).wait();
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
// Hang up
|
|
60
|
-
await call.hangup();
|
|
61
|
-
console.log('Call ended');
|
|
62
|
-
});
|
|
63
|
-
|
|
64
|
-
console.log('Starting RELAY inbound call handler...');
|
|
65
|
-
console.log('Listening on context: office');
|
|
66
|
-
client.run();
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* RELAY Messaging Example
|
|
3
|
-
*
|
|
4
|
-
* Sends an outbound SMS and listens for inbound messages.
|
|
5
|
-
*
|
|
6
|
-
* Required env vars:
|
|
7
|
-
* SIGNALWIRE_PROJECT_ID - Your SignalWire project ID
|
|
8
|
-
* SIGNALWIRE_API_TOKEN - Your SignalWire API token
|
|
9
|
-
* SIGNALWIRE_SPACE - Your SignalWire space (e.g. example.signalwire.com)
|
|
10
|
-
* MSG_TO - Destination number in E.164 format
|
|
11
|
-
* MSG_FROM - Sender number in E.164 format (must be owned by your project)
|
|
12
|
-
*
|
|
13
|
-
* Usage:
|
|
14
|
-
* MSG_TO=+15551234567 MSG_FROM=+15559876543 npx tsx relay/examples/relay-messaging.ts
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
|
-
import { RelayClient, Message } from '../../src/relay/index.js';
|
|
18
|
-
|
|
19
|
-
const to = process.env.MSG_TO;
|
|
20
|
-
const from = process.env.MSG_FROM;
|
|
21
|
-
|
|
22
|
-
if (!to || !from) {
|
|
23
|
-
console.error('Set MSG_TO and MSG_FROM env vars');
|
|
24
|
-
process.exit(1);
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
const client = new RelayClient({
|
|
28
|
-
contexts: ['messaging'],
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
// Handle inbound messages
|
|
32
|
-
client.onMessage(async (message: Message) => {
|
|
33
|
-
console.log(`Inbound message from ${message.fromNumber}: ${message.body}`);
|
|
34
|
-
console.log(` media: ${message.media.length > 0 ? message.media.join(', ') : 'none'}`);
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
async function sendAndWait() {
|
|
38
|
-
await client.connect();
|
|
39
|
-
console.log('Connected to RELAY');
|
|
40
|
-
|
|
41
|
-
// Send outbound SMS
|
|
42
|
-
console.log(`Sending SMS to ${to}...`);
|
|
43
|
-
const message = await client.sendMessage({
|
|
44
|
-
toNumber: to,
|
|
45
|
-
fromNumber: from,
|
|
46
|
-
body: 'Hello from SignalWire RELAY TypeScript SDK!',
|
|
47
|
-
});
|
|
48
|
-
console.log(`Message queued: id=${message.messageId}`);
|
|
49
|
-
|
|
50
|
-
// Track delivery
|
|
51
|
-
message.on(async (event) => {
|
|
52
|
-
console.log(`Message state: ${event.params.message_state}`);
|
|
53
|
-
});
|
|
54
|
-
|
|
55
|
-
try {
|
|
56
|
-
const terminalEvent = await message.wait(30_000);
|
|
57
|
-
console.log(`Final state: ${message.state}`);
|
|
58
|
-
if (message.reason) {
|
|
59
|
-
console.log(`Reason: ${message.reason}`);
|
|
60
|
-
}
|
|
61
|
-
} catch (err) {
|
|
62
|
-
console.error(`Message tracking error: ${err}`);
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
console.log('Now listening for inbound messages... (Ctrl+C to stop)');
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
sendAndWait().catch(console.error);
|
|
69
|
-
|
|
70
|
-
// Keep running to receive inbound messages
|
|
71
|
-
client.run();
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* RELAY Outbound Call Example
|
|
3
|
-
*
|
|
4
|
-
* Dials an outbound call, detects answering machine, and plays a message.
|
|
5
|
-
*
|
|
6
|
-
* Required env vars:
|
|
7
|
-
* SIGNALWIRE_PROJECT_ID - Your SignalWire project ID
|
|
8
|
-
* SIGNALWIRE_API_TOKEN - Your SignalWire API token
|
|
9
|
-
* SIGNALWIRE_SPACE - Your SignalWire space (e.g. example.signalwire.com)
|
|
10
|
-
* DIAL_TO - Destination number in E.164 format
|
|
11
|
-
* DIAL_FROM - Caller ID number in E.164 format
|
|
12
|
-
*
|
|
13
|
-
* Usage:
|
|
14
|
-
* DIAL_TO=+15551234567 DIAL_FROM=+15559876543 npx tsx relay/examples/relay-outbound.ts
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
|
-
import { RelayClient, RelayError } from '../../src/relay/index.js';
|
|
18
|
-
|
|
19
|
-
const to = process.env.DIAL_TO;
|
|
20
|
-
const from = process.env.DIAL_FROM;
|
|
21
|
-
|
|
22
|
-
if (!to || !from) {
|
|
23
|
-
console.error('Set DIAL_TO and DIAL_FROM env vars');
|
|
24
|
-
process.exit(1);
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
async function main() {
|
|
28
|
-
const client = new RelayClient({ contexts: ['default'] });
|
|
29
|
-
|
|
30
|
-
try {
|
|
31
|
-
await client.connect();
|
|
32
|
-
console.log('Connected to RELAY');
|
|
33
|
-
|
|
34
|
-
// Dial outbound
|
|
35
|
-
console.log(`Dialing ${to} from ${from}...`);
|
|
36
|
-
const call = await client.dial(
|
|
37
|
-
[[{ type: 'phone', to, from }]],
|
|
38
|
-
{ dialTimeout: 30_000 },
|
|
39
|
-
);
|
|
40
|
-
console.log(`Call answered! call_id=${call.callId}`);
|
|
41
|
-
|
|
42
|
-
// Detect answering machine
|
|
43
|
-
const detectAction = await call.detect(
|
|
44
|
-
{ type: 'machine', params: { initial_timeout: 5 } },
|
|
45
|
-
{ timeout: 10 },
|
|
46
|
-
);
|
|
47
|
-
|
|
48
|
-
const detectEvent = await detectAction.wait(15_000);
|
|
49
|
-
const detect = detectEvent.params.detect as Record<string, unknown> | undefined;
|
|
50
|
-
const machineEvent = (detect?.params as Record<string, unknown>)?.event ?? 'unknown';
|
|
51
|
-
console.log(`Detection result: ${machineEvent}`);
|
|
52
|
-
|
|
53
|
-
// Play message
|
|
54
|
-
const playAction = await call.play([
|
|
55
|
-
{ type: 'tts', text: 'This is an automated message from SignalWire. Have a great day!' },
|
|
56
|
-
]);
|
|
57
|
-
await playAction.wait();
|
|
58
|
-
console.log('Message played');
|
|
59
|
-
|
|
60
|
-
// Hang up
|
|
61
|
-
await call.hangup();
|
|
62
|
-
console.log('Call ended');
|
|
63
|
-
|
|
64
|
-
await client.disconnect();
|
|
65
|
-
} catch (err) {
|
|
66
|
-
if (err instanceof RelayError) {
|
|
67
|
-
console.error(`RELAY error: ${err.message} (code=${err.code})`);
|
|
68
|
-
} else {
|
|
69
|
-
console.error(`Error: ${err}`);
|
|
70
|
-
}
|
|
71
|
-
await client.disconnect();
|
|
72
|
-
process.exit(1);
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
main();
|
package/rest/README.md
DELETED
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
# SignalWire REST Client
|
|
2
|
-
|
|
3
|
-
Typed HTTP client for managing SignalWire resources, controlling live calls, and interacting with every SignalWire API surface from TypeScript. No WebSocket required — just standard HTTP requests with `fetch`.
|
|
4
|
-
|
|
5
|
-
## Quick Start
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { RestClient } from '@signalwire/sdk';
|
|
9
|
-
|
|
10
|
-
const client = new RestClient({
|
|
11
|
-
project: 'your-project-id',
|
|
12
|
-
token: 'your-api-token',
|
|
13
|
-
host: 'example.signalwire.com',
|
|
14
|
-
});
|
|
15
|
-
|
|
16
|
-
// Create an AI agent
|
|
17
|
-
const agent = await client.fabric.aiAgents.create({
|
|
18
|
-
name: 'Support Bot',
|
|
19
|
-
prompt: { text: 'You are a helpful support agent.' },
|
|
20
|
-
});
|
|
21
|
-
|
|
22
|
-
// Search for a phone number
|
|
23
|
-
const results = await client.phoneNumbers.search({ area_code: '512' });
|
|
24
|
-
|
|
25
|
-
// Place a call via REST
|
|
26
|
-
await client.calling.dial({
|
|
27
|
-
from: '+15559876543',
|
|
28
|
-
to: '+15551234567',
|
|
29
|
-
url: 'https://example.com/call-handler',
|
|
30
|
-
});
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Features
|
|
34
|
-
|
|
35
|
-
- Single `RestClient` with namespaced sub-objects for every API
|
|
36
|
-
- All 37 calling commands: dial, play, record, collect, detect, tap, stream, AI, transcribe, and more
|
|
37
|
-
- Full Fabric API: 17 resource types with CRUD + addresses, tokens, and generic resources
|
|
38
|
-
- Datasphere: document management and semantic search
|
|
39
|
-
- Video: rooms, sessions, recordings, conferences, tokens, streams
|
|
40
|
-
- Compatibility API: full Twilio-compatible LAML surface
|
|
41
|
-
- Phone number management, 10DLC registry, MFA, logs, and more
|
|
42
|
-
- Zero dependencies — uses built-in `fetch` (Node 18+)
|
|
43
|
-
- Injectable `fetchImpl` for testing
|
|
44
|
-
|
|
45
|
-
## Documentation
|
|
46
|
-
|
|
47
|
-
- [Getting Started](docs/guide.md) — installation, configuration, namespaces, pagination, error handling
|
|
48
|
-
|
|
49
|
-
## Examples
|
|
50
|
-
|
|
51
|
-
- [rest-client.ts](examples/rest-client.ts) — overview: list numbers, agents, rooms, documents, logs
|
|
52
|
-
- [rest-manage-resources.ts](examples/rest-manage-resources.ts) — create an AI agent, assign a number, place a call
|
|
53
|
-
- [rest-datasphere-search.ts](examples/rest-datasphere-search.ts) — upload a document, semantic search
|
|
54
|
-
- [rest-calling-play-and-record.ts](examples/rest-calling-play-and-record.ts) — play, record, transcribe, denoise
|
|
55
|
-
- [rest-calling-ivr-and-ai.ts](examples/rest-calling-ivr-and-ai.ts) — IVR, detect, AI, tap, stream, SIP refer
|
|
56
|
-
- [rest-compat-laml.ts](examples/rest-compat-laml.ts) — Twilio-compatible LAML migration
|
|
57
|
-
- [rest-fabric-swml-and-callflows.ts](examples/rest-fabric-swml-and-callflows.ts) — SWML scripts, call flows, webhooks
|
|
58
|
-
- [rest-fabric-subscribers-and-sip.ts](examples/rest-fabric-subscribers-and-sip.ts) — subscribers, SIP endpoints, gateways
|
|
59
|
-
- [rest-fabric-conferences-and-routing.ts](examples/rest-fabric-conferences-and-routing.ts) — conferences, cXML, routing, tokens
|
|
60
|
-
- [rest-phone-number-management.ts](examples/rest-phone-number-management.ts) — search, purchase, groups, lookup, verified callers
|
|
61
|
-
- [rest-queues-mfa-and-recordings.ts](examples/rest-queues-mfa-and-recordings.ts) — queues, recordings, MFA
|
|
62
|
-
- [rest-video-rooms.ts](examples/rest-video-rooms.ts) — video rooms, sessions, conferences, streams
|
|
63
|
-
- [rest-10dlc-registration.ts](examples/rest-10dlc-registration.ts) — 10DLC brand and campaign registration
|
|
64
|
-
|
|
65
|
-
## Environment Variables
|
|
66
|
-
|
|
67
|
-
| Variable | Description |
|
|
68
|
-
|----------|-------------|
|
|
69
|
-
| `SIGNALWIRE_PROJECT_ID` | Project ID for authentication |
|
|
70
|
-
| `SIGNALWIRE_API_TOKEN` | API token for authentication |
|
|
71
|
-
| `SIGNALWIRE_SPACE` | Space hostname (e.g. `example.signalwire.com`) |
|
|
72
|
-
| `SIGNALWIRE_LOG_LEVEL` | Log level (`debug` for HTTP request details) |
|
|
73
|
-
|
|
74
|
-
## Module Structure
|
|
75
|
-
|
|
76
|
-
```
|
|
77
|
-
src/rest/
|
|
78
|
-
index.ts # RestClient + public exports
|
|
79
|
-
HttpClient.ts # fetch-based HTTP with Basic Auth
|
|
80
|
-
RestError.ts # Error class: statusCode, body, url, method
|
|
81
|
-
pagination.ts # paginate<T>() async generator + paginateAll()
|
|
82
|
-
types.ts # ClientOptions, PaginatedResponse, QueryParams
|
|
83
|
-
base/
|
|
84
|
-
BaseResource.ts # Abstract base with _http + _path()
|
|
85
|
-
CrudResource.ts # list/create/get/update/delete with generics
|
|
86
|
-
CrudWithAddresses.ts # CrudResource + listAddresses()
|
|
87
|
-
namespaces/
|
|
88
|
-
fabric.ts # 17 resource types + generic resources + addresses + tokens
|
|
89
|
-
calling.ts # 37 command dispatch methods via single POST
|
|
90
|
-
phone-numbers.ts # Search, purchase, update, release
|
|
91
|
-
compat.ts # Twilio-compatible LAML API (12 sub-resources)
|
|
92
|
-
video.ts # Rooms, sessions, recordings, conferences, streams
|
|
93
|
-
datasphere.ts # Documents, search, chunks
|
|
94
|
-
... and 15 more
|
|
95
|
-
```
|