@signalwire/sdk 2.0.4 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
# Messaging
|
|
2
|
+
|
|
3
|
+
The RELAY client sends and receives SMS and MMS messages over the same connection it uses for calls. This page covers sending, tracking delivery, receiving and the `Message` object.
|
|
4
|
+
|
|
5
|
+
<!-- snippet-setup -->
|
|
6
|
+
```ts
|
|
7
|
+
export {}; // treat each example as a module so top-level `await` is allowed
|
|
8
|
+
// Shared context: `client` is a constructed RelayClient (the full programs on this page build their own inside main()).
|
|
9
|
+
declare const client: import('@signalwire/sdk').RelayClient;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Sending Messages
|
|
13
|
+
|
|
14
|
+
Use `client.sendMessage()` to send an outbound SMS or MMS. It takes an options object and resolves with a `Message` that tracks delivery state:
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
const message = await client.sendMessage({
|
|
18
|
+
toNumber: '+15552222222',
|
|
19
|
+
fromNumber: '+15551111111',
|
|
20
|
+
body: 'Hello from SignalWire!',
|
|
21
|
+
});
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
`sendMessage()` resolves once the platform accepts the `messaging.send` request. The returned `Message` starts in state `queued`.
|
|
25
|
+
|
|
26
|
+
### Wait for delivery
|
|
27
|
+
|
|
28
|
+
Await `message.wait()` to pause until the message reaches `delivered`, `undelivered` or `failed`:
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
const message = await client.sendMessage({
|
|
32
|
+
toNumber: '+15552222222',
|
|
33
|
+
fromNumber: '+15551111111',
|
|
34
|
+
body: 'Hello!',
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
await message.wait(); // resolves at delivered, undelivered or failed
|
|
38
|
+
console.log(`Final state: ${message.state}`);
|
|
39
|
+
if (message.reason) {
|
|
40
|
+
console.log(`Reason: ${message.reason}`);
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
`wait()` accepts an optional timeout in **seconds**, and rejects with an `Error` when it passes:
|
|
45
|
+
|
|
46
|
+
<!-- snippet: no-run illustrative fragment: references the assumed `message` object established earlier on the page -->
|
|
47
|
+
```typescript
|
|
48
|
+
declare const message: import('@signalwire/sdk').Message;
|
|
49
|
+
await message.wait(30); // rejects if no terminal state within 30 seconds
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Continue without waiting
|
|
53
|
+
|
|
54
|
+
Skip `wait()` to continue immediately. The client keeps updating the message's `state` as events arrive:
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
const message = await client.sendMessage({
|
|
58
|
+
toNumber: '+15552222222',
|
|
59
|
+
fromNumber: '+15551111111',
|
|
60
|
+
body: 'Hello!',
|
|
61
|
+
});
|
|
62
|
+
// don't call message.wait(); continue immediately
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Run a callback on completion
|
|
66
|
+
|
|
67
|
+
Pass `onCompleted` to run a function when the message reaches a terminal state:
|
|
68
|
+
|
|
69
|
+
```typescript
|
|
70
|
+
const message = await client.sendMessage({
|
|
71
|
+
toNumber: '+15552222222',
|
|
72
|
+
fromNumber: '+15551111111',
|
|
73
|
+
body: 'Hello!',
|
|
74
|
+
onCompleted: (event) => console.log(`Delivery: ${event.params.message_state}`),
|
|
75
|
+
});
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
The callback may be sync or async, and the SDK logs its errors.
|
|
79
|
+
|
|
80
|
+
### MMS (media messages)
|
|
81
|
+
|
|
82
|
+
Pass `media` with one or more URLs to send an MMS:
|
|
83
|
+
|
|
84
|
+
```typescript
|
|
85
|
+
const message = await client.sendMessage({
|
|
86
|
+
toNumber: '+15552222222',
|
|
87
|
+
fromNumber: '+15551111111',
|
|
88
|
+
body: 'Check this out!',
|
|
89
|
+
media: ['https://example.com/image.jpg'],
|
|
90
|
+
});
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### All options
|
|
94
|
+
|
|
95
|
+
`sendMessage()` accepts these options:
|
|
96
|
+
|
|
97
|
+
```typescript
|
|
98
|
+
const message = await client.sendMessage({
|
|
99
|
+
toNumber: '+15552222222', // required, E.164 format
|
|
100
|
+
fromNumber: '+15551111111', // required, E.164 format
|
|
101
|
+
body: 'Message text', // required if no media
|
|
102
|
+
media: ['https://example.com/image.jpg'], // required if no body
|
|
103
|
+
context: 'my_context', // context for state events (default: the client's relay protocol, or 'default' before it has one)
|
|
104
|
+
tags: ['vip', 'support'], // tags attached to the message
|
|
105
|
+
region: 'us', // origination region
|
|
106
|
+
onCompleted: (event) => {}, // completion callback
|
|
107
|
+
});
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
`sendMessage()` throws an `Error` when both `body` and `media` are missing. The SDK doesn't validate the phone number format.
|
|
111
|
+
|
|
112
|
+
## Receiving Messages
|
|
113
|
+
|
|
114
|
+
Register a handler with `client.onMessage()` to receive inbound SMS and MMS on the contexts the client subscribes to. This program replies to every message it receives:
|
|
115
|
+
|
|
116
|
+
<!-- snippet: no-run client.run() opens a live WebSocket to SIGNALWIRE_SPACE and runs until SIGINT/SIGTERM; it can't reach the loopback mock standalone -->
|
|
117
|
+
```typescript
|
|
118
|
+
import { RelayClient } from '@signalwire/sdk';
|
|
119
|
+
|
|
120
|
+
async function main() {
|
|
121
|
+
const client = new RelayClient({
|
|
122
|
+
project: 'your-project-id',
|
|
123
|
+
token: 'your-api-token',
|
|
124
|
+
host: 'example.signalwire.com',
|
|
125
|
+
contexts: ['default'],
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
client.onMessage(async (message) => {
|
|
129
|
+
console.log(`From: ${message.fromNumber}`);
|
|
130
|
+
console.log(`To: ${message.toNumber}`);
|
|
131
|
+
console.log(`Body: ${message.body}`);
|
|
132
|
+
if (message.media.length) {
|
|
133
|
+
console.log(`Media: ${message.media.join(', ')}`);
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
// Reply
|
|
137
|
+
await client.sendMessage({
|
|
138
|
+
toNumber: message.fromNumber,
|
|
139
|
+
fromNumber: message.toNumber,
|
|
140
|
+
body: `You said: ${message.body}`,
|
|
141
|
+
});
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
await client.run();
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
await main();
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
An inbound message arrives in state `received` and gets no further state events, so don't call `wait()` on it: its promise never settles.
|
|
151
|
+
|
|
152
|
+
## Message Object
|
|
153
|
+
|
|
154
|
+
### Properties
|
|
155
|
+
|
|
156
|
+
A `Message` has these properties:
|
|
157
|
+
|
|
158
|
+
| Property | Type | Description |
|
|
159
|
+
|----------|------|-------------|
|
|
160
|
+
| `messageId` | `string` | Message identifier assigned by the platform |
|
|
161
|
+
| `context` | `string` | Context the message belongs to |
|
|
162
|
+
| `direction` | `string` | `inbound` or `outbound` |
|
|
163
|
+
| `fromNumber` | `string` | Sender phone number (E.164) |
|
|
164
|
+
| `toNumber` | `string` | Recipient phone number (E.164) |
|
|
165
|
+
| `body` | `string` | Text body of the message |
|
|
166
|
+
| `media` | `string[]` | Media URLs (MMS) |
|
|
167
|
+
| `segments` | `number` | Number of segments, from the inbound event (`0` for outbound messages) |
|
|
168
|
+
| `state` | `MessageState` | Current message state |
|
|
169
|
+
| `reason` | `string` | Failure reason the platform sent with a state event, for example with `undelivered` or `failed` |
|
|
170
|
+
| `tags` | `string[]` | Tags attached to the message |
|
|
171
|
+
| `isDone` | `boolean` | `true` once the message has reached a terminal state through a state event |
|
|
172
|
+
| `isTerminal` | `boolean` | `true` when `state` is `delivered`, `undelivered` or `failed` |
|
|
173
|
+
| `result` | `RelayEvent \| null` | The terminal event, or `null` before one arrives |
|
|
174
|
+
|
|
175
|
+
For an outbound message, the client updates only `state` and `reason` from the platform's events. The other properties hold the values you sent.
|
|
176
|
+
|
|
177
|
+
### Methods
|
|
178
|
+
|
|
179
|
+
A `Message` has these methods:
|
|
180
|
+
|
|
181
|
+
| Method | Description |
|
|
182
|
+
|--------|-------------|
|
|
183
|
+
| `await message.wait(timeout?)` | Resolves with the terminal `messaging.state` event. `timeout` is in **seconds**. |
|
|
184
|
+
| `message.on(handler)` | Registers a listener that runs for every `messaging.state` event for this message |
|
|
185
|
+
| `message.toString()` | Returns `Message(id=..., direction=..., state=..., from=..., to=...)` for logging |
|
|
186
|
+
|
|
187
|
+
`wait()`, `on()` listeners and `onCompleted` receive a plain `RelayEvent`; read the raw fields from `event.params`.
|
|
188
|
+
|
|
189
|
+
### Message States
|
|
190
|
+
|
|
191
|
+
Outbound messages move through these states:
|
|
192
|
+
|
|
193
|
+
| State | Description |
|
|
194
|
+
|-------|-------------|
|
|
195
|
+
| `queued` | Message accepted and queued for sending |
|
|
196
|
+
| `initiated` | Sending has started |
|
|
197
|
+
| `sent` | Message sent to carrier |
|
|
198
|
+
| `delivered` | Message delivered to recipient (terminal) |
|
|
199
|
+
| `undelivered` | Delivery failed (terminal); check `reason` |
|
|
200
|
+
| `failed` | Message failed to send (terminal); check `reason` |
|
|
201
|
+
|
|
202
|
+
Inbound messages arrive with state `received`.
|
|
203
|
+
|
|
204
|
+
## Event Types
|
|
205
|
+
|
|
206
|
+
The typed classes for messaging events are `MessageReceiveEvent` (`messaging.receive`) and `MessageStateEvent` (`messaging.state`). `parseEvent()` builds them from raw payloads; the `Message` API itself doesn't use them. Import them from the package:
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
import { MessageReceiveEvent, MessageStateEvent } from '@signalwire/sdk';
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
## Combining Calls and Messages
|
|
213
|
+
|
|
214
|
+
One `RelayClient` handles both calls and messages:
|
|
215
|
+
|
|
216
|
+
<!-- snippet: no-run client.run() opens a live WebSocket to SIGNALWIRE_SPACE and runs until SIGINT/SIGTERM; it can't reach the loopback mock standalone -->
|
|
217
|
+
```typescript
|
|
218
|
+
import { RelayClient } from '@signalwire/sdk';
|
|
219
|
+
|
|
220
|
+
async function main() {
|
|
221
|
+
const client = new RelayClient({ project: 'your-project-id', token: 'your-api-token', contexts: ['default'] });
|
|
222
|
+
|
|
223
|
+
client.onCall(async (call) => {
|
|
224
|
+
await call.answer();
|
|
225
|
+
const action = await call.play([{ type: 'tts', params: { text: 'Hello!' } }]);
|
|
226
|
+
await action.wait();
|
|
227
|
+
await call.hangup();
|
|
228
|
+
});
|
|
229
|
+
|
|
230
|
+
client.onMessage(async (message) => {
|
|
231
|
+
console.log(`SMS from ${message.fromNumber}: ${message.body}`);
|
|
232
|
+
});
|
|
233
|
+
|
|
234
|
+
await client.run();
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
await main();
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
## Next Steps
|
|
241
|
+
|
|
242
|
+
Continue with these pages:
|
|
243
|
+
|
|
244
|
+
- [Client Reference](client-reference.md): `RelayClient` options and methods
|
|
245
|
+
- [Events](events.md): handling real-time call and message events
|
|
246
|
+
- [Getting Started](getting-started.md): connecting and placing a first call
|
|
@@ -0,0 +1,66 @@
|
|
|
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 } from '@signalwire/sdk';
|
|
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 (
|
|
51
|
+
await call.play([
|
|
52
|
+
{ type: 'tts', text: `You entered ${digitParams?.digits ?? 'nothing'}. Thank you!` },
|
|
53
|
+
])
|
|
54
|
+
).wait();
|
|
55
|
+
} else {
|
|
56
|
+
await (await call.play([{ type: 'tts', text: 'No input received. Goodbye!' }])).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();
|
|
@@ -0,0 +1,74 @@
|
|
|
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 '@signalwire/sdk';
|
|
18
|
+
|
|
19
|
+
const toEnv = process.env.MSG_TO;
|
|
20
|
+
const fromEnv = process.env.MSG_FROM;
|
|
21
|
+
|
|
22
|
+
if (!toEnv || !fromEnv) {
|
|
23
|
+
console.error('Set MSG_TO and MSG_FROM env vars');
|
|
24
|
+
process.exit(1);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const to: string = toEnv;
|
|
28
|
+
const from: string = fromEnv;
|
|
29
|
+
|
|
30
|
+
const client = new RelayClient({
|
|
31
|
+
contexts: ['messaging'],
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
// Handle inbound messages
|
|
35
|
+
client.onMessage(async (message: Message) => {
|
|
36
|
+
console.log(`Inbound message from ${message.fromNumber}: ${message.body}`);
|
|
37
|
+
console.log(` media: ${message.media.length > 0 ? message.media.join(', ') : 'none'}`);
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
async function sendAndWait() {
|
|
41
|
+
await client.connect();
|
|
42
|
+
console.log('Connected to RELAY');
|
|
43
|
+
|
|
44
|
+
// Send outbound SMS
|
|
45
|
+
console.log(`Sending SMS to ${to}...`);
|
|
46
|
+
const message = await client.sendMessage({
|
|
47
|
+
toNumber: to,
|
|
48
|
+
fromNumber: from,
|
|
49
|
+
body: 'Hello from SignalWire RELAY TypeScript SDK!',
|
|
50
|
+
});
|
|
51
|
+
console.log(`Message queued: id=${message.messageId}`);
|
|
52
|
+
|
|
53
|
+
// Track delivery
|
|
54
|
+
message.on(async (event) => {
|
|
55
|
+
console.log(`Message state: ${event.params.message_state}`);
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
try {
|
|
59
|
+
await message.wait(30);
|
|
60
|
+
console.log(`Final state: ${message.state}`);
|
|
61
|
+
if (message.reason) {
|
|
62
|
+
console.log(`Reason: ${message.reason}`);
|
|
63
|
+
}
|
|
64
|
+
} catch (err) {
|
|
65
|
+
console.error(`Message tracking error: ${err}`);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
console.log('Now listening for inbound messages... (Ctrl+C to stop)');
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
sendAndWait().catch(console.error);
|
|
72
|
+
|
|
73
|
+
// Keep running to receive inbound messages
|
|
74
|
+
client.run();
|
|
@@ -0,0 +1,76 @@
|
|
|
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 '@signalwire/sdk';
|
|
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 }, // seconds
|
|
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);
|
|
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
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# SignalWire REST Client
|
|
2
|
+
|
|
3
|
+
`RestClient` is a typed HTTP client for the SignalWire platform APIs. You use it from TypeScript to manage resources such as phone numbers, AI agents and video rooms, and to control live calls. It sends standard HTTP requests with `fetch` and needs no WebSocket connection.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
This example creates a client, creates an AI agent, searches for phone numbers and places a call:
|
|
8
|
+
|
|
9
|
+
<!-- snippet: no-run makes live REST calls to a real SignalWire space; the loopback-mock override is documented in "Pointing at a non-default endpoint" -->
|
|
10
|
+
```typescript
|
|
11
|
+
import { RestClient } from '@signalwire/sdk';
|
|
12
|
+
|
|
13
|
+
const client = new RestClient({
|
|
14
|
+
project: 'your-project-id',
|
|
15
|
+
token: 'your-api-token',
|
|
16
|
+
host: 'example.signalwire.com',
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
// Create an AI agent
|
|
20
|
+
const agent = await client.fabric.aiAgents.create({
|
|
21
|
+
name: 'Support Bot',
|
|
22
|
+
prompt: { text: 'You are a helpful support agent.' },
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
// Search for a phone number
|
|
26
|
+
const results = await client.phoneNumbers.search({ areacode: '512' });
|
|
27
|
+
|
|
28
|
+
// Place a call via REST; from and to are positional
|
|
29
|
+
await client.calling.dial('+15559876543', '+15551234567', {
|
|
30
|
+
url: 'https://example.com/call-handler',
|
|
31
|
+
});
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Every method is async and returns the parsed JSON response.
|
|
35
|
+
|
|
36
|
+
## Pointing at a non-default endpoint
|
|
37
|
+
|
|
38
|
+
By default the client talks to your SignalWire space over `https://`. To point it at a local mock, a private space or a proxy, use one of these settings. The client checks them in this order:
|
|
39
|
+
|
|
40
|
+
1. The `host` option. A value that starts with `http` is used as the full base URL:
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
import { RestClient } from '@signalwire/sdk';
|
|
44
|
+
|
|
45
|
+
const client = new RestClient({
|
|
46
|
+
project: 'your-project-id',
|
|
47
|
+
token: 'your-api-token',
|
|
48
|
+
host: 'http://127.0.0.1:8933', // a full URL is used as is
|
|
49
|
+
});
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
2. The `SIGNALWIRE_REST_BASE_URL` environment variable, a full URL. It applies when you don't pass `host`.
|
|
53
|
+
3. The `SIGNALWIRE_SPACE` environment variable, a bare host such as `example.signalwire.com`. The client adds `https://`.
|
|
54
|
+
|
|
55
|
+
When the bare host is a loopback address (`127.0.0.1`, `localhost` or `::1`, with or without a port), the client uses `http://` instead of `https://`. That lets it reach a local mock server.
|
|
56
|
+
|
|
57
|
+
To trust a private or self-signed certificate, set `SIGNALWIRE_REST_CA_FILE` to a PEM bundle. The bundle replaces Node's default trust roots for REST requests. The client loads it through the `undici` package. If the file or `undici` can't be loaded, the client logs `rest_ca_file_load_failed` and uses Node's default trust store.
|
|
58
|
+
|
|
59
|
+
## Features
|
|
60
|
+
|
|
61
|
+
The client covers these API areas:
|
|
62
|
+
|
|
63
|
+
- One `RestClient` with a property for each API area, such as `client.fabric` and `client.calling`
|
|
64
|
+
- Every command of the Calling API: dial, play, record, collect, detect, tap, stream, AI control, transcription and more
|
|
65
|
+
- The Fabric API resources (AI agents, SWML scripts, subscribers, call flows and others), with CRUD, address listing and tokens
|
|
66
|
+
- Datasphere document management and semantic search
|
|
67
|
+
- Video rooms, sessions, recordings, conferences, tokens and streams
|
|
68
|
+
- Phone numbers, messaging, 10DLC registry, MFA, logs and project tokens
|
|
69
|
+
- A `requestOptions` setting on every request for timeouts, retries and cancellation
|
|
70
|
+
- An injectable `fetchImpl` for tests
|
|
71
|
+
|
|
72
|
+
The client uses the `fetch` built into Node.js 22 and later.
|
|
73
|
+
|
|
74
|
+
## Documentation
|
|
75
|
+
|
|
76
|
+
These pages cover the client in depth:
|
|
77
|
+
|
|
78
|
+
- [Getting Started](docs/getting-started.md): installation, configuration and your first API call
|
|
79
|
+
- [REST Client Guide](docs/guide.md): namespaces, pagination, request options, error handling and test injection
|
|
80
|
+
- [Client Reference](docs/client-reference.md): the `RestClient` constructor, every namespace and the error class
|
|
81
|
+
- [Fabric Resources](docs/fabric.md): AI agents, SWML scripts, subscribers, call flows, addresses and tokens
|
|
82
|
+
- [Binding a phone number to a call handler](docs/phone-binding.md): the `PhoneCallHandler` values and the `phoneNumbers.set*` helpers
|
|
83
|
+
- [Calling Commands](docs/calling.md): REST-based call control
|
|
84
|
+
- [All Namespaces](docs/namespaces.md): phone numbers, messaging, video, Datasphere, logs, registry and more
|
|
85
|
+
|
|
86
|
+
## Examples
|
|
87
|
+
|
|
88
|
+
These examples are in the repository:
|
|
89
|
+
|
|
90
|
+
- [rest-client.ts](examples/rest-client.ts): list numbers, agents, rooms, documents and logs
|
|
91
|
+
- [rest-manage-resources.ts](examples/rest-manage-resources.ts): create an AI agent, assign a number and place a call
|
|
92
|
+
- [rest-bind-phone-to-swml-webhook.ts](examples/rest-bind-phone-to-swml-webhook.ts): route a phone number to an SWML webhook
|
|
93
|
+
- [rest-datasphere-search.ts](examples/rest-datasphere-search.ts): upload a document and run a semantic search
|
|
94
|
+
- [rest-calling-play-and-record.ts](examples/rest-calling-play-and-record.ts): play, record, transcribe and denoise
|
|
95
|
+
- [rest-calling-ivr-and-ai.ts](examples/rest-calling-ivr-and-ai.ts): IVR input, detection, AI, tap, stream and SIP REFER
|
|
96
|
+
- [rest-fabric-swml-and-callflows.ts](examples/rest-fabric-swml-and-callflows.ts): SWML scripts, call flows and webhooks
|
|
97
|
+
- [rest-fabric-subscribers-and-sip.ts](examples/rest-fabric-subscribers-and-sip.ts): subscribers, SIP endpoints and gateways
|
|
98
|
+
- [rest-fabric-conferences-and-routing.ts](examples/rest-fabric-conferences-and-routing.ts): conferences, cXML, routing and tokens
|
|
99
|
+
- [rest-phone-number-management.ts](examples/rest-phone-number-management.ts): search, purchase, groups, lookup and verified callers
|
|
100
|
+
- [rest-queues-mfa-and-recordings.ts](examples/rest-queues-mfa-and-recordings.ts): queues, recordings and MFA
|
|
101
|
+
- [rest-video-rooms.ts](examples/rest-video-rooms.ts): video rooms, sessions, conferences and streams
|
|
102
|
+
- [rest-10dlc-registration.ts](examples/rest-10dlc-registration.ts): 10DLC brand and campaign registration
|
|
103
|
+
|
|
104
|
+
## Environment Variables
|
|
105
|
+
|
|
106
|
+
The client reads these variables:
|
|
107
|
+
|
|
108
|
+
| Variable | Description |
|
|
109
|
+
|----------|-------------|
|
|
110
|
+
| `SIGNALWIRE_PROJECT_ID` | Project ID for authentication, used when you don't pass `project` |
|
|
111
|
+
| `SIGNALWIRE_API_TOKEN` | API token for authentication, used when you don't pass `token` |
|
|
112
|
+
| `SIGNALWIRE_SPACE` | Space hostname (for example `example.signalwire.com`), used when you don't pass `host` |
|
|
113
|
+
| `SIGNALWIRE_REST_BASE_URL` | Full base URL; takes precedence over `SIGNALWIRE_SPACE` |
|
|
114
|
+
| `SIGNALWIRE_REST_CA_FILE` | PEM bundle to trust for REST HTTPS requests |
|
|
115
|
+
| `SIGNALWIRE_LOG_LEVEL` | Log level; `debug` logs the method and URL of each request |
|
|
116
|
+
|
|
117
|
+
## Module Structure
|
|
118
|
+
|
|
119
|
+
The client's code lives in `src/rest/`:
|
|
120
|
+
|
|
121
|
+
```text
|
|
122
|
+
src/rest/
|
|
123
|
+
index.ts # RestClient + public exports
|
|
124
|
+
HttpClient.ts # fetch-based HTTP with Basic Auth, retries and the CA bundle
|
|
125
|
+
RequestOptions.ts # timeout, retry and abort settings
|
|
126
|
+
RestError.ts # RestError and RestTransportError
|
|
127
|
+
pagination.ts # paginate() async generator + paginateAll()
|
|
128
|
+
callHandler.ts # PhoneCallHandler values for phoneNumbers.update
|
|
129
|
+
types.ts # ClientOptions, PaginatedResponse, QueryParams
|
|
130
|
+
base/
|
|
131
|
+
BaseResource.ts # Base class with the HttpClient and _path()
|
|
132
|
+
ReadResource.ts # list(), get() and paginate()
|
|
133
|
+
CrudResource.ts # ReadResource + create(), update(), delete()
|
|
134
|
+
CrudWithAddresses.ts # CrudResource + listAddresses()
|
|
135
|
+
FabricResource.ts # Fabric bases (PATCH or PUT updates)
|
|
136
|
+
namespaces/
|
|
137
|
+
*.resources.generated.ts # resource classes generated from the OpenAPI specs
|
|
138
|
+
*.types.generated.ts # request and response types
|
|
139
|
+
_client_tree_generated.ts # the namespace properties on RestClient
|
|
140
|
+
fabric.ts, calling.ts, ... # re-exports and compatibility aliases
|
|
141
|
+
```
|