Package com.mypurecloud.sdk.v2.api

Class LicenseApiAsync

java.lang.Object

com.mypurecloud.sdk.v2.api.LicenseApiAsync

public class LicenseApiAsync
extends Object

Constructor Summary

Constructors

Constructor	Description
LicenseApiAsync()
LicenseApiAsync(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Future<LicenseDefinition>	getLicenseDefinitionAsync(GetLicenseDefinitionRequest request, AsyncApiCallback<LicenseDefinition> callback)	Get PureCloud license definition.
Future<ApiResponse<LicenseDefinition>>	getLicenseDefinitionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LicenseDefinition>> callback)	Get PureCloud license definition.
Future<List<LicenseDefinition>>	getLicenseDefinitionsAsync(GetLicenseDefinitionsRequest request, AsyncApiCallback<List<LicenseDefinition>> callback)	Get all PureCloud license definitions available for the organization.
Future<ApiResponse<List<LicenseDefinition>>>	getLicenseDefinitionsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<LicenseDefinition>>> callback)	Get all PureCloud license definitions available for the organization.
Future<LicenseOrgToggle>	getLicenseToggleAsync(GetLicenseToggleRequest request, AsyncApiCallback<LicenseOrgToggle> callback)	Deprecated - no alternative required.
Future<ApiResponse<LicenseOrgToggle>>	getLicenseToggleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LicenseOrgToggle>> callback)	Deprecated - no alternative required.
Future<LicenseUser>	getLicenseUserAsync(GetLicenseUserRequest request, AsyncApiCallback<LicenseUser> callback)	Get licenses for specified user.
Future<ApiResponse<LicenseUser>>	getLicenseUserAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LicenseUser>> callback)	Get licenses for specified user.
Future<UserLicensesEntityListing>	getLicenseUsersAsync(GetLicenseUsersRequest request, AsyncApiCallback<UserLicensesEntityListing> callback)	Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
Future<ApiResponse<UserLicensesEntityListing>>	getLicenseUsersAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserLicensesEntityListing>> callback)	Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
Future<List<String>>	postLicenseInferAsync(PostLicenseInferRequest request, AsyncApiCallback<List<String>> callback)	Get a list of licenses inferred based on a list of roleIds
Future<ApiResponse<List<String>>>	postLicenseInferAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<List<String>>> callback)	Get a list of licenses inferred based on a list of roleIds
Future<List<String>>	postLicenseInferPermissionsAsync(PostLicenseInferPermissionsRequest request, AsyncApiCallback<List<String>> callback)	Get a list of licenses inferred based on a list of permissions postLicenseInferPermissions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
Future<ApiResponse<List<String>>>	postLicenseInferPermissionsAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<List<String>>> callback)	Get a list of licenses inferred based on a list of permissions postLicenseInferPermissions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
Future<List<LicenseUpdateStatus>>	postLicenseOrganizationAsync(PostLicenseOrganizationRequest request, AsyncApiCallback<List<LicenseUpdateStatus>> callback)	Update the organization's license assignments in a batch.
Future<ApiResponse<List<LicenseUpdateStatus>>>	postLicenseOrganizationAsync(ApiRequest<LicenseBatchAssignmentRequest> request, AsyncApiCallback<ApiResponse<List<LicenseUpdateStatus>>> callback)	Update the organization's license assignments in a batch.
Future<LicenseOrgToggle>	postLicenseToggleAsync(PostLicenseToggleRequest request, AsyncApiCallback<LicenseOrgToggle> callback)	Deprecated.
Future<ApiResponse<LicenseOrgToggle>>	postLicenseToggleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LicenseOrgToggle>> callback)	Deprecated.
Future<Map<String,Object>>	postLicenseUsersAsync(PostLicenseUsersRequest request, AsyncApiCallback<Map<String,Object>> callback)	Fetch user licenses in a batch.
Future<ApiResponse<Map<String,Object>>>	postLicenseUsersAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<Map<String,Object>>> callback)	Fetch user licenses in a batch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LicenseApiAsync

public LicenseApiAsync()

LicenseApiAsync

public LicenseApiAsync(ApiClient apiClient)

Method Details

getLicenseDefinitionAsync

public Future<LicenseDefinition> getLicenseDefinitionAsync(GetLicenseDefinitionRequest request,
 AsyncApiCallback<LicenseDefinition> callback)

Get PureCloud license definition.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLicenseDefinitionAsync

public Future<ApiResponse<LicenseDefinition>> getLicenseDefinitionAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LicenseDefinition>> callback)

Get PureCloud license definition.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLicenseDefinitionsAsync

public Future<List<LicenseDefinition>> getLicenseDefinitionsAsync(GetLicenseDefinitionsRequest request,
 AsyncApiCallback<List<LicenseDefinition>> callback)

Get all PureCloud license definitions available for the organization.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLicenseDefinitionsAsync

public Future<ApiResponse<List<LicenseDefinition>>> getLicenseDefinitionsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<List<LicenseDefinition>>> callback)

Get all PureCloud license definitions available for the organization.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLicenseToggleAsync

public Future<LicenseOrgToggle> getLicenseToggleAsync(GetLicenseToggleRequest request,
 AsyncApiCallback<LicenseOrgToggle> callback)

Deprecated - no alternative required. This operation will always return 'true' for requested toggles

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLicenseToggleAsync

public Future<ApiResponse<LicenseOrgToggle>> getLicenseToggleAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LicenseOrgToggle>> callback)

Deprecated - no alternative required. This operation will always return 'true' for requested toggles

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLicenseUserAsync

public Future<LicenseUser> getLicenseUserAsync(GetLicenseUserRequest request,
 AsyncApiCallback<LicenseUser> callback)

Get licenses for specified user.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLicenseUserAsync

public Future<ApiResponse<LicenseUser>> getLicenseUserAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LicenseUser>> callback)

Get licenses for specified user.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLicenseUsersAsync

public Future<UserLicensesEntityListing> getLicenseUsersAsync(GetLicenseUsersRequest request,
 AsyncApiCallback<UserLicensesEntityListing> callback)

Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLicenseUsersAsync

public Future<ApiResponse<UserLicensesEntityListing>> getLicenseUsersAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<UserLicensesEntityListing>> callback)

Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseInferAsync

public Future<List<String>> postLicenseInferAsync(PostLicenseInferRequest request,
 AsyncApiCallback<List<String>> callback)

Get a list of licenses inferred based on a list of roleIds

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseInferAsync

public Future<ApiResponse<List<String>>> postLicenseInferAsync(ApiRequest<List<String>> request,
 AsyncApiCallback<ApiResponse<List<String>>> callback)

Get a list of licenses inferred based on a list of roleIds

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseInferPermissionsAsync

public Future<List<String>> postLicenseInferPermissionsAsync(PostLicenseInferPermissionsRequest request,
 AsyncApiCallback<List<String>> callback)

Get a list of licenses inferred based on a list of permissions postLicenseInferPermissions is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseInferPermissionsAsync

public Future<ApiResponse<List<String>>> postLicenseInferPermissionsAsync(ApiRequest<List<String>> request,
 AsyncApiCallback<ApiResponse<List<String>>> callback)

Get a list of licenses inferred based on a list of permissions postLicenseInferPermissions is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseOrganizationAsync

public Future<List<LicenseUpdateStatus>> postLicenseOrganizationAsync(PostLicenseOrganizationRequest request,
 AsyncApiCallback<List<LicenseUpdateStatus>> callback)

Update the organization's license assignments in a batch.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseOrganizationAsync

public Future<ApiResponse<List<LicenseUpdateStatus>>> postLicenseOrganizationAsync(ApiRequest<LicenseBatchAssignmentRequest> request,
 AsyncApiCallback<ApiResponse<List<LicenseUpdateStatus>>> callback)

Update the organization's license assignments in a batch.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseToggleAsync

public Future<LicenseOrgToggle> postLicenseToggleAsync(PostLicenseToggleRequest request,
 AsyncApiCallback<LicenseOrgToggle> callback)

Deprecated. No alternative required - this endpoint has no effect

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseToggleAsync

public Future<ApiResponse<LicenseOrgToggle>> postLicenseToggleAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LicenseOrgToggle>> callback)

Deprecated. No alternative required - this endpoint has no effect

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseUsersAsync

public Future<Map<String,Object>> postLicenseUsersAsync(PostLicenseUsersRequest request,
 AsyncApiCallback<Map<String,Object>> callback)

Fetch user licenses in a batch.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLicenseUsersAsync

public Future<ApiResponse<Map<String,Object>>> postLicenseUsersAsync(ApiRequest<List<String>> request,
 AsyncApiCallback<ApiResponse<Map<String,Object>>> callback)

Fetch user licenses in a batch.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed