Package com.mypurecloud.sdk.v2.api

Class ResponseManagementApiAsync

java.lang.Object

com.mypurecloud.sdk.v2.api.ResponseManagementApiAsync

public class ResponseManagementApiAsync
extends Object

Constructor Summary

Constructors

Constructor	Description
ResponseManagementApiAsync()
ResponseManagementApiAsync(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Future<Void>	deleteResponsemanagementLibraryAsync(DeleteResponsemanagementLibraryRequest request, AsyncApiCallback<Void> callback)	Delete an existing response library.
Future<ApiResponse<Void>>	deleteResponsemanagementLibraryAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete an existing response library.
Future<Void>	deleteResponsemanagementResponseassetAsync(DeleteResponsemanagementResponseassetRequest request, AsyncApiCallback<Void> callback)	Delete response asset
Future<ApiResponse<Void>>	deleteResponsemanagementResponseassetAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete response asset
Future<Void>	deleteResponsemanagementResponseAsync(DeleteResponsemanagementResponseRequest request, AsyncApiCallback<Void> callback)	Delete an existing response.
Future<ApiResponse<Void>>	deleteResponsemanagementResponseAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete an existing response.
Future<LibraryEntityListing>	getResponsemanagementLibrariesAsync(GetResponsemanagementLibrariesRequest request, AsyncApiCallback<LibraryEntityListing> callback)	Gets a list of existing response libraries.
Future<ApiResponse<LibraryEntityListing>>	getResponsemanagementLibrariesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LibraryEntityListing>> callback)	Gets a list of existing response libraries.
Future<Library>	getResponsemanagementLibraryAsync(GetResponsemanagementLibraryRequest request, AsyncApiCallback<Library> callback)	Get details about an existing response library.
Future<ApiResponse<Library>>	getResponsemanagementLibraryAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Library>> callback)	Get details about an existing response library.
Future<ResponseAsset>	getResponsemanagementResponseassetAsync(GetResponsemanagementResponseassetRequest request, AsyncApiCallback<ResponseAsset> callback)	Get response asset information
Future<ApiResponse<ResponseAsset>>	getResponsemanagementResponseassetAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ResponseAsset>> callback)	Get response asset information
Future<ResponseAssetStatus>	getResponsemanagementResponseassetsStatusStatusIdAsync(GetResponsemanagementResponseassetsStatusStatusIdRequest request, AsyncApiCallback<ResponseAssetStatus> callback)	Get response asset upload status
Future<ApiResponse<ResponseAssetStatus>>	getResponsemanagementResponseassetsStatusStatusIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ResponseAssetStatus>> callback)	Get response asset upload status
Future<Response>	getResponsemanagementResponseAsync(GetResponsemanagementResponseRequest request, AsyncApiCallback<Response> callback)	Get details about an existing response.
Future<ApiResponse<Response>>	getResponsemanagementResponseAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Response>> callback)	Get details about an existing response.
Future<ResponseEntityListing>	getResponsemanagementResponsesAsync(GetResponsemanagementResponsesRequest request, AsyncApiCallback<ResponseEntityListing> callback)	Gets a list of existing responses.
Future<ApiResponse<ResponseEntityListing>>	getResponsemanagementResponsesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ResponseEntityListing>> callback)	Gets a list of existing responses.
Future<Library>	postResponsemanagementLibrariesAsync(PostResponsemanagementLibrariesRequest request, AsyncApiCallback<Library> callback)	Create a response library.
Future<ApiResponse<Library>>	postResponsemanagementLibrariesAsync(ApiRequest<Library> request, AsyncApiCallback<ApiResponse<Library>> callback)	Create a response library.
Future<LibraryEntityListing>	postResponsemanagementLibrariesBulkAsync(PostResponsemanagementLibrariesBulkRequest request, AsyncApiCallback<LibraryEntityListing> callback)	Get response libraries.
Future<ApiResponse<LibraryEntityListing>>	postResponsemanagementLibrariesBulkAsync(ApiRequest<LibraryBatchRequest> request, AsyncApiCallback<ApiResponse<LibraryEntityListing>> callback)	Get response libraries.
Future<LibraryEntityListing>	postResponsemanagementLibrariesQueryAsync(PostResponsemanagementLibrariesQueryRequest request, AsyncApiCallback<LibraryEntityListing> callback)	Query libraries using criteria.
Future<ApiResponse<LibraryEntityListing>>	postResponsemanagementLibrariesQueryAsync(ApiRequest<QueryCriteriaQuery> request, AsyncApiCallback<ApiResponse<LibraryEntityListing>> callback)	Query libraries using criteria.
Future<ResponseAssetEntityListing>	postResponsemanagementResponseassetsBulkAsync(PostResponsemanagementResponseassetsBulkRequest request, AsyncApiCallback<ResponseAssetEntityListing> callback)	Get response assets.
Future<ApiResponse<ResponseAssetEntityListing>>	postResponsemanagementResponseassetsBulkAsync(ApiRequest<ResponseAssetBulkRequest> request, AsyncApiCallback<ApiResponse<ResponseAssetEntityListing>> callback)	Get response assets.
Future<ResponseAssetSearchResults>	postResponsemanagementResponseassetsSearchAsync(PostResponsemanagementResponseassetsSearchRequest request, AsyncApiCallback<ResponseAssetSearchResults> callback)	Search response assets
Future<ApiResponse<ResponseAssetSearchResults>>	postResponsemanagementResponseassetsSearchAsync(ApiRequest<ResponseAssetSearchRequest> request, AsyncApiCallback<ApiResponse<ResponseAssetSearchResults>> callback)	Search response assets
Future<CreateResponseAssetResponse>	postResponsemanagementResponseassetsUploadsAsync(PostResponsemanagementResponseassetsUploadsRequest request, AsyncApiCallback<CreateResponseAssetResponse> callback)	Creates pre-signed url for uploading response asset
Future<ApiResponse<CreateResponseAssetResponse>>	postResponsemanagementResponseassetsUploadsAsync(ApiRequest<CreateResponseAssetRequest> request, AsyncApiCallback<ApiResponse<CreateResponseAssetResponse>> callback)	Creates pre-signed url for uploading response asset
Future<Response>	postResponsemanagementResponsesAsync(PostResponsemanagementResponsesRequest request, AsyncApiCallback<Response> callback)	Create a response.
Future<ApiResponse<Response>>	postResponsemanagementResponsesAsync(ApiRequest<Response> request, AsyncApiCallback<ApiResponse<Response>> callback)	Create a response.
Future<ResponseQueryResults>	postResponsemanagementResponsesQueryAsync(PostResponsemanagementResponsesQueryRequest request, AsyncApiCallback<ResponseQueryResults> callback)	Query responses
Future<ApiResponse<ResponseQueryResults>>	postResponsemanagementResponsesQueryAsync(ApiRequest<ResponseQueryRequest> request, AsyncApiCallback<ApiResponse<ResponseQueryResults>> callback)	Query responses
Future<Library>	putResponsemanagementLibraryAsync(PutResponsemanagementLibraryRequest request, AsyncApiCallback<Library> callback)	Update an existing response library.
Future<ApiResponse<Library>>	putResponsemanagementLibraryAsync(ApiRequest<Library> request, AsyncApiCallback<ApiResponse<Library>> callback)	Update an existing response library.
Future<ResponseAsset>	putResponsemanagementResponseassetAsync(PutResponsemanagementResponseassetRequest request, AsyncApiCallback<ResponseAsset> callback)	Update response asset
Future<ApiResponse<ResponseAsset>>	putResponsemanagementResponseassetAsync(ApiRequest<ResponseAssetRequest> request, AsyncApiCallback<ApiResponse<ResponseAsset>> callback)	Update response asset
Future<Response>	putResponsemanagementResponseAsync(PutResponsemanagementResponseRequest request, AsyncApiCallback<Response> callback)	Update an existing response.
Future<ApiResponse<Response>>	putResponsemanagementResponseAsync(ApiRequest<Response> request, AsyncApiCallback<ApiResponse<Response>> callback)	Update an existing response.

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseManagementApiAsync

public ResponseManagementApiAsync()

ResponseManagementApiAsync

public ResponseManagementApiAsync(ApiClient apiClient)

Method Details

deleteResponsemanagementLibraryAsync

public Future<Void> deleteResponsemanagementLibraryAsync(DeleteResponsemanagementLibraryRequest request,
 AsyncApiCallback<Void> callback)

Delete an existing response library. This will remove any responses associated with the library.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteResponsemanagementLibraryAsync

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

Delete an existing response library. This will remove any responses associated with the library.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteResponsemanagementResponseAsync

public Future<Void> deleteResponsemanagementResponseAsync(DeleteResponsemanagementResponseRequest request,
 AsyncApiCallback<Void> callback)

Delete an existing response. This will remove the response from any libraries associated with it.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteResponsemanagementResponseAsync

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

Delete an existing response. This will remove the response from any libraries associated with it.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteResponsemanagementResponseassetAsync

public Future<Void> deleteResponsemanagementResponseassetAsync(DeleteResponsemanagementResponseassetRequest request,
 AsyncApiCallback<Void> callback)

Delete response asset

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteResponsemanagementResponseassetAsync

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

Delete response asset

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementLibrariesAsync

public Future<LibraryEntityListing> getResponsemanagementLibrariesAsync(GetResponsemanagementLibrariesRequest request,
 AsyncApiCallback<LibraryEntityListing> callback)

Gets a list of existing response libraries.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementLibrariesAsync

public Future<ApiResponse<LibraryEntityListing>> getResponsemanagementLibrariesAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LibraryEntityListing>> callback)

Gets a list of existing response libraries.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementLibraryAsync

public Future<Library> getResponsemanagementLibraryAsync(GetResponsemanagementLibraryRequest request,
 AsyncApiCallback<Library> callback)

Get details about an existing response library.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementLibraryAsync

public Future<ApiResponse<Library>> getResponsemanagementLibraryAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<Library>> callback)

Get details about an existing response library.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementResponseAsync

public Future<Response> getResponsemanagementResponseAsync(GetResponsemanagementResponseRequest request,
 AsyncApiCallback<Response> callback)

Get details about an existing response.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementResponseAsync

public Future<ApiResponse<Response>> getResponsemanagementResponseAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<Response>> callback)

Get details about an existing response.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementResponseassetAsync

public Future<ResponseAsset> getResponsemanagementResponseassetAsync(GetResponsemanagementResponseassetRequest request,
 AsyncApiCallback<ResponseAsset> callback)

Get response asset information

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementResponseassetAsync

public Future<ApiResponse<ResponseAsset>> getResponsemanagementResponseassetAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<ResponseAsset>> callback)

Get response asset information

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementResponseassetsStatusStatusIdAsync

public Future<ResponseAssetStatus> getResponsemanagementResponseassetsStatusStatusIdAsync(GetResponsemanagementResponseassetsStatusStatusIdRequest request,
 AsyncApiCallback<ResponseAssetStatus> callback)

Get response asset upload status

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementResponseassetsStatusStatusIdAsync

public Future<ApiResponse<ResponseAssetStatus>> getResponsemanagementResponseassetsStatusStatusIdAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<ResponseAssetStatus>> callback)

Get response asset upload status

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementResponsesAsync

public Future<ResponseEntityListing> getResponsemanagementResponsesAsync(GetResponsemanagementResponsesRequest request,
 AsyncApiCallback<ResponseEntityListing> callback)

Gets a list of existing responses.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getResponsemanagementResponsesAsync

public Future<ApiResponse<ResponseEntityListing>> getResponsemanagementResponsesAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<ResponseEntityListing>> callback)

Gets a list of existing responses.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementLibrariesAsync

public Future<Library> postResponsemanagementLibrariesAsync(PostResponsemanagementLibrariesRequest request,
 AsyncApiCallback<Library> callback)

Create a response library.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementLibrariesAsync

public Future<ApiResponse<Library>> postResponsemanagementLibrariesAsync(ApiRequest<Library> request,
 AsyncApiCallback<ApiResponse<Library>> callback)

Create a response library.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementLibrariesBulkAsync

public Future<LibraryEntityListing> postResponsemanagementLibrariesBulkAsync(PostResponsemanagementLibrariesBulkRequest request,
 AsyncApiCallback<LibraryEntityListing> callback)

Get response libraries.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementLibrariesBulkAsync

public Future<ApiResponse<LibraryEntityListing>> postResponsemanagementLibrariesBulkAsync(ApiRequest<LibraryBatchRequest> request,
 AsyncApiCallback<ApiResponse<LibraryEntityListing>> callback)

Get response libraries.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementLibrariesQueryAsync

public Future<LibraryEntityListing> postResponsemanagementLibrariesQueryAsync(PostResponsemanagementLibrariesQueryRequest request,
 AsyncApiCallback<LibraryEntityListing> callback)

Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementLibrariesQueryAsync

public Future<ApiResponse<LibraryEntityListing>> postResponsemanagementLibrariesQueryAsync(ApiRequest<QueryCriteriaQuery> request,
 AsyncApiCallback<ApiResponse<LibraryEntityListing>> callback)

Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponseassetsBulkAsync

public Future<ResponseAssetEntityListing> postResponsemanagementResponseassetsBulkAsync(PostResponsemanagementResponseassetsBulkRequest request,
 AsyncApiCallback<ResponseAssetEntityListing> callback)

Get response assets.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponseassetsBulkAsync

public Future<ApiResponse<ResponseAssetEntityListing>> postResponsemanagementResponseassetsBulkAsync(ApiRequest<ResponseAssetBulkRequest> request,
 AsyncApiCallback<ApiResponse<ResponseAssetEntityListing>> callback)

Get response assets.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponseassetsSearchAsync

public Future<ResponseAssetSearchResults> postResponsemanagementResponseassetsSearchAsync(PostResponsemanagementResponseassetsSearchRequest request,
 AsyncApiCallback<ResponseAssetSearchResults> callback)

Search response assets

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponseassetsSearchAsync

public Future<ApiResponse<ResponseAssetSearchResults>> postResponsemanagementResponseassetsSearchAsync(ApiRequest<ResponseAssetSearchRequest> request,
 AsyncApiCallback<ApiResponse<ResponseAssetSearchResults>> callback)

Search response assets

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponseassetsUploadsAsync

public Future<CreateResponseAssetResponse> postResponsemanagementResponseassetsUploadsAsync(PostResponsemanagementResponseassetsUploadsRequest request,
 AsyncApiCallback<CreateResponseAssetResponse> callback)

Creates pre-signed url for uploading response asset

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponseassetsUploadsAsync

public Future<ApiResponse<CreateResponseAssetResponse>> postResponsemanagementResponseassetsUploadsAsync(ApiRequest<CreateResponseAssetRequest> request,
 AsyncApiCallback<ApiResponse<CreateResponseAssetResponse>> callback)

Creates pre-signed url for uploading response asset

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponsesAsync

public Future<Response> postResponsemanagementResponsesAsync(PostResponsemanagementResponsesRequest request,
 AsyncApiCallback<Response> callback)

Create a response.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponsesAsync

public Future<ApiResponse<Response>> postResponsemanagementResponsesAsync(ApiRequest<Response> request,
 AsyncApiCallback<ApiResponse<Response>> callback)

Create a response.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponsesQueryAsync

public Future<ResponseQueryResults> postResponsemanagementResponsesQueryAsync(PostResponsemanagementResponsesQueryRequest request,
 AsyncApiCallback<ResponseQueryResults> callback)

Query responses

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postResponsemanagementResponsesQueryAsync

public Future<ApiResponse<ResponseQueryResults>> postResponsemanagementResponsesQueryAsync(ApiRequest<ResponseQueryRequest> request,
 AsyncApiCallback<ApiResponse<ResponseQueryResults>> callback)

Query responses

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putResponsemanagementLibraryAsync

public Future<Library> putResponsemanagementLibraryAsync(PutResponsemanagementLibraryRequest request,
 AsyncApiCallback<Library> callback)

Update an existing response library. Fields that can be updated: name. The most recent version is required for updates.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putResponsemanagementLibraryAsync

public Future<ApiResponse<Library>> putResponsemanagementLibraryAsync(ApiRequest<Library> request,
 AsyncApiCallback<ApiResponse<Library>> callback)

Update an existing response library. Fields that can be updated: name. The most recent version is required for updates.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putResponsemanagementResponseAsync

public Future<Response> putResponsemanagementResponseAsync(PutResponsemanagementResponseRequest request,
 AsyncApiCallback<Response> callback)

Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putResponsemanagementResponseAsync

public Future<ApiResponse<Response>> putResponsemanagementResponseAsync(ApiRequest<Response> request,
 AsyncApiCallback<ApiResponse<Response>> callback)

Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putResponsemanagementResponseassetAsync

public Future<ResponseAsset> putResponsemanagementResponseassetAsync(PutResponsemanagementResponseassetRequest request,
 AsyncApiCallback<ResponseAsset> callback)

Update response asset

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putResponsemanagementResponseassetAsync

public Future<ApiResponse<ResponseAsset>> putResponsemanagementResponseassetAsync(ApiRequest<ResponseAssetRequest> request,
 AsyncApiCallback<ApiResponse<ResponseAsset>> callback)

Update response asset

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed