namespace static

nexus.licence

Source: src/licence/index.js:7

Namespace

type

Methods

create(params)
list(params)
preAssign(body)
update(params)

Namespace

Methods

async static

create(params) → Promise containing ApiResponse

creates a licence

Parameters

Name Type Optional Description

params

Object

 

Values in params have the following properties:

Name Type Optional Description

params

Object

 

params.typeId

string

 
Returns

Promise containing ApiResponse 

async static

list(params) → Promise containing ApiResponse

queries the licences collection

Parameters

Name Type Optional Description

params

Object

 

Values in params have the following properties:

Name Type Optional Description

textQuery

string

 

textQueryField

string

 

sortBy

string

 

sortOrder

string

 

typeId

string

 

embedUsers

boolean

 

embedDevices

boolean

 

skip

number

 

limit

number

 
Returns

Promise containing ApiResponse 

async static

preAssign(body) → Promise containing ApiResponse

preassigns a licence to a device

Parameters

Name Type Optional Description

body

Object

 

Values in body have the following properties:

Name Type Optional Description

key

string

 

the licence key

deviceId

string

 

the deviceId to be preassigned
Returns

Promise containing ApiResponse 

async static

update(params) → Promise containing ApiResponse

updates a licence

Parameters

Name Type Optional Description

params

Object

 

Values in params have the following properties:

Name Type Optional Description

licenceId

string

 

params.

Object

 

params.invoiceId

string

 

params.state

string

 
Returns

Promise containing ApiResponse