doc_out/AlertingApi.html.md in purecloud-0.59.1 vs doc_out/AlertingApi.html.md in purecloud-0.60.1

- old
+ new

@@ -10,24 +10,40 @@ ------------- | ------------- | ------------- |[**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| {: class="table table-striped"} <a name="delete_heartbeat_alerts_alert_id"></a> ## - delete_heartbeat_alerts_alert_id(alert_id) @@ -246,13 +262,233 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="delete_routingstatus_alerts_alert_id"></a> + +## - delete_routingstatus_alerts_alert_id(alert_id) + +Delete a routing status alert + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +alert_id = "alert_id_example" # String | Alert ID + + +begin + #Delete a routing status alert + api_instance.delete_routingstatus_alerts_alert_id(alert_id) +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->delete_routingstatus_alerts_alert_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **alert_id** | **String**| Alert ID | +{: class="table table-striped"} + + +### Return type + +nil (empty response body) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="delete_routingstatus_rules_rule_id"></a> + +## - delete_routingstatus_rules_rule_id(rule_id) + +Delete a routing status rule. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +rule_id = "rule_id_example" # String | Rule ID + + +begin + #Delete a routing status rule. + api_instance.delete_routingstatus_rules_rule_id(rule_id) +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->delete_routingstatus_rules_rule_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rule_id** | **String**| Rule ID | +{: class="table table-striped"} + + +### Return type + +nil (empty response body) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="delete_userpresence_alerts_alert_id"></a> + +## - delete_userpresence_alerts_alert_id(alert_id) + +Delete a user presence alert + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +alert_id = "alert_id_example" # String | Alert ID + + +begin + #Delete a user presence alert + api_instance.delete_userpresence_alerts_alert_id(alert_id) +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->delete_userpresence_alerts_alert_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **alert_id** | **String**| Alert ID | +{: class="table table-striped"} + + +### Return type + +nil (empty response body) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="delete_userpresence_rules_rule_id"></a> + +## - delete_userpresence_rules_rule_id(rule_id) + +Delete a user presence rule. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +rule_id = "rule_id_example" # String | Rule ID + + +begin + #Delete a user presence rule. + api_instance.delete_userpresence_rules_rule_id(rule_id) +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->delete_userpresence_rules_rule_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rule_id** | **String**| Rule ID | +{: class="table table-striped"} + + +### Return type + +nil (empty response body) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_heartbeat_alerts"></a> -## -[**HeartBeatAlertContainer**](HeartBeatAlertContainer.html) get_heartbeat_alerts +## -[**HeartBeatAlertContainer**](HeartBeatAlertContainer.html) get_heartbeat_alerts(opts) Get heart beat alert list. @@ -271,21 +507,28 @@ config.access_token = @authToken end api_instance = PureCloud::AlertingApi.new +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + begin #Get heart beat alert list. - result = api_instance.get_heartbeat_alerts + result = api_instance.get_heartbeat_alerts(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->get_heartbeat_alerts: #{e}" end ~~~ ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -298,11 +541,11 @@ <a name="get_heartbeat_alerts_alert_id"></a> -## -[**HeartBeatAlert**](HeartBeatAlert.html) get_heartbeat_alerts_alert_id(alert_id) +## -[**HeartBeatAlert**](HeartBeatAlert.html) get_heartbeat_alerts_alert_id(alert_id, opts) Get a heart beat alert @@ -323,14 +566,17 @@ api_instance = PureCloud::AlertingApi.new alert_id = "alert_id_example" # String | Alert ID +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} begin #Get a heart beat alert - result = api_instance.get_heartbeat_alerts_alert_id(alert_id) + result = api_instance.get_heartbeat_alerts_alert_id(alert_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->get_heartbeat_alerts_alert_id: #{e}" end ~~~ @@ -338,10 +584,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **alert_id** | **String**| Alert ID | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -354,11 +601,11 @@ <a name="get_heartbeat_rules"></a> -## -[**HeartBeatRuleContainer**](HeartBeatRuleContainer.html) get_heartbeat_rules +## -[**HeartBeatRuleContainer**](HeartBeatRuleContainer.html) get_heartbeat_rules(opts) Get a heart beat rule list. @@ -377,21 +624,28 @@ config.access_token = @authToken end api_instance = PureCloud::AlertingApi.new +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + begin #Get a heart beat rule list. - result = api_instance.get_heartbeat_rules + result = api_instance.get_heartbeat_rules(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->get_heartbeat_rules: #{e}" end ~~~ ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -404,11 +658,11 @@ <a name="get_heartbeat_rules_rule_id"></a> -## -[**HeartBeatRule**](HeartBeatRule.html) get_heartbeat_rules_rule_id(rule_id) +## -[**HeartBeatRule**](HeartBeatRule.html) get_heartbeat_rules_rule_id(rule_id, opts) Get a heart beat rule. @@ -429,14 +683,17 @@ api_instance = PureCloud::AlertingApi.new rule_id = "rule_id_example" # String | Rule ID +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} begin #Get a heart beat rule. - result = api_instance.get_heartbeat_rules_rule_id(rule_id) + result = api_instance.get_heartbeat_rules_rule_id(rule_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->get_heartbeat_rules_rule_id: #{e}" end ~~~ @@ -444,10 +701,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **rule_id** | **String**| Rule ID | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -460,11 +718,11 @@ <a name="get_interactionstats_alerts"></a> -## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_interactionstats_alerts +## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_interactionstats_alerts(opts) Get interaction stats alert list. @@ -483,21 +741,28 @@ config.access_token = @authToken end api_instance = PureCloud::AlertingApi.new +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + begin #Get interaction stats alert list. - result = api_instance.get_interactionstats_alerts + result = api_instance.get_interactionstats_alerts(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->get_interactionstats_alerts: #{e}" end ~~~ ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -510,11 +775,11 @@ <a name="get_interactionstats_alerts_alert_id"></a> -## -[**InteractionStatsAlert**](InteractionStatsAlert.html) get_interactionstats_alerts_alert_id(alert_id) +## -[**InteractionStatsAlert**](InteractionStatsAlert.html) get_interactionstats_alerts_alert_id(alert_id, opts) Get an interaction stats alert @@ -535,14 +800,17 @@ api_instance = PureCloud::AlertingApi.new alert_id = "alert_id_example" # String | Alert ID +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} begin #Get an interaction stats alert - result = api_instance.get_interactionstats_alerts_alert_id(alert_id) + result = api_instance.get_interactionstats_alerts_alert_id(alert_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->get_interactionstats_alerts_alert_id: #{e}" end ~~~ @@ -550,10 +818,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **alert_id** | **String**| Alert ID | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -616,11 +885,11 @@ <a name="get_interactionstats_rules"></a> -## -[**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html) get_interactionstats_rules +## -[**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html) get_interactionstats_rules(opts) Get an interaction stats rule list. @@ -639,21 +908,28 @@ config.access_token = @authToken end api_instance = PureCloud::AlertingApi.new +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + begin #Get an interaction stats rule list. - result = api_instance.get_interactionstats_rules + result = api_instance.get_interactionstats_rules(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->get_interactionstats_rules: #{e}" end ~~~ ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -666,11 +942,11 @@ <a name="get_interactionstats_rules_rule_id"></a> -## -[**InteractionStatsRule**](InteractionStatsRule.html) get_interactionstats_rules_rule_id(rule_id) +## -[**InteractionStatsRule**](InteractionStatsRule.html) get_interactionstats_rules_rule_id(rule_id, opts) Get an interaction stats rule. @@ -691,14 +967,17 @@ api_instance = PureCloud::AlertingApi.new rule_id = "rule_id_example" # String | Rule ID +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} begin #Get an interaction stats rule. - result = api_instance.get_interactionstats_rules_rule_id(rule_id) + result = api_instance.get_interactionstats_rules_rule_id(rule_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->get_interactionstats_rules_rule_id: #{e}" end ~~~ @@ -706,10 +985,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **rule_id** | **String**| Rule ID | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -720,13 +1000,481 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_routingstatus_alerts"></a> + +## -[**RoutingStatusAlertContainer**](RoutingStatusAlertContainer.html) get_routingstatus_alerts(opts) + +Get routing status alert list. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Get routing status alert list. + result = api_instance.get_routingstatus_alerts(opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->get_routingstatus_alerts: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**RoutingStatusAlertContainer**](RoutingStatusAlertContainer.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_routingstatus_alerts_alert_id"></a> + +## -[**RoutingStatusAlert**](RoutingStatusAlert.html) get_routingstatus_alerts_alert_id(alert_id, opts) + +Get a routing status alert + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +alert_id = "alert_id_example" # String | Alert ID + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Get a routing status alert + result = api_instance.get_routingstatus_alerts_alert_id(alert_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->get_routingstatus_alerts_alert_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **alert_id** | **String**| Alert ID | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**RoutingStatusAlert**](RoutingStatusAlert.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_routingstatus_rules"></a> + +## -[**RoutingStatusRuleContainer**](RoutingStatusRuleContainer.html) get_routingstatus_rules(opts) + +Get a routing status rule list. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Get a routing status rule list. + result = api_instance.get_routingstatus_rules(opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->get_routingstatus_rules: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**RoutingStatusRuleContainer**](RoutingStatusRuleContainer.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_routingstatus_rules_rule_id"></a> + +## -[**RoutingStatusRule**](RoutingStatusRule.html) get_routingstatus_rules_rule_id(rule_id, opts) + +Get a routing status rule. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +rule_id = "rule_id_example" # String | Rule ID + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Get a routing status rule. + result = api_instance.get_routingstatus_rules_rule_id(rule_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->get_routingstatus_rules_rule_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rule_id** | **String**| Rule ID | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**RoutingStatusRule**](RoutingStatusRule.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_userpresence_alerts"></a> + +## -[**UserPresenceAlertContainer**](UserPresenceAlertContainer.html) get_userpresence_alerts(opts) + +Get user presence alert list. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Get user presence alert list. + result = api_instance.get_userpresence_alerts(opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->get_userpresence_alerts: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**UserPresenceAlertContainer**](UserPresenceAlertContainer.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_userpresence_alerts_alert_id"></a> + +## -[**UserPresenceAlert**](UserPresenceAlert.html) get_userpresence_alerts_alert_id(alert_id, opts) + +Get a user presence alert + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +alert_id = "alert_id_example" # String | Alert ID + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Get a user presence alert + result = api_instance.get_userpresence_alerts_alert_id(alert_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->get_userpresence_alerts_alert_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **alert_id** | **String**| Alert ID | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**UserPresenceAlert**](UserPresenceAlert.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_userpresence_rules"></a> + +## -[**UserPresenceRuleContainer**](UserPresenceRuleContainer.html) get_userpresence_rules(opts) + +Get a user presence rule list. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Get a user presence rule list. + result = api_instance.get_userpresence_rules(opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->get_userpresence_rules: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**UserPresenceRuleContainer**](UserPresenceRuleContainer.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_userpresence_rules_rule_id"></a> + +## -[**UserPresenceRule**](UserPresenceRule.html) get_userpresence_rules_rule_id(rule_id, opts) + +Get a user presence rule. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +rule_id = "rule_id_example" # String | Rule ID + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Get a user presence rule. + result = api_instance.get_userpresence_rules_rule_id(rule_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->get_userpresence_rules_rule_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rule_id** | **String**| Rule ID | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**UserPresenceRule**](UserPresenceRule.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="post_heartbeat_rules"></a> -## -[**HeartBeatRule**](HeartBeatRule.html) post_heartbeat_rules(body) +## -[**HeartBeatRule**](HeartBeatRule.html) post_heartbeat_rules(body, opts) Create a heart beat rule. @@ -747,14 +1495,17 @@ api_instance = PureCloud::AlertingApi.new body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} begin #Create a heart beat rule. - result = api_instance.post_heartbeat_rules(body) + result = api_instance.post_heartbeat_rules(body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->post_heartbeat_rules: #{e}" end ~~~ @@ -762,10 +1513,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -778,11 +1530,11 @@ <a name="post_interactionstats_rules"></a> -## -[**InteractionStatsRule**](InteractionStatsRule.html) post_interactionstats_rules(body) +## -[**InteractionStatsRule**](InteractionStatsRule.html) post_interactionstats_rules(body, opts) Create an interaction stats rule. @@ -803,14 +1555,17 @@ api_instance = PureCloud::AlertingApi.new body = PureCloud::InteractionStatsRule.new # InteractionStatsRule | AlertingRule +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} begin #Create an interaction stats rule. - result = api_instance.post_interactionstats_rules(body) + result = api_instance.post_interactionstats_rules(body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->post_interactionstats_rules: #{e}" end ~~~ @@ -818,10 +1573,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**InteractionStatsRule**](InteractionStatsRule.html)| AlertingRule | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -832,13 +1588,133 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="post_routingstatus_rules"></a> + +## -[**RoutingStatusRule**](RoutingStatusRule.html) post_routingstatus_rules(body, opts) + +Create a routing status rule. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +body = PureCloud::RoutingStatusRule.new # RoutingStatusRule | RoutingStatusRule + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Create a routing status rule. + result = api_instance.post_routingstatus_rules(body, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->post_routingstatus_rules: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**RoutingStatusRule**](RoutingStatusRule.html)| RoutingStatusRule | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**RoutingStatusRule**](RoutingStatusRule.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="post_userpresence_rules"></a> + +## -[**UserPresenceRule**](UserPresenceRule.html) post_userpresence_rules(body, opts) + +Create a user presence rule. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +body = PureCloud::UserPresenceRule.new # UserPresenceRule | UserPresenceRule + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Create a user presence rule. + result = api_instance.post_userpresence_rules(body, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->post_userpresence_rules: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UserPresenceRule**](UserPresenceRule.html)| UserPresenceRule | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**UserPresenceRule**](UserPresenceRule.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="put_heartbeat_rules_rule_id"></a> -## -[**HeartBeatRule**](HeartBeatRule.html) put_heartbeat_rules_rule_id(rule_id, body) +## -[**HeartBeatRule**](HeartBeatRule.html) put_heartbeat_rules_rule_id(rule_id, body, opts) Update a heart beat rule @@ -861,14 +1737,17 @@ rule_id = "rule_id_example" # String | Rule ID body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} begin #Update a heart beat rule - result = api_instance.put_heartbeat_rules_rule_id(rule_id, body) + result = api_instance.put_heartbeat_rules_rule_id(rule_id, body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->put_heartbeat_rules_rule_id: #{e}" end ~~~ @@ -877,10 +1756,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **rule_id** | **String**| Rule ID | **body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -893,11 +1773,11 @@ <a name="put_interactionstats_alerts_alert_id"></a> -## -[**UnreadStatus**](UnreadStatus.html) put_interactionstats_alerts_alert_id(alert_id, body) +## -[**UnreadStatus**](UnreadStatus.html) put_interactionstats_alerts_alert_id(alert_id, body, opts) Update an interaction stats alert read status @@ -920,14 +1800,17 @@ alert_id = "alert_id_example" # String | Alert ID body = PureCloud::UnreadStatus.new # UnreadStatus | InteractionStatsAlert +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} begin #Update an interaction stats alert read status - result = api_instance.put_interactionstats_alerts_alert_id(alert_id, body) + result = api_instance.put_interactionstats_alerts_alert_id(alert_id, body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->put_interactionstats_alerts_alert_id: #{e}" end ~~~ @@ -936,10 +1819,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **alert_id** | **String**| Alert ID | **body** | [**UnreadStatus**](UnreadStatus.html)| InteractionStatsAlert | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type @@ -952,11 +1836,11 @@ <a name="put_interactionstats_rules_rule_id"></a> -## -[**InteractionStatsRule**](InteractionStatsRule.html) put_interactionstats_rules_rule_id(rule_id, body) +## -[**InteractionStatsRule**](InteractionStatsRule.html) put_interactionstats_rules_rule_id(rule_id, body, opts) Update an interaction stats rule @@ -979,14 +1863,17 @@ rule_id = "rule_id_example" # String | Rule ID body = PureCloud::InteractionStatsRule.new # InteractionStatsRule | AlertingRule +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} begin #Update an interaction stats rule - result = api_instance.put_interactionstats_rules_rule_id(rule_id, body) + result = api_instance.put_interactionstats_rules_rule_id(rule_id, body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling AlertingApi->put_interactionstats_rules_rule_id: #{e}" end ~~~ @@ -995,15 +1882,142 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **rule_id** | **String**| Rule ID | **body** | [**InteractionStatsRule**](InteractionStatsRule.html)| AlertingRule | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} ### Return type [**InteractionStatsRule**](InteractionStatsRule.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="put_routingstatus_rules_rule_id"></a> + +## -[**RoutingStatusRule**](RoutingStatusRule.html) put_routingstatus_rules_rule_id(rule_id, body, opts) + +Update a routing status rule + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +rule_id = "rule_id_example" # String | Rule ID + +body = PureCloud::RoutingStatusRule.new # RoutingStatusRule | RoutingStatusRule + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Update a routing status rule + result = api_instance.put_routingstatus_rules_rule_id(rule_id, body, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->put_routingstatus_rules_rule_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rule_id** | **String**| Rule ID | + **body** | [**RoutingStatusRule**](RoutingStatusRule.html)| RoutingStatusRule | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**RoutingStatusRule**](RoutingStatusRule.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="put_userpresence_rules_rule_id"></a> + +## -[**UserPresenceRule**](UserPresenceRule.html) put_userpresence_rules_rule_id(rule_id, body, opts) + +Update a user presence rule + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::AlertingApi.new + +rule_id = "rule_id_example" # String | Rule ID + +body = PureCloud::UserPresenceRule.new # UserPresenceRule | UserPresenceRule + +opts = { + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand +} + +begin + #Update a user presence rule + result = api_instance.put_userpresence_rules_rule_id(rule_id, body, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling AlertingApi->put_userpresence_rules_rule_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **rule_id** | **String**| Rule ID | + **body** | [**UserPresenceRule**](UserPresenceRule.html)| UserPresenceRule | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] +{: class="table table-striped"} + + +### Return type + +[**UserPresenceRule**](UserPresenceRule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json