Skip to main content

@wildix/xbees-users-client

xbees-users-client package

Classes

Class

Description

BatchGetUsersCommand

BatchGetUsersPbxLinkDataCommand

BatchGetUsersPbxLinkDataV1Command

BotApiKeyNotFoundException

BotNotFoundException

BotSecretKeyNotValidException

ChangeUserEmailCommand

Schedules user's email changing.

CreateBotApiKeyCommand

CreateBotCommand

DeleteBotApiKeyCommand

DeleteBotCommand

ForbiddenException

GetBotCallbackCommand

GetBotCommand

GetUserCommand

GetUserPbxLinkDataCommand

GetUserPbxLinkSuggestionCommand

GetUserPbxLinkSuggestionV1Command

ListBotApiKeysCommand

ListBotsCommand

QueryUserCommand

QueryUsersCommand

UpdateBotCallbackCommand

UpdateBotCommand

UploadPictureCommand

UploadPictureV1Command

UserCompanyNotValidException

UserNotFoundException

UserQueryPredicateNotMetException

Users

UsersClient

UsersServiceException

Base exception class for all service exceptions from Users service.

ValidationException

VerifyBotSecretKeyCommand

VerifyBotSecretKeyV1Command

Interfaces

Interface

Description

BatchGetUsersCommandInput

The input for BatchGetUsersCommand.

BatchGetUsersCommandOutput

The output of BatchGetUsersCommand.

BatchGetUsersInput

BatchGetUsersOutput

BatchGetUsersPbxLinkDataCommandInput

The input for BatchGetUsersPbxLinkDataCommand.

BatchGetUsersPbxLinkDataCommandOutput

The output of BatchGetUsersPbxLinkDataCommand.

BatchGetUsersPbxLinkDataInput

BatchGetUsersPbxLinkDataOutput

BatchGetUsersPbxLinkDataV1CommandInput

The input for BatchGetUsersPbxLinkDataV1Command.

BatchGetUsersPbxLinkDataV1CommandOutput

The output of BatchGetUsersPbxLinkDataV1Command.

BatchGetUsersPbxLinkDataV1Input

BatchGetUsersPbxLinkDataV1Output

Bot

BotApiKey

BotCallback

BotDialogflowCxEndpoint

BotOpenAiAssistantEndpoint

BotSqsEndpoint

BotWebhookEndpoint

ChangeUserEmailCommandInput

The input for ChangeUserEmailCommand.

ChangeUserEmailCommandOutput

The output of ChangeUserEmailCommand.

ChangeUserEmailInput

ChangeUserEmailOutput

ClientDefaults

CreateBotApiKeyCommandInput

The input for CreateBotApiKeyCommand.

CreateBotApiKeyCommandOutput

The output of CreateBotApiKeyCommand.

CreateBotApiKeyInput

CreateBotApiKeyOutput

CreateBotCommandInput

The input for CreateBotCommand.

CreateBotCommandOutput

The output of CreateBotCommand.

CreateBotInput

CreateBotOutput

DeleteBotApiKeyCommandInput

The input for DeleteBotApiKeyCommand.

DeleteBotApiKeyCommandOutput

The output of DeleteBotApiKeyCommand.

DeleteBotApiKeyInput

DeleteBotApiKeyOutput

DeleteBotCommandInput

The input for DeleteBotCommand.

DeleteBotCommandOutput

The output of DeleteBotCommand.

DeleteBotInput

DeleteBotOutput

GetBotCallbackCommandInput

The input for GetBotCallbackCommand.

GetBotCallbackCommandOutput

The output of GetBotCallbackCommand.

GetBotCallbackInput

GetBotCallbackOutput

GetBotCommandInput

The input for GetBotCommand.

GetBotCommandOutput

The output of GetBotCommand.

GetBotInput

GetBotOutput

GetUserCommandInput

The input for GetUserCommand.

GetUserCommandOutput

The output of GetUserCommand.

GetUserInput

GetUserOutput

GetUserPbxLinkDataCommandInput

The input for GetUserPbxLinkDataCommand.

GetUserPbxLinkDataCommandOutput

The output of GetUserPbxLinkDataCommand.

GetUserPbxLinkDataInput

GetUserPbxLinkDataOutput

GetUserPbxLinkSuggestionCommandInput

The input for GetUserPbxLinkSuggestionCommand.

GetUserPbxLinkSuggestionCommandOutput

The output of GetUserPbxLinkSuggestionCommand.

GetUserPbxLinkSuggestionInput

GetUserPbxLinkSuggestionOutput

GetUserPbxLinkSuggestionV1CommandInput

The input for GetUserPbxLinkSuggestionV1Command.

GetUserPbxLinkSuggestionV1CommandOutput

The output of GetUserPbxLinkSuggestionV1Command.

GetUserPbxLinkSuggestionV1Input

GetUserPbxLinkSuggestionV1Output

ListBotApiKeysCommandInput

The input for ListBotApiKeysCommand.

ListBotApiKeysCommandOutput

The output of ListBotApiKeysCommand.

ListBotApiKeysInput

ListBotApiKeysOutput

ListBotsCommandInput

The input for ListBotsCommand.

ListBotsCommandOutput

The output of ListBotsCommand.

ListBotsInput

ListBotsOutput

NewEmailData

OldEmailData

QueryUserCommandInput

The input for QueryUserCommand.

QueryUserCommandOutput

The output of QueryUserCommand.

QueryUserInput

QueryUserOutput

QueryUsersCommandInput

The input for QueryUsersCommand.

QueryUsersCommandOutput

The output of QueryUsersCommand.

QueryUsersInput

QueryUsersOutput

RuntimeExtension

UpdateBotCallbackCommandInput

The input for UpdateBotCallbackCommand.

UpdateBotCallbackCommandOutput

The output of UpdateBotCallbackCommand.

UpdateBotCallbackInput

UpdateBotCallbackOutput

UpdateBotCommandInput

The input for UpdateBotCommand.

UpdateBotCommandOutput

The output of UpdateBotCommand.

UpdateBotInput

UpdateBotOutput

UploadPictureCommandInput

The input for UploadPictureCommand.

UploadPictureCommandOutput

The output of UploadPictureCommand.

UploadPictureInput

UploadPictureOutput

UploadPictureV1CommandInput

The input for UploadPictureV1Command.

UploadPictureV1CommandOutput

The output of UploadPictureV1Command.

UploadPictureV1Input

UploadPictureV1Output

User

UserPbxDialplanSettings

UserPbxInfo

UserPbxLinkData

UserPbxLinkSuggestion

UserPbxPersonalSettings

UserPbxServices

UserPersonalInfo

UserQueryPredicate

Users

UsersClientConfig

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

UsersClientResolvedConfig

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

VerifyBotSecretKeyCommandInput

The input for VerifyBotSecretKeyCommand.

VerifyBotSecretKeyCommandOutput

The output of VerifyBotSecretKeyCommand.

VerifyBotSecretKeyInput

VerifyBotSecretKeyOutput

VerifyBotSecretKeyV1CommandInput

The input for VerifyBotSecretKeyV1Command.

VerifyBotSecretKeyV1CommandOutput

The output of VerifyBotSecretKeyV1Command.

VerifyBotSecretKeyV1Input

VerifyBotSecretKeyV1Output

Namespaces

Namespace

Description

BotEndpoint

UserQuery

Variables

Variable

Description

PbxLicenseType

Type Aliases

Type Alias

Description

BotEndpoint

PbxLicenseType

ServiceInputTypes

ServiceOutputTypes

UserQuery

UsersClientConfigType

UsersClientResolvedConfigType