@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
package/rest/docs/fabric.md
DELETED
|
@@ -1,183 +0,0 @@
|
|
|
1
|
-
# Fabric Resources
|
|
2
|
-
|
|
3
|
-
The Fabric API (`/api/fabric`) manages all resource types in your SignalWire project. Every resource type supports CRUD operations and address listing.
|
|
4
|
-
|
|
5
|
-
## Standard CRUD Pattern
|
|
6
|
-
|
|
7
|
-
All 13 resource types share the same methods:
|
|
8
|
-
|
|
9
|
-
```python
|
|
10
|
-
# List all resources of this type
|
|
11
|
-
items = client.fabric.ai_agents.list()
|
|
12
|
-
items = client.fabric.ai_agents.list(page=2, page_size=10)
|
|
13
|
-
|
|
14
|
-
# Create a new resource
|
|
15
|
-
agent = client.fabric.ai_agents.create(
|
|
16
|
-
name="Support Bot",
|
|
17
|
-
prompt={"text": "You are a helpful support agent."},
|
|
18
|
-
)
|
|
19
|
-
|
|
20
|
-
# Get a resource by ID
|
|
21
|
-
agent = client.fabric.ai_agents.get("agent-uuid")
|
|
22
|
-
|
|
23
|
-
# Update a resource
|
|
24
|
-
client.fabric.ai_agents.update("agent-uuid", name="Updated Name")
|
|
25
|
-
|
|
26
|
-
# Delete a resource
|
|
27
|
-
client.fabric.ai_agents.delete("agent-uuid")
|
|
28
|
-
|
|
29
|
-
# List addresses assigned to this resource
|
|
30
|
-
addresses = client.fabric.ai_agents.list_addresses("agent-uuid")
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Resource Types
|
|
34
|
-
|
|
35
|
-
### PUT-Update Resources
|
|
36
|
-
|
|
37
|
-
These resources use `PUT` for updates (full replacement):
|
|
38
|
-
|
|
39
|
-
| Attribute | API Path |
|
|
40
|
-
|-----------|----------|
|
|
41
|
-
| `fabric.swml_scripts` | `/api/fabric/resources/swml_scripts` |
|
|
42
|
-
| `fabric.relay_applications` | `/api/fabric/resources/relay_applications` |
|
|
43
|
-
| `fabric.call_flows` | `/api/fabric/resources/call_flows` |
|
|
44
|
-
| `fabric.conference_rooms` | `/api/fabric/resources/conference_rooms` |
|
|
45
|
-
| `fabric.freeswitch_connectors` | `/api/fabric/resources/freeswitch_connectors` |
|
|
46
|
-
| `fabric.subscribers` | `/api/fabric/resources/subscribers` |
|
|
47
|
-
| `fabric.sip_endpoints` | `/api/fabric/resources/sip_endpoints` |
|
|
48
|
-
| `fabric.cxml_scripts` | `/api/fabric/resources/cxml_scripts` |
|
|
49
|
-
| `fabric.cxml_applications` | `/api/fabric/resources/cxml_applications` |
|
|
50
|
-
|
|
51
|
-
### PATCH-Update Resources
|
|
52
|
-
|
|
53
|
-
These resources use `PATCH` for updates (partial update):
|
|
54
|
-
|
|
55
|
-
| Attribute | API Path |
|
|
56
|
-
|-----------|----------|
|
|
57
|
-
| `fabric.swml_webhooks` | `/api/fabric/resources/swml_webhooks` |
|
|
58
|
-
| `fabric.ai_agents` | `/api/fabric/resources/ai_agents` |
|
|
59
|
-
| `fabric.sip_gateways` | `/api/fabric/resources/sip_gateways` |
|
|
60
|
-
| `fabric.cxml_webhooks` | `/api/fabric/resources/cxml_webhooks` |
|
|
61
|
-
|
|
62
|
-
## Call Flows -- Extra Methods
|
|
63
|
-
|
|
64
|
-
Call flows support version management:
|
|
65
|
-
|
|
66
|
-
```python
|
|
67
|
-
# List all versions of a call flow
|
|
68
|
-
versions = client.fabric.call_flows.list_versions("call-flow-uuid")
|
|
69
|
-
|
|
70
|
-
# Deploy a new version
|
|
71
|
-
client.fabric.call_flows.deploy_version("call-flow-uuid", document_version=3)
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
## Subscribers -- SIP Endpoints
|
|
75
|
-
|
|
76
|
-
Subscribers have nested SIP endpoint management:
|
|
77
|
-
|
|
78
|
-
```python
|
|
79
|
-
# List subscriber's SIP endpoints
|
|
80
|
-
endpoints = client.fabric.subscribers.list_sip_endpoints("subscriber-uuid")
|
|
81
|
-
|
|
82
|
-
# Create a SIP endpoint for a subscriber
|
|
83
|
-
endpoint = client.fabric.subscribers.create_sip_endpoint(
|
|
84
|
-
"subscriber-uuid",
|
|
85
|
-
username="user1",
|
|
86
|
-
password="secret",
|
|
87
|
-
caller_id="+15551234567",
|
|
88
|
-
)
|
|
89
|
-
|
|
90
|
-
# Get a specific SIP endpoint
|
|
91
|
-
endpoint = client.fabric.subscribers.get_sip_endpoint("subscriber-uuid", "endpoint-uuid")
|
|
92
|
-
|
|
93
|
-
# Update a SIP endpoint (uses PATCH)
|
|
94
|
-
client.fabric.subscribers.update_sip_endpoint(
|
|
95
|
-
"subscriber-uuid", "endpoint-uuid",
|
|
96
|
-
caller_id="+15559876543",
|
|
97
|
-
)
|
|
98
|
-
|
|
99
|
-
# Delete a SIP endpoint
|
|
100
|
-
client.fabric.subscribers.delete_sip_endpoint("subscriber-uuid", "endpoint-uuid")
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
## cXML Applications
|
|
104
|
-
|
|
105
|
-
cXML applications support list/get/update/delete but not create:
|
|
106
|
-
|
|
107
|
-
```python
|
|
108
|
-
apps = client.fabric.cxml_applications.list()
|
|
109
|
-
app = client.fabric.cxml_applications.get("app-uuid")
|
|
110
|
-
client.fabric.cxml_applications.update("app-uuid", voice_url="https://example.com/voice")
|
|
111
|
-
client.fabric.cxml_applications.delete("app-uuid")
|
|
112
|
-
|
|
113
|
-
# This raises NotImplementedError:
|
|
114
|
-
# client.fabric.cxml_applications.create(...)
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
## Generic Resources
|
|
118
|
-
|
|
119
|
-
Operate on any resource type by ID:
|
|
120
|
-
|
|
121
|
-
```python
|
|
122
|
-
# List all resources across all types
|
|
123
|
-
all_resources = client.fabric.resources.list()
|
|
124
|
-
|
|
125
|
-
# Get any resource by ID
|
|
126
|
-
resource = client.fabric.resources.get("resource-uuid")
|
|
127
|
-
|
|
128
|
-
# Delete any resource
|
|
129
|
-
client.fabric.resources.delete("resource-uuid")
|
|
130
|
-
|
|
131
|
-
# List addresses for any resource
|
|
132
|
-
addresses = client.fabric.resources.list_addresses("resource-uuid")
|
|
133
|
-
|
|
134
|
-
# Assign a resource to a phone route
|
|
135
|
-
client.fabric.resources.assign_phone_route("resource-uuid", phone_route_id="route-uuid")
|
|
136
|
-
|
|
137
|
-
# Assign a resource as a domain application handler
|
|
138
|
-
client.fabric.resources.assign_domain_application("resource-uuid", domain_application_id="da-uuid")
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
## Fabric Addresses
|
|
142
|
-
|
|
143
|
-
Read-only access to all fabric addresses:
|
|
144
|
-
|
|
145
|
-
```python
|
|
146
|
-
# List all addresses (filter by type or display_name)
|
|
147
|
-
addresses = client.fabric.addresses.list(type="room")
|
|
148
|
-
|
|
149
|
-
# Get a specific address
|
|
150
|
-
address = client.fabric.addresses.get("address-uuid")
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
## Tokens
|
|
154
|
-
|
|
155
|
-
Create tokens for subscribers, guests, invites, and embeds:
|
|
156
|
-
|
|
157
|
-
```python
|
|
158
|
-
# Subscriber token
|
|
159
|
-
token = client.fabric.tokens.create_subscriber_token(
|
|
160
|
-
reference="user@example.com",
|
|
161
|
-
password="secret",
|
|
162
|
-
)
|
|
163
|
-
|
|
164
|
-
# Refresh a subscriber token
|
|
165
|
-
refreshed = client.fabric.tokens.refresh_subscriber_token(
|
|
166
|
-
refresh_token="existing-refresh-token",
|
|
167
|
-
)
|
|
168
|
-
|
|
169
|
-
# Guest token
|
|
170
|
-
token = client.fabric.tokens.create_guest_token(
|
|
171
|
-
allowed_addresses=["address-uuid-1", "address-uuid-2"],
|
|
172
|
-
expire_at="2025-12-31T23:59:59Z",
|
|
173
|
-
)
|
|
174
|
-
|
|
175
|
-
# Subscriber invite token
|
|
176
|
-
token = client.fabric.tokens.create_invite_token(
|
|
177
|
-
address_id="address-uuid",
|
|
178
|
-
expires_at="2025-12-31T23:59:59Z",
|
|
179
|
-
)
|
|
180
|
-
|
|
181
|
-
# Click-to-call embed token
|
|
182
|
-
token = client.fabric.tokens.create_embed_token(token="embed-source-token")
|
|
183
|
-
```
|
|
@@ -1,110 +0,0 @@
|
|
|
1
|
-
# Getting Started with the REST Client
|
|
2
|
-
|
|
3
|
-
The REST client provides synchronous access to all SignalWire APIs using standard HTTP requests. No WebSocket connection required.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
The REST client is included in the `@signalwire/sdk` package:
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
pip install @signalwire/sdk
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
The only additional dependency is `requests`, which is installed automatically.
|
|
14
|
-
|
|
15
|
-
## Configuration
|
|
16
|
-
|
|
17
|
-
You need three things to connect:
|
|
18
|
-
|
|
19
|
-
| Parameter | Env Var | Description |
|
|
20
|
-
|-----------|---------|-------------|
|
|
21
|
-
| `project` | `SIGNALWIRE_PROJECT_ID` | Your SignalWire project ID |
|
|
22
|
-
| `token` | `SIGNALWIRE_API_TOKEN` | Your SignalWire API token |
|
|
23
|
-
| `host` | `SIGNALWIRE_SPACE` | Your space hostname (e.g. `example.signalwire.com`) |
|
|
24
|
-
|
|
25
|
-
## Minimal Example
|
|
26
|
-
|
|
27
|
-
```python
|
|
28
|
-
from signalwire_agents.rest import RestClient
|
|
29
|
-
|
|
30
|
-
client = RestClient(
|
|
31
|
-
project="your-project-id",
|
|
32
|
-
token="your-api-token",
|
|
33
|
-
host="example.signalwire.com",
|
|
34
|
-
)
|
|
35
|
-
|
|
36
|
-
# List your AI agents
|
|
37
|
-
agents = client.fabric.ai_agents.list()
|
|
38
|
-
print(agents)
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Or use environment variables and skip the constructor args:
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
export SIGNALWIRE_PROJECT_ID=your-project-id
|
|
45
|
-
export SIGNALWIRE_API_TOKEN=your-api-token
|
|
46
|
-
export SIGNALWIRE_SPACE=example.signalwire.com
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
```python
|
|
50
|
-
from signalwire_agents.rest import RestClient
|
|
51
|
-
|
|
52
|
-
client = RestClient()
|
|
53
|
-
agents = client.fabric.ai_agents.list()
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
## CRUD Pattern
|
|
57
|
-
|
|
58
|
-
Most resources follow the same CRUD pattern:
|
|
59
|
-
|
|
60
|
-
```python
|
|
61
|
-
# List
|
|
62
|
-
items = client.fabric.ai_agents.list()
|
|
63
|
-
|
|
64
|
-
# Create
|
|
65
|
-
agent = client.fabric.ai_agents.create(name="Support", prompt={"text": "Be helpful"})
|
|
66
|
-
|
|
67
|
-
# Get by ID
|
|
68
|
-
agent = client.fabric.ai_agents.get("agent-uuid")
|
|
69
|
-
|
|
70
|
-
# Update
|
|
71
|
-
client.fabric.ai_agents.update("agent-uuid", name="Updated Name")
|
|
72
|
-
|
|
73
|
-
# Delete
|
|
74
|
-
client.fabric.ai_agents.delete("agent-uuid")
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
Fabric resources also support listing addresses:
|
|
78
|
-
|
|
79
|
-
```python
|
|
80
|
-
addresses = client.fabric.ai_agents.list_addresses("agent-uuid")
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
## Error Handling
|
|
84
|
-
|
|
85
|
-
```python
|
|
86
|
-
from signalwire_agents.rest import RestClient, SignalWireRestError
|
|
87
|
-
|
|
88
|
-
client = RestClient()
|
|
89
|
-
|
|
90
|
-
try:
|
|
91
|
-
agent = client.fabric.ai_agents.get("nonexistent-id")
|
|
92
|
-
except SignalWireRestError as e:
|
|
93
|
-
print(f"HTTP {e.status_code}: {e.body}")
|
|
94
|
-
# HTTP 404: {'error': 'not found'}
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
## Debug Logging
|
|
98
|
-
|
|
99
|
-
Set the log level to see HTTP request details:
|
|
100
|
-
|
|
101
|
-
```bash
|
|
102
|
-
export SIGNALWIRE_LOG_LEVEL=debug
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
## Next Steps
|
|
106
|
-
|
|
107
|
-
- [Client Reference](client-reference.md) -- all namespaces and constructor options
|
|
108
|
-
- [Fabric Resources](fabric.md) -- managing AI agents, SWML scripts, and more
|
|
109
|
-
- [Calling Commands](calling.md) -- REST-based call control
|
|
110
|
-
- [All Namespaces](namespaces.md) -- phone numbers, video, datasphere, and more
|
package/rest/docs/guide.md
DELETED
|
@@ -1,351 +0,0 @@
|
|
|
1
|
-
# REST Client Guide
|
|
2
|
-
|
|
3
|
-
The SignalWire REST client provides typed HTTP access to all SignalWire platform APIs. It's a standalone module that doesn't depend on AgentBase — you can use it independently for any server-side integration.
|
|
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: 'your-space.signalwire.com',
|
|
14
|
-
});
|
|
15
|
-
|
|
16
|
-
// List AI agents
|
|
17
|
-
const agents = await client.fabric.aiAgents.list();
|
|
18
|
-
|
|
19
|
-
// Search phone numbers
|
|
20
|
-
const numbers = await client.phoneNumbers.search({ area_code: '512' });
|
|
21
|
-
|
|
22
|
-
// Make a REST call
|
|
23
|
-
await client.calling.play('call-id', { url: 'https://example.com/audio.mp3' });
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Authentication
|
|
27
|
-
|
|
28
|
-
The client uses HTTP Basic Auth with your project ID and API token. Credentials can be provided explicitly or via environment variables:
|
|
29
|
-
|
|
30
|
-
| Option | Environment Variable |
|
|
31
|
-
|--------|---------------------|
|
|
32
|
-
| `project` | `SIGNALWIRE_PROJECT_ID` |
|
|
33
|
-
| `token` | `SIGNALWIRE_API_TOKEN` |
|
|
34
|
-
| `host` | `SIGNALWIRE_SPACE` |
|
|
35
|
-
|
|
36
|
-
```typescript
|
|
37
|
-
// Using environment variables (no args needed)
|
|
38
|
-
const client = new RestClient();
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## Namespaces
|
|
42
|
-
|
|
43
|
-
The client organizes all APIs into namespaces:
|
|
44
|
-
|
|
45
|
-
### Fabric (`client.fabric.*`)
|
|
46
|
-
|
|
47
|
-
Resource management for the SignalWire Fabric platform.
|
|
48
|
-
|
|
49
|
-
```typescript
|
|
50
|
-
// AI Agents (PATCH updates)
|
|
51
|
-
await client.fabric.aiAgents.list();
|
|
52
|
-
await client.fabric.aiAgents.create({ name: 'My Agent' });
|
|
53
|
-
await client.fabric.aiAgents.get('agent-id');
|
|
54
|
-
await client.fabric.aiAgents.update('agent-id', { name: 'Updated' });
|
|
55
|
-
await client.fabric.aiAgents.delete('agent-id');
|
|
56
|
-
await client.fabric.aiAgents.listAddresses('agent-id');
|
|
57
|
-
|
|
58
|
-
// SWML Scripts (PUT updates)
|
|
59
|
-
await client.fabric.swmlScripts.create({ name: 'flow', code: '...' });
|
|
60
|
-
await client.fabric.swmlScripts.update('id', { code: '...' });
|
|
61
|
-
|
|
62
|
-
// Call Flows (with version management)
|
|
63
|
-
await client.fabric.callFlows.list();
|
|
64
|
-
await client.fabric.callFlows.listVersions('cf-id');
|
|
65
|
-
await client.fabric.callFlows.deployVersion('cf-id', { version: 2 });
|
|
66
|
-
|
|
67
|
-
// Subscribers (with SIP endpoints)
|
|
68
|
-
await client.fabric.subscribers.listSipEndpoints('sub-id');
|
|
69
|
-
await client.fabric.subscribers.createSipEndpoint('sub-id', { username: 'user' });
|
|
70
|
-
|
|
71
|
-
// Tokens
|
|
72
|
-
await client.fabric.tokens.createSubscriberToken({ subscriber_id: 's1' });
|
|
73
|
-
await client.fabric.tokens.createGuestToken({ resource_id: 'r1' });
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
**Sub-resources:** `swmlScripts`, `relayApplications`, `callFlows`, `conferenceRooms`, `freeswitchConnectors`, `subscribers`, `sipEndpoints`, `cxmlScripts`, `cxmlApplications`, `swmlWebhooks`, `aiAgents`, `sipGateways`, `cxmlWebhooks`, `resources`, `addresses`, `tokens`
|
|
77
|
-
|
|
78
|
-
### Calling (`client.calling.*`)
|
|
79
|
-
|
|
80
|
-
REST-based call control — all 37 commands dispatched via POST.
|
|
81
|
-
|
|
82
|
-
```typescript
|
|
83
|
-
// Dial
|
|
84
|
-
await client.calling.dial({ to: '+15551234567', from: '+15559876543' });
|
|
85
|
-
|
|
86
|
-
// Play audio
|
|
87
|
-
await client.calling.play('call-id', { url: 'https://example.com/audio.mp3' });
|
|
88
|
-
await client.calling.playPause('call-id');
|
|
89
|
-
await client.calling.playResume('call-id');
|
|
90
|
-
await client.calling.playStop('call-id');
|
|
91
|
-
|
|
92
|
-
// Record
|
|
93
|
-
await client.calling.record('call-id', { beep: true });
|
|
94
|
-
await client.calling.recordStop('call-id');
|
|
95
|
-
|
|
96
|
-
// AI control
|
|
97
|
-
await client.calling.aiMessage('call-id', { message: 'Hello' });
|
|
98
|
-
await client.calling.aiStop('call-id');
|
|
99
|
-
|
|
100
|
-
// End call
|
|
101
|
-
await client.calling.end('call-id');
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
### Phone Numbers (`client.phoneNumbers`)
|
|
105
|
-
|
|
106
|
-
```typescript
|
|
107
|
-
await client.phoneNumbers.list();
|
|
108
|
-
await client.phoneNumbers.search({ area_code: '512' });
|
|
109
|
-
await client.phoneNumbers.create({ number: '+15551234567' }); // Purchase
|
|
110
|
-
await client.phoneNumbers.update('id', { name: 'Main Line' });
|
|
111
|
-
await client.phoneNumbers.delete('id'); // Release
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### Datasphere (`client.datasphere.*`)
|
|
115
|
-
|
|
116
|
-
Document management and semantic search.
|
|
117
|
-
|
|
118
|
-
```typescript
|
|
119
|
-
// Documents
|
|
120
|
-
await client.datasphere.documents.list();
|
|
121
|
-
await client.datasphere.documents.create({ name: 'FAQ', content: '...' });
|
|
122
|
-
await client.datasphere.documents.get('doc-id');
|
|
123
|
-
await client.datasphere.documents.update('doc-id', { name: 'Updated FAQ' });
|
|
124
|
-
await client.datasphere.documents.delete('doc-id');
|
|
125
|
-
|
|
126
|
-
// Search
|
|
127
|
-
await client.datasphere.documents.search({ query: 'how do I reset my password', count: 5 });
|
|
128
|
-
|
|
129
|
-
// Chunks
|
|
130
|
-
await client.datasphere.documents.listChunks('doc-id');
|
|
131
|
-
await client.datasphere.documents.getChunk('doc-id', 'chunk-id');
|
|
132
|
-
await client.datasphere.documents.deleteChunk('doc-id', 'chunk-id');
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
### Video (`client.video.*`)
|
|
136
|
-
|
|
137
|
-
```typescript
|
|
138
|
-
// Rooms
|
|
139
|
-
await client.video.rooms.list();
|
|
140
|
-
await client.video.rooms.create({ name: 'standup' });
|
|
141
|
-
await client.video.rooms.update('room-id', { max_participants: 10 });
|
|
142
|
-
await client.video.rooms.listStreams('room-id');
|
|
143
|
-
await client.video.rooms.createStream('room-id', { url: 'rtmp://...' });
|
|
144
|
-
|
|
145
|
-
// Room Tokens
|
|
146
|
-
await client.video.roomTokens.create({ room_name: 'standup', user_name: 'alice' });
|
|
147
|
-
|
|
148
|
-
// Sessions
|
|
149
|
-
await client.video.roomSessions.list();
|
|
150
|
-
await client.video.roomSessions.listMembers('session-id');
|
|
151
|
-
await client.video.roomSessions.listRecordings('session-id');
|
|
152
|
-
|
|
153
|
-
// Conferences
|
|
154
|
-
await client.video.conferences.list();
|
|
155
|
-
await client.video.conferences.listConferenceTokens('conf-id');
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
### Compatibility API (`client.compat.*`)
|
|
159
|
-
|
|
160
|
-
Twilio-compatible LAML API — scoped to your project ID as AccountSid. All updates use POST (not PATCH/PUT).
|
|
161
|
-
|
|
162
|
-
```typescript
|
|
163
|
-
// Calls
|
|
164
|
-
await client.compat.calls.list();
|
|
165
|
-
await client.compat.calls.create({ To: '+15551234567', From: '+15559876543', Url: '...' });
|
|
166
|
-
await client.compat.calls.update('CA...', { Status: 'completed' });
|
|
167
|
-
await client.compat.calls.startRecording('CA...');
|
|
168
|
-
|
|
169
|
-
// Messages
|
|
170
|
-
await client.compat.messages.create({ To: '+15551234567', Body: 'Hello' });
|
|
171
|
-
await client.compat.messages.listMedia('MM...');
|
|
172
|
-
|
|
173
|
-
// Phone Numbers
|
|
174
|
-
await client.compat.phoneNumbers.list();
|
|
175
|
-
await client.compat.phoneNumbers.searchLocal('US', { AreaCode: '512' });
|
|
176
|
-
await client.compat.phoneNumbers.searchTollFree('US');
|
|
177
|
-
await client.compat.phoneNumbers.purchase({ PhoneNumber: '+15551234567' });
|
|
178
|
-
|
|
179
|
-
// Conferences
|
|
180
|
-
await client.compat.conferences.list();
|
|
181
|
-
await client.compat.conferences.listParticipants('CF...');
|
|
182
|
-
await client.compat.conferences.updateParticipant('CF...', 'CA...', { Muted: true });
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
### Other Namespaces
|
|
186
|
-
|
|
187
|
-
```typescript
|
|
188
|
-
// Addresses
|
|
189
|
-
await client.addresses.list();
|
|
190
|
-
await client.addresses.create({ ... });
|
|
191
|
-
|
|
192
|
-
// Queues (with member management)
|
|
193
|
-
await client.queues.list();
|
|
194
|
-
await client.queues.listMembers('queue-id');
|
|
195
|
-
await client.queues.getNextMember('queue-id');
|
|
196
|
-
|
|
197
|
-
// Recordings
|
|
198
|
-
await client.recordings.list();
|
|
199
|
-
await client.recordings.get('recording-id');
|
|
200
|
-
await client.recordings.delete('recording-id');
|
|
201
|
-
|
|
202
|
-
// Number Groups (with membership)
|
|
203
|
-
await client.numberGroups.list();
|
|
204
|
-
await client.numberGroups.listMemberships('group-id');
|
|
205
|
-
await client.numberGroups.addMembership('group-id', { phone_number_id: 'pn-id' });
|
|
206
|
-
|
|
207
|
-
// Verified Callers
|
|
208
|
-
await client.verifiedCallers.list();
|
|
209
|
-
await client.verifiedCallers.create({ phone_number: '+15551234567' });
|
|
210
|
-
await client.verifiedCallers.submitVerification('id', { code: '1234' });
|
|
211
|
-
|
|
212
|
-
// SIP Profile (singleton)
|
|
213
|
-
await client.sipProfile.get();
|
|
214
|
-
await client.sipProfile.update({ codecs: ['PCMU', 'PCMA'] });
|
|
215
|
-
|
|
216
|
-
// Lookup
|
|
217
|
-
await client.lookup.phoneNumber('+15551234567', { include: 'cnam' });
|
|
218
|
-
|
|
219
|
-
// Short Codes
|
|
220
|
-
await client.shortCodes.list();
|
|
221
|
-
await client.shortCodes.update('sc-id', { url: 'https://...' });
|
|
222
|
-
|
|
223
|
-
// Imported Numbers
|
|
224
|
-
await client.importedNumbers.create({ number: '+15551234567' });
|
|
225
|
-
|
|
226
|
-
// MFA
|
|
227
|
-
await client.mfa.sms({ to: '+15551234567', from: '+15559876543' });
|
|
228
|
-
await client.mfa.call({ to: '+15551234567', from: '+15559876543' });
|
|
229
|
-
await client.mfa.verify('request-id', { token: '1234' });
|
|
230
|
-
|
|
231
|
-
// Registry (10DLC)
|
|
232
|
-
await client.registry.brands.list();
|
|
233
|
-
await client.registry.brands.createCampaign('brand-id', { use_case: 'marketing' });
|
|
234
|
-
await client.registry.campaigns.listNumbers('campaign-id');
|
|
235
|
-
|
|
236
|
-
// Logs
|
|
237
|
-
await client.logs.voice.list({ page_size: 10 });
|
|
238
|
-
await client.logs.voice.listEvents('log-id');
|
|
239
|
-
await client.logs.messages.list();
|
|
240
|
-
await client.logs.fax.list();
|
|
241
|
-
await client.logs.conferences.list();
|
|
242
|
-
|
|
243
|
-
// Project tokens
|
|
244
|
-
await client.project.tokens.create({ label: 'ci-token' });
|
|
245
|
-
await client.project.tokens.update('token-id', { label: 'updated' });
|
|
246
|
-
await client.project.tokens.delete('token-id');
|
|
247
|
-
|
|
248
|
-
// PubSub & Chat tokens
|
|
249
|
-
await client.pubsub.createToken({ channels: ['updates'] });
|
|
250
|
-
await client.chat.createToken({ member_id: 'user-1' });
|
|
251
|
-
```
|
|
252
|
-
|
|
253
|
-
## Pagination
|
|
254
|
-
|
|
255
|
-
The client provides two pagination utilities that work with both standard (`links.next`) and LAML (`next_page_uri`) pagination styles.
|
|
256
|
-
|
|
257
|
-
### Async Generator
|
|
258
|
-
|
|
259
|
-
```typescript
|
|
260
|
-
import { RestClient, paginate, HttpClient } from '@signalwire/sdk';
|
|
261
|
-
|
|
262
|
-
// paginate() yields items one at a time across pages
|
|
263
|
-
for await (const number of paginate(httpClient, '/api/relay/rest/phone_numbers')) {
|
|
264
|
-
console.log(number.id, number.number);
|
|
265
|
-
}
|
|
266
|
-
```
|
|
267
|
-
|
|
268
|
-
### Collect All
|
|
269
|
-
|
|
270
|
-
```typescript
|
|
271
|
-
import { paginateAll } from '@signalwire/sdk';
|
|
272
|
-
|
|
273
|
-
const allNumbers = await paginateAll(httpClient, '/api/relay/rest/phone_numbers');
|
|
274
|
-
console.log(`Total: ${allNumbers.length}`);
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
### Custom Data Key
|
|
278
|
-
|
|
279
|
-
Some APIs use different keys for the data array. Use the `dataKey` parameter:
|
|
280
|
-
|
|
281
|
-
```typescript
|
|
282
|
-
// LAML uses resource-specific keys like "calls", "messages"
|
|
283
|
-
const allCalls = await paginateAll(httpClient, '/api/laml/.../Calls', undefined, 'calls');
|
|
284
|
-
```
|
|
285
|
-
|
|
286
|
-
## Error Handling
|
|
287
|
-
|
|
288
|
-
All HTTP errors throw `RestError` with status code, body, URL, and method:
|
|
289
|
-
|
|
290
|
-
```typescript
|
|
291
|
-
import { RestError } from '@signalwire/sdk';
|
|
292
|
-
|
|
293
|
-
try {
|
|
294
|
-
await client.phoneNumbers.get('nonexistent');
|
|
295
|
-
} catch (err) {
|
|
296
|
-
if (err instanceof RestError) {
|
|
297
|
-
console.error(`${err.method} ${err.url} returned ${err.statusCode}`);
|
|
298
|
-
console.error('Body:', err.body);
|
|
299
|
-
}
|
|
300
|
-
}
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
## Test Injection
|
|
304
|
-
|
|
305
|
-
For testing, inject a custom `fetch` implementation:
|
|
306
|
-
|
|
307
|
-
```typescript
|
|
308
|
-
const mockFetch = async (url, init) => new Response(JSON.stringify({ data: [] }));
|
|
309
|
-
|
|
310
|
-
const client = new RestClient({
|
|
311
|
-
project: 'test',
|
|
312
|
-
token: 'test',
|
|
313
|
-
host: 'test.signalwire.com',
|
|
314
|
-
fetchImpl: mockFetch,
|
|
315
|
-
});
|
|
316
|
-
```
|
|
317
|
-
|
|
318
|
-
This follows the same pattern as the RELAY client's `_wsFactory` injection.
|
|
319
|
-
|
|
320
|
-
## Architecture
|
|
321
|
-
|
|
322
|
-
```
|
|
323
|
-
RestClient
|
|
324
|
-
├── HttpClient (fetch + Basic Auth)
|
|
325
|
-
├── fabric: FabricNamespace (17 sub-resources)
|
|
326
|
-
├── calling: CallingNamespace (37 commands)
|
|
327
|
-
├── phoneNumbers: PhoneNumbersResource (CRUD + search)
|
|
328
|
-
├── addresses: AddressesResource
|
|
329
|
-
├── queues: QueuesResource (CRUD + members)
|
|
330
|
-
├── recordings: RecordingsResource
|
|
331
|
-
├── numberGroups: NumberGroupsResource (CRUD + membership)
|
|
332
|
-
├── verifiedCallers: VerifiedCallersResource (CRUD + verify)
|
|
333
|
-
├── sipProfile: SipProfileResource (singleton)
|
|
334
|
-
├── lookup: LookupResource
|
|
335
|
-
├── shortCodes: ShortCodesResource
|
|
336
|
-
├── importedNumbers: ImportedNumbersResource
|
|
337
|
-
├── mfa: MfaResource
|
|
338
|
-
├── registry: RegistryNamespace (brands, campaigns, orders, numbers)
|
|
339
|
-
├── datasphere: DatasphereNamespace (documents + chunks + search)
|
|
340
|
-
├── video: VideoNamespace (rooms, sessions, recordings, conferences, streams)
|
|
341
|
-
├── logs: LogsNamespace (messages, voice, fax, conferences)
|
|
342
|
-
├── project: ProjectNamespace (tokens)
|
|
343
|
-
├── pubsub: PubSubResource
|
|
344
|
-
├── chat: ChatResource
|
|
345
|
-
└── compat: CompatNamespace (Twilio-compatible, 12 sub-resources)
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
The base class hierarchy:
|
|
349
|
-
- `BaseResource` — holds `HttpClient` + base path, provides `_path()` helper
|
|
350
|
-
- `CrudResource` — adds `list()`, `create()`, `get()`, `update()`, `delete()` with configurable `_updateMethod` (PATCH or PUT)
|
|
351
|
-
- `CrudWithAddresses` — adds `listAddresses()` to CrudResource
|