Class Client<RequestType, ResponseType>

class: Client

Type parameters

RequestType
ResponseType

Hierarchy

Client

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Client(requestFactory: RequestFactory<RequestType>, requestPerformer: RequestPerformer<RequestType, ResponseType>, responseParser: ResponseParser<ResponseType>): Client

- Defined in index.ts:55
Parameters
- requestFactory: RequestFactory<RequestType>
- requestPerformer: RequestPerformer<RequestType, ResponseType>
- responseParser: ResponseParser<ResponseType>
Returns Client

Properties

Private requestFactory

requestFactory: RequestFactory<RequestType>

Private requestPerformer

requestPerformer: RequestPerformer<RequestType, ResponseType>

Private responseParser

responseParser: ResponseParser<ResponseType>

Methods

createCalendar

createCalendar(params: Calendar): Promise<Calendar>

- Defined in index.ts:157
Parameters
- params: Calendar
Returns Promise<Calendar>

createCallflow

createCallflow(params: Callflow): Promise<Callflow>

- Defined in index.ts:178
Parameters
- params: Callflow
Returns Promise<Callflow>

createConference

createConference(params: Conference): Promise<Conference>

- Defined in index.ts:208
Parameters
- params: Conference
Returns Promise<Conference>

createContact

createContact(params: Contact): Promise<Contact>

- Defined in index.ts:271
Parameters
- params: Contact
Returns Promise<Contact>

createDevice

createDevice(params: Device): Promise<Device>

- Defined in index.ts:233
Parameters
- params: Device
Returns Promise<Device>

createGroup

createGroup(params: Group): Promise<Group>

- Defined in index.ts:308
Parameters
- params: Group
Returns Promise<Group>

createMedia

createMedia(params: Media): Promise<Media>

- Defined in index.ts:333
Parameters
- params: Media
Returns Promise<Media>

createMenu

createMenu(params: Menu): Promise<Menu>

- Defined in index.ts:354
Parameters
- params: Menu
Returns Promise<Menu>

createPhoneNumber

createPhoneNumber(params: PhoneNumberCreate): Promise<PhoneNumber>

- Defined in index.ts:389
Parameters
- params: PhoneNumberCreate
Returns Promise<PhoneNumber>

Private createResource

createResource<T>(uri: string, params: Object): Promise<T>

- Defined in index.ts:112
Type parameters
- T
Parameters
- uri: string
- params: Object
Returns Promise<T>

createTrunk

createTrunk(params: Trunk): Promise<Trunk>

- Defined in index.ts:427
Parameters
- params: Trunk
Returns Promise<Trunk>

createUser

createUser(params: User): Promise<User>

- Defined in index.ts:448
Parameters
- params: User
Returns Promise<User>

createVoicemailBox

createVoicemailBox(params: VoicemailBox): Promise<VoicemailBox>

- Defined in index.ts:469
Parameters
- params: VoicemailBox
Returns Promise<VoicemailBox>

deleteCalendar

deleteCalendar(id: ID): Promise<object>

- Defined in index.ts:165
Parameters
- id: ID
Returns Promise<object>

deleteCallflow

deleteCallflow(id: ID): Promise<object>

- Defined in index.ts:186
Parameters
- id: ID
Returns Promise<object>

deleteConference

deleteConference(id: ID): Promise<object>

- Defined in index.ts:216
Parameters
- id: ID
Returns Promise<object>

deleteContact

deleteContact(id: ID): Promise<ContactDeleteResponse>

- Defined in index.ts:279
Parameters
- id: ID
Returns Promise<ContactDeleteResponse>

deleteDevice

deleteDevice(id: ID): Promise<object>

- Defined in index.ts:241
Parameters
- id: ID
Returns Promise<object>

deleteGroup

deleteGroup(id: ID): Promise<object>

- Defined in index.ts:316
Parameters
- id: ID
Returns Promise<object>

deleteMedia

deleteMedia(id: ID): Promise<object>

- Defined in index.ts:341
Parameters
- id: ID
Returns Promise<object>

deleteMenu

deleteMenu(id: ID): Promise<object>

- Defined in index.ts:362
Parameters
- id: ID
Returns Promise<object>

deleteMultipleContacts

deleteMultipleContacts(ids: ID[]): Promise<ContactDeleteResponse>

- Defined in index.ts:283
Parameters
- ids: ID[]
Returns Promise<ContactDeleteResponse>

deletePhoneNumber

deletePhoneNumber(id: ID): Promise<object>

- Defined in index.ts:397
Parameters
- id: ID
Returns Promise<object>

deleteRecording

deleteRecording(id: ID): Promise<object>

- Defined in index.ts:414
Parameters
- id: ID
Returns Promise<object>

Private deleteResource

deleteResource<T>(uri: string, params?: Object): Promise<T>

- Defined in index.ts:130
Type parameters
- T
Parameters
- uri: string
- Optional params: Object
Returns Promise<T>

deleteTrunk

deleteTrunk(id: ID): Promise<object>

- Defined in index.ts:435
Parameters
- id: ID
Returns Promise<object>

deleteUser

deleteUser(id: ID): Promise<object>

- Defined in index.ts:456
Parameters
- id: ID
Returns Promise<object>

deleteVoicemailBox

deleteVoicemailBox(id: ID): Promise<object>

- Defined in index.ts:477
Parameters
- id: ID
Returns Promise<object>

getAccount

getAccount(): Promise<Account>

- Defined in index.ts:144
Accounts

Returns Promise<Account>

getCalendar

getCalendar(id: ID): Promise<Calendar>

- Defined in index.ts:153
Parameters
- id: ID
Returns Promise<Calendar>

getCallflow

getCallflow(id: ID): Promise<Callflow>

- Defined in index.ts:174
Parameters
- id: ID
Returns Promise<Callflow>

getConference

getConference(id: ID): Promise<Conference>

- Defined in index.ts:204
Parameters
- id: ID
Returns Promise<Conference>

getContact

getContact(id: ID): Promise<Contact>

- Defined in index.ts:267
Parameters
- id: ID
Returns Promise<Contact>

getDevice

getDevice(id: ID): Promise<Device>

- Defined in index.ts:229
Parameters
- id: ID
Returns Promise<Device>

getGroup

getGroup(id: ID): Promise<Group>

- Defined in index.ts:304
Parameters
- id: ID
Returns Promise<Group>

getHistoryCall

getHistoryCall(id: ID): Promise<HistoryCall>

- Defined in index.ts:195
Parameters
- id: ID
Returns Promise<HistoryCall>

getMedia

getMedia(id: ID): Promise<Media>

- Defined in index.ts:325
Parameters
- id: ID
Returns Promise<Media>

getMediaRaw

getMediaRaw(id: ID): Promise<Media>

- Defined in index.ts:329
Parameters
- id: ID
Returns Promise<Media>

getMenu

getMenu(id: ID): Promise<Menu>

- Defined in index.ts:350
Parameters
- id: ID
Returns Promise<Menu>

getPhoneNumber

getPhoneNumber(id: ID): Promise<PhoneNumber>

- Defined in index.ts:385
Parameters
- id: ID
Returns Promise<PhoneNumber>

getRecording

getRecording(id: ID): Promise<Recording>

- Defined in index.ts:406
Parameters
- id: ID
Returns Promise<Recording>

getRecordingRaw

getRecordingRaw(id: ID): Promise<Recording>

- Defined in index.ts:410
Parameters
- id: ID
Returns Promise<Recording>

Private getResource

getResource<T>(uri: string, params?: Object): Promise<T>

- Defined in index.ts:103
Type parameters
- T
Parameters
- uri: string
- Optional params: Object
Returns Promise<T>

getTrunk

getTrunk(id: ID): Promise<Trunk>

- Defined in index.ts:423
Parameters
- id: ID
Returns Promise<Trunk>

getUser

getUser(id: ID): Promise<User>

- Defined in index.ts:444
Parameters
- id: ID
Returns Promise<User>

getVoicemailBox

getVoicemailBox(id: ID): Promise<VoicemailBox>

- Defined in index.ts:465
Parameters
- id: ID
Returns Promise<VoicemailBox>

listCalendars

listCalendars(): Promise<Calendar[]>

- Defined in index.ts:149
Calendars

Returns Promise<Calendar[]>

listCallflows

listCallflows(): Promise<ReadAllShort[]>

- Defined in index.ts:170
Callflows

Returns Promise<ReadAllShort[]>

listConferences

listConferences(): Promise<ReadAllShort[]>

- Defined in index.ts:200
Conferences

Returns Promise<ReadAllShort[]>

listContacts

listContacts(): Promise<Contact[]>

- Defined in index.ts:263
Directories

Returns Promise<Contact[]>

listDeviceFunctionKeys

listDeviceFunctionKeys(deviceId: ID): Promise<FunctionKey[]>

- Defined in index.ts:288
Function Keys

Parameters
- deviceId: ID
Returns Promise<FunctionKey[]>

listDevices

listDevices(filters?: object): Promise<Device[]>

- Defined in index.ts:221
Devices

Parameters
- Optional filters: object
  - Optional externalSipAccount?: boolean
  - Optional ownerId?: number
Returns Promise<Device[]>

listDevicesRegistrations

listDevicesRegistrations(): Promise<DeviceRegistration[]>

- Defined in index.ts:245
Returns Promise<DeviceRegistration[]>

listDevicesStatus

listDevicesStatus(): Promise<DeviceStatus[]>

- Defined in index.ts:249
Returns Promise<DeviceStatus[]>

listGroups

listGroups(): Promise<Group[]>

- Defined in index.ts:300
Groups

Returns Promise<Group[]>

listHistoryCalls

listHistoryCalls(direction?: string): Promise<HistoryCall[]>

- Defined in index.ts:191
Calls history

Parameters
- Default value direction: string = "all"
Returns Promise<HistoryCall[]>

listMedias

listMedias(): Promise<Media[]>

- Defined in index.ts:321
Medias

Returns Promise<Media[]>

listMenus

listMenus(): Promise<Menu[]>

- Defined in index.ts:346
Menus

Returns Promise<Menu[]>

listNetworks

listNetworks(): Promise<Network[]>

- Defined in index.ts:367
Networks

Returns Promise<Network[]>

listPhoneNumbers

listPhoneNumbers(): Promise<PhoneNumber[]>

- Defined in index.ts:373
Phone numbers

Returns Promise<PhoneNumber[]>

listRecordings

listRecordings(): Promise<Recording[]>

- Defined in index.ts:402
Recordings

Returns Promise<Recording[]>

Private listResource

listResource<T>(uri: string): Promise<T[]>

- Defined in index.ts:96
Type parameters
- T
Parameters
- uri: string
Returns Promise<T[]>

listTrunks

listTrunks(): Promise<Trunk[]>

- Defined in index.ts:419
Trunks

Returns Promise<Trunk[]>

listUsers

listUsers(): Promise<User[]>

- Defined in index.ts:440
Users

Returns Promise<User[]>

listVoicemailBoxes

listVoicemailBoxes(): Promise<VoicemailBox[]>

- Defined in index.ts:461
Voicemails Boxes

Returns Promise<VoicemailBox[]>

updateCalendar

updateCalendar(id: ID, params: Calendar): Promise<Calendar>

- Defined in index.ts:161
Parameters
- id: ID
- params: Calendar
Returns Promise<Calendar>

updateCallflow

updateCallflow(id: ID, params: Callflow): Promise<Callflow>

- Defined in index.ts:182
Parameters
- id: ID
- params: Callflow
Returns Promise<Callflow>

updateConference

updateConference(id: ID, params: Conference): Promise<Conference>

- Defined in index.ts:212
Parameters
- id: ID
- params: Conference
Returns Promise<Conference>

updateContacts

updateContacts(params: ContactUpdate): Promise<object>

- Defined in index.ts:275
Parameters
- params: ContactUpdate
Returns Promise<object>

updateDevice

updateDevice(id: ID, params: Device): Promise<Device>

- Defined in index.ts:237
Parameters
- id: ID
- params: Device
Returns Promise<Device>

updateDeviceFunctionKeys

updateDeviceFunctionKeys(deviceId: ID, params: FunctionKey): Promise<FunctionKey[]>

- Defined in index.ts:292
Parameters
- deviceId: ID
- params: FunctionKey
Returns Promise<FunctionKey[]>

updateGroup

updateGroup(id: ID, params: Group): Promise<Group>

- Defined in index.ts:312
Parameters
- id: ID
- params: Group
Returns Promise<Group>

updateMedia

updateMedia(id: ID, params: Media): Promise<Media>

- Defined in index.ts:337
Parameters
- id: ID
- params: Media
Returns Promise<Media>

updateMenu

updateMenu(id: ID, params: Menu): Promise<Menu>

- Defined in index.ts:358
Parameters
- id: ID
- params: Menu
Returns Promise<Menu>

updatePhoneNumber

updatePhoneNumber(params: PhoneNumberUpdate): Promise<PhoneNumberUpdate>

- Defined in index.ts:393
Parameters
- params: PhoneNumberUpdate
Returns Promise<PhoneNumberUpdate>

Private updateResource

updateResource<T>(uri: string, params: Object): Promise<T>

- Defined in index.ts:121
Type parameters
- T
Parameters
- uri: string
- params: Object
Returns Promise<T>

updateTrunk

updateTrunk(id: ID, params: Trunk): Promise<Trunk>

- Defined in index.ts:431
Parameters
- id: ID
- params: Trunk
Returns Promise<Trunk>

updateUser

updateUser(id: ID, params: User): Promise<User>

- Defined in index.ts:452
Parameters
- id: ID
- params: User
Returns Promise<User>

updateVoicemailBox

updateVoicemailBox(id: ID, params: VoicemailBox): Promise<VoicemailBox>

- Defined in index.ts:473
Parameters
- id: ID
- params: VoicemailBox
Returns Promise<VoicemailBox>

Static create

create(apiKey: string, config?: ClientConfig): Promise<Client<any, any>>

- Defined in index.ts:81
Parameters
- apiKey: string
- Default value config: ClientConfig = defaultConfig
Returns Promise<Client<any, any>>

Static getAuthTokenFromAPIKey

getAuthTokenFromAPIKey(apiKey: string, config: ClientConfig): Promise<any>

- Defined in index.ts:62
Parameters
- apiKey: string
- config: ClientConfig
Returns Promise<any>

Generated using TypeDoc