Package com.mypurecloud.sdk.v2.api

Class AlertingApi

java.lang.Object

com.mypurecloud.sdk.v2.api.AlertingApi

public class AlertingApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AlertingApi()
AlertingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteAlertingAlert(DeleteAlertingAlertRequest request)	Delete an alert
ApiResponse<Void>	deleteAlertingAlert(ApiRequest<Void> request)	Delete an alert
void	deleteAlertingAlert(String alertId)	Delete an alert
Empty	deleteAlertingAlertsAll()	Delete all alerts for the user
Empty	deleteAlertingAlertsAll(DeleteAlertingAlertsAllRequest request)	Delete all alerts for the user
ApiResponse<Empty>	deleteAlertingAlertsAll(ApiRequest<Void> request)	Delete all alerts for the user
ApiResponse<Empty>	deleteAlertingAlertsAllWithHttpInfo()	Delete all alerts for the user
ApiResponse<Void>	deleteAlertingAlertWithHttpInfo(String alertId)	Delete an alert
void	deleteAlertingRule(DeleteAlertingRuleRequest request)	Delete a rule.
ApiResponse<Void>	deleteAlertingRule(ApiRequest<Void> request)	Delete a rule.
void	deleteAlertingRule(String ruleId)	Delete a rule.
ApiResponse<Void>	deleteAlertingRuleWithHttpInfo(String ruleId)	Delete a rule.
CommonAlert	getAlertingAlert(GetAlertingAlertRequest request)	Get an alert
ApiResponse<CommonAlert>	getAlertingAlert(ApiRequest<Void> request)	Get an alert
CommonAlert	getAlertingAlert(String alertId)	Get an alert
ApiResponse<CommonAlert>	getAlertingAlertWithHttpInfo(String alertId)	Get an alert
CommonRule	getAlertingRule(GetAlertingRuleRequest request)	Get a rule.
ApiResponse<CommonRule>	getAlertingRule(ApiRequest<Void> request)	Get a rule.
CommonRule	getAlertingRule(String ruleId)	Get a rule.
ApiResponse<CommonRule>	getAlertingRuleWithHttpInfo(String ruleId)	Get a rule.
CommonAlert	patchAlertingAlert(PatchAlertingAlertRequest request)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
ApiResponse<CommonAlert>	patchAlertingAlert(ApiRequest<AlertRequest> request)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
CommonAlert	patchAlertingAlert(String alertId, AlertRequest body)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
Empty	patchAlertingAlertsAll(PatchAlertingAlertsAllRequest request)	Updates all alerts
ApiResponse<Empty>	patchAlertingAlertsAll(ApiRequest<CommonAllAlertUpdateRequest> request)	Updates all alerts
Empty	patchAlertingAlertsAll(CommonAllAlertUpdateRequest body)	Updates all alerts
ApiResponse<Empty>	patchAlertingAlertsAllWithHttpInfo(CommonAllAlertUpdateRequest body)	Updates all alerts
BulkResponse	patchAlertingAlertsBulk(PatchAlertingAlertsBulkRequest request)	Bulk alert updates
ApiResponse<BulkResponse>	patchAlertingAlertsBulk(ApiRequest<CommonAlertBulkUpdateRequest> request)	Bulk alert updates
BulkResponse	patchAlertingAlertsBulk(CommonAlertBulkUpdateRequest body)	Bulk alert updates
ApiResponse<BulkResponse>	patchAlertingAlertsBulkWithHttpInfo(CommonAlertBulkUpdateRequest body)	Bulk alert updates
ApiResponse<CommonAlert>	patchAlertingAlertWithHttpInfo(String alertId, AlertRequest body)	Allows an entity to mute/snooze an alert or update the unread status of the alert.
BulkResponse	patchAlertingRulesBulk(PatchAlertingRulesBulkRequest request)	Bulk update of notification lists
ApiResponse<BulkResponse>	patchAlertingRulesBulk(ApiRequest<CommonRuleBulkUpdateNotificationsRequest> request)	Bulk update of notification lists
BulkResponse	patchAlertingRulesBulk(CommonRuleBulkUpdateNotificationsRequest body)	Bulk update of notification lists
ApiResponse<BulkResponse>	patchAlertingRulesBulkWithHttpInfo(CommonRuleBulkUpdateNotificationsRequest body)	Bulk update of notification lists
AlertListing	postAlertingAlertsQuery(PostAlertingAlertsQueryRequest request)	Gets a paged list of alerts.
ApiResponse<AlertListing>	postAlertingAlertsQuery(ApiRequest<GetAlertQuery> request)	Gets a paged list of alerts.
AlertListing	postAlertingAlertsQuery(GetAlertQuery body)	Gets a paged list of alerts.
ApiResponse<AlertListing>	postAlertingAlertsQueryWithHttpInfo(GetAlertQuery body)	Gets a paged list of alerts.
CommonRule	postAlertingRules(PostAlertingRulesRequest request)	Create a Rule.
ApiResponse<CommonRule>	postAlertingRules(ApiRequest<CommonRule> request)	Create a Rule.
CommonRule	postAlertingRules(CommonRule body)	Create a Rule.
BulkResponse	postAlertingRulesBulkRemove(PostAlertingRulesBulkRemoveRequest request)	Bulk remove rules
ApiResponse<BulkResponse>	postAlertingRulesBulkRemove(ApiRequest<CommonRuleBulkDeleteRequest> request)	Bulk remove rules
BulkResponse	postAlertingRulesBulkRemove(CommonRuleBulkDeleteRequest body)	Bulk remove rules
ApiResponse<BulkResponse>	postAlertingRulesBulkRemoveWithHttpInfo(CommonRuleBulkDeleteRequest body)	Bulk remove rules
CommonRuleContainer	postAlertingRulesQuery(PostAlertingRulesQueryRequest request)	Get a paged list of rules.
ApiResponse<CommonRuleContainer>	postAlertingRulesQuery(ApiRequest<GetRulesQuery> request)	Get a paged list of rules.
CommonRuleContainer	postAlertingRulesQuery(GetRulesQuery body)	Get a paged list of rules.
ApiResponse<CommonRuleContainer>	postAlertingRulesQueryWithHttpInfo(GetRulesQuery body)	Get a paged list of rules.
ApiResponse<CommonRule>	postAlertingRulesWithHttpInfo(CommonRule body)	Create a Rule.
AlertingUnreadStatus	putAlertingAlert(PutAlertingAlertRequest request)	Update an alert read status
ApiResponse<AlertingUnreadStatus>	putAlertingAlert(ApiRequest<AlertingUnreadStatus> request)	Update an alert read status
AlertingUnreadStatus	putAlertingAlert(String alertId, AlertingUnreadStatus body)	Update an alert read status
ApiResponse<AlertingUnreadStatus>	putAlertingAlertWithHttpInfo(String alertId, AlertingUnreadStatus body)	Update an alert read status
CommonRule	putAlertingRule(PutAlertingRuleRequest request)	Update a rule
ApiResponse<CommonRule>	putAlertingRule(ApiRequest<ModifiableRuleProperties> request)	Update a rule
CommonRule	putAlertingRule(String ruleId, ModifiableRuleProperties body)	Update a rule
ApiResponse<CommonRule>	putAlertingRuleWithHttpInfo(String ruleId, ModifiableRuleProperties body)	Update a rule

Methods inherited from class java.lang.Object

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

Constructor Details

AlertingApi

public AlertingApi()

AlertingApi

public AlertingApi(ApiClient apiClient)

Method Details

deleteAlertingAlert

public void deleteAlertingAlert(String alertId)
                         throws IOException,
ApiException

Delete an alert

Parameters:

alertId - Alert ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAlertingAlertWithHttpInfo

public ApiResponse<Void> deleteAlertingAlertWithHttpInfo(String alertId)
                                                  throws IOException

Delete an alert

Parameters:

alertId - Alert ID (required)

Throws:

IOException - if the request fails to be processed

deleteAlertingAlert

public void deleteAlertingAlert(DeleteAlertingAlertRequest request)
                         throws IOException,
ApiException

Delete an alert

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAlertingAlert

public ApiResponse<Void> deleteAlertingAlert(ApiRequest<Void> request)
                                      throws IOException

Delete an alert

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteAlertingAlertsAll

public Empty deleteAlertingAlertsAll()
                              throws IOException,
ApiException

Delete all alerts for the user

Returns:

Empty

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAlertingAlertsAllWithHttpInfo

public ApiResponse<Empty> deleteAlertingAlertsAllWithHttpInfo()
                                                       throws IOException

Delete all alerts for the user

Returns:

Empty

Throws:

IOException - if the request fails to be processed

deleteAlertingAlertsAll

public Empty deleteAlertingAlertsAll(DeleteAlertingAlertsAllRequest request)
                              throws IOException,
ApiException

Delete all alerts for the user

Parameters:

request - The request object

Returns:

Empty

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAlertingAlertsAll

public ApiResponse<Empty> deleteAlertingAlertsAll(ApiRequest<Void> request)
                                           throws IOException

Delete all alerts for the user

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteAlertingRule

public void deleteAlertingRule(String ruleId)
                        throws IOException,
ApiException

Delete a rule.

Parameters:

ruleId - Rule Id (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAlertingRuleWithHttpInfo

public ApiResponse<Void> deleteAlertingRuleWithHttpInfo(String ruleId)
                                                 throws IOException

Delete a rule.

Parameters:

ruleId - Rule Id (required)

Throws:

IOException - if the request fails to be processed

deleteAlertingRule

public void deleteAlertingRule(DeleteAlertingRuleRequest request)
                        throws IOException,
ApiException

Delete a rule.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAlertingRule

public ApiResponse<Void> deleteAlertingRule(ApiRequest<Void> request)
                                     throws IOException

Delete a rule.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAlertingAlert

public CommonAlert getAlertingAlert(String alertId)
                             throws IOException,
ApiException

Get an alert

Parameters:

alertId - Alert ID (required)

Returns:

CommonAlert

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAlertingAlertWithHttpInfo

public ApiResponse<CommonAlert> getAlertingAlertWithHttpInfo(String alertId)
                                                      throws IOException

Get an alert

Parameters:

alertId - Alert ID (required)

Returns:

CommonAlert

Throws:

IOException - if the request fails to be processed

getAlertingAlert

public CommonAlert getAlertingAlert(GetAlertingAlertRequest request)
                             throws IOException,
ApiException

Get an alert

Parameters:

request - The request object

Returns:

CommonAlert

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAlertingAlert

public ApiResponse<CommonAlert> getAlertingAlert(ApiRequest<Void> request)
                                          throws IOException

Get an alert

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAlertingRule

public CommonRule getAlertingRule(String ruleId)
                           throws IOException,
ApiException

Get a rule.

Parameters:

ruleId - Rule Id (required)

Returns:

CommonRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAlertingRuleWithHttpInfo

public ApiResponse<CommonRule> getAlertingRuleWithHttpInfo(String ruleId)
                                                    throws IOException

Get a rule.

Parameters:

ruleId - Rule Id (required)

Returns:

CommonRule

Throws:

IOException - if the request fails to be processed

getAlertingRule

public CommonRule getAlertingRule(GetAlertingRuleRequest request)
                           throws IOException,
ApiException

Get a rule.

Parameters:

request - The request object

Returns:

CommonRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAlertingRule

public ApiResponse<CommonRule> getAlertingRule(ApiRequest<Void> request)
                                        throws IOException

Get a rule.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchAlertingAlert

public CommonAlert patchAlertingAlert(String alertId,
 AlertRequest body)
                               throws IOException,
ApiException

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:

alertId - Alert ID (required)

body - (optional)

Returns:

CommonAlert

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchAlertingAlertWithHttpInfo

public ApiResponse<CommonAlert> patchAlertingAlertWithHttpInfo(String alertId,
 AlertRequest body)
                                                        throws IOException

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:

alertId - Alert ID (required)

body - (optional)

Returns:

CommonAlert

Throws:

IOException - if the request fails to be processed

patchAlertingAlert

public CommonAlert patchAlertingAlert(PatchAlertingAlertRequest request)
                               throws IOException,
ApiException

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

Returns:

CommonAlert

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchAlertingAlert

public ApiResponse<CommonAlert> patchAlertingAlert(ApiRequest<AlertRequest> request)
                                            throws IOException

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

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchAlertingAlertsAll

public Empty patchAlertingAlertsAll(CommonAllAlertUpdateRequest body)
                             throws IOException,
ApiException

Updates all alerts

Parameters:

body - (optional)

Returns:

Empty

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchAlertingAlertsAllWithHttpInfo

public ApiResponse<Empty> patchAlertingAlertsAllWithHttpInfo(CommonAllAlertUpdateRequest body)
                                                      throws IOException

Updates all alerts

Parameters:

body - (optional)

Returns:

Empty

Throws:

IOException - if the request fails to be processed

patchAlertingAlertsAll

public Empty patchAlertingAlertsAll(PatchAlertingAlertsAllRequest request)
                             throws IOException,
ApiException

Updates all alerts

Parameters:

request - The request object

Returns:

Empty

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchAlertingAlertsAll

public ApiResponse<Empty> patchAlertingAlertsAll(ApiRequest<CommonAllAlertUpdateRequest> request)
                                          throws IOException

Updates all alerts

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchAlertingAlertsBulk

public BulkResponse patchAlertingAlertsBulk(CommonAlertBulkUpdateRequest body)
                                     throws IOException,
ApiException

Bulk alert updates

Parameters:

body - (required)

Returns:

BulkResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchAlertingAlertsBulkWithHttpInfo

public ApiResponse<BulkResponse> patchAlertingAlertsBulkWithHttpInfo(CommonAlertBulkUpdateRequest body)
                                                              throws IOException

Bulk alert updates

Parameters:

body - (required)

Returns:

BulkResponse

Throws:

IOException - if the request fails to be processed

patchAlertingAlertsBulk

public BulkResponse patchAlertingAlertsBulk(PatchAlertingAlertsBulkRequest request)
                                     throws IOException,
ApiException

Bulk alert updates

Parameters:

request - The request object

Returns:

BulkResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchAlertingAlertsBulk

public ApiResponse<BulkResponse> patchAlertingAlertsBulk(ApiRequest<CommonAlertBulkUpdateRequest> request)
                                                  throws IOException

Bulk alert updates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchAlertingRulesBulk

public BulkResponse patchAlertingRulesBulk(CommonRuleBulkUpdateNotificationsRequest body)
                                    throws IOException,
ApiException

Bulk update of notification lists

Parameters:

body - (required)

Returns:

BulkResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchAlertingRulesBulkWithHttpInfo

public ApiResponse<BulkResponse> patchAlertingRulesBulkWithHttpInfo(CommonRuleBulkUpdateNotificationsRequest body)
                                                             throws IOException

Bulk update of notification lists

Parameters:

body - (required)

Returns:

BulkResponse

Throws:

IOException - if the request fails to be processed

patchAlertingRulesBulk

public BulkResponse patchAlertingRulesBulk(PatchAlertingRulesBulkRequest request)
                                    throws IOException,
ApiException

Bulk update of notification lists

Parameters:

request - The request object

Returns:

BulkResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchAlertingRulesBulk

public ApiResponse<BulkResponse> patchAlertingRulesBulk(ApiRequest<CommonRuleBulkUpdateNotificationsRequest> request)
                                                 throws IOException

Bulk update of notification lists

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAlertingAlertsQuery

public AlertListing postAlertingAlertsQuery(GetAlertQuery body)
                                     throws IOException,
ApiException

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

Parameters:

body - (optional)

Returns:

AlertListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAlertingAlertsQueryWithHttpInfo

public ApiResponse<AlertListing> postAlertingAlertsQueryWithHttpInfo(GetAlertQuery body)
                                                              throws IOException

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

Parameters:

body - (optional)

Returns:

AlertListing

Throws:

IOException - if the request fails to be processed

postAlertingAlertsQuery

public AlertListing postAlertingAlertsQuery(PostAlertingAlertsQueryRequest request)
                                     throws IOException,
ApiException

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

Parameters:

request - The request object

Returns:

AlertListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAlertingAlertsQuery

public ApiResponse<AlertListing> postAlertingAlertsQuery(ApiRequest<GetAlertQuery> request)
                                                  throws IOException

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

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAlertingRules

public CommonRule postAlertingRules(CommonRule body)
                             throws IOException,
ApiException

Create a Rule.

Parameters:

body - rule to be created (required)

Returns:

CommonRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAlertingRulesWithHttpInfo

public ApiResponse<CommonRule> postAlertingRulesWithHttpInfo(CommonRule body)
                                                      throws IOException

Create a Rule.

Parameters:

body - rule to be created (required)

Returns:

CommonRule

Throws:

IOException - if the request fails to be processed

postAlertingRules

public CommonRule postAlertingRules(PostAlertingRulesRequest request)
                             throws IOException,
ApiException

Create a Rule.

Parameters:

request - The request object

Returns:

CommonRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAlertingRules

public ApiResponse<CommonRule> postAlertingRules(ApiRequest<CommonRule> request)
                                          throws IOException

Create a Rule.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAlertingRulesBulkRemove

public BulkResponse postAlertingRulesBulkRemove(CommonRuleBulkDeleteRequest body)
                                         throws IOException,
ApiException

Bulk remove rules

Parameters:

body - (required)

Returns:

BulkResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAlertingRulesBulkRemoveWithHttpInfo

public ApiResponse<BulkResponse> postAlertingRulesBulkRemoveWithHttpInfo(CommonRuleBulkDeleteRequest body)
                                                                  throws IOException

Bulk remove rules

Parameters:

body - (required)

Returns:

BulkResponse

Throws:

IOException - if the request fails to be processed

postAlertingRulesBulkRemove

public BulkResponse postAlertingRulesBulkRemove(PostAlertingRulesBulkRemoveRequest request)
                                         throws IOException,
ApiException

Bulk remove rules

Parameters:

request - The request object

Returns:

BulkResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAlertingRulesBulkRemove

public ApiResponse<BulkResponse> postAlertingRulesBulkRemove(ApiRequest<CommonRuleBulkDeleteRequest> request)
                                                      throws IOException

Bulk remove rules

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAlertingRulesQuery

public CommonRuleContainer postAlertingRulesQuery(GetRulesQuery body)
                                           throws IOException,
ApiException

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

Parameters:

body - (optional)

Returns:

CommonRuleContainer

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAlertingRulesQueryWithHttpInfo

public ApiResponse<CommonRuleContainer> postAlertingRulesQueryWithHttpInfo(GetRulesQuery body)
                                                                    throws IOException

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

Parameters:

body - (optional)

Returns:

CommonRuleContainer

Throws:

IOException - if the request fails to be processed

postAlertingRulesQuery

public CommonRuleContainer postAlertingRulesQuery(PostAlertingRulesQueryRequest request)
                                           throws IOException,
ApiException

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

Parameters:

request - The request object

Returns:

CommonRuleContainer

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAlertingRulesQuery

public ApiResponse<CommonRuleContainer> postAlertingRulesQuery(ApiRequest<GetRulesQuery> request)
                                                        throws IOException

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

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putAlertingAlert

public AlertingUnreadStatus putAlertingAlert(String alertId,
 AlertingUnreadStatus body)
                                      throws IOException,
ApiException

Update an alert read status

Parameters:

alertId - Alert ID (required)

body - (optional)

Returns:

AlertingUnreadStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putAlertingAlertWithHttpInfo

public ApiResponse<AlertingUnreadStatus> putAlertingAlertWithHttpInfo(String alertId,
 AlertingUnreadStatus body)
                                                               throws IOException

Update an alert read status

Parameters:

alertId - Alert ID (required)

body - (optional)

Returns:

AlertingUnreadStatus

Throws:

IOException - if the request fails to be processed

putAlertingAlert

public AlertingUnreadStatus putAlertingAlert(PutAlertingAlertRequest request)
                                      throws IOException,
ApiException

Update an alert read status

Parameters:

request - The request object

Returns:

AlertingUnreadStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putAlertingAlert

public ApiResponse<AlertingUnreadStatus> putAlertingAlert(ApiRequest<AlertingUnreadStatus> request)
                                                   throws IOException

Update an alert read status

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putAlertingRule

public CommonRule putAlertingRule(String ruleId,
 ModifiableRuleProperties body)
                           throws IOException,
ApiException

Update a rule

Parameters:

ruleId - Rule Id (required)

body - rule to be updated (required)

Returns:

CommonRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putAlertingRuleWithHttpInfo

public ApiResponse<CommonRule> putAlertingRuleWithHttpInfo(String ruleId,
 ModifiableRuleProperties body)
                                                    throws IOException

Update a rule

Parameters:

ruleId - Rule Id (required)

body - rule to be updated (required)

Returns:

CommonRule

Throws:

IOException - if the request fails to be processed

putAlertingRule

public CommonRule putAlertingRule(PutAlertingRuleRequest request)
                           throws IOException,
ApiException

Update a rule

Parameters:

request - The request object

Returns:

CommonRule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putAlertingRule

public ApiResponse<CommonRule> putAlertingRule(ApiRequest<ModifiableRuleProperties> request)
                                        throws IOException

Update a rule

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed