docs/AlertingApi.md in purecloudplatformclientv2-34.0.0 vs docs/AlertingApi.md in purecloudplatformclientv2-35.0.0

- old
+ new

@@ -23,17 +23,23 @@ <a name="delete_alerting_interactionstats_alert"></a> ## - delete_alerting_interactionstats_alert(alert_id) + + Delete an interaction stats alert Wraps DELETE /api/v2/alerting/interactionstats/alerts/{alertId} +Requires ANY permissions: +* alerting:alert:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -81,17 +87,23 @@ <a name="delete_alerting_interactionstats_rule"></a> ## - delete_alerting_interactionstats_rule(rule_id) + + Delete an interaction stats rule. Wraps DELETE /api/v2/alerting/interactionstats/rules/{ruleId} +Requires ANY permissions: +* alerting:rule:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -139,17 +151,23 @@ <a name="get_alerting_alerts_active"></a> ## -[**ActiveAlertCount**](ActiveAlertCount.html) get_alerting_alerts_active + + Gets active alert count for a user. Wraps GET /api/v2/alerting/alerts/active +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -192,17 +210,23 @@ <a name="get_alerting_interactionstats_alert"></a> ## -[**InteractionStatsAlert**](InteractionStatsAlert.html) get_alerting_interactionstats_alert(alert_id, opts) + + Get an interaction stats alert Wraps GET /api/v2/alerting/interactionstats/alerts/{alertId} +Requires ANY permissions: +* alerting:alert:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -255,17 +279,23 @@ <a name="get_alerting_interactionstats_alerts"></a> ## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_alerting_interactionstats_alerts(opts) + + Get interaction stats alert list. Wraps GET /api/v2/alerting/interactionstats/alerts +Requires ANY permissions: +* alerting:alert:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -315,17 +345,23 @@ <a name="get_alerting_interactionstats_alerts_unread"></a> ## -[**UnreadMetric**](UnreadMetric.html) get_alerting_interactionstats_alerts_unread + + Gets user unread count of interaction stats alerts. Wraps GET /api/v2/alerting/interactionstats/alerts/unread +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -368,17 +404,23 @@ <a name="get_alerting_interactionstats_rule"></a> ## -[**InteractionStatsRule**](InteractionStatsRule.html) get_alerting_interactionstats_rule(rule_id, opts) + + Get an interaction stats rule. Wraps GET /api/v2/alerting/interactionstats/rules/{ruleId} +Requires ANY permissions: +* alerting:rule:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -431,17 +473,23 @@ <a name="get_alerting_interactionstats_rules"></a> ## -[**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html) get_alerting_interactionstats_rules(opts) + + Get an interaction stats rule list. Wraps GET /api/v2/alerting/interactionstats/rules +Requires ANY permissions: +* alerting:rule:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -491,17 +539,23 @@ <a name="post_alerting_interactionstats_rules"></a> ## -[**InteractionStatsRule**](InteractionStatsRule.html) post_alerting_interactionstats_rules(body, opts) + + Create an interaction stats rule. Wraps POST /api/v2/alerting/interactionstats/rules +Requires ANY permissions: +* alerting:rule:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -554,17 +608,23 @@ <a name="put_alerting_interactionstats_alert"></a> ## -[**UnreadStatus**](UnreadStatus.html) put_alerting_interactionstats_alert(alert_id, body, opts) + + Update an interaction stats alert read status Wraps PUT /api/v2/alerting/interactionstats/alerts/{alertId} +Requires ANY permissions: +* alerting:alert:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -620,14 +680,20 @@ <a name="put_alerting_interactionstats_rule"></a> ## -[**InteractionStatsRule**](InteractionStatsRule.html) put_alerting_interactionstats_rule(rule_id, body, opts) + + Update an interaction stats rule Wraps PUT /api/v2/alerting/interactionstats/rules/{ruleId} + +Requires ANY permissions: + +* alerting:rule:edit ### Example ~~~ruby # load the gem