Skip to main content

@wildix/xbees-assistant-client

xbees-assistant-client package

Classes

Class

Description

Assistant

AssistantClient

AssistantServiceException

Base exception class for all service exceptions from Assistant service.

BadRequestException

CommandNotFoundException

DeleteSettingsCommand

GetSettingsCommand

PostSettingsCommand

ProcessCompletionCommand

PutSettingsCommand

RateLimitExceededException

UnauthorizedException

ValidationException

Interfaces

Interface

Description

Assistant

AssistantClientConfig

The configuration interface of AssistantClient class constructor that set the region, credentials and other options.

AssistantClientResolvedConfig

The resolved configuration interface of AssistantClient class. This is resolved and normalized from the constructor configuration interface.

ClientDefaults

CompletionItem

ContentItem

DeleteSettingsCommandInput

The input for DeleteSettingsCommand.

DeleteSettingsCommandOutput

The output of DeleteSettingsCommand.

DeleteSettingsInput

DeleteSettingsOutput

GetSettingsCommandInput

The input for GetSettingsCommand.

GetSettingsCommandOutput

The output of GetSettingsCommand.

GetSettingsInput

GetSettingsOutput

PostSettingsCommandInput

The input for PostSettingsCommand.

PostSettingsCommandOutput

The output of PostSettingsCommand.

PostSettingsInput

PostSettingsOutput

ProcessCompletionCommandInput

The input for ProcessCompletionCommand.

ProcessCompletionCommandOutput

The output of ProcessCompletionCommand.

ProcessCompletionInput

ProcessCompletionOutput

PutSettingsCommandInput

The input for PutSettingsCommand.

PutSettingsCommandOutput

The output of PutSettingsCommand.

PutSettingsInput

PutSettingsOutput

RuntimeExtension

SystemCommandData

UserCommandData

Variables

Variable

Description

CommandType

CompatibilityType

SystemCommandType

Type Aliases

Type Alias

Description

AssistantClientConfigType

AssistantClientResolvedConfigType

CommandType

CompatibilityType

ServiceInputTypes

ServiceOutputTypes

SystemCommandType