@signalwire/sdk 2.0.5 → 3.6.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 +821 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +510 -126
- package/dist/AgentBase.js +1581 -455
- 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 +186 -45
- package/dist/DataMap.js +210 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +309 -83
- package/dist/FunctionResult.js +483 -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 +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- 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 +18 -0
- package/dist/PomBuilder.js +53 -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 +22 -1
- package/dist/PromptManager.js +28 -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 +169 -59
- package/dist/SWMLService.js +456 -129
- 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 +49 -9
- package/dist/SecurityUtils.js +153 -51
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/SemanticGate.d.ts +183 -0
- package/dist/SemanticGate.js +533 -0
- package/dist/SemanticGate.js.map +1 -0
- 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 +139 -7
- package/dist/SwaigFunction.js +170 -22
- 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 +92 -33
- 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 -371
- 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 +920 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +49 -68
- package/dist/index.js +45 -73
- 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 +44 -17
- package/dist/relay/RelayClient.js +175 -65
- 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 +73 -42
- 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 +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -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 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- 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 +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- 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 +111 -21
- 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 +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- 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 +18 -6
- 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 +21 -22
- 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 +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- 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 +38 -30
- 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 +294 -100
- 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 +14 -13
- 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 +59 -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 +3641 -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 +1207 -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 +1986 -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 +85 -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
|
@@ -1,449 +1,24 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fabric API namespace — resource composition, addresses, and tokens.
|
|
3
|
-
*/
|
|
4
|
-
import { BaseResource } from '../base/BaseResource.js';
|
|
5
|
-
import { CrudWithAddresses } from '../base/CrudWithAddresses.js';
|
|
6
|
-
/** Standard fabric resource with CRUD + addresses (PATCH updates). */
|
|
7
|
-
export class FabricResource extends CrudWithAddresses {
|
|
8
|
-
constructor(http, basePath) {
|
|
9
|
-
super(http, basePath);
|
|
10
|
-
}
|
|
11
|
-
}
|
|
12
|
-
/** Fabric resource that uses PUT for updates. */
|
|
13
|
-
export class FabricResourcePUT extends CrudWithAddresses {
|
|
14
|
-
_updateMethod = 'PUT';
|
|
15
|
-
constructor(http, basePath) {
|
|
16
|
-
super(http, basePath);
|
|
17
|
-
}
|
|
18
|
-
}
|
|
19
|
-
/** Call flows with version management. Uses singular `call_flow` for sub-resource paths. */
|
|
20
|
-
export class CallFlowsResource extends FabricResourcePUT {
|
|
21
|
-
constructor(http, basePath) {
|
|
22
|
-
super(http, basePath);
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* List addresses attached to a call flow resource.
|
|
26
|
-
*
|
|
27
|
-
* @param resourceId - Unique identifier of the call flow.
|
|
28
|
-
* @param params - Optional filter / pagination query parameters.
|
|
29
|
-
* @returns A paginated list of addresses.
|
|
30
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
31
|
-
*/
|
|
32
|
-
async listAddresses(resourceId, params) {
|
|
33
|
-
const path = this._basePath.replace('/call_flows', '/call_flow');
|
|
34
|
-
return this._http.get(`${path}/${resourceId}/addresses`, params);
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* List all saved versions of a call flow.
|
|
38
|
-
*
|
|
39
|
-
* @param resourceId - Unique identifier of the call flow.
|
|
40
|
-
* @param params - Optional filter / pagination query parameters.
|
|
41
|
-
* @returns A paginated list of call-flow versions.
|
|
42
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
43
|
-
*/
|
|
44
|
-
async listVersions(resourceId, params) {
|
|
45
|
-
const path = this._basePath.replace('/call_flows', '/call_flow');
|
|
46
|
-
return this._http.get(`${path}/${resourceId}/versions`, params);
|
|
47
|
-
}
|
|
48
|
-
/**
|
|
49
|
-
* Publish a new version of a call flow.
|
|
50
|
-
*
|
|
51
|
-
* @param resourceId - Unique identifier of the call flow.
|
|
52
|
-
* @param body - Version payload (schema and metadata). Defaults to `{}`.
|
|
53
|
-
* @returns The newly-published version record.
|
|
54
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
55
|
-
*/
|
|
56
|
-
async deployVersion(resourceId, body = {}) {
|
|
57
|
-
const path = this._basePath.replace('/call_flows', '/call_flow');
|
|
58
|
-
return this._http.post(`${path}/${resourceId}/versions`, body);
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
/** Conference rooms — uses singular 'conference_room' for sub-resource paths. */
|
|
62
|
-
export class ConferenceRoomsResource extends FabricResourcePUT {
|
|
63
|
-
constructor(http, basePath) {
|
|
64
|
-
super(http, basePath);
|
|
65
|
-
}
|
|
66
|
-
/**
|
|
67
|
-
* List addresses attached to a conference-room resource.
|
|
68
|
-
*
|
|
69
|
-
* @param resourceId - Unique identifier of the conference room.
|
|
70
|
-
* @param params - Optional filter / pagination query parameters.
|
|
71
|
-
* @returns A paginated list of addresses.
|
|
72
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
73
|
-
*/
|
|
74
|
-
async listAddresses(resourceId, params) {
|
|
75
|
-
const path = this._basePath.replace('/conference_rooms', '/conference_room');
|
|
76
|
-
return this._http.get(`${path}/${resourceId}/addresses`, params);
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
/** Subscribers with SIP endpoint management. */
|
|
80
|
-
export class SubscribersResource extends FabricResourcePUT {
|
|
81
|
-
constructor(http, basePath) {
|
|
82
|
-
super(http, basePath);
|
|
83
|
-
}
|
|
84
|
-
/**
|
|
85
|
-
* List the SIP endpoints registered under a subscriber.
|
|
86
|
-
*
|
|
87
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
88
|
-
* @param params - Optional filter / pagination query parameters.
|
|
89
|
-
* @returns A paginated list of SIP endpoints.
|
|
90
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
91
|
-
*/
|
|
92
|
-
async listSipEndpoints(subscriberId, params) {
|
|
93
|
-
return this._http.get(this._path(subscriberId, 'sip_endpoints'), params);
|
|
94
|
-
}
|
|
95
|
-
/**
|
|
96
|
-
* Register a new SIP endpoint under a subscriber.
|
|
97
|
-
*
|
|
98
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
99
|
-
* @param body - SIP endpoint payload (credentials, codecs, etc.).
|
|
100
|
-
* @returns The newly-created SIP endpoint record.
|
|
101
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
102
|
-
*/
|
|
103
|
-
async createSipEndpoint(subscriberId, body) {
|
|
104
|
-
return this._http.post(this._path(subscriberId, 'sip_endpoints'), body);
|
|
105
|
-
}
|
|
106
|
-
/**
|
|
107
|
-
* Fetch a single SIP endpoint by ID.
|
|
108
|
-
*
|
|
109
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
110
|
-
* @param endpointId - Unique identifier of the SIP endpoint.
|
|
111
|
-
* @returns The SIP endpoint record.
|
|
112
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
113
|
-
*/
|
|
114
|
-
async getSipEndpoint(subscriberId, endpointId) {
|
|
115
|
-
return this._http.get(this._path(subscriberId, 'sip_endpoints', endpointId));
|
|
116
|
-
}
|
|
117
|
-
/**
|
|
118
|
-
* Update a SIP endpoint's settings.
|
|
119
|
-
*
|
|
120
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
121
|
-
* @param endpointId - Unique identifier of the SIP endpoint.
|
|
122
|
-
* @param body - Partial update payload (PATCH semantics).
|
|
123
|
-
* @returns The updated SIP endpoint record.
|
|
124
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
125
|
-
*/
|
|
126
|
-
async updateSipEndpoint(subscriberId, endpointId, body) {
|
|
127
|
-
return this._http.patch(this._path(subscriberId, 'sip_endpoints', endpointId), body);
|
|
128
|
-
}
|
|
129
|
-
/**
|
|
130
|
-
* Delete a SIP endpoint.
|
|
131
|
-
*
|
|
132
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
133
|
-
* @param endpointId - Unique identifier of the SIP endpoint.
|
|
134
|
-
* @returns The platform's delete response.
|
|
135
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
136
|
-
*/
|
|
137
|
-
async deleteSipEndpoint(subscriberId, endpointId) {
|
|
138
|
-
return this._http.delete(this._path(subscriberId, 'sip_endpoints', endpointId));
|
|
139
|
-
}
|
|
140
|
-
}
|
|
141
|
-
/** cXML applications — no create method (read/update/delete only). */
|
|
142
|
-
export class CxmlApplicationsResource extends FabricResourcePUT {
|
|
143
|
-
constructor(http, basePath) {
|
|
144
|
-
super(http, basePath);
|
|
145
|
-
}
|
|
146
|
-
async create() {
|
|
147
|
-
throw new Error('cXML applications cannot be created via this API');
|
|
148
|
-
}
|
|
149
|
-
}
|
|
150
|
-
/**
|
|
151
|
-
* Fabric webhook resource that is normally auto-materialized by the
|
|
152
|
-
* corresponding `phoneNumbers.set*Webhook` helper.
|
|
153
|
-
*
|
|
154
|
-
* Creating directly produces an orphan Fabric resource that isn't bound to
|
|
155
|
-
* any phone number — the API's binding model configures the webhook on the
|
|
156
|
-
* phone number, and the server materializes the Fabric resource as a
|
|
157
|
-
* side-effect. `create` remains for backwards compatibility but emits a
|
|
158
|
-
* one-time deprecation warning on first call.
|
|
159
|
-
*
|
|
160
|
-
* See the porting-sdk's `phone-binding.md` for the full model.
|
|
161
|
-
*/
|
|
162
|
-
export class AutoMaterializedWebhookResource extends FabricResource {
|
|
163
|
-
/** Label used in the deprecation warning (subclasses override). */
|
|
164
|
-
_autoHelperName = 'phoneNumbers.set*Webhook';
|
|
165
|
-
static _warned = new WeakSet();
|
|
166
|
-
constructor(http, basePath) {
|
|
167
|
-
super(http, basePath);
|
|
168
|
-
}
|
|
169
|
-
/**
|
|
170
|
-
* @deprecated Creating a webhook Fabric resource directly produces an
|
|
171
|
-
* orphan that is not bound to any phone number. Use the
|
|
172
|
-
* `phoneNumbers.setSwmlWebhook` / `setCxmlWebhook` helper instead — it
|
|
173
|
-
* updates the phone number and the server auto-materializes the
|
|
174
|
-
* resource. Kept for backwards compatibility.
|
|
175
|
-
*/
|
|
176
|
-
async create(body = {}) {
|
|
177
|
-
if (!AutoMaterializedWebhookResource._warned.has(this)) {
|
|
178
|
-
AutoMaterializedWebhookResource._warned.add(this);
|
|
179
|
-
console.warn(`[signalwire] Creating a webhook Fabric resource directly produces ` +
|
|
180
|
-
`an orphan not bound to any phone number. Use ${this._autoHelperName} ` +
|
|
181
|
-
`instead; it updates the phone number and the server auto-materializes ` +
|
|
182
|
-
`the resource. See porting-sdk's phone-binding.md.`);
|
|
183
|
-
}
|
|
184
|
-
return super.create(body);
|
|
185
|
-
}
|
|
186
|
-
}
|
|
187
|
-
/** Auto-materialized SWML webhook — normally created via `phoneNumbers.setSwmlWebhook`. */
|
|
188
|
-
export class SwmlWebhooksResource extends AutoMaterializedWebhookResource {
|
|
189
|
-
_autoHelperName = 'phoneNumbers.setSwmlWebhook(sid, url)';
|
|
190
|
-
}
|
|
191
|
-
/** Auto-materialized cXML webhook — normally created via `phoneNumbers.setCxmlWebhook`. */
|
|
192
|
-
export class CxmlWebhooksResource extends AutoMaterializedWebhookResource {
|
|
193
|
-
_autoHelperName = 'phoneNumbers.setCxmlWebhook(sid, { url })';
|
|
194
|
-
}
|
|
195
|
-
/** Generic resource operations across all fabric resource types. */
|
|
196
|
-
export class GenericResources extends BaseResource {
|
|
197
|
-
static _assignPhoneRouteWarned = new WeakSet();
|
|
198
|
-
constructor(http, basePath) {
|
|
199
|
-
super(http, basePath);
|
|
200
|
-
}
|
|
201
|
-
/**
|
|
202
|
-
* List all fabric resources regardless of specific type.
|
|
203
|
-
*
|
|
204
|
-
* @param params - Optional filter / pagination query parameters.
|
|
205
|
-
* @returns A paginated list of generic fabric resources.
|
|
206
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
207
|
-
*/
|
|
208
|
-
async list(params) {
|
|
209
|
-
return this._http.get(this._basePath, params);
|
|
210
|
-
}
|
|
211
|
-
/**
|
|
212
|
-
* Fetch a single fabric resource by ID.
|
|
213
|
-
*
|
|
214
|
-
* @param resourceId - Unique identifier of the resource.
|
|
215
|
-
* @returns The resource record.
|
|
216
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
217
|
-
*/
|
|
218
|
-
async get(resourceId) {
|
|
219
|
-
return this._http.get(this._path(resourceId));
|
|
220
|
-
}
|
|
221
|
-
/**
|
|
222
|
-
* Delete a fabric resource.
|
|
223
|
-
*
|
|
224
|
-
* @param resourceId - Unique identifier of the resource.
|
|
225
|
-
* @returns The platform's delete response.
|
|
226
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
227
|
-
*/
|
|
228
|
-
async delete(resourceId) {
|
|
229
|
-
return this._http.delete(this._path(resourceId));
|
|
230
|
-
}
|
|
231
|
-
/**
|
|
232
|
-
* List addresses associated with any fabric resource.
|
|
233
|
-
*
|
|
234
|
-
* @param resourceId - Unique identifier of the resource.
|
|
235
|
-
* @param params - Optional filter / pagination query parameters.
|
|
236
|
-
* @returns A paginated list of addresses.
|
|
237
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
238
|
-
*/
|
|
239
|
-
async listAddresses(resourceId, params) {
|
|
240
|
-
return this._http.get(this._path(resourceId, 'addresses'), params);
|
|
241
|
-
}
|
|
242
|
-
/**
|
|
243
|
-
* Assign a phone route to a fabric resource.
|
|
244
|
-
*
|
|
245
|
-
* @deprecated For the common cases — SWML webhooks, cXML webhooks, AI
|
|
246
|
-
* agents — this endpoint **does not work**. Bindings for those are
|
|
247
|
-
* configured on the phone number via {@link PhoneNumbersResource.setSwmlWebhook}
|
|
248
|
-
* / `setCxmlWebhook` / `setAiAgent`, and the Fabric resource is
|
|
249
|
-
* auto-materialized by the server. Calling this method against
|
|
250
|
-
* `swml_webhook`, `cxml_webhook`, or `ai_agent` resource IDs returns
|
|
251
|
-
* `404` or `422`. The endpoint (`POST /api/fabric/resources/{id}/phone_routes`)
|
|
252
|
-
* applies only to a narrow set of legacy resource types listed in
|
|
253
|
-
* `rest-apis/relay-rest/openapi.yaml`. Emits a one-time deprecation
|
|
254
|
-
* warning on first call; kept for backwards compatibility.
|
|
255
|
-
*
|
|
256
|
-
* @param resourceId - Unique identifier of the resource.
|
|
257
|
-
* @param body - Phone route payload.
|
|
258
|
-
* @returns The phone-route assignment record.
|
|
259
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
260
|
-
*/
|
|
261
|
-
async assignPhoneRoute(resourceId, body) {
|
|
262
|
-
if (!GenericResources._assignPhoneRouteWarned.has(this)) {
|
|
263
|
-
GenericResources._assignPhoneRouteWarned.add(this);
|
|
264
|
-
console.warn('[signalwire] assignPhoneRoute does not bind phone numbers to ' +
|
|
265
|
-
'swml_webhook / cxml_webhook / ai_agent resources — those are ' +
|
|
266
|
-
'configured via phoneNumbers.setSwmlWebhook / setCxmlWebhook / ' +
|
|
267
|
-
'setAiAgent. This method applies only to a narrow set of legacy ' +
|
|
268
|
-
"resource types. See porting-sdk's phone-binding.md.");
|
|
269
|
-
}
|
|
270
|
-
return this._http.post(this._path(resourceId, 'phone_routes'), body);
|
|
271
|
-
}
|
|
272
|
-
/**
|
|
273
|
-
* Assign a domain application to a fabric resource.
|
|
274
|
-
*
|
|
275
|
-
* @param resourceId - Unique identifier of the resource.
|
|
276
|
-
* @param body - Domain application payload.
|
|
277
|
-
* @returns The domain-application assignment record.
|
|
278
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
279
|
-
*/
|
|
280
|
-
async assignDomainApplication(resourceId, body) {
|
|
281
|
-
return this._http.post(this._path(resourceId, 'domain_applications'), body);
|
|
282
|
-
}
|
|
283
|
-
}
|
|
284
|
-
/** Read-only fabric addresses. */
|
|
285
|
-
export class FabricAddresses extends BaseResource {
|
|
286
|
-
constructor(http, basePath) {
|
|
287
|
-
super(http, basePath);
|
|
288
|
-
}
|
|
289
|
-
/**
|
|
290
|
-
* List all fabric addresses in the project.
|
|
291
|
-
*
|
|
292
|
-
* @param params - Optional filter / pagination query parameters.
|
|
293
|
-
* @returns A paginated list of fabric addresses.
|
|
294
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
295
|
-
*/
|
|
296
|
-
async list(params) {
|
|
297
|
-
return this._http.get(this._basePath, params);
|
|
298
|
-
}
|
|
299
|
-
/**
|
|
300
|
-
* Fetch a single fabric address by ID.
|
|
301
|
-
*
|
|
302
|
-
* @param addressId - Unique identifier of the address.
|
|
303
|
-
* @returns The address record.
|
|
304
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
305
|
-
*/
|
|
306
|
-
async get(addressId) {
|
|
307
|
-
return this._http.get(this._path(addressId));
|
|
308
|
-
}
|
|
309
|
-
}
|
|
310
|
-
/** Subscriber, guest, invite, and embed token creation. */
|
|
311
|
-
export class FabricTokens extends BaseResource {
|
|
312
|
-
constructor(http) {
|
|
313
|
-
super(http, '/api/fabric');
|
|
314
|
-
}
|
|
315
|
-
/**
|
|
316
|
-
* Issue a new subscriber JWT used by end-user clients.
|
|
317
|
-
*
|
|
318
|
-
* @param body - Token payload (subscriber ID, TTL, scopes). Defaults to `{}`.
|
|
319
|
-
* @returns The token record, typically `{ token: "eyJ..." }`.
|
|
320
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
321
|
-
*/
|
|
322
|
-
async createSubscriberToken(body = {}) {
|
|
323
|
-
return this._http.post(this._path('subscribers', 'tokens'), body);
|
|
324
|
-
}
|
|
325
|
-
/**
|
|
326
|
-
* Refresh an existing subscriber JWT, extending its lifetime.
|
|
327
|
-
*
|
|
328
|
-
* @param body - Refresh payload (usually containing the current token).
|
|
329
|
-
* Defaults to `{}`.
|
|
330
|
-
* @returns The refreshed token record.
|
|
331
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
332
|
-
*/
|
|
333
|
-
async refreshSubscriberToken(body = {}) {
|
|
334
|
-
return this._http.post(this._path('subscribers', 'tokens', 'refresh'), body);
|
|
335
|
-
}
|
|
336
|
-
/**
|
|
337
|
-
* Create a single-use invite token for onboarding a new subscriber.
|
|
338
|
-
*
|
|
339
|
-
* @param body - Invite payload (email, phone, permissions). Defaults to `{}`.
|
|
340
|
-
* @returns The invite record, including the share URL / code.
|
|
341
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
342
|
-
*/
|
|
343
|
-
async createInviteToken(body = {}) {
|
|
344
|
-
return this._http.post(this._path('subscriber', 'invites'), body);
|
|
345
|
-
}
|
|
346
|
-
/**
|
|
347
|
-
* Issue a guest token (no subscriber account required).
|
|
348
|
-
*
|
|
349
|
-
* @param body - Guest-token payload (context, TTL, etc.). Defaults to `{}`.
|
|
350
|
-
* @returns The token record.
|
|
351
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
352
|
-
*/
|
|
353
|
-
async createGuestToken(body = {}) {
|
|
354
|
-
return this._http.post(this._path('guests', 'tokens'), body);
|
|
355
|
-
}
|
|
356
|
-
/**
|
|
357
|
-
* Issue a short-lived embed token for browser-side SignalWire widgets.
|
|
358
|
-
*
|
|
359
|
-
* @param body - Embed-token payload (allowed origins, TTL, etc.). Defaults to `{}`.
|
|
360
|
-
* @returns The token record.
|
|
361
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
362
|
-
*/
|
|
363
|
-
async createEmbedToken(body = {}) {
|
|
364
|
-
return this._http.post(this._path('embeds', 'tokens'), body);
|
|
365
|
-
}
|
|
366
|
-
}
|
|
367
|
-
/**
|
|
368
|
-
* Fabric API namespace grouping all resource types.
|
|
369
3
|
*
|
|
370
|
-
*
|
|
4
|
+
* All fabric resource classes are generated from the fabric OpenAPI spec
|
|
5
|
+
* (`fabric.resources.generated.ts`); the `FabricNamespace` container is generated
|
|
6
|
+
* into the client tree (`_client_tree_generated.ts`). This module re-exports them
|
|
7
|
+
* (plus the historical `*Resource` aliases) so existing imports keep working.
|
|
371
8
|
*
|
|
372
9
|
* @example
|
|
373
10
|
* ```ts
|
|
11
|
+
* import { RestClient } from '@signalwire/sdk';
|
|
12
|
+
* const client = new RestClient();
|
|
374
13
|
* const agents = await client.fabric.aiAgents.list();
|
|
375
|
-
* const flow = await client.fabric.callFlows.create({
|
|
376
|
-
* const token = await client.fabric.tokens.createSubscriberToken(
|
|
14
|
+
* const flow = await client.fabric.callFlows.create({ title: 'main-ivr' });
|
|
15
|
+
* const token = await client.fabric.tokens.createSubscriberToken('sub_123');
|
|
377
16
|
* ```
|
|
378
17
|
*/
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
/** Call Flow CRUD with version listing and publishing. */
|
|
386
|
-
callFlows;
|
|
387
|
-
/** Conference Room CRUD with address listing. */
|
|
388
|
-
conferenceRooms;
|
|
389
|
-
/** FreeSWITCH Connector CRUD. */
|
|
390
|
-
freeswitchConnectors;
|
|
391
|
-
/** Subscriber CRUD plus nested SIP endpoint management. */
|
|
392
|
-
subscribers;
|
|
393
|
-
/** Top-level SIP endpoint CRUD. */
|
|
394
|
-
sipEndpoints;
|
|
395
|
-
/** cXML (LaML) script CRUD. */
|
|
396
|
-
cxmlScripts;
|
|
397
|
-
/** cXML application read / update / delete (no create). */
|
|
398
|
-
cxmlApplications;
|
|
399
|
-
// PATCH-update resources
|
|
400
|
-
/**
|
|
401
|
-
* SWML webhook CRUD. **Auto-materialized** as a side-effect of
|
|
402
|
-
* {@link PhoneNumbersResource.setSwmlWebhook}; direct `create` produces
|
|
403
|
-
* an orphan resource and emits a deprecation warning.
|
|
404
|
-
*/
|
|
405
|
-
swmlWebhooks;
|
|
406
|
-
/** AI Agent CRUD — the platform-managed agent registration resource. */
|
|
407
|
-
aiAgents;
|
|
408
|
-
/** SIP Gateway CRUD. */
|
|
409
|
-
sipGateways;
|
|
410
|
-
/**
|
|
411
|
-
* cXML webhook CRUD. **Auto-materialized** as a side-effect of
|
|
412
|
-
* {@link PhoneNumbersResource.setCxmlWebhook}; direct `create` produces
|
|
413
|
-
* an orphan resource and emits a deprecation warning.
|
|
414
|
-
*/
|
|
415
|
-
cxmlWebhooks;
|
|
416
|
-
// Special resources
|
|
417
|
-
/** Generic operations across all resource types (list, get, delete, phone route assignment). */
|
|
418
|
-
resources;
|
|
419
|
-
/** Read-only access to the unified fabric address table. */
|
|
420
|
-
addresses;
|
|
421
|
-
/** Subscriber, guest, invite, and embed token generation. */
|
|
422
|
-
tokens;
|
|
423
|
-
constructor(http) {
|
|
424
|
-
const base = '/api/fabric/resources';
|
|
425
|
-
// PUT-update resources
|
|
426
|
-
this.swmlScripts = new FabricResourcePUT(http, `${base}/swml_scripts`);
|
|
427
|
-
this.relayApplications = new FabricResourcePUT(http, `${base}/relay_applications`);
|
|
428
|
-
this.callFlows = new CallFlowsResource(http, `${base}/call_flows`);
|
|
429
|
-
this.conferenceRooms = new ConferenceRoomsResource(http, `${base}/conference_rooms`);
|
|
430
|
-
this.freeswitchConnectors = new FabricResourcePUT(http, `${base}/freeswitch_connectors`);
|
|
431
|
-
this.subscribers = new SubscribersResource(http, `${base}/subscribers`);
|
|
432
|
-
this.sipEndpoints = new FabricResourcePUT(http, `${base}/sip_endpoints`);
|
|
433
|
-
this.cxmlScripts = new FabricResourcePUT(http, `${base}/cxml_scripts`);
|
|
434
|
-
this.cxmlApplications = new CxmlApplicationsResource(http, `${base}/cxml_applications`);
|
|
435
|
-
// PATCH-update resources
|
|
436
|
-
// swmlWebhooks and cxmlWebhooks are normally auto-materialized by
|
|
437
|
-
// phoneNumbers.setSwmlWebhook / setCxmlWebhook. Direct create still
|
|
438
|
-
// works for backcompat but emits a deprecation warning.
|
|
439
|
-
this.swmlWebhooks = new SwmlWebhooksResource(http, `${base}/swml_webhooks`);
|
|
440
|
-
this.aiAgents = new FabricResource(http, `${base}/ai_agents`);
|
|
441
|
-
this.sipGateways = new FabricResource(http, `${base}/sip_gateways`);
|
|
442
|
-
this.cxmlWebhooks = new CxmlWebhooksResource(http, `${base}/cxml_webhooks`);
|
|
443
|
-
// Special resources
|
|
444
|
-
this.resources = new GenericResources(http, base);
|
|
445
|
-
this.addresses = new FabricAddresses(http, '/api/fabric/addresses');
|
|
446
|
-
this.tokens = new FabricTokens(http);
|
|
447
|
-
}
|
|
448
|
-
}
|
|
18
|
+
// `FabricResource` / `FabricResourcePUT` are the CrudWithAddresses bases the
|
|
19
|
+
// generated fabric subclasses extend (kept in `../base/FabricResource.js` to
|
|
20
|
+
// avoid an import cycle). Re-exported for callers that import them from here.
|
|
21
|
+
export { FabricResource, FabricResourcePUT } from '../base/FabricResource.js';
|
|
22
|
+
export { AiAgents, CallFlows, CallFlows as CallFlowsResource, ConferenceRooms, ConferenceRooms as ConferenceRoomsResource, CxmlApplications, CxmlApplications as CxmlApplicationsResource, CxmlScripts, CxmlWebhooks, FabricAddresses, FabricTokens, FreeswitchConnectors, GenericResources, RelayApplications, SipEndpoints, SipGateways, Subscribers, Subscribers as SubscribersResource, SwmlScripts, SwmlWebhooks, } from './fabric.resources.generated.js';
|
|
23
|
+
export { FabricNamespace } from './_client_tree_generated.js';
|
|
449
24
|
//# sourceMappingURL=fabric.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fabric.js","sourceRoot":"","sources":["../../../src/rest/namespaces/fabric.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"fabric.js","sourceRoot":"","sources":["../../../src/rest/namespaces/fabric.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,6EAA6E;AAC7E,6EAA6E;AAC7E,8EAA8E;AAC9E,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAE9E,OAAO,EACL,QAAQ,EACR,SAAS,EACT,SAAS,IAAI,iBAAiB,EAC9B,eAAe,EACf,eAAe,IAAI,uBAAuB,EAC1C,gBAAgB,EAChB,gBAAgB,IAAI,wBAAwB,EAC5C,WAAW,EACX,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACX,WAAW,EACX,WAAW,IAAI,mBAAmB,EAClC,WAAW,EACX,YAAY,GACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC"}
|