Package com.mypurecloud.sdk.v2.api

Class AlertingApiAsync

java.lang.Object

com.mypurecloud.sdk.v2.api.AlertingApiAsync

public class AlertingApiAsync
extends Object

Constructor Summary

Constructors

Constructor	Description
AlertingApiAsync()
AlertingApiAsync(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Future<Void>	deleteAlertingAlertAsync(DeleteAlertingAlertRequest request, AsyncApiCallback<Void> callback)	Delete an alert
Future<ApiResponse<Void>>	deleteAlertingAlertAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete an alert
Future<Empty>	deleteAlertingAlertsAllAsync(DeleteAlertingAlertsAllRequest request, AsyncApiCallback<Empty> callback)	Delete all alerts for the user
Future<ApiResponse<Empty>>	deleteAlertingAlertsAllAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Empty>> callback)	Delete all alerts for the user
Future<Void>	deleteAlertingRuleAsync(DeleteAlertingRuleRequest request, AsyncApiCallback<Void> callback)	Delete a rule.
Future<ApiResponse<Void>>	deleteAlertingRuleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete a rule.
Future<CommonAlert>	getAlertingAlertAsync(GetAlertingAlertRequest request, AsyncApiCallback<CommonAlert> callback)	Get an alert
Future<ApiResponse<CommonAlert>>	getAlertingAlertAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<CommonAlert>> callback)	Get an alert
Future<CommonRule>	getAlertingRuleAsync(GetAlertingRuleRequest request, AsyncApiCallback<CommonRule> callback)	Get a rule.
Future<ApiResponse<CommonRule>>	getAlertingRuleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<CommonRule>> callback)	Get a rule.
Future<CommonAlert>	patchAlertingAlertAsync(PatchAlertingAlertRequest request, AsyncApiCallback<CommonAlert> callback)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
Future<ApiResponse<CommonAlert>>	patchAlertingAlertAsync(ApiRequest<AlertRequest> request, AsyncApiCallback<ApiResponse<CommonAlert>> callback)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
Future<Empty>	patchAlertingAlertsAllAsync(PatchAlertingAlertsAllRequest request, AsyncApiCallback<Empty> callback)	Updates all alerts
Future<ApiResponse<Empty>>	patchAlertingAlertsAllAsync(ApiRequest<CommonAllAlertUpdateRequest> request, AsyncApiCallback<ApiResponse<Empty>> callback)	Updates all alerts
Future<BulkResponse>	patchAlertingAlertsBulkAsync(PatchAlertingAlertsBulkRequest request, AsyncApiCallback<BulkResponse> callback)	Bulk alert updates
Future<ApiResponse<BulkResponse>>	patchAlertingAlertsBulkAsync(ApiRequest<CommonAlertBulkUpdateRequest> request, AsyncApiCallback<ApiResponse<BulkResponse>> callback)	Bulk alert updates
Future<BulkResponse>	patchAlertingRulesBulkAsync(PatchAlertingRulesBulkRequest request, AsyncApiCallback<BulkResponse> callback)	Bulk update of notification lists
Future<ApiResponse<BulkResponse>>	patchAlertingRulesBulkAsync(ApiRequest<CommonRuleBulkUpdateNotificationsRequest> request, AsyncApiCallback<ApiResponse<BulkResponse>> callback)	Bulk update of notification lists
Future<AlertListing>	postAlertingAlertsQueryAsync(PostAlertingAlertsQueryRequest request, AsyncApiCallback<AlertListing> callback)	Gets a paged list of alerts.
Future<ApiResponse<AlertListing>>	postAlertingAlertsQueryAsync(ApiRequest<GetAlertQuery> request, AsyncApiCallback<ApiResponse<AlertListing>> callback)	Gets a paged list of alerts.
Future<CommonRule>	postAlertingRulesAsync(PostAlertingRulesRequest request, AsyncApiCallback<CommonRule> callback)	Create a Rule.
Future<ApiResponse<CommonRule>>	postAlertingRulesAsync(ApiRequest<CommonRule> request, AsyncApiCallback<ApiResponse<CommonRule>> callback)	Create a Rule.
Future<BulkResponse>	postAlertingRulesBulkRemoveAsync(PostAlertingRulesBulkRemoveRequest request, AsyncApiCallback<BulkResponse> callback)	Bulk remove rules
Future<ApiResponse<BulkResponse>>	postAlertingRulesBulkRemoveAsync(ApiRequest<CommonRuleBulkDeleteRequest> request, AsyncApiCallback<ApiResponse<BulkResponse>> callback)	Bulk remove rules
Future<CommonRuleContainer>	postAlertingRulesQueryAsync(PostAlertingRulesQueryRequest request, AsyncApiCallback<CommonRuleContainer> callback)	Get a paged list of rules.
Future<ApiResponse<CommonRuleContainer>>	postAlertingRulesQueryAsync(ApiRequest<GetRulesQuery> request, AsyncApiCallback<ApiResponse<CommonRuleContainer>> callback)	Get a paged list of rules.
Future<AlertingUnreadStatus>	putAlertingAlertAsync(PutAlertingAlertRequest request, AsyncApiCallback<AlertingUnreadStatus> callback)	Update an alert read status
Future<ApiResponse<AlertingUnreadStatus>>	putAlertingAlertAsync(ApiRequest<AlertingUnreadStatus> request, AsyncApiCallback<ApiResponse<AlertingUnreadStatus>> callback)	Update an alert read status
Future<CommonRule>	putAlertingRuleAsync(PutAlertingRuleRequest request, AsyncApiCallback<CommonRule> callback)	Update a rule
Future<ApiResponse<CommonRule>>	putAlertingRuleAsync(ApiRequest<ModifiableRuleProperties> request, AsyncApiCallback<ApiResponse<CommonRule>> callback)	Update a rule

Methods inherited from class java.lang.Object

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

Constructor Details

AlertingApiAsync

public AlertingApiAsync()

AlertingApiAsync

public AlertingApiAsync(ApiClient apiClient)

Method Details

deleteAlertingAlertAsync

public Future<Void> deleteAlertingAlertAsync(DeleteAlertingAlertRequest request,
 AsyncApiCallback<Void> callback)

Delete an alert

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteAlertingAlertAsync

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

Delete an alert

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteAlertingAlertsAllAsync

public Future<Empty> deleteAlertingAlertsAllAsync(DeleteAlertingAlertsAllRequest request,
 AsyncApiCallback<Empty> callback)

Delete all alerts for the 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

deleteAlertingAlertsAllAsync

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

Delete all alerts for the 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

deleteAlertingRuleAsync

public Future<Void> deleteAlertingRuleAsync(DeleteAlertingRuleRequest request,
 AsyncApiCallback<Void> callback)

Delete a rule.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteAlertingRuleAsync

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

Delete a rule.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getAlertingAlertAsync

public Future<CommonAlert> getAlertingAlertAsync(GetAlertingAlertRequest request,
 AsyncApiCallback<CommonAlert> callback)

Get an alert

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getAlertingAlertAsync

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

Get an alert

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getAlertingRuleAsync

public Future<CommonRule> getAlertingRuleAsync(GetAlertingRuleRequest request,
 AsyncApiCallback<CommonRule> callback)

Get a rule.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getAlertingRuleAsync

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

Get a rule.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchAlertingAlertAsync

public Future<CommonAlert> patchAlertingAlertAsync(PatchAlertingAlertRequest request,
 AsyncApiCallback<CommonAlert> callback)

Allows an entity to mute/snooze an alert or update the unread status of the alert. Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchAlertingAlertAsync

public Future<ApiResponse<CommonAlert>> patchAlertingAlertAsync(ApiRequest<AlertRequest> request,
 AsyncApiCallback<ApiResponse<CommonAlert>> callback)

Allows an entity to mute/snooze an alert or update the unread status of the alert. Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchAlertingAlertsAllAsync

public Future<Empty> patchAlertingAlertsAllAsync(PatchAlertingAlertsAllRequest request,
 AsyncApiCallback<Empty> callback)

Updates all alerts

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchAlertingAlertsAllAsync

public Future<ApiResponse<Empty>> patchAlertingAlertsAllAsync(ApiRequest<CommonAllAlertUpdateRequest> request,
 AsyncApiCallback<ApiResponse<Empty>> callback)

Updates all alerts

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchAlertingAlertsBulkAsync

public Future<BulkResponse> patchAlertingAlertsBulkAsync(PatchAlertingAlertsBulkRequest request,
 AsyncApiCallback<BulkResponse> callback)

Bulk alert 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

patchAlertingAlertsBulkAsync

public Future<ApiResponse<BulkResponse>> patchAlertingAlertsBulkAsync(ApiRequest<CommonAlertBulkUpdateRequest> request,
 AsyncApiCallback<ApiResponse<BulkResponse>> callback)

Bulk alert 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

patchAlertingRulesBulkAsync

public Future<BulkResponse> patchAlertingRulesBulkAsync(PatchAlertingRulesBulkRequest request,
 AsyncApiCallback<BulkResponse> callback)

Bulk update of notification lists

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchAlertingRulesBulkAsync

public Future<ApiResponse<BulkResponse>> patchAlertingRulesBulkAsync(ApiRequest<CommonRuleBulkUpdateNotificationsRequest> request,
 AsyncApiCallback<ApiResponse<BulkResponse>> callback)

Bulk update of notification lists

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postAlertingAlertsQueryAsync

public Future<AlertListing> postAlertingAlertsQueryAsync(PostAlertingAlertsQueryRequest request,
 AsyncApiCallback<AlertListing> callback)

Gets a paged list of alerts. The max page size is 50

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postAlertingAlertsQueryAsync

public Future<ApiResponse<AlertListing>> postAlertingAlertsQueryAsync(ApiRequest<GetAlertQuery> request,
 AsyncApiCallback<ApiResponse<AlertListing>> callback)

Gets a paged list of alerts. The max page size is 50

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postAlertingRulesAsync

public Future<CommonRule> postAlertingRulesAsync(PostAlertingRulesRequest request,
 AsyncApiCallback<CommonRule> callback)

Create a Rule.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postAlertingRulesAsync

public Future<ApiResponse<CommonRule>> postAlertingRulesAsync(ApiRequest<CommonRule> request,
 AsyncApiCallback<ApiResponse<CommonRule>> callback)

Create a Rule.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postAlertingRulesBulkRemoveAsync

public Future<BulkResponse> postAlertingRulesBulkRemoveAsync(PostAlertingRulesBulkRemoveRequest request,
 AsyncApiCallback<BulkResponse> callback)

Bulk remove rules

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postAlertingRulesBulkRemoveAsync

public Future<ApiResponse<BulkResponse>> postAlertingRulesBulkRemoveAsync(ApiRequest<CommonRuleBulkDeleteRequest> request,
 AsyncApiCallback<ApiResponse<BulkResponse>> callback)

Bulk remove rules

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postAlertingRulesQueryAsync

public Future<CommonRuleContainer> postAlertingRulesQueryAsync(PostAlertingRulesQueryRequest request,
 AsyncApiCallback<CommonRuleContainer> callback)

Get a paged list of rules. The max size of the page is 50 items.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postAlertingRulesQueryAsync

public Future<ApiResponse<CommonRuleContainer>> postAlertingRulesQueryAsync(ApiRequest<GetRulesQuery> request,
 AsyncApiCallback<ApiResponse<CommonRuleContainer>> callback)

Get a paged list of rules. The max size of the page is 50 items.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putAlertingAlertAsync

public Future<AlertingUnreadStatus> putAlertingAlertAsync(PutAlertingAlertRequest request,
 AsyncApiCallback<AlertingUnreadStatus> callback)

Update an alert read 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

putAlertingAlertAsync

public Future<ApiResponse<AlertingUnreadStatus>> putAlertingAlertAsync(ApiRequest<AlertingUnreadStatus> request,
 AsyncApiCallback<ApiResponse<AlertingUnreadStatus>> callback)

Update an alert read 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

putAlertingRuleAsync

public Future<CommonRule> putAlertingRuleAsync(PutAlertingRuleRequest request,
 AsyncApiCallback<CommonRule> callback)

Update a rule

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putAlertingRuleAsync

public Future<ApiResponse<CommonRule>> putAlertingRuleAsync(ApiRequest<ModifiableRuleProperties> request,
 AsyncApiCallback<ApiResponse<CommonRule>> callback)

Update a rule

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed