@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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CrudResource.js","sourceRoot":"","sources":["../../../src/rest/base/CrudResource.ts"],"names":[],"mappings":"AAAA;;GAEG;
|
|
1
|
+
{"version":3,"file":"CrudResource.js","sourceRoot":"","sources":["../../../src/rest/base/CrudResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,YAKX,SAAQ,YAA0B;IAClC,qEAAqE;IAC3D,aAAa,GAAoB,OAAO,CAAC;IAEnD,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,IAAa,EAAE,cAAmC;QAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAQ,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CACV,UAAkB,EAClB,IAAa,EACb,cAAmC;QAEnC,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAQ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;QAC7E,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAQ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,UAAkB,EAAE,cAAmC;QAClE,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,CAAC;IACnE,CAAC;CACF"}
|
|
@@ -2,13 +2,14 @@
|
|
|
2
2
|
* CrudResource extended with address listing.
|
|
3
3
|
*/
|
|
4
4
|
import type { HttpClient } from '../HttpClient.js';
|
|
5
|
+
import type { RequestOptionsInit } from '../RequestOptions.js';
|
|
5
6
|
import type { QueryParams } from '../types.js';
|
|
6
7
|
import { CrudResource } from './CrudResource.js';
|
|
7
8
|
/**
|
|
8
9
|
* {@link CrudResource} extended with a `listAddresses()` helper for resources that
|
|
9
10
|
* have associated Address records (e.g. fabric resources).
|
|
10
11
|
*/
|
|
11
|
-
export declare class CrudWithAddresses<TList =
|
|
12
|
+
export declare class CrudWithAddresses<TList = unknown, TItem = unknown, TCreate = unknown, TUpdate = unknown> extends CrudResource<TList, TItem, TCreate, TUpdate> {
|
|
12
13
|
constructor(http: HttpClient, basePath: string);
|
|
13
14
|
/**
|
|
14
15
|
* List addresses associated with a specific resource instance.
|
|
@@ -18,5 +19,5 @@ export declare class CrudWithAddresses<TList = any, TItem = any, TCreate = any,
|
|
|
18
19
|
* @returns A paginated list of addresses.
|
|
19
20
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
20
21
|
*/
|
|
21
|
-
listAddresses(resourceId: string, params?: QueryParams): Promise<
|
|
22
|
+
listAddresses(resourceId: string, params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<unknown>;
|
|
22
23
|
}
|
|
@@ -18,8 +18,8 @@ export class CrudWithAddresses extends CrudResource {
|
|
|
18
18
|
* @returns A paginated list of addresses.
|
|
19
19
|
* @throws {RestError} On any non-2xx HTTP response.
|
|
20
20
|
*/
|
|
21
|
-
async listAddresses(resourceId, params) {
|
|
22
|
-
return this._http.get(this._path(resourceId, 'addresses'), params);
|
|
21
|
+
async listAddresses(resourceId, params, requestOptions) {
|
|
22
|
+
return this._http.get(this._path(resourceId, 'addresses'), params, requestOptions);
|
|
23
23
|
}
|
|
24
24
|
}
|
|
25
25
|
//# sourceMappingURL=CrudWithAddresses.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CrudWithAddresses.js","sourceRoot":"","sources":["../../../src/rest/base/CrudWithAddresses.ts"],"names":[],"mappings":"AAAA;;GAEG;
|
|
1
|
+
{"version":3,"file":"CrudWithAddresses.js","sourceRoot":"","sources":["../../../src/rest/base/CrudWithAddresses.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;;GAGG;AACH,MAAM,OAAO,iBAKX,SAAQ,YAA4C;IACpD,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CACjB,UAAkB,EAClB,MAAoB,EACpB,cAAmC;QAEnC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;IACrF,CAAC;CACF"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Fabric resource base classes.
|
|
3
|
+
*
|
|
4
|
+
* Generic CRUD-with-addresses bases for fabric resources. They live here (not in
|
|
5
|
+
* the fabric namespace) so the generated `fabric.resources.generated` subclasses can
|
|
6
|
+
* extend them without an import cycle. Re-exported from the fabric namespace.
|
|
7
|
+
*/
|
|
8
|
+
import { CrudWithAddresses } from './CrudWithAddresses.js';
|
|
9
|
+
/** Standard fabric resource: CRUD plus address listing (PATCH updates). */
|
|
10
|
+
export declare class FabricResource<TList = unknown, TItem = unknown, TCreate = unknown, TUpdate = unknown> extends CrudWithAddresses<TList, TItem, TCreate, TUpdate> {
|
|
11
|
+
}
|
|
12
|
+
/** Fabric resource that uses PUT for updates. */
|
|
13
|
+
export declare class FabricResourcePUT<TList = unknown, TItem = unknown, TCreate = unknown, TUpdate = unknown> extends CrudWithAddresses<TList, TItem, TCreate, TUpdate> {
|
|
14
|
+
protected _updateMethod: 'PATCH' | 'PUT';
|
|
15
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Fabric resource base classes.
|
|
3
|
+
*
|
|
4
|
+
* Generic CRUD-with-addresses bases for fabric resources. They live here (not in
|
|
5
|
+
* the fabric namespace) so the generated `fabric.resources.generated` subclasses can
|
|
6
|
+
* extend them without an import cycle. Re-exported from the fabric namespace.
|
|
7
|
+
*/
|
|
8
|
+
import { CrudWithAddresses } from './CrudWithAddresses.js';
|
|
9
|
+
/** Standard fabric resource: CRUD plus address listing (PATCH updates). */
|
|
10
|
+
export class FabricResource extends CrudWithAddresses {
|
|
11
|
+
}
|
|
12
|
+
/** Fabric resource that uses PUT for updates. */
|
|
13
|
+
export class FabricResourcePUT extends CrudWithAddresses {
|
|
14
|
+
_updateMethod = 'PUT';
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=FabricResource.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FabricResource.js","sourceRoot":"","sources":["../../../src/rest/base/FabricResource.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,2EAA2E;AAC3E,MAAM,OAAO,cAKX,SAAQ,iBAAiD;CAAG;AAE9D,iDAAiD;AACjD,MAAM,OAAO,iBAKX,SAAQ,iBAAiD;IACtC,aAAa,GAAoB,KAAK,CAAC;CAC3D"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Read-only resource base: `list()` + `get()` only.
|
|
3
|
+
*/
|
|
4
|
+
import type { HttpClient } from '../HttpClient.js';
|
|
5
|
+
import type { RequestOptionsInit } from '../RequestOptions.js';
|
|
6
|
+
import type { QueryParams } from '../types.js';
|
|
7
|
+
import { BaseResource } from './BaseResource.js';
|
|
8
|
+
/**
|
|
9
|
+
* Read-only REST resource exposing `list()` and `get()` (no create/update/delete).
|
|
10
|
+
*
|
|
11
|
+
* The read-only counterpart of {@link CrudResource} — used by resources whose
|
|
12
|
+
* surface is just listing and fetching (e.g. video room sessions, fabric
|
|
13
|
+
* addresses). Generated subclasses bind the two generic types and add any
|
|
14
|
+
* declared sub-resource accessors.
|
|
15
|
+
*
|
|
16
|
+
* @typeParam TList - Type of the paginated list response.
|
|
17
|
+
* @typeParam TItem - Type of a single resource item.
|
|
18
|
+
*/
|
|
19
|
+
export declare class ReadResource<TList = unknown, TItem = unknown> extends BaseResource {
|
|
20
|
+
constructor(http: HttpClient, basePath: string);
|
|
21
|
+
/**
|
|
22
|
+
* List resources with optional query parameters.
|
|
23
|
+
*
|
|
24
|
+
* @param params - Optional filter / pagination query parameters.
|
|
25
|
+
* @returns The paginated list response.
|
|
26
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
27
|
+
*/
|
|
28
|
+
list(params?: QueryParams, requestOptions?: RequestOptionsInit): Promise<TList>;
|
|
29
|
+
/**
|
|
30
|
+
* Iterate every item across all pages of this resource's list endpoint.
|
|
31
|
+
*
|
|
32
|
+
* `list()` returns a single raw page (the server's first response).
|
|
33
|
+
* `paginate()` walks every page transparently, following the server's
|
|
34
|
+
* `links.next` / `next_page_uri` cursor, and yields one item at a time — so
|
|
35
|
+
* callers no longer hand-build the page-token loop:
|
|
36
|
+
*
|
|
37
|
+
* ```typescript
|
|
38
|
+
* import { RestClient } from '@signalwire/sdk';
|
|
39
|
+
* const client = new RestClient();
|
|
40
|
+
* for await (const address of client.fabric.addresses.paginate()) {
|
|
41
|
+
* console.log(address);
|
|
42
|
+
* }
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
45
|
+
* The TS analogue of Python's `ReadResource.paginate()` /
|
|
46
|
+
* `PaginatedIterator`: an async iterator wired to the shared {@link paginate}
|
|
47
|
+
* generator, reading items from `resp["data"]`.
|
|
48
|
+
*
|
|
49
|
+
* @param params - Query parameters applied to the FIRST request only;
|
|
50
|
+
* subsequent pages follow the server-supplied next-page URL.
|
|
51
|
+
* @returns An async iterator yielding each `TItem` across all pages.
|
|
52
|
+
*/
|
|
53
|
+
paginate(params?: QueryParams, requestOptions?: RequestOptionsInit): AsyncGenerator<TItem, void, undefined>;
|
|
54
|
+
/**
|
|
55
|
+
* Fetch a single resource by ID.
|
|
56
|
+
*
|
|
57
|
+
* @param resourceId - Unique identifier of the resource.
|
|
58
|
+
* @returns The resource record.
|
|
59
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
60
|
+
*/
|
|
61
|
+
get(resourceId: string, requestOptions?: RequestOptionsInit): Promise<TItem>;
|
|
62
|
+
}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Read-only resource base: `list()` + `get()` only.
|
|
3
|
+
*/
|
|
4
|
+
import { paginate } from '../pagination.js';
|
|
5
|
+
import { BaseResource } from './BaseResource.js';
|
|
6
|
+
/**
|
|
7
|
+
* Read-only REST resource exposing `list()` and `get()` (no create/update/delete).
|
|
8
|
+
*
|
|
9
|
+
* The read-only counterpart of {@link CrudResource} — used by resources whose
|
|
10
|
+
* surface is just listing and fetching (e.g. video room sessions, fabric
|
|
11
|
+
* addresses). Generated subclasses bind the two generic types and add any
|
|
12
|
+
* declared sub-resource accessors.
|
|
13
|
+
*
|
|
14
|
+
* @typeParam TList - Type of the paginated list response.
|
|
15
|
+
* @typeParam TItem - Type of a single resource item.
|
|
16
|
+
*/
|
|
17
|
+
export class ReadResource extends BaseResource {
|
|
18
|
+
constructor(http, basePath) {
|
|
19
|
+
super(http, basePath);
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* List resources with optional query parameters.
|
|
23
|
+
*
|
|
24
|
+
* @param params - Optional filter / pagination query parameters.
|
|
25
|
+
* @returns The paginated list response.
|
|
26
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
27
|
+
*/
|
|
28
|
+
async list(params, requestOptions) {
|
|
29
|
+
return this._http.get(this._basePath, params, requestOptions);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Iterate every item across all pages of this resource's list endpoint.
|
|
33
|
+
*
|
|
34
|
+
* `list()` returns a single raw page (the server's first response).
|
|
35
|
+
* `paginate()` walks every page transparently, following the server's
|
|
36
|
+
* `links.next` / `next_page_uri` cursor, and yields one item at a time — so
|
|
37
|
+
* callers no longer hand-build the page-token loop:
|
|
38
|
+
*
|
|
39
|
+
* ```typescript
|
|
40
|
+
* import { RestClient } from '@signalwire/sdk';
|
|
41
|
+
* const client = new RestClient();
|
|
42
|
+
* for await (const address of client.fabric.addresses.paginate()) {
|
|
43
|
+
* console.log(address);
|
|
44
|
+
* }
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* The TS analogue of Python's `ReadResource.paginate()` /
|
|
48
|
+
* `PaginatedIterator`: an async iterator wired to the shared {@link paginate}
|
|
49
|
+
* generator, reading items from `resp["data"]`.
|
|
50
|
+
*
|
|
51
|
+
* @param params - Query parameters applied to the FIRST request only;
|
|
52
|
+
* subsequent pages follow the server-supplied next-page URL.
|
|
53
|
+
* @returns An async iterator yielding each `TItem` across all pages.
|
|
54
|
+
*/
|
|
55
|
+
paginate(params, requestOptions) {
|
|
56
|
+
return paginate(this._http, this._basePath, params, 'data', requestOptions);
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Fetch a single resource by ID.
|
|
60
|
+
*
|
|
61
|
+
* @param resourceId - Unique identifier of the resource.
|
|
62
|
+
* @returns The resource record.
|
|
63
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
64
|
+
*/
|
|
65
|
+
async get(resourceId, requestOptions) {
|
|
66
|
+
return this._http.get(this._path(resourceId), undefined, requestOptions);
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
//# sourceMappingURL=ReadResource.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ReadResource.js","sourceRoot":"","sources":["../../../src/rest/base/ReadResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAG5C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,YAA+C,SAAQ,YAAY;IAC9E,YAAY,IAAgB,EAAE,QAAgB;QAC5C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,MAAoB,EAAE,cAAmC;QAClE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAQ,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CACN,MAAoB,EACpB,cAAmC;QAEnC,OAAO,QAAQ,CAAQ,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CAAC,UAAkB,EAAE,cAAmC;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAQ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IAClF,CAAC;CACF"}
|
|
@@ -32,7 +32,10 @@
|
|
|
32
32
|
*
|
|
33
33
|
* @example
|
|
34
34
|
* ```ts
|
|
35
|
-
* import { PhoneCallHandler } from '@signalwire/sdk';
|
|
35
|
+
* import { PhoneCallHandler, RestClient } from '@signalwire/sdk';
|
|
36
|
+
*
|
|
37
|
+
* const client = new RestClient();
|
|
38
|
+
* const pnSid = 'pn-uuid';
|
|
36
39
|
*
|
|
37
40
|
* await client.phoneNumbers.update(pnSid, {
|
|
38
41
|
* call_handler: PhoneCallHandler.RELAY_SCRIPT,
|
|
@@ -57,4 +60,4 @@ export declare const PhoneCallHandler: {
|
|
|
57
60
|
readonly DIALOGFLOW: "dialogflow";
|
|
58
61
|
};
|
|
59
62
|
/** Union of every valid `call_handler` wire value. */
|
|
60
|
-
export type PhoneCallHandler = typeof PhoneCallHandler[keyof typeof PhoneCallHandler];
|
|
63
|
+
export type PhoneCallHandler = (typeof PhoneCallHandler)[keyof typeof PhoneCallHandler];
|
package/dist/rest/callHandler.js
CHANGED
|
@@ -32,7 +32,10 @@
|
|
|
32
32
|
*
|
|
33
33
|
* @example
|
|
34
34
|
* ```ts
|
|
35
|
-
* import { PhoneCallHandler } from '@signalwire/sdk';
|
|
35
|
+
* import { PhoneCallHandler, RestClient } from '@signalwire/sdk';
|
|
36
|
+
*
|
|
37
|
+
* const client = new RestClient();
|
|
38
|
+
* const pnSid = 'pn-uuid';
|
|
36
39
|
*
|
|
37
40
|
* await client.phoneNumbers.update(pnSid, {
|
|
38
41
|
* call_handler: PhoneCallHandler.RELAY_SCRIPT,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"callHandler.js","sourceRoot":"","sources":["../../src/rest/callHandler.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"callHandler.js","sourceRoot":"","sources":["../../src/rest/callHandler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,YAAY,EAAE,cAAc;IAC5B,aAAa,EAAE,eAAe;IAC9B,gBAAgB,EAAE,kBAAkB;IACpC,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,iBAAiB,EAAE,mBAAmB;IACtC,WAAW,EAAE,aAAa;IAC1B,aAAa,EAAE,eAAe;IAC9B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,YAAY;CAChB,CAAC"}
|
package/dist/rest/index.d.ts
CHANGED
|
@@ -4,92 +4,32 @@
|
|
|
4
4
|
* Standalone module (not coupled to AgentBase). Shares Logger + env var conventions.
|
|
5
5
|
*/
|
|
6
6
|
import type { ClientOptions } from './types.js';
|
|
7
|
-
import {
|
|
8
|
-
import { CallingNamespace } from './namespaces/calling.js';
|
|
9
|
-
import { PhoneNumbersResource } from './namespaces/phone-numbers.js';
|
|
10
|
-
import { AddressesResource } from './namespaces/addresses.js';
|
|
11
|
-
import { QueuesResource } from './namespaces/queues.js';
|
|
12
|
-
import { RecordingsResource } from './namespaces/recordings.js';
|
|
13
|
-
import { NumberGroupsResource } from './namespaces/number-groups.js';
|
|
14
|
-
import { VerifiedCallersResource } from './namespaces/verified-callers.js';
|
|
15
|
-
import { SipProfileResource } from './namespaces/sip-profile.js';
|
|
16
|
-
import { LookupResource } from './namespaces/lookup.js';
|
|
17
|
-
import { ShortCodesResource } from './namespaces/short-codes.js';
|
|
18
|
-
import { ImportedNumbersResource } from './namespaces/imported-numbers.js';
|
|
19
|
-
import { MfaResource } from './namespaces/mfa.js';
|
|
20
|
-
import { RegistryNamespace } from './namespaces/registry.js';
|
|
21
|
-
import { DatasphereNamespace } from './namespaces/datasphere.js';
|
|
22
|
-
import { VideoNamespace } from './namespaces/video.js';
|
|
23
|
-
import { LogsNamespace } from './namespaces/logs.js';
|
|
24
|
-
import { ProjectNamespace } from './namespaces/project.js';
|
|
25
|
-
import { PubSubResource } from './namespaces/pubsub.js';
|
|
26
|
-
import { ChatResource } from './namespaces/chat.js';
|
|
27
|
-
import { CompatNamespace } from './namespaces/compat.js';
|
|
7
|
+
import { _GeneratedResourceTree } from './namespaces/_client_tree_generated.js';
|
|
28
8
|
/**
|
|
29
9
|
* REST client for the SignalWire platform APIs.
|
|
30
10
|
*
|
|
31
11
|
* @example
|
|
32
12
|
* ```ts
|
|
13
|
+
* import { RestClient } from '@signalwire/sdk';
|
|
14
|
+
*
|
|
33
15
|
* const client = new RestClient({
|
|
34
16
|
* project: 'your-project-id',
|
|
35
17
|
* token: 'your-api-token',
|
|
36
18
|
* host: 'your-space.signalwire.com',
|
|
37
19
|
* });
|
|
38
20
|
*
|
|
39
|
-
* // Or use env vars
|
|
40
|
-
* const client = new RestClient();
|
|
21
|
+
* // Or use env vars (SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE):
|
|
22
|
+
* // const client = new RestClient();
|
|
41
23
|
*
|
|
42
24
|
* // Use namespaced resources
|
|
25
|
+
* const callId = 'call-uuid';
|
|
43
26
|
* await client.fabric.aiAgents.list();
|
|
44
|
-
* await client.calling.play(callId, {
|
|
45
|
-
* await client.phoneNumbers.search({
|
|
27
|
+
* await client.calling.play(callId, [{ type: 'audio', params: { url: 'https://cdn.example.com/greeting.mp3' } }]);
|
|
28
|
+
* await client.phoneNumbers.search({ areacode: '512' });
|
|
46
29
|
* await client.video.rooms.create({ name: 'standup' });
|
|
47
|
-
* await client.compat.calls.list();
|
|
48
30
|
* ```
|
|
49
31
|
*/
|
|
50
|
-
export declare class RestClient {
|
|
51
|
-
/** Fabric composition — AI Agents, SWML scripts, call flows, tokens, etc. */
|
|
52
|
-
readonly fabric: FabricNamespace;
|
|
53
|
-
/** REST-based call control surface (all 37 commands as methods). */
|
|
54
|
-
readonly calling: CallingNamespace;
|
|
55
|
-
/** Phone-number CRUD plus availability search. */
|
|
56
|
-
readonly phoneNumbers: PhoneNumbersResource;
|
|
57
|
-
/** Relay Address CRUD. */
|
|
58
|
-
readonly addresses: AddressesResource;
|
|
59
|
-
/** Call-queue CRUD plus member operations. */
|
|
60
|
-
readonly queues: QueuesResource;
|
|
61
|
-
/** Recording read / delete. */
|
|
62
|
-
readonly recordings: RecordingsResource;
|
|
63
|
-
/** Number-group CRUD plus membership operations. */
|
|
64
|
-
readonly numberGroups: NumberGroupsResource;
|
|
65
|
-
/** Verified Caller ID CRUD plus verification flow. */
|
|
66
|
-
readonly verifiedCallers: VerifiedCallersResource;
|
|
67
|
-
/** Project-level SIP profile read / update (singleton). */
|
|
68
|
-
readonly sipProfile: SipProfileResource;
|
|
69
|
-
/** Carrier + CNAM phone-number lookups. */
|
|
70
|
-
readonly lookup: LookupResource;
|
|
71
|
-
/** Short-code read / update. */
|
|
72
|
-
readonly shortCodes: ShortCodesResource;
|
|
73
|
-
/** Import externally-hosted phone numbers. */
|
|
74
|
-
readonly importedNumbers: ImportedNumbersResource;
|
|
75
|
-
/** Multi-factor authentication (SMS / voice code send + verify). */
|
|
76
|
-
readonly mfa: MfaResource;
|
|
77
|
-
/** US 10DLC Campaign Registry — brands, campaigns, orders, numbers. */
|
|
78
|
-
readonly registry: RegistryNamespace;
|
|
79
|
-
/** Datasphere RAG — document indexing and semantic search. */
|
|
80
|
-
readonly datasphere: DatasphereNamespace;
|
|
81
|
-
/** Video rooms, sessions, recordings, conferences, tokens, streams. */
|
|
82
|
-
readonly video: VideoNamespace;
|
|
83
|
-
/** Read-only message / voice / fax / conference logs. */
|
|
84
|
-
readonly logs: LogsNamespace;
|
|
85
|
-
/** Project-scoped API token management. */
|
|
86
|
-
readonly project: ProjectNamespace;
|
|
87
|
-
/** PubSub token issuance. */
|
|
88
|
-
readonly pubsub: PubSubResource;
|
|
89
|
-
/** Chat token issuance. */
|
|
90
|
-
readonly chat: ChatResource;
|
|
91
|
-
/** Twilio-compatible LAML surface (legacy; prefer native namespaces for new work). */
|
|
92
|
-
readonly compat: CompatNamespace;
|
|
32
|
+
export declare class RestClient extends _GeneratedResourceTree {
|
|
93
33
|
/**
|
|
94
34
|
* Create a new REST client.
|
|
95
35
|
*
|
|
@@ -102,18 +42,20 @@ export declare class RestClient {
|
|
|
102
42
|
constructor(options?: ClientOptions);
|
|
103
43
|
}
|
|
104
44
|
export { HttpClient } from './HttpClient.js';
|
|
105
|
-
export { RestError, SignalWireRestError } from './RestError.js';
|
|
45
|
+
export { RestError, RestTransportError, SignalWireRestError, SignalWireRestTransportError, } from './RestError.js';
|
|
106
46
|
export { paginate, paginateAll } from './pagination.js';
|
|
107
|
-
export
|
|
47
|
+
export { RequestOptions } from './RequestOptions.js';
|
|
48
|
+
export type { RequestOptionsInit } from './RequestOptions.js';
|
|
49
|
+
export type { ClientOptions, HttpClientOptions, PaginatedResponse, LamlPaginatedResponse, QueryParams, } from './types.js';
|
|
108
50
|
export { BaseResource } from './base/BaseResource.js';
|
|
109
51
|
export { CrudResource } from './base/CrudResource.js';
|
|
110
52
|
export { CrudWithAddresses } from './base/CrudWithAddresses.js';
|
|
111
53
|
export { PhoneCallHandler } from './callHandler.js';
|
|
112
|
-
export { FabricNamespace, FabricResource, FabricResourcePUT, CallFlowsResource, ConferenceRoomsResource, SubscribersResource, CxmlApplicationsResource,
|
|
54
|
+
export { FabricNamespace, FabricResource, FabricResourcePUT, CallFlowsResource, ConferenceRoomsResource, SubscribersResource, CxmlApplicationsResource, GenericResources, FabricAddresses, FabricTokens, } from './namespaces/fabric.js';
|
|
55
|
+
export { AiAgents, CxmlScripts, CxmlWebhooks, FreeswitchConnectors, RelayApplications, SipEndpoints, SipGateways, SwmlScripts, SwmlWebhooks, } from './namespaces/fabric.resources.generated.js';
|
|
113
56
|
export { CallingNamespace } from './namespaces/calling.js';
|
|
114
57
|
export { DatasphereNamespace, DatasphereDocuments } from './namespaces/datasphere.js';
|
|
115
58
|
export { PhoneNumbersResource } from './namespaces/phone-numbers.js';
|
|
116
|
-
export type { SetSwmlWebhookExtra, SetCxmlWebhookParams, SetCallFlowParams, SetRelayTopicParams } from './namespaces/phone-numbers.js';
|
|
117
59
|
export { AddressesResource } from './namespaces/addresses.js';
|
|
118
60
|
export { QueuesResource } from './namespaces/queues.js';
|
|
119
61
|
export { RecordingsResource } from './namespaces/recordings.js';
|
|
@@ -124,10 +66,9 @@ export { LookupResource } from './namespaces/lookup.js';
|
|
|
124
66
|
export { ShortCodesResource } from './namespaces/short-codes.js';
|
|
125
67
|
export { ImportedNumbersResource } from './namespaces/imported-numbers.js';
|
|
126
68
|
export { MfaResource } from './namespaces/mfa.js';
|
|
127
|
-
export { RegistryNamespace, RegistryBrands, RegistryCampaigns, RegistryOrders, RegistryNumbers } from './namespaces/registry.js';
|
|
128
|
-
export { VideoNamespace, VideoRooms, VideoRoomTokens, VideoRoomSessions, VideoRoomRecordings, VideoConferences, VideoConferenceTokens, VideoStreams } from './namespaces/video.js';
|
|
129
|
-
export { LogsNamespace, MessageLogs, VoiceLogs, FaxLogs, ConferenceLogs } from './namespaces/logs.js';
|
|
69
|
+
export { RegistryNamespace, RegistryBrands, RegistryCampaigns, RegistryOrders, RegistryNumbers, } from './namespaces/registry.js';
|
|
70
|
+
export { VideoNamespace, VideoRooms, VideoRoomTokens, VideoRoomSessions, VideoRoomRecordings, VideoConferences, VideoConferenceTokens, VideoStreams, } from './namespaces/video.js';
|
|
71
|
+
export { LogsNamespace, MessageLogs, VoiceLogs, FaxLogs, ConferenceLogs, } from './namespaces/logs.js';
|
|
130
72
|
export { ProjectNamespace, ProjectTokens } from './namespaces/project.js';
|
|
131
73
|
export { PubSubResource } from './namespaces/pubsub.js';
|
|
132
74
|
export { ChatResource } from './namespaces/chat.js';
|
|
133
|
-
export { CompatNamespace, CompatAccounts, CompatCalls, CompatMessages, CompatFaxes, CompatConferences, CompatPhoneNumbers, CompatApplications, CompatLamlBins, CompatQueues, CompatRecordings, CompatTranscriptions, CompatTokens } from './namespaces/compat.js';
|
package/dist/rest/index.js
CHANGED
|
@@ -5,103 +5,40 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { getLogger } from '../Logger.js';
|
|
7
7
|
import { HttpClient } from './HttpClient.js';
|
|
8
|
-
//
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
import {
|
|
12
|
-
import { AddressesResource } from './namespaces/addresses.js';
|
|
13
|
-
import { QueuesResource } from './namespaces/queues.js';
|
|
14
|
-
import { RecordingsResource } from './namespaces/recordings.js';
|
|
15
|
-
import { NumberGroupsResource } from './namespaces/number-groups.js';
|
|
16
|
-
import { VerifiedCallersResource } from './namespaces/verified-callers.js';
|
|
17
|
-
import { SipProfileResource } from './namespaces/sip-profile.js';
|
|
18
|
-
import { LookupResource } from './namespaces/lookup.js';
|
|
19
|
-
import { ShortCodesResource } from './namespaces/short-codes.js';
|
|
20
|
-
import { ImportedNumbersResource } from './namespaces/imported-numbers.js';
|
|
21
|
-
import { MfaResource } from './namespaces/mfa.js';
|
|
22
|
-
import { RegistryNamespace } from './namespaces/registry.js';
|
|
23
|
-
import { DatasphereNamespace } from './namespaces/datasphere.js';
|
|
24
|
-
import { VideoNamespace } from './namespaces/video.js';
|
|
25
|
-
import { LogsNamespace } from './namespaces/logs.js';
|
|
26
|
-
import { ProjectNamespace } from './namespaces/project.js';
|
|
27
|
-
import { PubSubResource } from './namespaces/pubsub.js';
|
|
28
|
-
import { ChatResource } from './namespaces/chat.js';
|
|
29
|
-
import { CompatNamespace } from './namespaces/compat.js';
|
|
8
|
+
// The generated resource tree (flat resources + namespace containers), wired
|
|
9
|
+
// from each resource's spec placement (RULES §8). RestClient composes it and
|
|
10
|
+
// owns only the non-spec-derivable bits (auth, HTTP construction).
|
|
11
|
+
import { _GeneratedResourceTree } from './namespaces/_client_tree_generated.js';
|
|
30
12
|
const logger = getLogger('rest_client');
|
|
31
13
|
/**
|
|
32
14
|
* REST client for the SignalWire platform APIs.
|
|
33
15
|
*
|
|
34
16
|
* @example
|
|
35
17
|
* ```ts
|
|
18
|
+
* import { RestClient } from '@signalwire/sdk';
|
|
19
|
+
*
|
|
36
20
|
* const client = new RestClient({
|
|
37
21
|
* project: 'your-project-id',
|
|
38
22
|
* token: 'your-api-token',
|
|
39
23
|
* host: 'your-space.signalwire.com',
|
|
40
24
|
* });
|
|
41
25
|
*
|
|
42
|
-
* // Or use env vars
|
|
43
|
-
* const client = new RestClient();
|
|
26
|
+
* // Or use env vars (SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE):
|
|
27
|
+
* // const client = new RestClient();
|
|
44
28
|
*
|
|
45
29
|
* // Use namespaced resources
|
|
30
|
+
* const callId = 'call-uuid';
|
|
46
31
|
* await client.fabric.aiAgents.list();
|
|
47
|
-
* await client.calling.play(callId, {
|
|
48
|
-
* await client.phoneNumbers.search({
|
|
32
|
+
* await client.calling.play(callId, [{ type: 'audio', params: { url: 'https://cdn.example.com/greeting.mp3' } }]);
|
|
33
|
+
* await client.phoneNumbers.search({ areacode: '512' });
|
|
49
34
|
* await client.video.rooms.create({ name: 'standup' });
|
|
50
|
-
* await client.compat.calls.list();
|
|
51
35
|
* ```
|
|
52
36
|
*/
|
|
53
|
-
export class RestClient {
|
|
54
|
-
//
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
//
|
|
58
|
-
/** REST-based call control surface (all 37 commands as methods). */
|
|
59
|
-
calling;
|
|
60
|
-
// Relay REST resources
|
|
61
|
-
/** Phone-number CRUD plus availability search. */
|
|
62
|
-
phoneNumbers;
|
|
63
|
-
/** Relay Address CRUD. */
|
|
64
|
-
addresses;
|
|
65
|
-
/** Call-queue CRUD plus member operations. */
|
|
66
|
-
queues;
|
|
67
|
-
/** Recording read / delete. */
|
|
68
|
-
recordings;
|
|
69
|
-
/** Number-group CRUD plus membership operations. */
|
|
70
|
-
numberGroups;
|
|
71
|
-
/** Verified Caller ID CRUD plus verification flow. */
|
|
72
|
-
verifiedCallers;
|
|
73
|
-
/** Project-level SIP profile read / update (singleton). */
|
|
74
|
-
sipProfile;
|
|
75
|
-
/** Carrier + CNAM phone-number lookups. */
|
|
76
|
-
lookup;
|
|
77
|
-
/** Short-code read / update. */
|
|
78
|
-
shortCodes;
|
|
79
|
-
/** Import externally-hosted phone numbers. */
|
|
80
|
-
importedNumbers;
|
|
81
|
-
/** Multi-factor authentication (SMS / voice code send + verify). */
|
|
82
|
-
mfa;
|
|
83
|
-
/** US 10DLC Campaign Registry — brands, campaigns, orders, numbers. */
|
|
84
|
-
registry;
|
|
85
|
-
// Datasphere API
|
|
86
|
-
/** Datasphere RAG — document indexing and semantic search. */
|
|
87
|
-
datasphere;
|
|
88
|
-
// Video API
|
|
89
|
-
/** Video rooms, sessions, recordings, conferences, tokens, streams. */
|
|
90
|
-
video;
|
|
91
|
-
// Logs
|
|
92
|
-
/** Read-only message / voice / fax / conference logs. */
|
|
93
|
-
logs;
|
|
94
|
-
// Project management
|
|
95
|
-
/** Project-scoped API token management. */
|
|
96
|
-
project;
|
|
97
|
-
// PubSub & Chat
|
|
98
|
-
/** PubSub token issuance. */
|
|
99
|
-
pubsub;
|
|
100
|
-
/** Chat token issuance. */
|
|
101
|
-
chat;
|
|
102
|
-
// Compatibility (Twilio-compatible) API
|
|
103
|
-
/** Twilio-compatible LAML surface (legacy; prefer native namespaces for new work). */
|
|
104
|
-
compat;
|
|
37
|
+
export class RestClient extends _GeneratedResourceTree {
|
|
38
|
+
// The flat resources (phoneNumbers, addresses, …) and namespace containers
|
|
39
|
+
// (fabric, video, logs, registry, …) are declared + wired by the generated
|
|
40
|
+
// `_GeneratedResourceTree` base (RULES §8). RestClient adds only what is NOT
|
|
41
|
+
// spec-derivable below.
|
|
105
42
|
/**
|
|
106
43
|
* Create a new REST client.
|
|
107
44
|
*
|
|
@@ -112,60 +49,50 @@ export class RestClient {
|
|
|
112
49
|
* the options and the environment.
|
|
113
50
|
*/
|
|
114
51
|
constructor(options = {}) {
|
|
52
|
+
super();
|
|
115
53
|
const project = options.project || process.env['SIGNALWIRE_PROJECT_ID'] || '';
|
|
116
54
|
const token = options.token || process.env['SIGNALWIRE_API_TOKEN'] || '';
|
|
117
|
-
|
|
55
|
+
// Endpoint override, in precedence order (fleet convention, r5 F4):
|
|
56
|
+
// 1. explicit `host` option (may be a bare host OR a full http(s):// URL),
|
|
57
|
+
// 2. `SIGNALWIRE_REST_BASE_URL` env — the canonical fleet base-url override
|
|
58
|
+
// (matches go's `SIGNALWIRE_REST_BASE_URL`); always a full URL,
|
|
59
|
+
// 3. `SIGNALWIRE_SPACE` env — the bare space host.
|
|
60
|
+
const host = options.host ||
|
|
61
|
+
process.env['SIGNALWIRE_REST_BASE_URL'] ||
|
|
62
|
+
process.env['SIGNALWIRE_SPACE'] ||
|
|
63
|
+
'';
|
|
118
64
|
if (!project || !token || !host) {
|
|
119
65
|
throw new Error('project, token, and host are required. ' +
|
|
120
66
|
'Provide them as arguments or set SIGNALWIRE_PROJECT_ID, ' +
|
|
121
|
-
'SIGNALWIRE_API_TOKEN, and SIGNALWIRE_SPACE
|
|
67
|
+
'SIGNALWIRE_API_TOKEN, and (SIGNALWIRE_SPACE or SIGNALWIRE_REST_BASE_URL) ' +
|
|
68
|
+
'environment variables.');
|
|
122
69
|
}
|
|
123
|
-
//
|
|
124
|
-
|
|
70
|
+
// Pass a fully-qualified host as baseUrl; otherwise pass the bare host and let
|
|
71
|
+
// HttpClient pick the scheme (http:// for a loopback mock/dev host, https://
|
|
72
|
+
// for a real *.signalwire.com space). This lets a shipped example run verbatim
|
|
73
|
+
// against the local mock via SIGNALWIRE_REST_BASE_URL=http://127.0.0.1:<port>
|
|
74
|
+
// (or SIGNALWIRE_SPACE=127.0.0.1:<port>), with the scheme decision living in
|
|
75
|
+
// one place (HttpClient). Mirrors the python reference.
|
|
76
|
+
const httpOptions = host.startsWith('http') ? { baseUrl: host } : { host };
|
|
125
77
|
const http = new HttpClient({
|
|
126
|
-
|
|
78
|
+
...httpOptions,
|
|
127
79
|
project,
|
|
128
80
|
token,
|
|
129
81
|
fetchImpl: options.fetchImpl,
|
|
82
|
+
requestOptions: options.requestOptions,
|
|
130
83
|
});
|
|
131
84
|
logger.info('RestClient initialized', { host });
|
|
132
|
-
//
|
|
133
|
-
this.
|
|
134
|
-
// Calling API
|
|
135
|
-
this.calling = new CallingNamespace(http);
|
|
136
|
-
// Relay REST resources
|
|
137
|
-
this.phoneNumbers = new PhoneNumbersResource(http);
|
|
138
|
-
this.addresses = new AddressesResource(http);
|
|
139
|
-
this.queues = new QueuesResource(http);
|
|
140
|
-
this.recordings = new RecordingsResource(http);
|
|
141
|
-
this.numberGroups = new NumberGroupsResource(http);
|
|
142
|
-
this.verifiedCallers = new VerifiedCallersResource(http);
|
|
143
|
-
this.sipProfile = new SipProfileResource(http);
|
|
144
|
-
this.lookup = new LookupResource(http);
|
|
145
|
-
this.shortCodes = new ShortCodesResource(http);
|
|
146
|
-
this.importedNumbers = new ImportedNumbersResource(http);
|
|
147
|
-
this.mfa = new MfaResource(http);
|
|
148
|
-
this.registry = new RegistryNamespace(http);
|
|
149
|
-
// Datasphere API
|
|
150
|
-
this.datasphere = new DatasphereNamespace(http);
|
|
151
|
-
// Video API
|
|
152
|
-
this.video = new VideoNamespace(http);
|
|
153
|
-
// Logs
|
|
154
|
-
this.logs = new LogsNamespace(http);
|
|
155
|
-
// Project management
|
|
156
|
-
this.project = new ProjectNamespace(http);
|
|
157
|
-
// PubSub & Chat
|
|
158
|
-
this.pubsub = new PubSubResource(http);
|
|
159
|
-
this.chat = new ChatResource(http);
|
|
160
|
-
// Compatibility (Twilio-compatible) API
|
|
161
|
-
this.compat = new CompatNamespace(http, project);
|
|
85
|
+
// Generated resource tree (flat resources + namespace containers).
|
|
86
|
+
this._wireResources(http);
|
|
162
87
|
}
|
|
163
88
|
}
|
|
164
89
|
// --- Barrel exports ---
|
|
165
90
|
// Client
|
|
166
91
|
export { HttpClient } from './HttpClient.js';
|
|
167
|
-
export { RestError, SignalWireRestError } from './RestError.js';
|
|
92
|
+
export { RestError, RestTransportError, SignalWireRestError, SignalWireRestTransportError, } from './RestError.js';
|
|
168
93
|
export { paginate, paginateAll } from './pagination.js';
|
|
94
|
+
// Request-options transport envelope (plan 4.2): timeout / retry / abort.
|
|
95
|
+
export { RequestOptions } from './RequestOptions.js';
|
|
169
96
|
// Base classes
|
|
170
97
|
export { BaseResource } from './base/BaseResource.js';
|
|
171
98
|
export { CrudResource } from './base/CrudResource.js';
|
|
@@ -173,7 +100,8 @@ export { CrudWithAddresses } from './base/CrudWithAddresses.js';
|
|
|
173
100
|
// Call-handler enum (for phoneNumbers.update call_handler field)
|
|
174
101
|
export { PhoneCallHandler } from './callHandler.js';
|
|
175
102
|
// Namespaces
|
|
176
|
-
export { FabricNamespace, FabricResource, FabricResourcePUT, CallFlowsResource, ConferenceRoomsResource, SubscribersResource, CxmlApplicationsResource,
|
|
103
|
+
export { FabricNamespace, FabricResource, FabricResourcePUT, CallFlowsResource, ConferenceRoomsResource, SubscribersResource, CxmlApplicationsResource, GenericResources, FabricAddresses, FabricTokens, } from './namespaces/fabric.js';
|
|
104
|
+
export { AiAgents, CxmlScripts, CxmlWebhooks, FreeswitchConnectors, RelayApplications, SipEndpoints, SipGateways, SwmlScripts, SwmlWebhooks, } from './namespaces/fabric.resources.generated.js';
|
|
177
105
|
export { CallingNamespace } from './namespaces/calling.js';
|
|
178
106
|
export { DatasphereNamespace, DatasphereDocuments } from './namespaces/datasphere.js';
|
|
179
107
|
export { PhoneNumbersResource } from './namespaces/phone-numbers.js';
|
|
@@ -187,11 +115,10 @@ export { LookupResource } from './namespaces/lookup.js';
|
|
|
187
115
|
export { ShortCodesResource } from './namespaces/short-codes.js';
|
|
188
116
|
export { ImportedNumbersResource } from './namespaces/imported-numbers.js';
|
|
189
117
|
export { MfaResource } from './namespaces/mfa.js';
|
|
190
|
-
export { RegistryNamespace, RegistryBrands, RegistryCampaigns, RegistryOrders, RegistryNumbers } from './namespaces/registry.js';
|
|
191
|
-
export { VideoNamespace, VideoRooms, VideoRoomTokens, VideoRoomSessions, VideoRoomRecordings, VideoConferences, VideoConferenceTokens, VideoStreams } from './namespaces/video.js';
|
|
192
|
-
export { LogsNamespace, MessageLogs, VoiceLogs, FaxLogs, ConferenceLogs } from './namespaces/logs.js';
|
|
118
|
+
export { RegistryNamespace, RegistryBrands, RegistryCampaigns, RegistryOrders, RegistryNumbers, } from './namespaces/registry.js';
|
|
119
|
+
export { VideoNamespace, VideoRooms, VideoRoomTokens, VideoRoomSessions, VideoRoomRecordings, VideoConferences, VideoConferenceTokens, VideoStreams, } from './namespaces/video.js';
|
|
120
|
+
export { LogsNamespace, MessageLogs, VoiceLogs, FaxLogs, ConferenceLogs, } from './namespaces/logs.js';
|
|
193
121
|
export { ProjectNamespace, ProjectTokens } from './namespaces/project.js';
|
|
194
122
|
export { PubSubResource } from './namespaces/pubsub.js';
|
|
195
123
|
export { ChatResource } from './namespaces/chat.js';
|
|
196
|
-
export { CompatNamespace, CompatAccounts, CompatCalls, CompatMessages, CompatFaxes, CompatConferences, CompatPhoneNumbers, CompatApplications, CompatLamlBins, CompatQueues, CompatRecordings, CompatTranscriptions, CompatTokens } from './namespaces/compat.js';
|
|
197
124
|
//# sourceMappingURL=index.js.map
|