@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,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* REST Example: Bind an inbound phone number to an SWML webhook (the happy path).
|
|
3
|
+
*
|
|
4
|
+
* This is the simplest way to route a SignalWire phone number to a backend
|
|
5
|
+
* that returns an SWML document per inbound call. You set `call_handler`
|
|
6
|
+
* on the phone number; the server auto-materializes a `swml_webhook`
|
|
7
|
+
* Fabric resource pointing at your URL. You do **not** need to create the
|
|
8
|
+
* Fabric webhook resource manually; you do **not** call `assignPhoneRoute`.
|
|
9
|
+
*
|
|
10
|
+
* Prerequisites:
|
|
11
|
+
* export SIGNALWIRE_PROJECT_ID=your-project-id
|
|
12
|
+
* export SIGNALWIRE_API_TOKEN=your-api-token
|
|
13
|
+
* export SIGNALWIRE_SPACE=your-space.signalwire.com
|
|
14
|
+
* export PHONE_NUMBER_SID=pn-... # SID of a phone number you own
|
|
15
|
+
* export SWML_WEBHOOK_URL=https://... # your backend's SWML endpoint
|
|
16
|
+
*
|
|
17
|
+
* Run:
|
|
18
|
+
* npx tsx rest/examples/rest-bind-phone-to-swml-webhook.ts
|
|
19
|
+
*/
|
|
20
|
+
|
|
21
|
+
import { RestClient, PhoneCallHandler } from '@signalwire/sdk';
|
|
22
|
+
|
|
23
|
+
async function main(): Promise<void> {
|
|
24
|
+
// Read the resource identifiers from the environment; fall back to placeholders
|
|
25
|
+
// so the example runs verbatim against the local mock (which serves any
|
|
26
|
+
// well-formed SID). A real run exports your own PHONE_NUMBER_SID / SWML_WEBHOOK_URL.
|
|
27
|
+
const pnSid = process.env['PHONE_NUMBER_SID'] ?? 'pn-00000000-0000-0000-0000-000000000000';
|
|
28
|
+
const webhookUrl = process.env['SWML_WEBHOOK_URL'] ?? 'https://example.com/swml';
|
|
29
|
+
|
|
30
|
+
const client = new RestClient();
|
|
31
|
+
|
|
32
|
+
// The typed helper — one line:
|
|
33
|
+
console.log(`Binding ${pnSid} to ${webhookUrl} ...`);
|
|
34
|
+
await client.phoneNumbers.setSwmlWebhook(pnSid, webhookUrl);
|
|
35
|
+
|
|
36
|
+
// The equivalent wire-level form (use this if you need unusual fields):
|
|
37
|
+
//
|
|
38
|
+
// await client.phoneNumbers.update(pnSid, {
|
|
39
|
+
// call_handler: PhoneCallHandler.RELAY_SCRIPT,
|
|
40
|
+
// call_relay_script_url: webhookUrl,
|
|
41
|
+
// });
|
|
42
|
+
|
|
43
|
+
// Verify: the server auto-created a swml_webhook Fabric resource.
|
|
44
|
+
const pn = await client.phoneNumbers.get(pnSid);
|
|
45
|
+
console.log(` call_handler = ${JSON.stringify(pn.call_handler)}`);
|
|
46
|
+
console.log(` call_relay_script_url = ${JSON.stringify(pn.call_relay_script_url)}`);
|
|
47
|
+
console.log(
|
|
48
|
+
` calling_handler_resource_id (server-derived) = ${JSON.stringify(pn.calling_handler_resource_id)}`,
|
|
49
|
+
);
|
|
50
|
+
|
|
51
|
+
// To route to something other than an SWML webhook, use:
|
|
52
|
+
// client.phoneNumbers.setCxmlWebhook(sid, { url }) // LAML / Twilio-compat
|
|
53
|
+
// client.phoneNumbers.setAiAgent(sid, agentId) // AI Agent
|
|
54
|
+
// client.phoneNumbers.setCallFlow(sid, { flowId }) // Call Flow
|
|
55
|
+
// client.phoneNumbers.setRelayApplication(sid, name) // Named RELAY app
|
|
56
|
+
// client.phoneNumbers.setRelayTopic(sid, { topic }) // RELAY topic
|
|
57
|
+
|
|
58
|
+
// Keep PhoneCallHandler referenced so eslint/tsc don't strip it from the
|
|
59
|
+
// illustrative "wire-level form" comment above.
|
|
60
|
+
void PhoneCallHandler;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
main().catch((err) => {
|
|
64
|
+
console.error('Error:', err.message);
|
|
65
|
+
process.exit(1);
|
|
66
|
+
});
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* REST Example: IVR input collection, AI operations, and advanced call control.
|
|
3
|
+
*
|
|
4
|
+
* NOTE: These commands require an active call. The CALL_ID used here is
|
|
5
|
+
* illustrative -- in production you would obtain it from a dial response or
|
|
6
|
+
* inbound call event.
|
|
7
|
+
*
|
|
8
|
+
* Prerequisites:
|
|
9
|
+
* export SIGNALWIRE_PROJECT_ID=your-project-id
|
|
10
|
+
* export SIGNALWIRE_API_TOKEN=your-api-token
|
|
11
|
+
* export SIGNALWIRE_SPACE=your-space.signalwire.com
|
|
12
|
+
*
|
|
13
|
+
* Run:
|
|
14
|
+
* npx tsx rest/examples/rest-calling-ivr-and-ai.ts
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import { RestClient, RestError } from '@signalwire/sdk';
|
|
18
|
+
|
|
19
|
+
const client = new RestClient();
|
|
20
|
+
const CALL_ID = 'demo-call-id';
|
|
21
|
+
|
|
22
|
+
async function safe<T>(label: string, fn: () => Promise<T>): Promise<T | null> {
|
|
23
|
+
try {
|
|
24
|
+
const result = await fn();
|
|
25
|
+
console.log(` ${label}: OK`);
|
|
26
|
+
return result;
|
|
27
|
+
} catch (err) {
|
|
28
|
+
if (err instanceof RestError) {
|
|
29
|
+
console.log(` ${label}: failed (${err.statusCode})`);
|
|
30
|
+
} else throw err;
|
|
31
|
+
return null;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
async function main() {
|
|
36
|
+
// 1. Collect DTMF input
|
|
37
|
+
console.log('Collecting DTMF input...');
|
|
38
|
+
await safe('Collect', () =>
|
|
39
|
+
client.calling.collect(CALL_ID, {
|
|
40
|
+
control_id: 'collect-1',
|
|
41
|
+
initial_timeout: 10,
|
|
42
|
+
digits: { max: 4, terminators: '#' },
|
|
43
|
+
}),
|
|
44
|
+
);
|
|
45
|
+
await safe('Start input timers', () =>
|
|
46
|
+
client.calling.collectStartInputTimers(CALL_ID, 'collect-1'),
|
|
47
|
+
);
|
|
48
|
+
await safe('Stop collect', () => client.calling.collectStop(CALL_ID, 'collect-1'));
|
|
49
|
+
|
|
50
|
+
// 2. Answering machine detection
|
|
51
|
+
console.log('\nDetecting answering machine...');
|
|
52
|
+
await safe('Detect', () =>
|
|
53
|
+
client.calling.detect(CALL_ID, { type: 'machine' }, { control_id: 'detect-1' }),
|
|
54
|
+
);
|
|
55
|
+
await safe('Stop detect', () => client.calling.detectStop(CALL_ID, 'detect-1'));
|
|
56
|
+
|
|
57
|
+
// 3. AI operations
|
|
58
|
+
console.log('\nAI agent operations...');
|
|
59
|
+
await safe('AI message', () =>
|
|
60
|
+
client.calling.aiMessage(CALL_ID, {
|
|
61
|
+
role: 'system',
|
|
62
|
+
message_text: 'The customer wants to check their balance.',
|
|
63
|
+
}),
|
|
64
|
+
);
|
|
65
|
+
await safe('AI hold', () => client.calling.aiHold(CALL_ID));
|
|
66
|
+
await safe('AI unhold', () => client.calling.aiUnhold(CALL_ID));
|
|
67
|
+
await safe('AI stop', () => client.calling.aiStop(CALL_ID, 'ai-1'));
|
|
68
|
+
|
|
69
|
+
// 4. Live transcription and translation
|
|
70
|
+
console.log('\nLive transcription and translation...');
|
|
71
|
+
await safe('Live transcribe', () =>
|
|
72
|
+
client.calling.liveTranscribe(CALL_ID, {
|
|
73
|
+
start: { lang: 'en-US', direction: ['remote-caller'] },
|
|
74
|
+
}),
|
|
75
|
+
);
|
|
76
|
+
await safe('Live translate', () =>
|
|
77
|
+
client.calling.liveTranslate(CALL_ID, {
|
|
78
|
+
start: { from_lang: 'en-US', to_lang: 'es-ES', direction: ['remote-caller'] },
|
|
79
|
+
}),
|
|
80
|
+
);
|
|
81
|
+
|
|
82
|
+
// 5. Tap (media fork)
|
|
83
|
+
console.log('\nTap (media fork)...');
|
|
84
|
+
await safe('Tap start', () =>
|
|
85
|
+
client.calling.tap(
|
|
86
|
+
CALL_ID,
|
|
87
|
+
{ type: 'audio', params: { direction: 'both' } },
|
|
88
|
+
{ type: 'rtp', params: { addr: '192.168.1.100', port: 9000 } },
|
|
89
|
+
),
|
|
90
|
+
);
|
|
91
|
+
await safe('Tap stop', () => client.calling.tapStop(CALL_ID, 'tap-1'));
|
|
92
|
+
|
|
93
|
+
// 6. Stream (WebSocket)
|
|
94
|
+
console.log('\nStream (WebSocket)...');
|
|
95
|
+
await safe('Stream start', () =>
|
|
96
|
+
client.calling.stream(CALL_ID, 'wss://example.com/audio-stream'),
|
|
97
|
+
);
|
|
98
|
+
await safe('Stream stop', () => client.calling.streamStop(CALL_ID, 'stream-1'));
|
|
99
|
+
|
|
100
|
+
// 7. User event
|
|
101
|
+
console.log('\nSending user event...');
|
|
102
|
+
await safe('User event', () =>
|
|
103
|
+
client.calling.userEvent(CALL_ID, {
|
|
104
|
+
event: { agent_note: { note: 'VIP caller' } },
|
|
105
|
+
}),
|
|
106
|
+
);
|
|
107
|
+
|
|
108
|
+
// 8. SIP refer
|
|
109
|
+
console.log('\nSIP refer...');
|
|
110
|
+
await safe('SIP refer', () =>
|
|
111
|
+
client.calling.refer(CALL_ID, {
|
|
112
|
+
device: { type: 'sip', params: { to: 'sip:support@example.com' } },
|
|
113
|
+
}),
|
|
114
|
+
);
|
|
115
|
+
|
|
116
|
+
// 9. Fax stop commands
|
|
117
|
+
console.log('\nFax stop commands...');
|
|
118
|
+
await safe('Send fax stop', () => client.calling.sendFaxStop(CALL_ID, 'fax-1'));
|
|
119
|
+
await safe('Receive fax stop', () => client.calling.receiveFaxStop(CALL_ID, 'fax-1'));
|
|
120
|
+
|
|
121
|
+
// 10. Transfer and disconnect
|
|
122
|
+
console.log('\nTransfer and disconnect...');
|
|
123
|
+
await safe('Transfer', () => client.calling.transfer(CALL_ID, '+15559999999'));
|
|
124
|
+
await safe('Update call', () =>
|
|
125
|
+
client.calling.update(CALL_ID, {
|
|
126
|
+
status_url: 'https://example.com/status',
|
|
127
|
+
url: 'https://example.com/swml/next-step',
|
|
128
|
+
}),
|
|
129
|
+
);
|
|
130
|
+
await safe('Disconnect', () => client.calling.disconnect(CALL_ID));
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
main().catch((err) => {
|
|
134
|
+
console.error('Error:', err.message);
|
|
135
|
+
process.exit(1);
|
|
136
|
+
});
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* REST Example: Control an active call with media operations (play, record, transcribe, denoise).
|
|
3
|
+
*
|
|
4
|
+
* NOTE: These commands require an active call. The call_id used here is
|
|
5
|
+
* illustrative -- in production you would obtain it from a dial response or
|
|
6
|
+
* inbound call event.
|
|
7
|
+
*
|
|
8
|
+
* Prerequisites:
|
|
9
|
+
* export SIGNALWIRE_PROJECT_ID=your-project-id
|
|
10
|
+
* export SIGNALWIRE_API_TOKEN=your-api-token
|
|
11
|
+
* export SIGNALWIRE_SPACE=your-space.signalwire.com
|
|
12
|
+
*
|
|
13
|
+
* Run:
|
|
14
|
+
* npx tsx rest/examples/rest-calling-play-and-record.ts
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import { RestClient, RestError } from '@signalwire/sdk';
|
|
18
|
+
|
|
19
|
+
const client = new RestClient();
|
|
20
|
+
|
|
21
|
+
async function safe<T>(label: string, fn: () => Promise<T>): Promise<T | null> {
|
|
22
|
+
try {
|
|
23
|
+
const result = await fn();
|
|
24
|
+
console.log(` ${label}: OK`);
|
|
25
|
+
return result;
|
|
26
|
+
} catch (err) {
|
|
27
|
+
if (err instanceof RestError) {
|
|
28
|
+
console.log(` ${label}: failed (${err.statusCode})`);
|
|
29
|
+
} else throw err;
|
|
30
|
+
return null;
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
async function main() {
|
|
35
|
+
// 1. Dial an outbound call
|
|
36
|
+
console.log('Dialing outbound call...');
|
|
37
|
+
let callId = 'demo-call-id';
|
|
38
|
+
try {
|
|
39
|
+
const call = await client.calling.dial('+15559876543', '+15551234567', {
|
|
40
|
+
url: 'https://example.com/call-handler',
|
|
41
|
+
});
|
|
42
|
+
callId = call.id ?? 'demo-call-id';
|
|
43
|
+
console.log(` Call initiated: ${callId}`);
|
|
44
|
+
} catch (err) {
|
|
45
|
+
if (err instanceof RestError) {
|
|
46
|
+
console.log(` Dial failed (expected in demo): ${err.statusCode}`);
|
|
47
|
+
} else throw err;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
// 2. Play TTS audio
|
|
51
|
+
console.log('\nPlaying TTS on call...');
|
|
52
|
+
await safe('Play', () =>
|
|
53
|
+
client.calling.play(callId, [{ type: 'tts', params: { text: 'Welcome to SignalWire.' } }]),
|
|
54
|
+
);
|
|
55
|
+
|
|
56
|
+
// 3. Pause, resume, adjust volume, stop playback
|
|
57
|
+
console.log('\nControlling playback...');
|
|
58
|
+
await safe('Pause', () => client.calling.playPause(callId, 'play-1'));
|
|
59
|
+
await safe('Resume', () => client.calling.playResume(callId, 'play-1'));
|
|
60
|
+
await safe('Volume +2dB', () => client.calling.playVolume(callId, 'play-1', 2.0));
|
|
61
|
+
await safe('Stop', () => client.calling.playStop(callId, 'play-1'));
|
|
62
|
+
|
|
63
|
+
// 4. Record the call
|
|
64
|
+
console.log('\nRecording call...');
|
|
65
|
+
await safe('Record', () =>
|
|
66
|
+
client.calling.record(callId, { control_id: 'record-1', audio: { beep: true, format: 'mp3' } }),
|
|
67
|
+
);
|
|
68
|
+
|
|
69
|
+
// 5. Pause, resume, stop recording
|
|
70
|
+
console.log('\nControlling recording...');
|
|
71
|
+
await safe('Pause', () => client.calling.recordPause(callId, 'record-1'));
|
|
72
|
+
await safe('Resume', () => client.calling.recordResume(callId, 'record-1'));
|
|
73
|
+
await safe('Stop', () => client.calling.recordStop(callId, 'record-1'));
|
|
74
|
+
|
|
75
|
+
// 6. Transcribe the call
|
|
76
|
+
console.log('\nTranscribing call...');
|
|
77
|
+
await safe('Transcribe', () =>
|
|
78
|
+
client.calling.transcribe(callId, {
|
|
79
|
+
control_id: 'transcribe-1',
|
|
80
|
+
status_url: 'https://example.com/transcriptions',
|
|
81
|
+
}),
|
|
82
|
+
);
|
|
83
|
+
await safe('Transcribe stop', () => client.calling.transcribeStop(callId, 'transcribe-1'));
|
|
84
|
+
|
|
85
|
+
// 7. Denoise the call
|
|
86
|
+
console.log('\nEnabling denoise...');
|
|
87
|
+
await safe('Denoise', () => client.calling.denoise(callId));
|
|
88
|
+
await safe('Denoise stop', () => client.calling.denoiseStop(callId));
|
|
89
|
+
|
|
90
|
+
// 8. End the call
|
|
91
|
+
console.log('\nEnding call...');
|
|
92
|
+
await safe('End', () => client.calling.end(callId, { reason: 'hangup' }));
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
main().catch((err) => {
|
|
96
|
+
console.error('Error:', err.message);
|
|
97
|
+
process.exit(1);
|
|
98
|
+
});
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* REST Client Example — demonstrates CRUD operations, search, and pagination.
|
|
3
|
+
*
|
|
4
|
+
* Prerequisites:
|
|
5
|
+
* export SIGNALWIRE_PROJECT_ID=your-project-id
|
|
6
|
+
* export SIGNALWIRE_API_TOKEN=your-api-token
|
|
7
|
+
* export SIGNALWIRE_SPACE=your-space.signalwire.com
|
|
8
|
+
*
|
|
9
|
+
* Run:
|
|
10
|
+
* npx tsx rest/examples/rest-client.ts
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
import { RestClient } from '@signalwire/sdk';
|
|
14
|
+
|
|
15
|
+
async function main() {
|
|
16
|
+
// Create client — reads from env vars if not provided explicitly
|
|
17
|
+
const client = new RestClient();
|
|
18
|
+
|
|
19
|
+
console.log('=== Phone Numbers ===');
|
|
20
|
+
|
|
21
|
+
// List owned phone numbers
|
|
22
|
+
const numbers = await client.phoneNumbers.list();
|
|
23
|
+
console.log('Owned numbers:', numbers.data?.length ?? 0);
|
|
24
|
+
|
|
25
|
+
// Search available numbers
|
|
26
|
+
const available = await client.phoneNumbers.search({ areacode: '512' });
|
|
27
|
+
console.log('Available 512 numbers:', available.data?.length ?? 0);
|
|
28
|
+
|
|
29
|
+
console.log('\n=== Fabric AI Agents ===');
|
|
30
|
+
|
|
31
|
+
// List AI agents
|
|
32
|
+
const agents = await client.fabric.aiAgents.list();
|
|
33
|
+
console.log('AI agents:', agents.data?.length ?? 0);
|
|
34
|
+
|
|
35
|
+
console.log('\n=== Video Rooms ===');
|
|
36
|
+
|
|
37
|
+
// List video rooms
|
|
38
|
+
const rooms = await client.video.rooms.list();
|
|
39
|
+
console.log('Video rooms:', rooms.data?.length ?? 0);
|
|
40
|
+
|
|
41
|
+
console.log('\n=== Datasphere ===');
|
|
42
|
+
|
|
43
|
+
// List documents
|
|
44
|
+
const docs = await client.datasphere.documents.list();
|
|
45
|
+
console.log('Documents:', docs.data?.length ?? 0);
|
|
46
|
+
|
|
47
|
+
console.log('\n=== Logs ===');
|
|
48
|
+
|
|
49
|
+
// List recent voice logs
|
|
50
|
+
const voiceLogs = await client.logs.voice.list({ page_size: 5 });
|
|
51
|
+
console.log('Recent voice logs:', voiceLogs.data?.length ?? 0);
|
|
52
|
+
|
|
53
|
+
console.log('\nDone.');
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
main().catch((err) => {
|
|
57
|
+
console.error('Error:', err.message);
|
|
58
|
+
process.exit(1);
|
|
59
|
+
});
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* REST Example: Upload a document to Datasphere and run a semantic search.
|
|
3
|
+
*
|
|
4
|
+
* Prerequisites:
|
|
5
|
+
* export SIGNALWIRE_PROJECT_ID=your-project-id
|
|
6
|
+
* export SIGNALWIRE_API_TOKEN=your-api-token
|
|
7
|
+
* export SIGNALWIRE_SPACE=your-space.signalwire.com
|
|
8
|
+
*
|
|
9
|
+
* Run:
|
|
10
|
+
* npx tsx rest/examples/rest-datasphere-search.ts
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
import { RestClient } from '@signalwire/sdk';
|
|
14
|
+
|
|
15
|
+
const client = new RestClient();
|
|
16
|
+
|
|
17
|
+
function sleep(ms: number): Promise<void> {
|
|
18
|
+
return new Promise((resolve) => setTimeout(resolve, ms));
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
async function main() {
|
|
22
|
+
// 1. Upload a document
|
|
23
|
+
console.log('Uploading document to Datasphere...');
|
|
24
|
+
const doc = await client.datasphere.documents.create({
|
|
25
|
+
url: 'https://filesamples.com/samples/document/txt/sample3.txt',
|
|
26
|
+
tags: ['support', 'demo'],
|
|
27
|
+
});
|
|
28
|
+
const docId = doc.id;
|
|
29
|
+
console.log(` Document created: ${docId} (status: ${doc.status})`);
|
|
30
|
+
|
|
31
|
+
// 2. Wait for vectorization to complete
|
|
32
|
+
console.log('\nWaiting for document to be vectorized...');
|
|
33
|
+
let vectorized = false;
|
|
34
|
+
for (let i = 0; i < 30; i++) {
|
|
35
|
+
await sleep(2000);
|
|
36
|
+
const docStatus = await client.datasphere.documents.get(docId);
|
|
37
|
+
const status = docStatus.status ?? 'unknown';
|
|
38
|
+
console.log(` Poll ${i + 1}: status=${status}`);
|
|
39
|
+
if (status === 'completed') {
|
|
40
|
+
console.log(` Vectorized! Chunks: ${docStatus.number_of_chunks ?? 0}`);
|
|
41
|
+
vectorized = true;
|
|
42
|
+
break;
|
|
43
|
+
}
|
|
44
|
+
if (status === 'failed') {
|
|
45
|
+
console.log(` Document processing failed: ${status}`);
|
|
46
|
+
await client.datasphere.documents.delete(docId);
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
if (!vectorized) {
|
|
51
|
+
console.log(' Timed out waiting for vectorization.');
|
|
52
|
+
await client.datasphere.documents.delete(docId);
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
// 3. List chunks
|
|
57
|
+
console.log(`\nListing chunks for document ${docId}...`);
|
|
58
|
+
const chunks = await client.datasphere.documents.listChunks(docId);
|
|
59
|
+
for (const chunk of (chunks.data ?? []).slice(0, 5)) {
|
|
60
|
+
console.log(` - Chunk ${chunk.id}: ${(chunk.content ?? '').slice(0, 80)}...`);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// 4. Semantic search across all documents
|
|
64
|
+
console.log('\nSearching Datasphere...');
|
|
65
|
+
const results = await client.datasphere.documents.search('lorem ipsum dolor sit amet', {
|
|
66
|
+
count: 3,
|
|
67
|
+
});
|
|
68
|
+
for (const chunk of results.chunks ?? []) {
|
|
69
|
+
console.log(` - ${(chunk.text ?? '').slice(0, 100)}...`);
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// 5. Clean up
|
|
73
|
+
console.log(`\nDeleting document ${docId}...`);
|
|
74
|
+
await client.datasphere.documents.delete(docId);
|
|
75
|
+
console.log(' Deleted.');
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
main().catch((err) => {
|
|
79
|
+
console.error('Error:', err.message);
|
|
80
|
+
process.exit(1);
|
|
81
|
+
});
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* REST Example: Conference infrastructure, cXML resources, generic routing, and tokens.
|
|
3
|
+
*
|
|
4
|
+
* Prerequisites:
|
|
5
|
+
* export SIGNALWIRE_PROJECT_ID=your-project-id
|
|
6
|
+
* export SIGNALWIRE_API_TOKEN=your-api-token
|
|
7
|
+
* export SIGNALWIRE_SPACE=your-space.signalwire.com
|
|
8
|
+
*
|
|
9
|
+
* Run:
|
|
10
|
+
* npx tsx rest/examples/rest-fabric-conferences-and-routing.ts
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
import { RestClient, RestError } from '@signalwire/sdk';
|
|
14
|
+
|
|
15
|
+
const client = new RestClient();
|
|
16
|
+
|
|
17
|
+
async function main() {
|
|
18
|
+
// 1. Create a conference room
|
|
19
|
+
console.log('Creating conference room...');
|
|
20
|
+
const room = await client.fabric.conferenceRooms.create({
|
|
21
|
+
name: 'team-standup',
|
|
22
|
+
enable_room_previews: true,
|
|
23
|
+
});
|
|
24
|
+
const roomId = room.id;
|
|
25
|
+
console.log(` Created conference room: ${roomId}`);
|
|
26
|
+
|
|
27
|
+
// 2. List conference room addresses
|
|
28
|
+
console.log('\nListing conference room addresses...');
|
|
29
|
+
try {
|
|
30
|
+
const addrs = await client.fabric.conferenceRooms.listAddresses(roomId);
|
|
31
|
+
for (const a of addrs.data ?? []) {
|
|
32
|
+
console.log(` - ${a.display_name ?? a.id ?? 'unknown'}`);
|
|
33
|
+
}
|
|
34
|
+
} catch (err) {
|
|
35
|
+
if (err instanceof RestError) {
|
|
36
|
+
console.log(` List addresses failed: ${err.statusCode}`);
|
|
37
|
+
} else throw err;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
// 3. Create a cXML script
|
|
41
|
+
console.log('\nCreating cXML script...');
|
|
42
|
+
const cxml = await client.fabric.cxmlScripts.create({
|
|
43
|
+
display_name: 'Hold Music Script',
|
|
44
|
+
contents:
|
|
45
|
+
'<Response><Say>Please hold.</Say><Play>https://example.com/hold.mp3</Play></Response>',
|
|
46
|
+
});
|
|
47
|
+
const cxmlId = cxml.id;
|
|
48
|
+
console.log(` Created cXML script: ${cxmlId}`);
|
|
49
|
+
|
|
50
|
+
// 4. Create a cXML webhook
|
|
51
|
+
console.log('\nCreating cXML webhook...');
|
|
52
|
+
const cxmlWh = await client.fabric.cxmlWebhooks.create({
|
|
53
|
+
name: 'External cXML Handler',
|
|
54
|
+
primary_request_url: 'https://example.com/cxml-handler',
|
|
55
|
+
});
|
|
56
|
+
const cxmlWhId = cxmlWh.id;
|
|
57
|
+
console.log(` Created cXML webhook: ${cxmlWhId}`);
|
|
58
|
+
|
|
59
|
+
// 5. Create a relay application
|
|
60
|
+
console.log('\nCreating relay application...');
|
|
61
|
+
const relayApp = await client.fabric.relayApplications.create({
|
|
62
|
+
name: 'Inbound Handler',
|
|
63
|
+
topic: 'office',
|
|
64
|
+
});
|
|
65
|
+
const relayId = relayApp.id;
|
|
66
|
+
console.log(` Created relay application: ${relayId}`);
|
|
67
|
+
|
|
68
|
+
// 6. Generic resources: list all
|
|
69
|
+
console.log('\nListing all fabric resources...');
|
|
70
|
+
const resources = await client.fabric.resources.list();
|
|
71
|
+
for (const r of (resources.data ?? []).slice(0, 5)) {
|
|
72
|
+
console.log(` - ${r.type ?? 'unknown'}: ${r.display_name ?? r.id ?? 'unknown'}`);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
// 7. Get a specific generic resource
|
|
76
|
+
const first = (resources.data ?? [{}])[0];
|
|
77
|
+
if (first?.id) {
|
|
78
|
+
const detail = await client.fabric.resources.get(first.id);
|
|
79
|
+
console.log(` Resource detail: ${detail.display_name ?? 'N/A'} (${detail.type ?? 'N/A'})`);
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
// 8. Assign a domain application (demo)
|
|
83
|
+
console.log('\nAssigning domain application (demo)...');
|
|
84
|
+
try {
|
|
85
|
+
await client.fabric.resources.assignDomainApplication(
|
|
86
|
+
relayId,
|
|
87
|
+
'da-00000000-0000-0000-0000-000000000000',
|
|
88
|
+
);
|
|
89
|
+
console.log(' Domain application assigned');
|
|
90
|
+
} catch (err) {
|
|
91
|
+
if (err instanceof RestError) {
|
|
92
|
+
console.log(` Domain assignment failed (expected in demo): ${err.statusCode}`);
|
|
93
|
+
} else throw err;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
// 9. Generate tokens
|
|
97
|
+
console.log('\nGenerating tokens...');
|
|
98
|
+
try {
|
|
99
|
+
const guest = await client.fabric.tokens.createGuestToken([relayId]);
|
|
100
|
+
console.log(` Guest token: ${String(guest.token ?? '').slice(0, 40)}...`);
|
|
101
|
+
} catch (err) {
|
|
102
|
+
if (err instanceof RestError) {
|
|
103
|
+
console.log(` Guest token failed (expected in demo): ${err.statusCode}`);
|
|
104
|
+
} else throw err;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
try {
|
|
108
|
+
const invite = await client.fabric.tokens.createInviteToken(relayId);
|
|
109
|
+
console.log(` Invite token: ${String(invite.token ?? '').slice(0, 40)}...`);
|
|
110
|
+
} catch (err) {
|
|
111
|
+
if (err instanceof RestError) {
|
|
112
|
+
console.log(` Invite token failed (expected in demo): ${err.statusCode}`);
|
|
113
|
+
} else throw err;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
try {
|
|
117
|
+
const embed = await client.fabric.tokens.createEmbedToken(
|
|
118
|
+
'click-to-call-token-from-guest-token',
|
|
119
|
+
);
|
|
120
|
+
console.log(` Embed token: ${String(embed.token ?? '').slice(0, 40)}...`);
|
|
121
|
+
} catch (err) {
|
|
122
|
+
if (err instanceof RestError) {
|
|
123
|
+
console.log(` Embed token failed (expected in demo): ${err.statusCode}`);
|
|
124
|
+
} else throw err;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
// NOTE: To bind a phone number to a webhook / agent / flow, set
|
|
128
|
+
// call_handler on the phone number directly — see
|
|
129
|
+
// rest-bind-phone-to-swml-webhook.ts. `assignPhoneRoute` does NOT work
|
|
130
|
+
// for swml_webhook / cxml_webhook / ai_agent bindings.
|
|
131
|
+
|
|
132
|
+
// Clean up
|
|
133
|
+
console.log('\nCleaning up...');
|
|
134
|
+
await client.fabric.relayApplications.delete(relayId);
|
|
135
|
+
console.log(` Deleted relay application ${relayId}`);
|
|
136
|
+
await client.fabric.cxmlWebhooks.delete(cxmlWhId);
|
|
137
|
+
console.log(` Deleted cXML webhook ${cxmlWhId}`);
|
|
138
|
+
await client.fabric.cxmlScripts.delete(cxmlId);
|
|
139
|
+
console.log(` Deleted cXML script ${cxmlId}`);
|
|
140
|
+
await client.fabric.conferenceRooms.delete(roomId);
|
|
141
|
+
console.log(` Deleted conference room ${roomId}`);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
main().catch((err) => {
|
|
145
|
+
console.error('Error:', err.message);
|
|
146
|
+
process.exit(1);
|
|
147
|
+
});
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* REST Example: Provision a SIP-enabled user on Fabric.
|
|
3
|
+
*
|
|
4
|
+
* Prerequisites:
|
|
5
|
+
* export SIGNALWIRE_PROJECT_ID=your-project-id
|
|
6
|
+
* export SIGNALWIRE_API_TOKEN=your-api-token
|
|
7
|
+
* export SIGNALWIRE_SPACE=your-space.signalwire.com
|
|
8
|
+
*
|
|
9
|
+
* Run:
|
|
10
|
+
* npx tsx rest/examples/rest-fabric-subscribers-and-sip.ts
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
import { RestClient, RestError } from '@signalwire/sdk';
|
|
14
|
+
|
|
15
|
+
const client = new RestClient();
|
|
16
|
+
|
|
17
|
+
async function main() {
|
|
18
|
+
// 1. Create a subscriber
|
|
19
|
+
console.log('Creating subscriber...');
|
|
20
|
+
const subscriber = await client.fabric.subscribers.create({
|
|
21
|
+
display_name: 'Alice Johnson',
|
|
22
|
+
email: 'alice@example.com',
|
|
23
|
+
});
|
|
24
|
+
const subId = subscriber.id;
|
|
25
|
+
const innerSubId = subscriber.subscriber?.id ?? subId;
|
|
26
|
+
console.log(` Created subscriber: ${subId}`);
|
|
27
|
+
|
|
28
|
+
// 2. Add a SIP endpoint to the subscriber
|
|
29
|
+
console.log('\nCreating SIP endpoint on subscriber...');
|
|
30
|
+
const endpoint = await client.fabric.subscribers.createSipEndpoint(
|
|
31
|
+
subId,
|
|
32
|
+
'alice_sip',
|
|
33
|
+
'SecurePass123!',
|
|
34
|
+
);
|
|
35
|
+
const epId = endpoint.id;
|
|
36
|
+
console.log(` Created SIP endpoint: ${epId}`);
|
|
37
|
+
|
|
38
|
+
// 3. List SIP endpoints on the subscriber
|
|
39
|
+
console.log('\nListing subscriber SIP endpoints...');
|
|
40
|
+
const endpoints = await client.fabric.subscribers.listSipEndpoints(subId);
|
|
41
|
+
for (const ep of endpoints.data ?? []) {
|
|
42
|
+
console.log(` - ${ep.id}: ${ep.username ?? 'unknown'}`);
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
// 4. Get specific SIP endpoint details
|
|
46
|
+
console.log(`\nGetting SIP endpoint ${epId}...`);
|
|
47
|
+
const epDetail = await client.fabric.subscribers.getSipEndpoint(subId, epId);
|
|
48
|
+
console.log(` Username: ${epDetail.username ?? 'N/A'}`);
|
|
49
|
+
|
|
50
|
+
// 5. Create a standalone SIP gateway
|
|
51
|
+
console.log('\nCreating SIP gateway...');
|
|
52
|
+
const gateway = await client.fabric.sipGateways.create({
|
|
53
|
+
name: 'Office PBX Gateway',
|
|
54
|
+
uri: 'sip:pbx.example.com',
|
|
55
|
+
encryption: 'required',
|
|
56
|
+
ciphers: ['AES_256_CM_HMAC_SHA1_80'],
|
|
57
|
+
codecs: ['PCMU', 'PCMA'],
|
|
58
|
+
});
|
|
59
|
+
const gwId = gateway.id;
|
|
60
|
+
console.log(` Created SIP gateway: ${gwId}`);
|
|
61
|
+
|
|
62
|
+
// 6. List fabric addresses
|
|
63
|
+
console.log('\nListing fabric addresses...');
|
|
64
|
+
try {
|
|
65
|
+
const addresses = await client.fabric.addresses.list();
|
|
66
|
+
for (const addr of (addresses.data ?? []).slice(0, 5)) {
|
|
67
|
+
console.log(` - ${addr.display_name ?? addr.id ?? 'unknown'}`);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
// 7. Get a specific fabric address
|
|
71
|
+
const firstAddr = (addresses.data ?? [{}])[0];
|
|
72
|
+
if (firstAddr?.id) {
|
|
73
|
+
const addrDetail = await client.fabric.addresses.get(firstAddr.id);
|
|
74
|
+
console.log(` Address detail: ${addrDetail.display_name ?? 'N/A'}`);
|
|
75
|
+
}
|
|
76
|
+
} catch (err) {
|
|
77
|
+
if (err instanceof RestError) {
|
|
78
|
+
console.log(` Fabric addresses failed: ${err.statusCode}`);
|
|
79
|
+
} else throw err;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
// 8. Generate a subscriber token
|
|
83
|
+
console.log('\nGenerating subscriber token...');
|
|
84
|
+
try {
|
|
85
|
+
const token = await client.fabric.tokens.createSubscriberToken(innerSubId);
|
|
86
|
+
console.log(` Token: ${String(token.token ?? '').slice(0, 40)}...`);
|
|
87
|
+
} catch (err) {
|
|
88
|
+
if (err instanceof RestError) {
|
|
89
|
+
console.log(` Token generation failed (expected in demo): ${err.statusCode}`);
|
|
90
|
+
} else throw err;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
// 9. Clean up
|
|
94
|
+
console.log('\nCleaning up...');
|
|
95
|
+
await client.fabric.subscribers.deleteSipEndpoint(subId, epId);
|
|
96
|
+
console.log(` Deleted SIP endpoint ${epId}`);
|
|
97
|
+
await client.fabric.subscribers.delete(subId);
|
|
98
|
+
console.log(` Deleted subscriber ${subId}`);
|
|
99
|
+
await client.fabric.sipGateways.delete(gwId);
|
|
100
|
+
console.log(` Deleted SIP gateway ${gwId}`);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
main().catch((err) => {
|
|
104
|
+
console.error('Error:', err.message);
|
|
105
|
+
process.exit(1);
|
|
106
|
+
});
|