Skip to main content

@wildix/wms-api-client

wms-api-client package

Classes

Class

Description

CreatePbxOAuth2ClientCommand

Create new OAuth2 client in the PBX.

DeletePbxOAuth2ClientCommand

Update OAuth2 client in the PBX.

GetColleagueByIdCommand

GetPbxAclGroupsPermissionsCommand

GetPbxCallGroupsCommand

Get the list of all available Call groups on the PBX.

GetPbxColleaguesCommand

GetPbxesCommand

Get list of PBXes.

GetPbxOAuth2ClientsCommand

Get the list of all OAuth2 clients on the PBX.

GetPersonalInfoCommand

NotificationsCommand

Notifications

OriginateCallCommand

Originate call

OriginateCommand

Originate

UpdatePbxOAuth2ClientCommand

Update OAuth2 client in the PBX.

WmsApi

WmsApiClient

WmsApiServiceException

Base exception class for all service exceptions from WmsApi service.

WmsNotFoundException

WmsUnauthorizedException

WmsValidationException

Interfaces

Interface

Description

AclGroupPermission

AclGroupPermissionFlatItem

AclGroupPermissionItem

ClientDefaults

CreatePbxOAuth2ClientCommandInput

The input for CreatePbxOAuth2ClientCommand.

CreatePbxOAuth2ClientCommandOutput

The output of CreatePbxOAuth2ClientCommand.

CreatePbxOAuth2ClientInput

CreatePbxOAuth2ClientOutput

DeletePbxOAuth2ClientCommandInput

The input for DeletePbxOAuth2ClientCommand.

DeletePbxOAuth2ClientCommandOutput

The output of DeletePbxOAuth2ClientCommand.

DeletePbxOAuth2ClientInput

DeletePbxOAuth2ClientOutput

GetColleagueByIdCommandInput

The input for GetColleagueByIdCommand.

GetColleagueByIdCommandOutput

The output of GetColleagueByIdCommand.

GetColleagueByIdInput

GetColleagueByIdOutput

GetPbxAclGroupsPermissionsCommandInput

The input for GetPbxAclGroupsPermissionsCommand.

GetPbxAclGroupsPermissionsCommandOutput

The output of GetPbxAclGroupsPermissionsCommand.

GetPbxAclGroupsPermissionsInput

GetPbxAclGroupsPermissionsOutput

GetPbxCallGroupsCommandInput

The input for GetPbxCallGroupsCommand.

GetPbxCallGroupsCommandOutput

The output of GetPbxCallGroupsCommand.

GetPbxCallGroupsOutput

GetPbxCallGroupsResult

GetPbxColleaguesCommandInput

The input for GetPbxColleaguesCommand.

GetPbxColleaguesCommandOutput

The output of GetPbxColleaguesCommand.

GetPbxColleaguesInput

GetPbxColleaguesOutput

GetPbxColleaguesResult

GetPbxesCommandInput

The input for GetPbxesCommand.

GetPbxesCommandOutput

The output of GetPbxesCommand.

GetPbxesOutput

GetPbxesResult

GetPbxOAuth2ClientsCommandInput

The input for GetPbxOAuth2ClientsCommand.

GetPbxOAuth2ClientsCommandOutput

The output of GetPbxOAuth2ClientsCommand.

GetPbxOAuth2ClientsOutput

GetPbxOAuth2ClientsResult

GetPersonalInfoCommandInput

The input for GetPersonalInfoCommand.

GetPersonalInfoCommandOutput

The output of GetPersonalInfoCommand.

GetPersonalInfoInput

GetPersonalInfoOutput

NotificationsCommandInput

The input for NotificationsCommand.

NotificationsCommandOutput

The output of NotificationsCommand.

NotificationsInput

NotificationsOutput

NotificationsOutputResult

OriginateCallCommandInput

The input for OriginateCallCommand.

OriginateCallCommandOutput

The output of OriginateCallCommand.

OriginateCallInput

OriginateCallOutput

OriginateCommandInput

The input for OriginateCommand.

OriginateCommandOutput

The output of OriginateCommand.

OriginateInput

OriginateOutput

Pbx

PbxCallGroup

PbxCallGroupAnnounce

PbxCallGroupExitAllMembers

PbxCallGroupSettings

PbxColleague

PbxOAuth2Client

PbxOAuth2ClientListProjection

RuntimeExtension

UpdatePbxOAuth2ClientCommandInput

The input for UpdatePbxOAuth2ClientCommand.

UpdatePbxOAuth2ClientCommandOutput

The output of UpdatePbxOAuth2ClientCommand.

UpdatePbxOAuth2ClientInput

UpdatePbxOAuth2ClientOutput

WmsApi

WmsApiClientConfig

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

WmsApiClientResolvedConfig

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

WmsErrorItem

Variables

Variable

Description

AclGroupPermissionAbility

GetPbxColleaguesDir

PbxColleagueRole

PbxColleaguesQueryField

PbxColleaguesSearchStrategy

PbxLicenseType

ResponseResult

ResponseType

Type Aliases

Type Alias

Description

AclGroupPermissionAbility

GetPbxColleaguesDir

PbxColleagueRole

PbxColleaguesQueryField

PbxColleaguesSearchStrategy

PbxLicenseType

ResponseResult

ResponseType

ServiceInputTypes

ServiceOutputTypes

WmsApiClientConfigType

WmsApiClientResolvedConfigType