doc_out/AlertingApi.html.md in purecloud-0.67.1 vs doc_out/AlertingApi.html.md in purecloud-0.68.1
- old
+ new
@@ -4,56 +4,59 @@
## PureCloud::AlertingApi
All URIs are relative to *https://api.mypurecloud.com*
-Method | HTTP request | Description
+Method | Description
------------- | ------------- | -------------
-|[**delete_heartbeat_alerts_alert_id**](AlertingApi.html#delete_heartbeat_alerts_alert_id) | **DELETE** /api/v2/alerting/heartbeat/alerts/{alertId} | Delete a heart beat alert|
-|[**delete_heartbeat_rules_rule_id**](AlertingApi.html#delete_heartbeat_rules_rule_id) | **DELETE** /api/v2/alerting/heartbeat/rules/{ruleId} | Delete a heart beat rule.|
-|[**delete_interactionstats_alerts_alert_id**](AlertingApi.html#delete_interactionstats_alerts_alert_id) | **DELETE** /api/v2/alerting/interactionstats/alerts/{alertId} | Delete an interaction stats alert|
-|[**delete_interactionstats_rules_rule_id**](AlertingApi.html#delete_interactionstats_rules_rule_id) | **DELETE** /api/v2/alerting/interactionstats/rules/{ruleId} | Delete an interaction stats rule.|
-|[**delete_routingstatus_alerts_alert_id**](AlertingApi.html#delete_routingstatus_alerts_alert_id) | **DELETE** /api/v2/alerting/routingstatus/alerts/{alertId} | Delete a routing status alert|
-|[**delete_routingstatus_rules_rule_id**](AlertingApi.html#delete_routingstatus_rules_rule_id) | **DELETE** /api/v2/alerting/routingstatus/rules/{ruleId} | Delete a routing status rule.|
-|[**delete_userpresence_alerts_alert_id**](AlertingApi.html#delete_userpresence_alerts_alert_id) | **DELETE** /api/v2/alerting/userpresence/alerts/{alertId} | Delete a user presence alert|
-|[**delete_userpresence_rules_rule_id**](AlertingApi.html#delete_userpresence_rules_rule_id) | **DELETE** /api/v2/alerting/userpresence/rules/{ruleId} | Delete a user presence rule.|
-|[**get_heartbeat_alerts**](AlertingApi.html#get_heartbeat_alerts) | **GET** /api/v2/alerting/heartbeat/alerts | Get heart beat alert list.|
-|[**get_heartbeat_alerts_alert_id**](AlertingApi.html#get_heartbeat_alerts_alert_id) | **GET** /api/v2/alerting/heartbeat/alerts/{alertId} | Get a heart beat alert|
-|[**get_heartbeat_rules**](AlertingApi.html#get_heartbeat_rules) | **GET** /api/v2/alerting/heartbeat/rules | Get a heart beat rule list.|
-|[**get_heartbeat_rules_rule_id**](AlertingApi.html#get_heartbeat_rules_rule_id) | **GET** /api/v2/alerting/heartbeat/rules/{ruleId} | Get a heart beat rule.|
-|[**get_interactionstats_alerts**](AlertingApi.html#get_interactionstats_alerts) | **GET** /api/v2/alerting/interactionstats/alerts | Get interaction stats alert list.|
-|[**get_interactionstats_alerts_alert_id**](AlertingApi.html#get_interactionstats_alerts_alert_id) | **GET** /api/v2/alerting/interactionstats/alerts/{alertId} | Get an interaction stats alert|
-|[**get_interactionstats_alerts_unread**](AlertingApi.html#get_interactionstats_alerts_unread) | **GET** /api/v2/alerting/interactionstats/alerts/unread | Gets user unread count of interaction stats alerts.|
-|[**get_interactionstats_rules**](AlertingApi.html#get_interactionstats_rules) | **GET** /api/v2/alerting/interactionstats/rules | Get an interaction stats rule list.|
-|[**get_interactionstats_rules_rule_id**](AlertingApi.html#get_interactionstats_rules_rule_id) | **GET** /api/v2/alerting/interactionstats/rules/{ruleId} | Get an interaction stats rule.|
-|[**get_routingstatus_alerts**](AlertingApi.html#get_routingstatus_alerts) | **GET** /api/v2/alerting/routingstatus/alerts | Get routing status alert list.|
-|[**get_routingstatus_alerts_alert_id**](AlertingApi.html#get_routingstatus_alerts_alert_id) | **GET** /api/v2/alerting/routingstatus/alerts/{alertId} | Get a routing status alert|
-|[**get_routingstatus_rules**](AlertingApi.html#get_routingstatus_rules) | **GET** /api/v2/alerting/routingstatus/rules | Get a routing status rule list.|
-|[**get_routingstatus_rules_rule_id**](AlertingApi.html#get_routingstatus_rules_rule_id) | **GET** /api/v2/alerting/routingstatus/rules/{ruleId} | Get a routing status rule.|
-|[**get_userpresence_alerts**](AlertingApi.html#get_userpresence_alerts) | **GET** /api/v2/alerting/userpresence/alerts | Get user presence alert list.|
-|[**get_userpresence_alerts_alert_id**](AlertingApi.html#get_userpresence_alerts_alert_id) | **GET** /api/v2/alerting/userpresence/alerts/{alertId} | Get a user presence alert|
-|[**get_userpresence_rules**](AlertingApi.html#get_userpresence_rules) | **GET** /api/v2/alerting/userpresence/rules | Get a user presence rule list.|
-|[**get_userpresence_rules_rule_id**](AlertingApi.html#get_userpresence_rules_rule_id) | **GET** /api/v2/alerting/userpresence/rules/{ruleId} | Get a user presence rule.|
-|[**post_heartbeat_rules**](AlertingApi.html#post_heartbeat_rules) | **POST** /api/v2/alerting/heartbeat/rules | Create a heart beat rule.|
-|[**post_interactionstats_rules**](AlertingApi.html#post_interactionstats_rules) | **POST** /api/v2/alerting/interactionstats/rules | Create an interaction stats rule.|
-|[**post_routingstatus_rules**](AlertingApi.html#post_routingstatus_rules) | **POST** /api/v2/alerting/routingstatus/rules | Create a routing status rule.|
-|[**post_userpresence_rules**](AlertingApi.html#post_userpresence_rules) | **POST** /api/v2/alerting/userpresence/rules | Create a user presence rule.|
-|[**put_heartbeat_rules_rule_id**](AlertingApi.html#put_heartbeat_rules_rule_id) | **PUT** /api/v2/alerting/heartbeat/rules/{ruleId} | Update a heart beat rule|
-|[**put_interactionstats_alerts_alert_id**](AlertingApi.html#put_interactionstats_alerts_alert_id) | **PUT** /api/v2/alerting/interactionstats/alerts/{alertId} | Update an interaction stats alert read status|
-|[**put_interactionstats_rules_rule_id**](AlertingApi.html#put_interactionstats_rules_rule_id) | **PUT** /api/v2/alerting/interactionstats/rules/{ruleId} | Update an interaction stats rule|
-|[**put_routingstatus_rules_rule_id**](AlertingApi.html#put_routingstatus_rules_rule_id) | **PUT** /api/v2/alerting/routingstatus/rules/{ruleId} | Update a routing status rule|
-|[**put_userpresence_rules_rule_id**](AlertingApi.html#put_userpresence_rules_rule_id) | **PUT** /api/v2/alerting/userpresence/rules/{ruleId} | Update a user presence rule|
+[**delete_heartbeat_alerts_alert_id**](AlertingApi.html#delete_heartbeat_alerts_alert_id) | Delete a heart beat alert
+[**delete_heartbeat_rules_rule_id**](AlertingApi.html#delete_heartbeat_rules_rule_id) | Delete a heart beat rule.
+[**delete_interactionstats_alerts_alert_id**](AlertingApi.html#delete_interactionstats_alerts_alert_id) | Delete an interaction stats alert
+[**delete_interactionstats_rules_rule_id**](AlertingApi.html#delete_interactionstats_rules_rule_id) | Delete an interaction stats rule.
+[**delete_routingstatus_alerts_alert_id**](AlertingApi.html#delete_routingstatus_alerts_alert_id) | Delete a routing status alert
+[**delete_routingstatus_rules_rule_id**](AlertingApi.html#delete_routingstatus_rules_rule_id) | Delete a routing status rule.
+[**delete_userpresence_alerts_alert_id**](AlertingApi.html#delete_userpresence_alerts_alert_id) | Delete a user presence alert
+[**delete_userpresence_rules_rule_id**](AlertingApi.html#delete_userpresence_rules_rule_id) | Delete a user presence rule.
+[**get_heartbeat_alerts**](AlertingApi.html#get_heartbeat_alerts) | Get heart beat alert list.
+[**get_heartbeat_alerts_alert_id**](AlertingApi.html#get_heartbeat_alerts_alert_id) | Get a heart beat alert
+[**get_heartbeat_rules**](AlertingApi.html#get_heartbeat_rules) | Get a heart beat rule list.
+[**get_heartbeat_rules_rule_id**](AlertingApi.html#get_heartbeat_rules_rule_id) | Get a heart beat rule.
+[**get_interactionstats_alerts**](AlertingApi.html#get_interactionstats_alerts) | Get interaction stats alert list.
+[**get_interactionstats_alerts_alert_id**](AlertingApi.html#get_interactionstats_alerts_alert_id) | Get an interaction stats alert
+[**get_interactionstats_alerts_unread**](AlertingApi.html#get_interactionstats_alerts_unread) | Gets user unread count of interaction stats alerts.
+[**get_interactionstats_rules**](AlertingApi.html#get_interactionstats_rules) | Get an interaction stats rule list.
+[**get_interactionstats_rules_rule_id**](AlertingApi.html#get_interactionstats_rules_rule_id) | Get an interaction stats rule.
+[**get_routingstatus_alerts**](AlertingApi.html#get_routingstatus_alerts) | Get routing status alert list.
+[**get_routingstatus_alerts_alert_id**](AlertingApi.html#get_routingstatus_alerts_alert_id) | Get a routing status alert
+[**get_routingstatus_rules**](AlertingApi.html#get_routingstatus_rules) | Get a routing status rule list.
+[**get_routingstatus_rules_rule_id**](AlertingApi.html#get_routingstatus_rules_rule_id) | Get a routing status rule.
+[**get_userpresence_alerts**](AlertingApi.html#get_userpresence_alerts) | Get user presence alert list.
+[**get_userpresence_alerts_alert_id**](AlertingApi.html#get_userpresence_alerts_alert_id) | Get a user presence alert
+[**get_userpresence_rules**](AlertingApi.html#get_userpresence_rules) | Get a user presence rule list.
+[**get_userpresence_rules_rule_id**](AlertingApi.html#get_userpresence_rules_rule_id) | Get a user presence rule.
+[**post_heartbeat_rules**](AlertingApi.html#post_heartbeat_rules) | Create a heart beat rule.
+[**post_interactionstats_rules**](AlertingApi.html#post_interactionstats_rules) | Create an interaction stats rule.
+[**post_routingstatus_rules**](AlertingApi.html#post_routingstatus_rules) | Create a routing status rule.
+[**post_userpresence_rules**](AlertingApi.html#post_userpresence_rules) | Create a user presence rule.
+[**put_heartbeat_rules_rule_id**](AlertingApi.html#put_heartbeat_rules_rule_id) | Update a heart beat rule
+[**put_interactionstats_alerts_alert_id**](AlertingApi.html#put_interactionstats_alerts_alert_id) | Update an interaction stats alert read status
+[**put_interactionstats_rules_rule_id**](AlertingApi.html#put_interactionstats_rules_rule_id) | Update an interaction stats rule
+[**put_routingstatus_rules_rule_id**](AlertingApi.html#put_routingstatus_rules_rule_id) | Update a routing status rule
+[**put_userpresence_rules_rule_id**](AlertingApi.html#put_userpresence_rules_rule_id) | Update a user presence rule
{: class="table table-striped"}
<a name="delete_heartbeat_alerts_alert_id"></a>
## - delete_heartbeat_alerts_alert_id(alert_id)
Delete a heart beat alert
+Wraps DELETE /api/v2/alerting/heartbeat/alerts/{alertId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -105,10 +108,13 @@
Delete a heart beat rule.
+Wraps DELETE /api/v2/alerting/heartbeat/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -160,10 +166,13 @@
Delete an interaction stats alert
+Wraps DELETE /api/v2/alerting/interactionstats/alerts/{alertId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -215,10 +224,13 @@
Delete an interaction stats rule.
+Wraps DELETE /api/v2/alerting/interactionstats/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -270,10 +282,13 @@
Delete a routing status alert
+Wraps DELETE /api/v2/alerting/routingstatus/alerts/{alertId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -325,10 +340,13 @@
Delete a routing status rule.
+Wraps DELETE /api/v2/alerting/routingstatus/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -380,10 +398,13 @@
Delete a user presence alert
+Wraps DELETE /api/v2/alerting/userpresence/alerts/{alertId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -435,10 +456,13 @@
Delete a user presence rule.
+Wraps DELETE /api/v2/alerting/userpresence/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -490,10 +514,13 @@
Get heart beat alert list.
+Wraps GET /api/v2/alerting/heartbeat/alerts
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -547,10 +574,13 @@
Get a heart beat alert
+Wraps GET /api/v2/alerting/heartbeat/alerts/{alertId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -607,10 +637,13 @@
Get a heart beat rule list.
+Wraps GET /api/v2/alerting/heartbeat/rules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -664,10 +697,13 @@
Get a heart beat rule.
+Wraps GET /api/v2/alerting/heartbeat/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -724,10 +760,13 @@
Get interaction stats alert list.
+Wraps GET /api/v2/alerting/interactionstats/alerts
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -781,10 +820,13 @@
Get an interaction stats alert
+Wraps GET /api/v2/alerting/interactionstats/alerts/{alertId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -841,10 +883,13 @@
Gets user unread count of interaction stats alerts.
+Wraps GET /api/v2/alerting/interactionstats/alerts/unread
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -891,10 +936,13 @@
Get an interaction stats rule list.
+Wraps GET /api/v2/alerting/interactionstats/rules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -948,10 +996,13 @@
Get an interaction stats rule.
+Wraps GET /api/v2/alerting/interactionstats/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1008,10 +1059,13 @@
Get routing status alert list.
+Wraps GET /api/v2/alerting/routingstatus/alerts
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1065,10 +1119,13 @@
Get a routing status alert
+Wraps GET /api/v2/alerting/routingstatus/alerts/{alertId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1125,10 +1182,13 @@
Get a routing status rule list.
+Wraps GET /api/v2/alerting/routingstatus/rules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1182,10 +1242,13 @@
Get a routing status rule.
+Wraps GET /api/v2/alerting/routingstatus/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1242,10 +1305,13 @@
Get user presence alert list.
+Wraps GET /api/v2/alerting/userpresence/alerts
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1299,10 +1365,13 @@
Get a user presence alert
+Wraps GET /api/v2/alerting/userpresence/alerts/{alertId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1359,10 +1428,13 @@
Get a user presence rule list.
+Wraps GET /api/v2/alerting/userpresence/rules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1416,10 +1488,13 @@
Get a user presence rule.
+Wraps GET /api/v2/alerting/userpresence/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1476,10 +1551,13 @@
Create a heart beat rule.
+Wraps POST /api/v2/alerting/heartbeat/rules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1536,10 +1614,13 @@
Create an interaction stats rule.
+Wraps POST /api/v2/alerting/interactionstats/rules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1596,10 +1677,13 @@
Create a routing status rule.
+Wraps POST /api/v2/alerting/routingstatus/rules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1656,10 +1740,13 @@
Create a user presence rule.
+Wraps POST /api/v2/alerting/userpresence/rules
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1716,10 +1803,13 @@
Update a heart beat rule
+Wraps PUT /api/v2/alerting/heartbeat/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1779,10 +1869,13 @@
Update an interaction stats alert read status
+Wraps PUT /api/v2/alerting/interactionstats/alerts/{alertId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1842,10 +1935,13 @@
Update an interaction stats rule
+Wraps PUT /api/v2/alerting/interactionstats/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1905,10 +2001,13 @@
Update a routing status rule
+Wraps PUT /api/v2/alerting/routingstatus/rules/{ruleId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1966,9 +2065,12 @@
## -[**UserPresenceRule**](UserPresenceRule.html) put_userpresence_rules_rule_id(rule_id, body, opts)
Update a user presence rule
+
+
+Wraps PUT /api/v2/alerting/userpresence/rules/{ruleId}
### Example
~~~ruby
# load the gem