@signalwire/sdk 2.0.4 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"projects.resources.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/projects.resources.generated.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,0DAA0D;AAC1D,EAAE;AACF,uEAAuE;AACvE,4EAA4E;AAC5E,8EAA8E;AAC9E,mCAAmC;AAInC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AASvD,MAAM,OAAO,QAAS,SAAQ,YAAgE;IAC5F,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC/B,CAAC;IAED,0FAA0F;IACjF,KAAK,CAAC,MAAM,CACnB,IAAmB,EACnB,MAAgC,EAChC,cAAmC;QAEnC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CACpB,IAAI,CAAC,SAAS,EACd,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,EAAE,EACtB,SAAS,EACT,cAAc,CACf,CAAC;IACJ,CAAC;IAED,iEAAiE;IACxD,KAAK,CAAC,MAAM,CACnB,EAAU,EACV,IAAmB,EACnB,MAAgC,EAChC,cAAmC;QAEnC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAU,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,EAAE,EAAE,cAAc,CAAC,CAAC;IAC3F,CAAC;IAED,KAAK,CAAC,gBAAgB,CACpB,EAAU,EACV,cAAmC;QAEnC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CACpB,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,aAAa,EAAE,QAAQ,CAAC,EACvC,SAAS,EACT,SAAS,EACT,cAAc,CACf,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
/** A project or subproject within the caller's project tree. */
|
|
2
|
+
export interface Project {
|
|
3
|
+
/** Project identifier. */
|
|
4
|
+
id: string;
|
|
5
|
+
/** Project name. */
|
|
6
|
+
name: string;
|
|
7
|
+
/** The root project's ID; `null` for a root project. */
|
|
8
|
+
parent_project_id: string | null;
|
|
9
|
+
/** `true` if this project is a subproject. */
|
|
10
|
+
subproject: boolean;
|
|
11
|
+
/** Effective region preference. Returned in all responses; not currently settable via this API. */
|
|
12
|
+
region_preference: string;
|
|
13
|
+
protect_recordings: boolean;
|
|
14
|
+
protect_message_media: boolean;
|
|
15
|
+
protect_fax_media: boolean;
|
|
16
|
+
force_https_requests: boolean;
|
|
17
|
+
created_at: string;
|
|
18
|
+
updated_at: string;
|
|
19
|
+
}
|
|
20
|
+
/** A project as returned by create and signing-key rotate, including the signing key. */
|
|
21
|
+
export type ProjectWithSigningKey = Project & {
|
|
22
|
+
/** The project's signing key. Only returned on create and rotate; not retrievable afterward. */
|
|
23
|
+
signing_key: string;
|
|
24
|
+
};
|
|
25
|
+
/** Request body for creating a subproject. */
|
|
26
|
+
export interface ProjectCreate {
|
|
27
|
+
/** Project name. **Required.** Max 250 characters. */
|
|
28
|
+
name: string;
|
|
29
|
+
protect_recordings?: boolean;
|
|
30
|
+
protect_message_media?: boolean;
|
|
31
|
+
protect_fax_media?: boolean;
|
|
32
|
+
force_https_requests?: boolean;
|
|
33
|
+
}
|
|
34
|
+
/** Request body for updating a project's name and settings. */
|
|
35
|
+
export type ProjectUpdate = ProjectCreate;
|
|
36
|
+
/** A page of projects. */
|
|
37
|
+
export interface ProjectList {
|
|
38
|
+
links: {
|
|
39
|
+
self: string;
|
|
40
|
+
first: string;
|
|
41
|
+
/** Present only when more results exist. */
|
|
42
|
+
next?: string;
|
|
43
|
+
/** Present only when a previous page exists. */
|
|
44
|
+
prev?: string;
|
|
45
|
+
};
|
|
46
|
+
data: Project[];
|
|
47
|
+
}
|
|
48
|
+
/** The request contains invalid parameters or violates a business rule. See errors for details. */
|
|
49
|
+
export interface ProjectStatusCode422 {
|
|
50
|
+
/** List of validation or business-rule errors. */
|
|
51
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
52
|
+
}
|
|
53
|
+
/** Details about a specific error. */
|
|
54
|
+
export interface Types_StatusCodes_RestApiErrorItem {
|
|
55
|
+
/** The category of error. */
|
|
56
|
+
type: string;
|
|
57
|
+
/** A specific error code. */
|
|
58
|
+
code: string;
|
|
59
|
+
/** A description of what caused the error. */
|
|
60
|
+
message: string;
|
|
61
|
+
/** The request parameter that caused the error, or null for project-level errors. */
|
|
62
|
+
attribute?: string | null;
|
|
63
|
+
/** A link to documentation about this error. */
|
|
64
|
+
url: string;
|
|
65
|
+
}
|
|
66
|
+
/** Access is unauthorized. */
|
|
67
|
+
export interface Types_StatusCodes_StatusCode401 {
|
|
68
|
+
error: 'Unauthorized';
|
|
69
|
+
}
|
|
70
|
+
/** The API token lacks the required `Management` scope. */
|
|
71
|
+
export interface Types_StatusCodes_StatusCode403 {
|
|
72
|
+
error: 'Forbidden';
|
|
73
|
+
}
|
|
74
|
+
/** The server cannot find the requested resource. */
|
|
75
|
+
export interface Types_StatusCodes_StatusCode404 {
|
|
76
|
+
error: 'Not Found';
|
|
77
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// AUTO-GENERATED from porting-sdk/rest-apis/projects/openapi.yaml — DO NOT EDIT.
|
|
2
|
+
// Regenerate with: npx tsx scripts/generate-rest-types.ts
|
|
3
|
+
//
|
|
4
|
+
// Held to the same lint bar as hand-written source (no rule suppressions, no
|
|
5
|
+
// loose types). If the generator cannot emit a clean faithful type, fix the
|
|
6
|
+
// generator rather than weaken the output.
|
|
7
|
+
export {};
|
|
8
|
+
//# sourceMappingURL=projects.types.generated.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"projects.types.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/projects.types.generated.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,0DAA0D;AAC1D,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,2CAA2C"}
|
|
@@ -1,22 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* PubSub API namespace — token creation.
|
|
3
|
-
*/
|
|
4
|
-
import type { HttpClient } from '../HttpClient.js';
|
|
5
|
-
import { BaseResource } from '../base/BaseResource.js';
|
|
6
|
-
/**
|
|
7
|
-
* PubSub token generation.
|
|
8
3
|
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
4
|
+
* The `PubSub` resource class is generated from the pubsub OpenAPI spec
|
|
5
|
+
* (`pubsub.resources.generated.ts`); this module re-exports it (plus the
|
|
6
|
+
* `PubSubResource` back-compat alias) so existing imports keep working.
|
|
11
7
|
*/
|
|
12
|
-
export
|
|
13
|
-
constructor(http: HttpClient);
|
|
14
|
-
/**
|
|
15
|
-
* Generate a short-lived PubSub token.
|
|
16
|
-
*
|
|
17
|
-
* @param body - Token payload (e.g. `{ namespace, channels, expires_in }`).
|
|
18
|
-
* @returns The token record, typically `{ token: "eyJ..." }`.
|
|
19
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
20
|
-
*/
|
|
21
|
-
createToken(body: any): Promise<any>;
|
|
22
|
-
}
|
|
8
|
+
export { PubSub, PubSub as PubSubResource } from './pubsub.resources.generated.js';
|
|
@@ -1,26 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* PubSub API namespace — token creation.
|
|
3
|
-
*/
|
|
4
|
-
import { BaseResource } from '../base/BaseResource.js';
|
|
5
|
-
/**
|
|
6
|
-
* PubSub token generation.
|
|
7
3
|
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
4
|
+
* The `PubSub` resource class is generated from the pubsub OpenAPI spec
|
|
5
|
+
* (`pubsub.resources.generated.ts`); this module re-exports it (plus the
|
|
6
|
+
* `PubSubResource` back-compat alias) so existing imports keep working.
|
|
10
7
|
*/
|
|
11
|
-
export
|
|
12
|
-
constructor(http) {
|
|
13
|
-
super(http, '/api/pubsub/tokens');
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* Generate a short-lived PubSub token.
|
|
17
|
-
*
|
|
18
|
-
* @param body - Token payload (e.g. `{ namespace, channels, expires_in }`).
|
|
19
|
-
* @returns The token record, typically `{ token: "eyJ..." }`.
|
|
20
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
21
|
-
*/
|
|
22
|
-
async createToken(body) {
|
|
23
|
-
return this._http.post(this._basePath, body);
|
|
24
|
-
}
|
|
25
|
-
}
|
|
8
|
+
export { PubSub, PubSub as PubSubResource } from './pubsub.resources.generated.js';
|
|
26
9
|
//# sourceMappingURL=pubsub.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pubsub.js","sourceRoot":"","sources":["../../../src/rest/namespaces/pubsub.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"pubsub.js","sourceRoot":"","sources":["../../../src/rest/namespaces/pubsub.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { HttpClient } from '../HttpClient.js';
|
|
2
|
+
import type { RequestOptionsInit } from '../RequestOptions.js';
|
|
3
|
+
import { BaseResource } from '../base/BaseResource.js';
|
|
4
|
+
import type { PubSubChannels, PubSubState, PubSubToken } from './pubsub.types.generated.js';
|
|
5
|
+
export declare class PubSub extends BaseResource {
|
|
6
|
+
constructor(http: HttpClient);
|
|
7
|
+
createToken(ttl: number, channels: PubSubChannels, options?: {
|
|
8
|
+
member_id?: string;
|
|
9
|
+
state?: PubSubState;
|
|
10
|
+
extras?: Record<string, unknown>;
|
|
11
|
+
}, requestOptions?: RequestOptionsInit): Promise<PubSubToken>;
|
|
12
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
// AUTO-GENERATED from porting-sdk/rest-apis/pubsub/openapi.yaml — DO NOT EDIT.
|
|
2
|
+
// Regenerate with: npx tsx scripts/generate-rest-types.ts
|
|
3
|
+
//
|
|
4
|
+
// One typed resource class per x-sdk-resource: CRUD bases bound to the
|
|
5
|
+
// resource's spec types (closed body + extras door) plus declared operation
|
|
6
|
+
// methods, command-dispatch, and set_methods — mirrors the Python reference's
|
|
7
|
+
// <ns>_resources_generated module.
|
|
8
|
+
import { BaseResource } from '../base/BaseResource.js';
|
|
9
|
+
export class PubSub extends BaseResource {
|
|
10
|
+
constructor(http) {
|
|
11
|
+
super(http, '/api/pubsub/tokens');
|
|
12
|
+
}
|
|
13
|
+
async createToken(ttl, channels, options, requestOptions) {
|
|
14
|
+
const body = {};
|
|
15
|
+
const _fields = {
|
|
16
|
+
ttl,
|
|
17
|
+
channels,
|
|
18
|
+
member_id: options?.member_id,
|
|
19
|
+
state: options?.state,
|
|
20
|
+
};
|
|
21
|
+
for (const [k, v] of Object.entries(_fields))
|
|
22
|
+
if (v !== undefined)
|
|
23
|
+
body[k] = v;
|
|
24
|
+
if (options?.extras)
|
|
25
|
+
Object.assign(body, options.extras);
|
|
26
|
+
return this._http.post(this._basePath, body, undefined, requestOptions);
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=pubsub.resources.generated.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pubsub.resources.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/pubsub.resources.generated.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,0DAA0D;AAC1D,EAAE;AACF,uEAAuE;AACvE,4EAA4E;AAC5E,8EAA8E;AAC9E,mCAAmC;AAInC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGvD,MAAM,OAAO,MAAO,SAAQ,YAAY;IACtC,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,WAAW,CACf,GAAW,EACX,QAAwB,EACxB,OAAuF,EACvF,cAAmC;QAEnC,MAAM,IAAI,GAA4B,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG;YACd,GAAG;YACH,QAAQ;YACR,SAAS,EAAE,OAAO,EAAE,SAAS;YAC7B,KAAK,EAAE,OAAO,EAAE,KAAK;SACtB,CAAC;QACF,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,KAAK,SAAS;gBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC/E,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAc,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IACvF,CAAC;CACF"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
export interface NewPubSubToken {
|
|
2
|
+
/** The maximum time, in minutes, for which the access token will be valid. Between 1 and 43,200 (30 days). */
|
|
3
|
+
ttl: number;
|
|
4
|
+
/** Each channel with `write` and `read` objects with boolean as values. Max of 500 channels inside main `channels`. */
|
|
5
|
+
channels: PubSubChannels;
|
|
6
|
+
/** The unique identifier of the member. Up to 250 characters. If not specified, a random UUID will be generated. */
|
|
7
|
+
member_id?: string;
|
|
8
|
+
/** An arbitrary JSON object available to store stateful application information in. Must be valid JSON and have a maximum size of 2,000 characters. */
|
|
9
|
+
state?: PubSubState;
|
|
10
|
+
}
|
|
11
|
+
/** User-defined channel names. Each channel is an object with `read` and/or `write` properties. */
|
|
12
|
+
export type PubSubChannels = Record<string, PubSubPermissionWithRead | PubSubPermissionWithWrite>;
|
|
13
|
+
export interface PubSubPermissionWithRead {
|
|
14
|
+
/** Gives the token read access to the channel. */
|
|
15
|
+
read: boolean;
|
|
16
|
+
/** Gives the token write access to the channel. */
|
|
17
|
+
write?: boolean;
|
|
18
|
+
}
|
|
19
|
+
export interface PubSubPermissionWithWrite {
|
|
20
|
+
/** Gives the token read access to the channel. */
|
|
21
|
+
read?: boolean;
|
|
22
|
+
/** Gives the token write access to the channel. */
|
|
23
|
+
write: boolean;
|
|
24
|
+
}
|
|
25
|
+
/** An arbitrary JSON object available to store stateful application information in. Must be valid JSON and have a maximum size of 2,000 characters. */
|
|
26
|
+
export type PubSubState = Record<string, Record<string, unknown>>;
|
|
27
|
+
export interface PubSubToken {
|
|
28
|
+
/** A PubSub Token to be used to authenticate clients to the PubSub Service. */
|
|
29
|
+
token: string;
|
|
30
|
+
}
|
|
31
|
+
/** The request contains invalid parameters. See errors for details. */
|
|
32
|
+
export interface PubSubToken422Error {
|
|
33
|
+
/** List of validation errors. */
|
|
34
|
+
errors: Types_StatusCodes_RestApiErrorItem[];
|
|
35
|
+
}
|
|
36
|
+
/** Details about a specific error. */
|
|
37
|
+
export interface Types_StatusCodes_RestApiErrorItem {
|
|
38
|
+
/** The category of error. */
|
|
39
|
+
type: string;
|
|
40
|
+
/** A specific error code. */
|
|
41
|
+
code: string;
|
|
42
|
+
/** A description of what caused the error. */
|
|
43
|
+
message: string;
|
|
44
|
+
/** The request parameter that caused the error, if applicable. */
|
|
45
|
+
attribute?: string | null;
|
|
46
|
+
/** A link to documentation about this error. */
|
|
47
|
+
url: string;
|
|
48
|
+
}
|
|
49
|
+
/** The request is invalid. */
|
|
50
|
+
export interface Types_StatusCodes_StatusCode400 {
|
|
51
|
+
error: 'Bad Request';
|
|
52
|
+
}
|
|
53
|
+
/** Access is unauthorized. */
|
|
54
|
+
export interface Types_StatusCodes_StatusCode401 {
|
|
55
|
+
error: 'Unauthorized';
|
|
56
|
+
}
|
|
57
|
+
/** An internal server error occurred. */
|
|
58
|
+
export interface Types_StatusCodes_StatusCode500 {
|
|
59
|
+
error: 'Internal Server Error';
|
|
60
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// AUTO-GENERATED from porting-sdk/rest-apis/pubsub/openapi.yaml — DO NOT EDIT.
|
|
2
|
+
// Regenerate with: npx tsx scripts/generate-rest-types.ts
|
|
3
|
+
//
|
|
4
|
+
// Held to the same lint bar as hand-written source (no rule suppressions, no
|
|
5
|
+
// loose types). If the generator cannot emit a clean faithful type, fix the
|
|
6
|
+
// generator rather than weaken the output.
|
|
7
|
+
export {};
|
|
8
|
+
//# sourceMappingURL=pubsub.types.generated.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pubsub.types.generated.js","sourceRoot":"","sources":["../../../src/rest/namespaces/pubsub.types.generated.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,0DAA0D;AAC1D,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,2CAA2C"}
|
|
@@ -1,42 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Queues namespace — CRUD + member management.
|
|
3
|
-
*/
|
|
4
|
-
import type { HttpClient } from '../HttpClient.js';
|
|
5
|
-
import type { QueryParams } from '../types.js';
|
|
6
|
-
import { CrudResource } from '../base/CrudResource.js';
|
|
7
|
-
/**
|
|
8
|
-
* Queue management with member operations.
|
|
9
3
|
*
|
|
10
|
-
*
|
|
4
|
+
* Generated from the relay-rest OpenAPI spec; re-exported here (with the
|
|
5
|
+
* `QueuesResource` back-compat alias) so existing imports keep working.
|
|
11
6
|
*/
|
|
12
|
-
export
|
|
13
|
-
protected _updateMethod: 'PATCH' | 'PUT';
|
|
14
|
-
constructor(http: HttpClient);
|
|
15
|
-
/**
|
|
16
|
-
* List members in a queue.
|
|
17
|
-
*
|
|
18
|
-
* @param queueId - Unique identifier of the queue.
|
|
19
|
-
* @param params - Optional filter / pagination query parameters.
|
|
20
|
-
* @returns A paginated list of queue members.
|
|
21
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
22
|
-
*/
|
|
23
|
-
listMembers(queueId: string, params?: QueryParams): Promise<any>;
|
|
24
|
-
/**
|
|
25
|
-
* Get the next member to be served in a queue (FIFO head).
|
|
26
|
-
*
|
|
27
|
-
* @param queueId - Unique identifier of the queue.
|
|
28
|
-
* @returns The next queue member record, or a platform-shaped empty
|
|
29
|
-
* response when the queue is empty.
|
|
30
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
31
|
-
*/
|
|
32
|
-
getNextMember(queueId: string): Promise<any>;
|
|
33
|
-
/**
|
|
34
|
-
* Fetch a specific queue member by ID.
|
|
35
|
-
*
|
|
36
|
-
* @param queueId - Unique identifier of the queue.
|
|
37
|
-
* @param memberId - Unique identifier of the queue member.
|
|
38
|
-
* @returns The queue member record.
|
|
39
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
40
|
-
*/
|
|
41
|
-
getMember(queueId: string, memberId: string): Promise<any>;
|
|
42
|
-
}
|
|
7
|
+
export { Queues, Queues as QueuesResource } from './relay-rest.resources.generated.js';
|
|
@@ -1,49 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Queues namespace — CRUD + member management.
|
|
3
|
-
*/
|
|
4
|
-
import { CrudResource } from '../base/CrudResource.js';
|
|
5
|
-
/**
|
|
6
|
-
* Queue management with member operations.
|
|
7
3
|
*
|
|
8
|
-
*
|
|
4
|
+
* Generated from the relay-rest OpenAPI spec; re-exported here (with the
|
|
5
|
+
* `QueuesResource` back-compat alias) so existing imports keep working.
|
|
9
6
|
*/
|
|
10
|
-
export
|
|
11
|
-
_updateMethod = 'PUT';
|
|
12
|
-
constructor(http) {
|
|
13
|
-
super(http, '/api/relay/rest/queues');
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* List members in a queue.
|
|
17
|
-
*
|
|
18
|
-
* @param queueId - Unique identifier of the queue.
|
|
19
|
-
* @param params - Optional filter / pagination query parameters.
|
|
20
|
-
* @returns A paginated list of queue members.
|
|
21
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
22
|
-
*/
|
|
23
|
-
async listMembers(queueId, params) {
|
|
24
|
-
return this._http.get(this._path(queueId, 'members'), params);
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Get the next member to be served in a queue (FIFO head).
|
|
28
|
-
*
|
|
29
|
-
* @param queueId - Unique identifier of the queue.
|
|
30
|
-
* @returns The next queue member record, or a platform-shaped empty
|
|
31
|
-
* response when the queue is empty.
|
|
32
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
33
|
-
*/
|
|
34
|
-
async getNextMember(queueId) {
|
|
35
|
-
return this._http.get(this._path(queueId, 'members', 'next'));
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* Fetch a specific queue member by ID.
|
|
39
|
-
*
|
|
40
|
-
* @param queueId - Unique identifier of the queue.
|
|
41
|
-
* @param memberId - Unique identifier of the queue member.
|
|
42
|
-
* @returns The queue member record.
|
|
43
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
44
|
-
*/
|
|
45
|
-
async getMember(queueId, memberId) {
|
|
46
|
-
return this._http.get(this._path(queueId, 'members', memberId));
|
|
47
|
-
}
|
|
48
|
-
}
|
|
7
|
+
export { Queues, Queues as QueuesResource } from './relay-rest.resources.generated.js';
|
|
49
8
|
//# sourceMappingURL=queues.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queues.js","sourceRoot":"","sources":["../../../src/rest/namespaces/queues.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"queues.js","sourceRoot":"","sources":["../../../src/rest/namespaces/queues.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,qCAAqC,CAAC"}
|
|
@@ -1,38 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Recordings namespace — list, get, delete (no create/update).
|
|
3
|
-
*/
|
|
4
|
-
import type { HttpClient } from '../HttpClient.js';
|
|
5
|
-
import type { QueryParams } from '../types.js';
|
|
6
|
-
import { BaseResource } from '../base/BaseResource.js';
|
|
7
|
-
/**
|
|
8
|
-
* Recording management (read-only + delete).
|
|
9
3
|
*
|
|
10
|
-
*
|
|
4
|
+
* Generated from the relay-rest OpenAPI spec; re-exported here (with the
|
|
5
|
+
* `RecordingsResource` back-compat alias) so existing imports keep working.
|
|
11
6
|
*/
|
|
12
|
-
export
|
|
13
|
-
constructor(http: HttpClient);
|
|
14
|
-
/**
|
|
15
|
-
* List recordings in the project.
|
|
16
|
-
*
|
|
17
|
-
* @param params - Optional filter / pagination query parameters.
|
|
18
|
-
* @returns A paginated list of recordings.
|
|
19
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
20
|
-
*/
|
|
21
|
-
list(params?: QueryParams): Promise<any>;
|
|
22
|
-
/**
|
|
23
|
-
* Fetch a recording's metadata by ID.
|
|
24
|
-
*
|
|
25
|
-
* @param recordingId - Unique identifier of the recording.
|
|
26
|
-
* @returns The recording metadata record.
|
|
27
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
28
|
-
*/
|
|
29
|
-
get(recordingId: string): Promise<any>;
|
|
30
|
-
/**
|
|
31
|
-
* Delete a recording.
|
|
32
|
-
*
|
|
33
|
-
* @param recordingId - Unique identifier of the recording.
|
|
34
|
-
* @returns The platform's delete response.
|
|
35
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
36
|
-
*/
|
|
37
|
-
delete(recordingId: string): Promise<any>;
|
|
38
|
-
}
|
|
7
|
+
export { Recordings, Recordings as RecordingsResource } from './relay-rest.resources.generated.js';
|
|
@@ -1,45 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Recordings namespace — list, get, delete (no create/update).
|
|
3
|
-
*/
|
|
4
|
-
import { BaseResource } from '../base/BaseResource.js';
|
|
5
|
-
/**
|
|
6
|
-
* Recording management (read-only + delete).
|
|
7
3
|
*
|
|
8
|
-
*
|
|
4
|
+
* Generated from the relay-rest OpenAPI spec; re-exported here (with the
|
|
5
|
+
* `RecordingsResource` back-compat alias) so existing imports keep working.
|
|
9
6
|
*/
|
|
10
|
-
export
|
|
11
|
-
constructor(http) {
|
|
12
|
-
super(http, '/api/relay/rest/recordings');
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* List recordings in the project.
|
|
16
|
-
*
|
|
17
|
-
* @param params - Optional filter / pagination query parameters.
|
|
18
|
-
* @returns A paginated list of recordings.
|
|
19
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
20
|
-
*/
|
|
21
|
-
async list(params) {
|
|
22
|
-
return this._http.get(this._basePath, params);
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* Fetch a recording's metadata by ID.
|
|
26
|
-
*
|
|
27
|
-
* @param recordingId - Unique identifier of the recording.
|
|
28
|
-
* @returns The recording metadata record.
|
|
29
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
30
|
-
*/
|
|
31
|
-
async get(recordingId) {
|
|
32
|
-
return this._http.get(this._path(recordingId));
|
|
33
|
-
}
|
|
34
|
-
/**
|
|
35
|
-
* Delete a recording.
|
|
36
|
-
*
|
|
37
|
-
* @param recordingId - Unique identifier of the recording.
|
|
38
|
-
* @returns The platform's delete response.
|
|
39
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
40
|
-
*/
|
|
41
|
-
async delete(recordingId) {
|
|
42
|
-
return this._http.delete(this._path(recordingId));
|
|
43
|
-
}
|
|
44
|
-
}
|
|
7
|
+
export { Recordings, Recordings as RecordingsResource } from './relay-rest.resources.generated.js';
|
|
45
8
|
//# sourceMappingURL=recordings.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"recordings.js","sourceRoot":"","sources":["../../../src/rest/namespaces/recordings.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"recordings.js","sourceRoot":"","sources":["../../../src/rest/namespaces/recordings.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAC"}
|
|
@@ -1,141 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* 10DLC Campaign Registry namespace — brands, campaigns, orders, numbers.
|
|
3
|
-
*/
|
|
4
|
-
import type { HttpClient } from '../HttpClient.js';
|
|
5
|
-
import type { QueryParams } from '../types.js';
|
|
6
|
-
import { BaseResource } from '../base/BaseResource.js';
|
|
7
|
-
/** 10DLC brand management. */
|
|
8
|
-
export declare class RegistryBrands extends BaseResource {
|
|
9
|
-
constructor(http: HttpClient, basePath: string);
|
|
10
|
-
/**
|
|
11
|
-
* List all 10DLC brands in the project.
|
|
12
|
-
*
|
|
13
|
-
* @param params - Optional filter / pagination query parameters.
|
|
14
|
-
* @returns A paginated list of brands.
|
|
15
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
16
|
-
*/
|
|
17
|
-
list(params?: QueryParams): Promise<any>;
|
|
18
|
-
/**
|
|
19
|
-
* Register a new 10DLC brand.
|
|
20
|
-
*
|
|
21
|
-
* @param body - Brand registration payload (EIN, legal name, etc.).
|
|
22
|
-
* @returns The newly-registered brand record.
|
|
23
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
24
|
-
*/
|
|
25
|
-
create(body: any): Promise<any>;
|
|
26
|
-
/**
|
|
27
|
-
* Fetch a brand by ID.
|
|
28
|
-
*
|
|
29
|
-
* @param brandId - Unique identifier of the brand.
|
|
30
|
-
* @returns The brand record.
|
|
31
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
32
|
-
*/
|
|
33
|
-
get(brandId: string): Promise<any>;
|
|
34
|
-
/**
|
|
35
|
-
* List campaigns registered under a brand.
|
|
36
|
-
*
|
|
37
|
-
* @param brandId - Unique identifier of the brand.
|
|
38
|
-
* @param params - Optional filter / pagination query parameters.
|
|
39
|
-
* @returns A paginated list of campaigns.
|
|
40
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
41
|
-
*/
|
|
42
|
-
listCampaigns(brandId: string, params?: QueryParams): Promise<any>;
|
|
43
|
-
/**
|
|
44
|
-
* Register a new campaign under a brand.
|
|
45
|
-
*
|
|
46
|
-
* @param brandId - Unique identifier of the brand.
|
|
47
|
-
* @param body - Campaign registration payload (use case, sample messages, etc.).
|
|
48
|
-
* @returns The newly-registered campaign record.
|
|
49
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
50
|
-
*/
|
|
51
|
-
createCampaign(brandId: string, body: any): Promise<any>;
|
|
52
|
-
}
|
|
53
|
-
/** 10DLC campaign management. */
|
|
54
|
-
export declare class RegistryCampaigns extends BaseResource {
|
|
55
|
-
constructor(http: HttpClient, basePath: string);
|
|
56
|
-
/**
|
|
57
|
-
* Fetch a campaign by ID.
|
|
58
|
-
*
|
|
59
|
-
* @param campaignId - Unique identifier of the campaign.
|
|
60
|
-
* @returns The campaign record.
|
|
61
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
62
|
-
*/
|
|
63
|
-
get(campaignId: string): Promise<any>;
|
|
64
|
-
/**
|
|
65
|
-
* Update a campaign's attributes.
|
|
66
|
-
*
|
|
67
|
-
* @param campaignId - Unique identifier of the campaign.
|
|
68
|
-
* @param body - Full updated campaign attributes (replace semantics).
|
|
69
|
-
* @returns The updated campaign record.
|
|
70
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
71
|
-
*/
|
|
72
|
-
update(campaignId: string, body: any): Promise<any>;
|
|
73
|
-
/**
|
|
74
|
-
* List the phone numbers assigned to a campaign.
|
|
75
|
-
*
|
|
76
|
-
* @param campaignId - Unique identifier of the campaign.
|
|
77
|
-
* @param params - Optional filter / pagination query parameters.
|
|
78
|
-
* @returns A paginated list of assigned numbers.
|
|
79
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
80
|
-
*/
|
|
81
|
-
listNumbers(campaignId: string, params?: QueryParams): Promise<any>;
|
|
82
|
-
/**
|
|
83
|
-
* List number-assignment orders for a campaign.
|
|
84
|
-
*
|
|
85
|
-
* @param campaignId - Unique identifier of the campaign.
|
|
86
|
-
* @param params - Optional filter / pagination query parameters.
|
|
87
|
-
* @returns A paginated list of number-assignment orders.
|
|
88
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
89
|
-
*/
|
|
90
|
-
listOrders(campaignId: string, params?: QueryParams): Promise<any>;
|
|
91
|
-
/**
|
|
92
|
-
* Create a new number-assignment order against a campaign.
|
|
93
|
-
*
|
|
94
|
-
* @param campaignId - Unique identifier of the campaign.
|
|
95
|
-
* @param body - Order payload (phone number IDs, etc.).
|
|
96
|
-
* @returns The newly-created order record.
|
|
97
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
98
|
-
*/
|
|
99
|
-
createOrder(campaignId: string, body: any): Promise<any>;
|
|
100
|
-
}
|
|
101
|
-
/** 10DLC assignment order management. */
|
|
102
|
-
export declare class RegistryOrders extends BaseResource {
|
|
103
|
-
constructor(http: HttpClient, basePath: string);
|
|
104
|
-
/**
|
|
105
|
-
* Fetch a number-assignment order by ID.
|
|
106
|
-
*
|
|
107
|
-
* @param orderId - Unique identifier of the order.
|
|
108
|
-
* @returns The order record.
|
|
109
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
110
|
-
*/
|
|
111
|
-
get(orderId: string): Promise<any>;
|
|
112
|
-
}
|
|
113
|
-
/** 10DLC number assignment management. */
|
|
114
|
-
export declare class RegistryNumbers extends BaseResource {
|
|
115
|
-
constructor(http: HttpClient, basePath: string);
|
|
116
|
-
/**
|
|
117
|
-
* Remove a number from a 10DLC campaign assignment.
|
|
118
|
-
*
|
|
119
|
-
* @param numberId - Unique identifier of the assigned number.
|
|
120
|
-
* @returns The platform's delete response.
|
|
121
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
122
|
-
*/
|
|
123
|
-
delete(numberId: string): Promise<any>;
|
|
124
|
-
}
|
|
125
|
-
/**
|
|
126
|
-
* 10DLC Campaign Registry namespace.
|
|
127
3
|
*
|
|
128
|
-
*
|
|
129
|
-
* resources
|
|
4
|
+
* The registry resource classes are generated from the relay-rest OpenAPI spec
|
|
5
|
+
* (`relay-rest.resources.generated.ts`); the cross-spec `RegistryNamespace`
|
|
6
|
+
* container is generated into the client tree (`_client_tree_generated.ts`).
|
|
7
|
+
* This module re-exports them so existing imports keep working.
|
|
130
8
|
*/
|
|
131
|
-
export
|
|
132
|
-
|
|
133
|
-
readonly brands: RegistryBrands;
|
|
134
|
-
/** 10DLC campaign CRUD, number listing, and order management. */
|
|
135
|
-
readonly campaigns: RegistryCampaigns;
|
|
136
|
-
/** 10DLC number-assignment order read access. */
|
|
137
|
-
readonly orders: RegistryOrders;
|
|
138
|
-
/** 10DLC number assignment removal. */
|
|
139
|
-
readonly numbers: RegistryNumbers;
|
|
140
|
-
constructor(http: HttpClient);
|
|
141
|
-
}
|
|
9
|
+
export { RegistryBrands, RegistryCampaigns, RegistryNumbers, RegistryOrders, } from './relay-rest.resources.generated.js';
|
|
10
|
+
export { RegistryNamespace } from './_client_tree_generated.js';
|