com.licensespring.management.api

Interface LicensesApi

public interface LicensesApi

Licenses APIs.

Method Summary

Modifier and Type	Method and Description
List<MultipleAssignmentResponse>	assignMultipleUsers(Long id, AssignMultipleUsersRequest request) Assign multiple users to a single license.
LicenseAssignmentResponse	assignUser(Long id, AssignUserToLicenseRequest licenseUser) Assign user to the license.
Response	blacklistDevice(Long id) Blacklist the device.
BackOfficeDeviceVariable	createDeviceVariable(CreateDeviceVariableRequest request) Create a device variable.
BackOfficeLicenseCustomField	createLicenseCustomField(CreateLicenseCustomFieldRequest request) Create a license custom field.
void	deleteDeviceVariable(Long id) Delete the device variable.
void	deleteLicenseCustomField(Integer id) Delete the license custom field.
void	disableAllLicenses(Long[] ids) Disable all licenses.
void	disableLicense(Long id) Disable the license.
Device	getDevice(Long id) Get device data.
BackOfficeDeviceVariable	getDeviceVariable(Long id) Get the device variable.
BackOfficeLicense	getLicense(Long id) Gets license data.
BackOfficeLicenseCustomField	getLicenseCustomField(Integer id) Get license custom field data.
BackOfficeLicense	patchLicenseFeatures(Long id, PatchLicenseFeaturesRequest request) Update license features.
Response	resetDevice(Long id) Reset the device.
Response	resetLicense(Long id) Reset the license.
SearchResult<Device>	searchDevices(SearchDevicesRequest request) Search devices.
SearchResult<BackOfficeDeviceVariable>	searchDeviceVariables(SearchDeviceVariablesRequest request) Search device variables
SearchResult<BackOfficeLicenseCustomField>	searchLicenseCustomFields(SearchLicenseCustomFieldsRequest request) Search license custom fields.
SearchResult<BackOfficeLicense>	searchLicenses(SearchLicensesRequest request) Search licenses.
Response	setUserPassword(int id, SetPasswordRequest request) Set license users password.
void	unassignUser(Long id, UnassignRequest request) Unassign a user from a single license.
BackOfficeDeviceVariable	updateDeviceVariable(Long id, UpdateDeviceVariableRequest request) Update the device variable.
BackOfficeLicense	updateLicense(Long id, UpdateLicenseRequest request) Update license.
BackOfficeLicenseCustomField	updateLicenseCustomField(Integer id, UpdateCustomLicenseFieldRequest request) Update the license custom field.

Method Detail

searchLicenses

SearchResult<BackOfficeLicense> searchLicenses(SearchLicensesRequest request)

Search licenses.

Parameters:

request - the request

Returns:

the search result

disableAllLicenses

void disableAllLicenses(Long[] ids)

Disable all licenses.

Parameters:

ids - the licenses ids

getLicense

BackOfficeLicense getLicense(Long id)

Gets license data.

Parameters:

id - the id of the license

Returns:

the back office license

updateLicense

BackOfficeLicense updateLicense(Long id,
                                UpdateLicenseRequest request)

Update license.

Parameters:

id - the id of the license

request - the request

Returns:

the back office license

patchLicenseFeatures

BackOfficeLicense patchLicenseFeatures(Long id,
                                       PatchLicenseFeaturesRequest request)

Update license features.

Parameters:

id - the id of the license

request - the request

Returns:

the back office license

assignUser

LicenseAssignmentResponse assignUser(Long id,
                                     AssignUserToLicenseRequest licenseUser)

Assign user to the license.

Parameters:

id - the id of the license

licenseUser - the license user

Returns:

the license assignment response

assignMultipleUsers

List<MultipleAssignmentResponse> assignMultipleUsers(Long id,
                                                     AssignMultipleUsersRequest request)

Assign multiple users to a single license.

Parameters:

id - the id of the license

request - the request

Returns:

list of assignment responses

unassignUser

void unassignUser(Long id,
                  UnassignRequest request)

Unassign a user from a single license.

Parameters:

id - the license id

request - the user id

disableLicense

void disableLicense(Long id)

Disable the license.

Parameters:

id - the license id

resetLicense

Response resetLicense(Long id)

Reset the license.

Parameters:

id - the license id

Returns:

the response

setUserPassword

Response setUserPassword(int id,
                         SetPasswordRequest request)

Set license users password.

Parameters:

id - the id of the user

request - password request

Returns:

the response

searchDevices

SearchResult<Device> searchDevices(SearchDevicesRequest request)

Search devices.

Parameters:

request - the request

Returns:

the search result

getDevice

Device getDevice(Long id)

Get device data.

Parameters:

id - the id

Returns:

the device

resetDevice

Response resetDevice(Long id)

Reset the device.

Parameters:

id - the id of the device

Returns:

message

blacklistDevice

Response blacklistDevice(Long id)

Blacklist the device.

Parameters:

id - the id of the device

Returns:

message

searchLicenseCustomFields

SearchResult<BackOfficeLicenseCustomField> searchLicenseCustomFields(SearchLicenseCustomFieldsRequest request)

Search license custom fields.

Parameters:

request - the request

Returns:

the search result

getLicenseCustomField

BackOfficeLicenseCustomField getLicenseCustomField(Integer id)

Get license custom field data.

Parameters:

id - the id of the license custom field

Returns:

the back office license custom field

createLicenseCustomField

BackOfficeLicenseCustomField createLicenseCustomField(CreateLicenseCustomFieldRequest request)

Create a license custom field.

Parameters:

request - the request

Returns:

the back office license custom field

updateLicenseCustomField

BackOfficeLicenseCustomField updateLicenseCustomField(Integer id,
                                                      UpdateCustomLicenseFieldRequest request)

Update the license custom field.

Parameters:

id - the id of the license custom field

request - the request

Returns:

the back office license custom field

deleteLicenseCustomField

void deleteLicenseCustomField(Integer id)

Delete the license custom field.

Parameters:

id - the id of the license custom field

searchDeviceVariables

SearchResult<BackOfficeDeviceVariable> searchDeviceVariables(SearchDeviceVariablesRequest request)

Search device variables

Parameters:

request - the request

Returns:

the result

getDeviceVariable

BackOfficeDeviceVariable getDeviceVariable(Long id)

Get the device variable.

Parameters:

id - the id of the device variable

Returns:

the back office device variable

createDeviceVariable

BackOfficeDeviceVariable createDeviceVariable(CreateDeviceVariableRequest request)

Create a device variable.

Parameters:

request - the request

Returns:

back office device variable

updateDeviceVariable

BackOfficeDeviceVariable updateDeviceVariable(Long id,
                                              UpdateDeviceVariableRequest request)

Update the device variable.

Parameters:

id - the id of the device variable

request - the request

Returns:

back office device variable

deleteDeviceVariable

void deleteDeviceVariable(Long id)

Delete the device variable.

Parameters:

id - the id of the device variable.