Skip to main content

@wildix/wms-api-client

wms-api-client package

Classes

Class

Description

CallControlAnswerCommand

CallControlAttendantTransferCommand

CallControlBlindTransferCommand

CallControlHangupCommand

CallControlHoldCommand

CallControlMakeCallCommand

CallControlUnholdCommand

CallControlUpdateContactInfoCommand

ChannelNotFoundException

CreatePbxAclGroupCommand

CreatePbxColleagueCommand

CreatePbxOAuth2ClientCommand

Create new OAuth2 client in the PBX.

DeletePbxAclGroupCommand

DeletePbxColleagueCommand

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

ListUserActiveCallsCommand

ListUserDevicesCommand

NotificationsCommand

Notifications

OriginateCallCommand

Originate call

OriginateCommand

Originate

ReloadBroadcastsCommand

Clear cache for broadcasts

UpdatePbxOAuth2ClientCommand

Update OAuth2 client in the PBX.

WmsApi

WmsApiClient

WmsApiServiceException

Base exception class for all service exceptions from WmsApi service.

WmsForbiddenException

WmsNotFoundException

WmsUnauthorizedException

WmsValidationException

Interfaces

Interface

Description

AclGroup

AclGroupPermission

AclGroupPermissionFlatItem

AclGroupPermissionItem

AclGroupRule

Call

CallControlAnswerCommandInput

The input for CallControlAnswerCommand.

CallControlAnswerCommandOutput

The output of CallControlAnswerCommand.

CallControlAnswerInput

CallControlAnswerOutput

CallControlAttendantTransferCommandInput

The input for CallControlAttendantTransferCommand.

CallControlAttendantTransferCommandOutput

The output of CallControlAttendantTransferCommand.

CallControlAttendantTransferInput

CallControlAttendantTransferOutput

CallControlBlindTransferCommandInput

The input for CallControlBlindTransferCommand.

CallControlBlindTransferCommandOutput

The output of CallControlBlindTransferCommand.

CallControlBlindTransferInput

CallControlBlindTransferOutput

CallControlHangupCommandInput

The input for CallControlHangupCommand.

CallControlHangupCommandOutput

The output of CallControlHangupCommand.

CallControlHangupInput

CallControlHangupOutput

CallControlHoldCommandInput

The input for CallControlHoldCommand.

CallControlHoldCommandOutput

The output of CallControlHoldCommand.

CallControlHoldInput

CallControlHoldOutput

CallControlMakeCallCommandInput

The input for CallControlMakeCallCommand.

CallControlMakeCallCommandOutput

The output of CallControlMakeCallCommand.

CallControlMakeCallInput

CallControlMakeCallOutput

CallControlUnholdCommandInput

The input for CallControlUnholdCommand.

CallControlUnholdCommandOutput

The output of CallControlUnholdCommand.

CallControlUnholdInput

CallControlUnholdOutput

CallControlUpdateContactInfoCommandInput

The input for CallControlUpdateContactInfoCommand.

CallControlUpdateContactInfoCommandOutput

The output of CallControlUpdateContactInfoCommand.

CallControlUpdateContactInfoInput

CallControlUpdateContactInfoOutput

ClientDefaults

CreatePbxAclGroupCommandInput

The input for CreatePbxAclGroupCommand.

CreatePbxAclGroupCommandOutput

The output of CreatePbxAclGroupCommand.

CreatePbxAclGroupInput

CreatePbxAclGroupOutput

CreatePbxColleagueCommandInput

The input for CreatePbxColleagueCommand.

CreatePbxColleagueCommandOutput

The output of CreatePbxColleagueCommand.

CreatePbxColleagueInput

CreatePbxColleagueOutput

CreatePbxOAuth2ClientCommandInput

The input for CreatePbxOAuth2ClientCommand.

CreatePbxOAuth2ClientCommandOutput

The output of CreatePbxOAuth2ClientCommand.

CreatePbxOAuth2ClientInput

CreatePbxOAuth2ClientOutput

DeletePbxAclGroupCommandInput

The input for DeletePbxAclGroupCommand.

DeletePbxAclGroupCommandOutput

The output of DeletePbxAclGroupCommand.

DeletePbxAclGroupInput

DeletePbxAclGroupOutput

DeletePbxColleagueCommandInput

The input for DeletePbxColleagueCommand.

DeletePbxColleagueCommandOutput

The output of DeletePbxColleagueCommand.

DeletePbxColleagueInput

DeletePbxColleagueOutput

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

ListUserActiveCallsCommandInput

The input for ListUserActiveCallsCommand.

ListUserActiveCallsCommandOutput

The output of ListUserActiveCallsCommand.

ListUserActiveCallsInput

ListUserActiveCallsOutput

ListUserDevicesCommandInput

The input for ListUserDevicesCommand.

ListUserDevicesCommandOutput

The output of ListUserDevicesCommand.

ListUserDevicesInput

ListUserDevicesOutput

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

ReloadBroadcastsCommandInput

The input for ReloadBroadcastsCommand.

ReloadBroadcastsCommandOutput

The output of ReloadBroadcastsCommand.

ReloadBroadcastsInput

ReloadBroadcastsOutput

RuntimeExtension

UpdatePbxOAuth2ClientCommandInput

The input for UpdatePbxOAuth2ClientCommand.

UpdatePbxOAuth2ClientCommandOutput

The output of UpdatePbxOAuth2ClientCommand.

UpdatePbxOAuth2ClientInput

UpdatePbxOAuth2ClientOutput

UserDevice

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