@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,336 +1,20 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fabric API namespace — resource composition, addresses, and tokens.
|
|
3
|
-
*/
|
|
4
|
-
import type { HttpClient } from '../HttpClient.js';
|
|
5
|
-
import type { QueryParams } from '../types.js';
|
|
6
|
-
import { BaseResource } from '../base/BaseResource.js';
|
|
7
|
-
import { CrudWithAddresses } from '../base/CrudWithAddresses.js';
|
|
8
|
-
/** Standard fabric resource with CRUD + addresses (PATCH updates). */
|
|
9
|
-
export declare class FabricResource extends CrudWithAddresses {
|
|
10
|
-
constructor(http: HttpClient, basePath: string);
|
|
11
|
-
}
|
|
12
|
-
/** Fabric resource that uses PUT for updates. */
|
|
13
|
-
export declare class FabricResourcePUT extends CrudWithAddresses {
|
|
14
|
-
protected _updateMethod: 'PATCH' | 'PUT';
|
|
15
|
-
constructor(http: HttpClient, basePath: string);
|
|
16
|
-
}
|
|
17
|
-
/** Call flows with version management. Uses singular `call_flow` for sub-resource paths. */
|
|
18
|
-
export declare class CallFlowsResource extends FabricResourcePUT {
|
|
19
|
-
constructor(http: HttpClient, basePath: string);
|
|
20
|
-
/**
|
|
21
|
-
* List addresses attached to a call flow resource.
|
|
22
|
-
*
|
|
23
|
-
* @param resourceId - Unique identifier of the call flow.
|
|
24
|
-
* @param params - Optional filter / pagination query parameters.
|
|
25
|
-
* @returns A paginated list of addresses.
|
|
26
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
27
|
-
*/
|
|
28
|
-
listAddresses(resourceId: string, params?: QueryParams): Promise<any>;
|
|
29
|
-
/**
|
|
30
|
-
* List all saved versions of a call flow.
|
|
31
|
-
*
|
|
32
|
-
* @param resourceId - Unique identifier of the call flow.
|
|
33
|
-
* @param params - Optional filter / pagination query parameters.
|
|
34
|
-
* @returns A paginated list of call-flow versions.
|
|
35
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
36
|
-
*/
|
|
37
|
-
listVersions(resourceId: string, params?: QueryParams): Promise<any>;
|
|
38
|
-
/**
|
|
39
|
-
* Publish a new version of a call flow.
|
|
40
|
-
*
|
|
41
|
-
* @param resourceId - Unique identifier of the call flow.
|
|
42
|
-
* @param body - Version payload (schema and metadata). Defaults to `{}`.
|
|
43
|
-
* @returns The newly-published version record.
|
|
44
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
45
|
-
*/
|
|
46
|
-
deployVersion(resourceId: string, body?: any): Promise<any>;
|
|
47
|
-
}
|
|
48
|
-
/** Conference rooms — uses singular 'conference_room' for sub-resource paths. */
|
|
49
|
-
export declare class ConferenceRoomsResource extends FabricResourcePUT {
|
|
50
|
-
constructor(http: HttpClient, basePath: string);
|
|
51
|
-
/**
|
|
52
|
-
* List addresses attached to a conference-room resource.
|
|
53
|
-
*
|
|
54
|
-
* @param resourceId - Unique identifier of the conference room.
|
|
55
|
-
* @param params - Optional filter / pagination query parameters.
|
|
56
|
-
* @returns A paginated list of addresses.
|
|
57
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
58
|
-
*/
|
|
59
|
-
listAddresses(resourceId: string, params?: QueryParams): Promise<any>;
|
|
60
|
-
}
|
|
61
|
-
/** Subscribers with SIP endpoint management. */
|
|
62
|
-
export declare class SubscribersResource extends FabricResourcePUT {
|
|
63
|
-
constructor(http: HttpClient, basePath: string);
|
|
64
|
-
/**
|
|
65
|
-
* List the SIP endpoints registered under a subscriber.
|
|
66
|
-
*
|
|
67
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
68
|
-
* @param params - Optional filter / pagination query parameters.
|
|
69
|
-
* @returns A paginated list of SIP endpoints.
|
|
70
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
71
|
-
*/
|
|
72
|
-
listSipEndpoints(subscriberId: string, params?: QueryParams): Promise<any>;
|
|
73
|
-
/**
|
|
74
|
-
* Register a new SIP endpoint under a subscriber.
|
|
75
|
-
*
|
|
76
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
77
|
-
* @param body - SIP endpoint payload (credentials, codecs, etc.).
|
|
78
|
-
* @returns The newly-created SIP endpoint record.
|
|
79
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
80
|
-
*/
|
|
81
|
-
createSipEndpoint(subscriberId: string, body: any): Promise<any>;
|
|
82
|
-
/**
|
|
83
|
-
* Fetch a single SIP endpoint by ID.
|
|
84
|
-
*
|
|
85
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
86
|
-
* @param endpointId - Unique identifier of the SIP endpoint.
|
|
87
|
-
* @returns The SIP endpoint record.
|
|
88
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
89
|
-
*/
|
|
90
|
-
getSipEndpoint(subscriberId: string, endpointId: string): Promise<any>;
|
|
91
|
-
/**
|
|
92
|
-
* Update a SIP endpoint's settings.
|
|
93
|
-
*
|
|
94
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
95
|
-
* @param endpointId - Unique identifier of the SIP endpoint.
|
|
96
|
-
* @param body - Partial update payload (PATCH semantics).
|
|
97
|
-
* @returns The updated SIP endpoint record.
|
|
98
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
99
|
-
*/
|
|
100
|
-
updateSipEndpoint(subscriberId: string, endpointId: string, body: any): Promise<any>;
|
|
101
|
-
/**
|
|
102
|
-
* Delete a SIP endpoint.
|
|
103
|
-
*
|
|
104
|
-
* @param subscriberId - Unique identifier of the subscriber.
|
|
105
|
-
* @param endpointId - Unique identifier of the SIP endpoint.
|
|
106
|
-
* @returns The platform's delete response.
|
|
107
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
108
|
-
*/
|
|
109
|
-
deleteSipEndpoint(subscriberId: string, endpointId: string): Promise<any>;
|
|
110
|
-
}
|
|
111
|
-
/** cXML applications — no create method (read/update/delete only). */
|
|
112
|
-
export declare class CxmlApplicationsResource extends FabricResourcePUT {
|
|
113
|
-
constructor(http: HttpClient, basePath: string);
|
|
114
|
-
create(): Promise<never>;
|
|
115
|
-
}
|
|
116
|
-
/**
|
|
117
|
-
* Fabric webhook resource that is normally auto-materialized by the
|
|
118
|
-
* corresponding `phoneNumbers.set*Webhook` helper.
|
|
119
|
-
*
|
|
120
|
-
* Creating directly produces an orphan Fabric resource that isn't bound to
|
|
121
|
-
* any phone number — the API's binding model configures the webhook on the
|
|
122
|
-
* phone number, and the server materializes the Fabric resource as a
|
|
123
|
-
* side-effect. `create` remains for backwards compatibility but emits a
|
|
124
|
-
* one-time deprecation warning on first call.
|
|
125
|
-
*
|
|
126
|
-
* See the porting-sdk's `phone-binding.md` for the full model.
|
|
127
|
-
*/
|
|
128
|
-
export declare class AutoMaterializedWebhookResource extends FabricResource {
|
|
129
|
-
/** Label used in the deprecation warning (subclasses override). */
|
|
130
|
-
protected _autoHelperName: string;
|
|
131
|
-
private static _warned;
|
|
132
|
-
constructor(http: HttpClient, basePath: string);
|
|
133
|
-
/**
|
|
134
|
-
* @deprecated Creating a webhook Fabric resource directly produces an
|
|
135
|
-
* orphan that is not bound to any phone number. Use the
|
|
136
|
-
* `phoneNumbers.setSwmlWebhook` / `setCxmlWebhook` helper instead — it
|
|
137
|
-
* updates the phone number and the server auto-materializes the
|
|
138
|
-
* resource. Kept for backwards compatibility.
|
|
139
|
-
*/
|
|
140
|
-
create(body?: any): Promise<any>;
|
|
141
|
-
}
|
|
142
|
-
/** Auto-materialized SWML webhook — normally created via `phoneNumbers.setSwmlWebhook`. */
|
|
143
|
-
export declare class SwmlWebhooksResource extends AutoMaterializedWebhookResource {
|
|
144
|
-
protected _autoHelperName: string;
|
|
145
|
-
}
|
|
146
|
-
/** Auto-materialized cXML webhook — normally created via `phoneNumbers.setCxmlWebhook`. */
|
|
147
|
-
export declare class CxmlWebhooksResource extends AutoMaterializedWebhookResource {
|
|
148
|
-
protected _autoHelperName: string;
|
|
149
|
-
}
|
|
150
|
-
/** Generic resource operations across all fabric resource types. */
|
|
151
|
-
export declare class GenericResources extends BaseResource {
|
|
152
|
-
private static _assignPhoneRouteWarned;
|
|
153
|
-
constructor(http: HttpClient, basePath: string);
|
|
154
|
-
/**
|
|
155
|
-
* List all fabric resources regardless of specific type.
|
|
156
|
-
*
|
|
157
|
-
* @param params - Optional filter / pagination query parameters.
|
|
158
|
-
* @returns A paginated list of generic fabric resources.
|
|
159
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
160
|
-
*/
|
|
161
|
-
list(params?: QueryParams): Promise<any>;
|
|
162
|
-
/**
|
|
163
|
-
* Fetch a single fabric resource by ID.
|
|
164
|
-
*
|
|
165
|
-
* @param resourceId - Unique identifier of the resource.
|
|
166
|
-
* @returns The resource record.
|
|
167
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
168
|
-
*/
|
|
169
|
-
get(resourceId: string): Promise<any>;
|
|
170
|
-
/**
|
|
171
|
-
* Delete a fabric resource.
|
|
172
|
-
*
|
|
173
|
-
* @param resourceId - Unique identifier of the resource.
|
|
174
|
-
* @returns The platform's delete response.
|
|
175
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
176
|
-
*/
|
|
177
|
-
delete(resourceId: string): Promise<any>;
|
|
178
|
-
/**
|
|
179
|
-
* List addresses associated with any fabric resource.
|
|
180
|
-
*
|
|
181
|
-
* @param resourceId - Unique identifier of the resource.
|
|
182
|
-
* @param params - Optional filter / pagination query parameters.
|
|
183
|
-
* @returns A paginated list of addresses.
|
|
184
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
185
|
-
*/
|
|
186
|
-
listAddresses(resourceId: string, params?: QueryParams): Promise<any>;
|
|
187
|
-
/**
|
|
188
|
-
* Assign a phone route to a fabric resource.
|
|
189
|
-
*
|
|
190
|
-
* @deprecated For the common cases — SWML webhooks, cXML webhooks, AI
|
|
191
|
-
* agents — this endpoint **does not work**. Bindings for those are
|
|
192
|
-
* configured on the phone number via {@link PhoneNumbersResource.setSwmlWebhook}
|
|
193
|
-
* / `setCxmlWebhook` / `setAiAgent`, and the Fabric resource is
|
|
194
|
-
* auto-materialized by the server. Calling this method against
|
|
195
|
-
* `swml_webhook`, `cxml_webhook`, or `ai_agent` resource IDs returns
|
|
196
|
-
* `404` or `422`. The endpoint (`POST /api/fabric/resources/{id}/phone_routes`)
|
|
197
|
-
* applies only to a narrow set of legacy resource types listed in
|
|
198
|
-
* `rest-apis/relay-rest/openapi.yaml`. Emits a one-time deprecation
|
|
199
|
-
* warning on first call; kept for backwards compatibility.
|
|
200
|
-
*
|
|
201
|
-
* @param resourceId - Unique identifier of the resource.
|
|
202
|
-
* @param body - Phone route payload.
|
|
203
|
-
* @returns The phone-route assignment record.
|
|
204
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
205
|
-
*/
|
|
206
|
-
assignPhoneRoute(resourceId: string, body: any): Promise<any>;
|
|
207
|
-
/**
|
|
208
|
-
* Assign a domain application to a fabric resource.
|
|
209
|
-
*
|
|
210
|
-
* @param resourceId - Unique identifier of the resource.
|
|
211
|
-
* @param body - Domain application payload.
|
|
212
|
-
* @returns The domain-application assignment record.
|
|
213
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
214
|
-
*/
|
|
215
|
-
assignDomainApplication(resourceId: string, body: any): Promise<any>;
|
|
216
|
-
}
|
|
217
|
-
/** Read-only fabric addresses. */
|
|
218
|
-
export declare class FabricAddresses extends BaseResource {
|
|
219
|
-
constructor(http: HttpClient, basePath: string);
|
|
220
|
-
/**
|
|
221
|
-
* List all fabric addresses in the project.
|
|
222
|
-
*
|
|
223
|
-
* @param params - Optional filter / pagination query parameters.
|
|
224
|
-
* @returns A paginated list of fabric addresses.
|
|
225
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
226
|
-
*/
|
|
227
|
-
list(params?: QueryParams): Promise<any>;
|
|
228
|
-
/**
|
|
229
|
-
* Fetch a single fabric address by ID.
|
|
230
|
-
*
|
|
231
|
-
* @param addressId - Unique identifier of the address.
|
|
232
|
-
* @returns The address record.
|
|
233
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
234
|
-
*/
|
|
235
|
-
get(addressId: string): Promise<any>;
|
|
236
|
-
}
|
|
237
|
-
/** Subscriber, guest, invite, and embed token creation. */
|
|
238
|
-
export declare class FabricTokens extends BaseResource {
|
|
239
|
-
constructor(http: HttpClient);
|
|
240
|
-
/**
|
|
241
|
-
* Issue a new subscriber JWT used by end-user clients.
|
|
242
|
-
*
|
|
243
|
-
* @param body - Token payload (subscriber ID, TTL, scopes). Defaults to `{}`.
|
|
244
|
-
* @returns The token record, typically `{ token: "eyJ..." }`.
|
|
245
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
246
|
-
*/
|
|
247
|
-
createSubscriberToken(body?: any): Promise<any>;
|
|
248
|
-
/**
|
|
249
|
-
* Refresh an existing subscriber JWT, extending its lifetime.
|
|
250
|
-
*
|
|
251
|
-
* @param body - Refresh payload (usually containing the current token).
|
|
252
|
-
* Defaults to `{}`.
|
|
253
|
-
* @returns The refreshed token record.
|
|
254
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
255
|
-
*/
|
|
256
|
-
refreshSubscriberToken(body?: any): Promise<any>;
|
|
257
|
-
/**
|
|
258
|
-
* Create a single-use invite token for onboarding a new subscriber.
|
|
259
|
-
*
|
|
260
|
-
* @param body - Invite payload (email, phone, permissions). Defaults to `{}`.
|
|
261
|
-
* @returns The invite record, including the share URL / code.
|
|
262
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
263
|
-
*/
|
|
264
|
-
createInviteToken(body?: any): Promise<any>;
|
|
265
|
-
/**
|
|
266
|
-
* Issue a guest token (no subscriber account required).
|
|
267
|
-
*
|
|
268
|
-
* @param body - Guest-token payload (context, TTL, etc.). Defaults to `{}`.
|
|
269
|
-
* @returns The token record.
|
|
270
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
271
|
-
*/
|
|
272
|
-
createGuestToken(body?: any): Promise<any>;
|
|
273
|
-
/**
|
|
274
|
-
* Issue a short-lived embed token for browser-side SignalWire widgets.
|
|
275
|
-
*
|
|
276
|
-
* @param body - Embed-token payload (allowed origins, TTL, etc.). Defaults to `{}`.
|
|
277
|
-
* @returns The token record.
|
|
278
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
279
|
-
*/
|
|
280
|
-
createEmbedToken(body?: any): Promise<any>;
|
|
281
|
-
}
|
|
282
|
-
/**
|
|
283
|
-
* Fabric API namespace grouping all resource types.
|
|
284
3
|
*
|
|
285
|
-
*
|
|
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.
|
|
286
8
|
*
|
|
287
9
|
* @example
|
|
288
10
|
* ```ts
|
|
11
|
+
* import { RestClient } from '@signalwire/sdk';
|
|
12
|
+
* const client = new RestClient();
|
|
289
13
|
* const agents = await client.fabric.aiAgents.list();
|
|
290
|
-
* const flow = await client.fabric.callFlows.create({
|
|
291
|
-
* 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');
|
|
292
16
|
* ```
|
|
293
17
|
*/
|
|
294
|
-
export
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
/** Relay Application CRUD (full-replacement `PUT` update). */
|
|
298
|
-
readonly relayApplications: FabricResourcePUT;
|
|
299
|
-
/** Call Flow CRUD with version listing and publishing. */
|
|
300
|
-
readonly callFlows: CallFlowsResource;
|
|
301
|
-
/** Conference Room CRUD with address listing. */
|
|
302
|
-
readonly conferenceRooms: ConferenceRoomsResource;
|
|
303
|
-
/** FreeSWITCH Connector CRUD. */
|
|
304
|
-
readonly freeswitchConnectors: FabricResourcePUT;
|
|
305
|
-
/** Subscriber CRUD plus nested SIP endpoint management. */
|
|
306
|
-
readonly subscribers: SubscribersResource;
|
|
307
|
-
/** Top-level SIP endpoint CRUD. */
|
|
308
|
-
readonly sipEndpoints: FabricResourcePUT;
|
|
309
|
-
/** cXML (LaML) script CRUD. */
|
|
310
|
-
readonly cxmlScripts: FabricResourcePUT;
|
|
311
|
-
/** cXML application read / update / delete (no create). */
|
|
312
|
-
readonly cxmlApplications: CxmlApplicationsResource;
|
|
313
|
-
/**
|
|
314
|
-
* SWML webhook CRUD. **Auto-materialized** as a side-effect of
|
|
315
|
-
* {@link PhoneNumbersResource.setSwmlWebhook}; direct `create` produces
|
|
316
|
-
* an orphan resource and emits a deprecation warning.
|
|
317
|
-
*/
|
|
318
|
-
readonly swmlWebhooks: SwmlWebhooksResource;
|
|
319
|
-
/** AI Agent CRUD — the platform-managed agent registration resource. */
|
|
320
|
-
readonly aiAgents: FabricResource;
|
|
321
|
-
/** SIP Gateway CRUD. */
|
|
322
|
-
readonly sipGateways: FabricResource;
|
|
323
|
-
/**
|
|
324
|
-
* cXML webhook CRUD. **Auto-materialized** as a side-effect of
|
|
325
|
-
* {@link PhoneNumbersResource.setCxmlWebhook}; direct `create` produces
|
|
326
|
-
* an orphan resource and emits a deprecation warning.
|
|
327
|
-
*/
|
|
328
|
-
readonly cxmlWebhooks: CxmlWebhooksResource;
|
|
329
|
-
/** Generic operations across all resource types (list, get, delete, phone route assignment). */
|
|
330
|
-
readonly resources: GenericResources;
|
|
331
|
-
/** Read-only access to the unified fabric address table. */
|
|
332
|
-
readonly addresses: FabricAddresses;
|
|
333
|
-
/** Subscriber, guest, invite, and embed token generation. */
|
|
334
|
-
readonly tokens: FabricTokens;
|
|
335
|
-
constructor(http: HttpClient);
|
|
336
|
-
}
|
|
18
|
+
export { FabricResource, FabricResourcePUT } from '../base/FabricResource.js';
|
|
19
|
+
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';
|
|
20
|
+
export { FabricNamespace } from './_client_tree_generated.js';
|