Class Licenses

Hierarchy

UrlSection
- Licenses

Index

Constructors

constructor

Methods

Constructors

constructor

new Licenses(prv: PathSegment, id?: string, service?: any): Licenses

Overrides UrlSection.constructor
- Defined in paths/Licenses.ts:7
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns Licenses

Methods

bulkPurchase

bulkPurchase(id?: string): BulkPurchase

- Defined in paths/Licenses.ts:12
Parameters
- Optional id: string
Returns BulkPurchase

delete

delete(): Promise<void>

Since 1.0.31 (Release 9.2)

Removes a license for a specific user. Please note: It is not allowed to remove assigned licenses (only Webinars and Large Meetings can be assigned).

Required Permissions

Permission	Description
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)
EditExtensions	Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings)
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)

API Group

Medium

Returns Promise<void>

get

get(): Promise<LicenseInfo>

- Defined in paths/Licenses.ts:32
Since 1.0.31 (Release 9.2)
Returns license information by its ID.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
API Group
Light

Returns Promise<LicenseInfo>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

list

list(query?: ListQuery): Promise<LicenseList>

- Defined in paths/Licenses.ts:19
Since 1.0.31 (Release 9.2)
Returns list of licenses for a specific user.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
API Group
Light

Parameters
- Optional query: ListQuery
Returns Promise<LicenseList>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc