purecloud 0.59.1 → 0.60.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/config-ruby.json +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AggregationQuery.html.md +1 -1
- data/doc_out/AlertingApi.html.md +1106 -92
- data/doc_out/Annotation.html.md +14 -4
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactSort.html.md +1 -1
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/Edge.html.md +1 -1
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/HeartBeatAlert.html.md +1 -1
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRule.html.md +1 -1
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlert.html.md +1 -1
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRule.html.md +1 -1
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/OAuthClient.html.md +2 -2
- data/doc_out/OAuthClientEntityListing.html.md +3 -3
- data/doc_out/OAuthClientListing.html.md +20 -0
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecording.html.md +1 -0
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OrphanUpdateRequest.html.md +15 -0
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/QualityApi.html.md +5 -1
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/RecordingApi.html.md +132 -4
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RoutingStatusAlert.html.md +23 -0
- data/doc_out/RoutingStatusAlertContainer.html.md +22 -0
- data/doc_out/RoutingStatusRule.html.md +22 -0
- data/doc_out/RoutingStatusRuleContainer.html.md +22 -0
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/ScriptEntityListing.html.md +2 -2
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StreetAddress.html.md +2 -2
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +21 -17
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkBaseEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserPresenceAlert.html.md +25 -0
- data/doc_out/UserPresenceAlertContainer.html.md +22 -0
- data/doc_out/UserPresenceRule.html.md +23 -0
- data/doc_out/{UsersEntityListing.html.md → UserPresenceRuleContainer.html.md} +5 -5
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +2 -2
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +10 -1
- data/lib/purecloud/api/alerting_api.rb +1070 -49
- data/lib/purecloud/api/quality_api.rb +6 -0
- data/lib/purecloud/api/recording_api.rb +140 -2
- data/lib/purecloud/api/telephony_providers_edge_api.rb +13 -10
- data/lib/purecloud/api/users_api.rb +3 -3
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/aggregation_query.rb +1 -1
- data/lib/purecloud/models/annotation.rb +115 -1
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
- data/lib/purecloud/models/channel_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_sort.rb +1 -0
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
- data/lib/purecloud/models/document_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
- data/lib/purecloud/models/edge.rb +2 -1
- data/lib/purecloud/models/edge_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_message_listing.rb +17 -17
- data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/group_search_criteria.rb +1 -1
- data/lib/purecloud/models/heart_beat_alert.rb +1 -1
- data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
- data/lib/purecloud/models/heart_beat_rule.rb +1 -1
- data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/interaction_stats_alert.rb +1 -1
- data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
- data/lib/purecloud/models/interaction_stats_rule.rb +1 -1
- data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
- data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/language_entity_listing.rb +17 -17
- data/lib/purecloud/models/library_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_entity_listing.rb +17 -17
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
- data/lib/purecloud/models/location_search_criteria.rb +1 -1
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +18 -18
- data/lib/purecloud/models/o_auth_client_listing.rb +246 -0
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
- data/lib/purecloud/models/orphan_recording.rb +21 -1
- data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
- data/lib/purecloud/models/orphan_update_request.rb +188 -0
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/policy_entity_listing.rb +17 -17
- data/lib/purecloud/models/quality_audit_page.rb +17 -17
- data/lib/purecloud/models/queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_entity_list.rb +17 -17
- data/lib/purecloud/models/response_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/routing_status_alert.rb +289 -0
- data/lib/purecloud/models/routing_status_alert_container.rb +257 -0
- data/lib/purecloud/models/routing_status_rule.rb +282 -0
- data/lib/purecloud/models/routing_status_rule_container.rb +257 -0
- data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
- data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
- data/lib/purecloud/models/script_entity_listing.rb +17 -17
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/street_address.rb +2 -0
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_presence_alert.rb +310 -0
- data/lib/purecloud/models/user_presence_alert_container.rb +257 -0
- data/lib/purecloud/models/user_presence_rule.rb +293 -0
- data/lib/purecloud/models/{users_entity_listing.rb → user_presence_rule_container.rb} +19 -19
- data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_schedule_adherence.rb +3 -3
- data/lib/purecloud/models/user_search_criteria.rb +1 -1
- data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +22 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cbadef339946b6aa5390ab34859ee0ce179c085f
|
|
4
|
+
data.tar.gz: 44f2297c9d981e7258890055106044ff39dfc49a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1a0f39558d0909778c3667ffc58a594a8e548a5b3a65b99a7aeae365d677a3ebe143f822ce993f6bc3317e6105f159409cb42c68affb1976f7126a7798dd7833
|
|
7
|
+
data.tar.gz: 626d6841a3faf39872697366dc16e7a39a0e6b393d3ac33fbc61b0c552c37fa780e7964255a0c25b211b87877b762269ea55df3f0fe21b5bf0a0ad9c68e72818
|
data/README.md
CHANGED
|
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
|
|
|
9
9
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
10
10
|
|
|
11
11
|
- API version: v2
|
|
12
|
-
- Package version: 0.
|
|
13
|
-
- Build date: 2016-
|
|
12
|
+
- Package version: 0.60.1
|
|
13
|
+
- Build date: 2016-12-05T21:10:35.816Z
|
|
14
14
|
|
|
15
15
|
For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
|
|
|
18
18
|
|
|
19
19
|
### from rubygems.org
|
|
20
20
|
|
|
21
|
-
gem 'purecloud', '~> 0.
|
|
21
|
+
gem 'purecloud', '~> 0.60.1'
|
|
22
22
|
|
|
23
23
|
### Install from Git
|
|
24
24
|
|
data/config-ruby.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"gemVersion":"0.
|
|
1
|
+
{"gemVersion":"0.60.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.60.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
|
|
@@ -11,11 +11,11 @@ title: AgentActivityEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -8,7 +8,7 @@ title: AggregationQuery
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
|
11
|
-
| **granularity** | **
|
|
11
|
+
| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
|
|
12
12
|
| **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London | [optional] |
|
|
13
13
|
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
|
14
14
|
| **filter** | [**AnalyticsQueryFilter**](AnalyticsQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
|
data/doc_out/AlertingApi.html.md
CHANGED
|
@@ -12,6 +12,10 @@ Method | HTTP request | Description
|
|
|
12
12
|
|[**delete_heartbeat_rules_rule_id**](AlertingApi.html#delete_heartbeat_rules_rule_id) | **DELETE** /api/v2/alerting/heartbeat/rules/{ruleId} | Delete a heart beat rule.|
|
|
13
13
|
|[**delete_interactionstats_alerts_alert_id**](AlertingApi.html#delete_interactionstats_alerts_alert_id) | **DELETE** /api/v2/alerting/interactionstats/alerts/{alertId} | Delete an interaction stats alert|
|
|
14
14
|
|[**delete_interactionstats_rules_rule_id**](AlertingApi.html#delete_interactionstats_rules_rule_id) | **DELETE** /api/v2/alerting/interactionstats/rules/{ruleId} | Delete an interaction stats rule.|
|
|
15
|
+
|[**delete_routingstatus_alerts_alert_id**](AlertingApi.html#delete_routingstatus_alerts_alert_id) | **DELETE** /api/v2/alerting/routingstatus/alerts/{alertId} | Delete a routing status alert|
|
|
16
|
+
|[**delete_routingstatus_rules_rule_id**](AlertingApi.html#delete_routingstatus_rules_rule_id) | **DELETE** /api/v2/alerting/routingstatus/rules/{ruleId} | Delete a routing status rule.|
|
|
17
|
+
|[**delete_userpresence_alerts_alert_id**](AlertingApi.html#delete_userpresence_alerts_alert_id) | **DELETE** /api/v2/alerting/userpresence/alerts/{alertId} | Delete a user presence alert|
|
|
18
|
+
|[**delete_userpresence_rules_rule_id**](AlertingApi.html#delete_userpresence_rules_rule_id) | **DELETE** /api/v2/alerting/userpresence/rules/{ruleId} | Delete a user presence rule.|
|
|
15
19
|
|[**get_heartbeat_alerts**](AlertingApi.html#get_heartbeat_alerts) | **GET** /api/v2/alerting/heartbeat/alerts | Get heart beat alert list.|
|
|
16
20
|
|[**get_heartbeat_alerts_alert_id**](AlertingApi.html#get_heartbeat_alerts_alert_id) | **GET** /api/v2/alerting/heartbeat/alerts/{alertId} | Get a heart beat alert|
|
|
17
21
|
|[**get_heartbeat_rules**](AlertingApi.html#get_heartbeat_rules) | **GET** /api/v2/alerting/heartbeat/rules | Get a heart beat rule list.|
|
|
@@ -21,11 +25,23 @@ Method | HTTP request | Description
|
|
|
21
25
|
|[**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.|
|
|
22
26
|
|[**get_interactionstats_rules**](AlertingApi.html#get_interactionstats_rules) | **GET** /api/v2/alerting/interactionstats/rules | Get an interaction stats rule list.|
|
|
23
27
|
|[**get_interactionstats_rules_rule_id**](AlertingApi.html#get_interactionstats_rules_rule_id) | **GET** /api/v2/alerting/interactionstats/rules/{ruleId} | Get an interaction stats rule.|
|
|
28
|
+
|[**get_routingstatus_alerts**](AlertingApi.html#get_routingstatus_alerts) | **GET** /api/v2/alerting/routingstatus/alerts | Get routing status alert list.|
|
|
29
|
+
|[**get_routingstatus_alerts_alert_id**](AlertingApi.html#get_routingstatus_alerts_alert_id) | **GET** /api/v2/alerting/routingstatus/alerts/{alertId} | Get a routing status alert|
|
|
30
|
+
|[**get_routingstatus_rules**](AlertingApi.html#get_routingstatus_rules) | **GET** /api/v2/alerting/routingstatus/rules | Get a routing status rule list.|
|
|
31
|
+
|[**get_routingstatus_rules_rule_id**](AlertingApi.html#get_routingstatus_rules_rule_id) | **GET** /api/v2/alerting/routingstatus/rules/{ruleId} | Get a routing status rule.|
|
|
32
|
+
|[**get_userpresence_alerts**](AlertingApi.html#get_userpresence_alerts) | **GET** /api/v2/alerting/userpresence/alerts | Get user presence alert list.|
|
|
33
|
+
|[**get_userpresence_alerts_alert_id**](AlertingApi.html#get_userpresence_alerts_alert_id) | **GET** /api/v2/alerting/userpresence/alerts/{alertId} | Get a user presence alert|
|
|
34
|
+
|[**get_userpresence_rules**](AlertingApi.html#get_userpresence_rules) | **GET** /api/v2/alerting/userpresence/rules | Get a user presence rule list.|
|
|
35
|
+
|[**get_userpresence_rules_rule_id**](AlertingApi.html#get_userpresence_rules_rule_id) | **GET** /api/v2/alerting/userpresence/rules/{ruleId} | Get a user presence rule.|
|
|
24
36
|
|[**post_heartbeat_rules**](AlertingApi.html#post_heartbeat_rules) | **POST** /api/v2/alerting/heartbeat/rules | Create a heart beat rule.|
|
|
25
37
|
|[**post_interactionstats_rules**](AlertingApi.html#post_interactionstats_rules) | **POST** /api/v2/alerting/interactionstats/rules | Create an interaction stats rule.|
|
|
38
|
+
|[**post_routingstatus_rules**](AlertingApi.html#post_routingstatus_rules) | **POST** /api/v2/alerting/routingstatus/rules | Create a routing status rule.|
|
|
39
|
+
|[**post_userpresence_rules**](AlertingApi.html#post_userpresence_rules) | **POST** /api/v2/alerting/userpresence/rules | Create a user presence rule.|
|
|
26
40
|
|[**put_heartbeat_rules_rule_id**](AlertingApi.html#put_heartbeat_rules_rule_id) | **PUT** /api/v2/alerting/heartbeat/rules/{ruleId} | Update a heart beat rule|
|
|
27
41
|
|[**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|
|
|
28
42
|
|[**put_interactionstats_rules_rule_id**](AlertingApi.html#put_interactionstats_rules_rule_id) | **PUT** /api/v2/alerting/interactionstats/rules/{ruleId} | Update an interaction stats rule|
|
|
43
|
+
|[**put_routingstatus_rules_rule_id**](AlertingApi.html#put_routingstatus_rules_rule_id) | **PUT** /api/v2/alerting/routingstatus/rules/{ruleId} | Update a routing status rule|
|
|
44
|
+
|[**put_userpresence_rules_rule_id**](AlertingApi.html#put_userpresence_rules_rule_id) | **PUT** /api/v2/alerting/userpresence/rules/{ruleId} | Update a user presence rule|
|
|
29
45
|
{: class="table table-striped"}
|
|
30
46
|
|
|
31
47
|
<a name="delete_heartbeat_alerts_alert_id"></a>
|
|
@@ -248,11 +264,749 @@ nil (empty response body)
|
|
|
248
264
|
|
|
249
265
|
|
|
250
266
|
|
|
267
|
+
<a name="delete_routingstatus_alerts_alert_id"></a>
|
|
268
|
+
|
|
269
|
+
## - delete_routingstatus_alerts_alert_id(alert_id)
|
|
270
|
+
|
|
271
|
+
Delete a routing status alert
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
### Example
|
|
276
|
+
~~~ruby
|
|
277
|
+
# load the gem
|
|
278
|
+
require 'purecloud'
|
|
279
|
+
# setup authorization
|
|
280
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
281
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
282
|
+
environment = "mypurecloud.com"
|
|
283
|
+
|
|
284
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
285
|
+
|
|
286
|
+
PureCloud.configure do |config|
|
|
287
|
+
config.access_token = @authToken
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
api_instance = PureCloud::AlertingApi.new
|
|
291
|
+
|
|
292
|
+
alert_id = "alert_id_example" # String | Alert ID
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
begin
|
|
296
|
+
#Delete a routing status alert
|
|
297
|
+
api_instance.delete_routingstatus_alerts_alert_id(alert_id)
|
|
298
|
+
rescue PureCloud::ApiError => e
|
|
299
|
+
puts "Exception when calling AlertingApi->delete_routingstatus_alerts_alert_id: #{e}"
|
|
300
|
+
end
|
|
301
|
+
~~~
|
|
302
|
+
|
|
303
|
+
### Parameters
|
|
304
|
+
|
|
305
|
+
Name | Type | Description | Notes
|
|
306
|
+
------------- | ------------- | ------------- | -------------
|
|
307
|
+
**alert_id** | **String**| Alert ID |
|
|
308
|
+
{: class="table table-striped"}
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
### Return type
|
|
312
|
+
|
|
313
|
+
nil (empty response body)
|
|
314
|
+
|
|
315
|
+
### HTTP request headers
|
|
316
|
+
|
|
317
|
+
- **Content-Type**: application/json
|
|
318
|
+
- **Accept**: application/json
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<a name="delete_routingstatus_rules_rule_id"></a>
|
|
323
|
+
|
|
324
|
+
## - delete_routingstatus_rules_rule_id(rule_id)
|
|
325
|
+
|
|
326
|
+
Delete a routing status rule.
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
### Example
|
|
331
|
+
~~~ruby
|
|
332
|
+
# load the gem
|
|
333
|
+
require 'purecloud'
|
|
334
|
+
# setup authorization
|
|
335
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
336
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
337
|
+
environment = "mypurecloud.com"
|
|
338
|
+
|
|
339
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
340
|
+
|
|
341
|
+
PureCloud.configure do |config|
|
|
342
|
+
config.access_token = @authToken
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
api_instance = PureCloud::AlertingApi.new
|
|
346
|
+
|
|
347
|
+
rule_id = "rule_id_example" # String | Rule ID
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
begin
|
|
351
|
+
#Delete a routing status rule.
|
|
352
|
+
api_instance.delete_routingstatus_rules_rule_id(rule_id)
|
|
353
|
+
rescue PureCloud::ApiError => e
|
|
354
|
+
puts "Exception when calling AlertingApi->delete_routingstatus_rules_rule_id: #{e}"
|
|
355
|
+
end
|
|
356
|
+
~~~
|
|
357
|
+
|
|
358
|
+
### Parameters
|
|
359
|
+
|
|
360
|
+
Name | Type | Description | Notes
|
|
361
|
+
------------- | ------------- | ------------- | -------------
|
|
362
|
+
**rule_id** | **String**| Rule ID |
|
|
363
|
+
{: class="table table-striped"}
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
### Return type
|
|
367
|
+
|
|
368
|
+
nil (empty response body)
|
|
369
|
+
|
|
370
|
+
### HTTP request headers
|
|
371
|
+
|
|
372
|
+
- **Content-Type**: application/json
|
|
373
|
+
- **Accept**: application/json
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<a name="delete_userpresence_alerts_alert_id"></a>
|
|
378
|
+
|
|
379
|
+
## - delete_userpresence_alerts_alert_id(alert_id)
|
|
380
|
+
|
|
381
|
+
Delete a user presence alert
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
### Example
|
|
386
|
+
~~~ruby
|
|
387
|
+
# load the gem
|
|
388
|
+
require 'purecloud'
|
|
389
|
+
# setup authorization
|
|
390
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
391
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
392
|
+
environment = "mypurecloud.com"
|
|
393
|
+
|
|
394
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
395
|
+
|
|
396
|
+
PureCloud.configure do |config|
|
|
397
|
+
config.access_token = @authToken
|
|
398
|
+
end
|
|
399
|
+
|
|
400
|
+
api_instance = PureCloud::AlertingApi.new
|
|
401
|
+
|
|
402
|
+
alert_id = "alert_id_example" # String | Alert ID
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
begin
|
|
406
|
+
#Delete a user presence alert
|
|
407
|
+
api_instance.delete_userpresence_alerts_alert_id(alert_id)
|
|
408
|
+
rescue PureCloud::ApiError => e
|
|
409
|
+
puts "Exception when calling AlertingApi->delete_userpresence_alerts_alert_id: #{e}"
|
|
410
|
+
end
|
|
411
|
+
~~~
|
|
412
|
+
|
|
413
|
+
### Parameters
|
|
414
|
+
|
|
415
|
+
Name | Type | Description | Notes
|
|
416
|
+
------------- | ------------- | ------------- | -------------
|
|
417
|
+
**alert_id** | **String**| Alert ID |
|
|
418
|
+
{: class="table table-striped"}
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
### Return type
|
|
422
|
+
|
|
423
|
+
nil (empty response body)
|
|
424
|
+
|
|
425
|
+
### HTTP request headers
|
|
426
|
+
|
|
427
|
+
- **Content-Type**: application/json
|
|
428
|
+
- **Accept**: application/json
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<a name="delete_userpresence_rules_rule_id"></a>
|
|
433
|
+
|
|
434
|
+
## - delete_userpresence_rules_rule_id(rule_id)
|
|
435
|
+
|
|
436
|
+
Delete a user presence rule.
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
### Example
|
|
441
|
+
~~~ruby
|
|
442
|
+
# load the gem
|
|
443
|
+
require 'purecloud'
|
|
444
|
+
# setup authorization
|
|
445
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
446
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
447
|
+
environment = "mypurecloud.com"
|
|
448
|
+
|
|
449
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
450
|
+
|
|
451
|
+
PureCloud.configure do |config|
|
|
452
|
+
config.access_token = @authToken
|
|
453
|
+
end
|
|
454
|
+
|
|
455
|
+
api_instance = PureCloud::AlertingApi.new
|
|
456
|
+
|
|
457
|
+
rule_id = "rule_id_example" # String | Rule ID
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
begin
|
|
461
|
+
#Delete a user presence rule.
|
|
462
|
+
api_instance.delete_userpresence_rules_rule_id(rule_id)
|
|
463
|
+
rescue PureCloud::ApiError => e
|
|
464
|
+
puts "Exception when calling AlertingApi->delete_userpresence_rules_rule_id: #{e}"
|
|
465
|
+
end
|
|
466
|
+
~~~
|
|
467
|
+
|
|
468
|
+
### Parameters
|
|
469
|
+
|
|
470
|
+
Name | Type | Description | Notes
|
|
471
|
+
------------- | ------------- | ------------- | -------------
|
|
472
|
+
**rule_id** | **String**| Rule ID |
|
|
473
|
+
{: class="table table-striped"}
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
### Return type
|
|
477
|
+
|
|
478
|
+
nil (empty response body)
|
|
479
|
+
|
|
480
|
+
### HTTP request headers
|
|
481
|
+
|
|
482
|
+
- **Content-Type**: application/json
|
|
483
|
+
- **Accept**: application/json
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
251
487
|
<a name="get_heartbeat_alerts"></a>
|
|
252
488
|
|
|
253
|
-
## -[**HeartBeatAlertContainer**](HeartBeatAlertContainer.html) get_heartbeat_alerts
|
|
489
|
+
## -[**HeartBeatAlertContainer**](HeartBeatAlertContainer.html) get_heartbeat_alerts(opts)
|
|
490
|
+
|
|
491
|
+
Get heart beat alert list.
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
### Example
|
|
496
|
+
~~~ruby
|
|
497
|
+
# load the gem
|
|
498
|
+
require 'purecloud'
|
|
499
|
+
# setup authorization
|
|
500
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
501
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
502
|
+
environment = "mypurecloud.com"
|
|
503
|
+
|
|
504
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
505
|
+
|
|
506
|
+
PureCloud.configure do |config|
|
|
507
|
+
config.access_token = @authToken
|
|
508
|
+
end
|
|
509
|
+
|
|
510
|
+
api_instance = PureCloud::AlertingApi.new
|
|
511
|
+
|
|
512
|
+
opts = {
|
|
513
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
begin
|
|
517
|
+
#Get heart beat alert list.
|
|
518
|
+
result = api_instance.get_heartbeat_alerts(opts)
|
|
519
|
+
p result
|
|
520
|
+
rescue PureCloud::ApiError => e
|
|
521
|
+
puts "Exception when calling AlertingApi->get_heartbeat_alerts: #{e}"
|
|
522
|
+
end
|
|
523
|
+
~~~
|
|
524
|
+
|
|
525
|
+
### Parameters
|
|
526
|
+
|
|
527
|
+
Name | Type | Description | Notes
|
|
528
|
+
------------- | ------------- | ------------- | -------------
|
|
529
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
530
|
+
{: class="table table-striped"}
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
### Return type
|
|
534
|
+
|
|
535
|
+
[**HeartBeatAlertContainer**](HeartBeatAlertContainer.html)
|
|
536
|
+
|
|
537
|
+
### HTTP request headers
|
|
538
|
+
|
|
539
|
+
- **Content-Type**: application/json
|
|
540
|
+
- **Accept**: application/json
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
<a name="get_heartbeat_alerts_alert_id"></a>
|
|
545
|
+
|
|
546
|
+
## -[**HeartBeatAlert**](HeartBeatAlert.html) get_heartbeat_alerts_alert_id(alert_id, opts)
|
|
547
|
+
|
|
548
|
+
Get a heart beat alert
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
### Example
|
|
553
|
+
~~~ruby
|
|
554
|
+
# load the gem
|
|
555
|
+
require 'purecloud'
|
|
556
|
+
# setup authorization
|
|
557
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
558
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
559
|
+
environment = "mypurecloud.com"
|
|
560
|
+
|
|
561
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
562
|
+
|
|
563
|
+
PureCloud.configure do |config|
|
|
564
|
+
config.access_token = @authToken
|
|
565
|
+
end
|
|
566
|
+
|
|
567
|
+
api_instance = PureCloud::AlertingApi.new
|
|
568
|
+
|
|
569
|
+
alert_id = "alert_id_example" # String | Alert ID
|
|
570
|
+
|
|
571
|
+
opts = {
|
|
572
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
begin
|
|
576
|
+
#Get a heart beat alert
|
|
577
|
+
result = api_instance.get_heartbeat_alerts_alert_id(alert_id, opts)
|
|
578
|
+
p result
|
|
579
|
+
rescue PureCloud::ApiError => e
|
|
580
|
+
puts "Exception when calling AlertingApi->get_heartbeat_alerts_alert_id: #{e}"
|
|
581
|
+
end
|
|
582
|
+
~~~
|
|
583
|
+
|
|
584
|
+
### Parameters
|
|
585
|
+
|
|
586
|
+
Name | Type | Description | Notes
|
|
587
|
+
------------- | ------------- | ------------- | -------------
|
|
588
|
+
**alert_id** | **String**| Alert ID |
|
|
589
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
590
|
+
{: class="table table-striped"}
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
### Return type
|
|
594
|
+
|
|
595
|
+
[**HeartBeatAlert**](HeartBeatAlert.html)
|
|
596
|
+
|
|
597
|
+
### HTTP request headers
|
|
598
|
+
|
|
599
|
+
- **Content-Type**: application/json
|
|
600
|
+
- **Accept**: application/json
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
<a name="get_heartbeat_rules"></a>
|
|
605
|
+
|
|
606
|
+
## -[**HeartBeatRuleContainer**](HeartBeatRuleContainer.html) get_heartbeat_rules(opts)
|
|
607
|
+
|
|
608
|
+
Get a heart beat rule list.
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
### Example
|
|
613
|
+
~~~ruby
|
|
614
|
+
# load the gem
|
|
615
|
+
require 'purecloud'
|
|
616
|
+
# setup authorization
|
|
617
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
618
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
619
|
+
environment = "mypurecloud.com"
|
|
620
|
+
|
|
621
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
622
|
+
|
|
623
|
+
PureCloud.configure do |config|
|
|
624
|
+
config.access_token = @authToken
|
|
625
|
+
end
|
|
626
|
+
|
|
627
|
+
api_instance = PureCloud::AlertingApi.new
|
|
628
|
+
|
|
629
|
+
opts = {
|
|
630
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
begin
|
|
634
|
+
#Get a heart beat rule list.
|
|
635
|
+
result = api_instance.get_heartbeat_rules(opts)
|
|
636
|
+
p result
|
|
637
|
+
rescue PureCloud::ApiError => e
|
|
638
|
+
puts "Exception when calling AlertingApi->get_heartbeat_rules: #{e}"
|
|
639
|
+
end
|
|
640
|
+
~~~
|
|
641
|
+
|
|
642
|
+
### Parameters
|
|
643
|
+
|
|
644
|
+
Name | Type | Description | Notes
|
|
645
|
+
------------- | ------------- | ------------- | -------------
|
|
646
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
647
|
+
{: class="table table-striped"}
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
### Return type
|
|
651
|
+
|
|
652
|
+
[**HeartBeatRuleContainer**](HeartBeatRuleContainer.html)
|
|
653
|
+
|
|
654
|
+
### HTTP request headers
|
|
655
|
+
|
|
656
|
+
- **Content-Type**: application/json
|
|
657
|
+
- **Accept**: application/json
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
<a name="get_heartbeat_rules_rule_id"></a>
|
|
662
|
+
|
|
663
|
+
## -[**HeartBeatRule**](HeartBeatRule.html) get_heartbeat_rules_rule_id(rule_id, opts)
|
|
664
|
+
|
|
665
|
+
Get a heart beat rule.
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
### Example
|
|
670
|
+
~~~ruby
|
|
671
|
+
# load the gem
|
|
672
|
+
require 'purecloud'
|
|
673
|
+
# setup authorization
|
|
674
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
675
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
676
|
+
environment = "mypurecloud.com"
|
|
677
|
+
|
|
678
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
679
|
+
|
|
680
|
+
PureCloud.configure do |config|
|
|
681
|
+
config.access_token = @authToken
|
|
682
|
+
end
|
|
683
|
+
|
|
684
|
+
api_instance = PureCloud::AlertingApi.new
|
|
685
|
+
|
|
686
|
+
rule_id = "rule_id_example" # String | Rule ID
|
|
687
|
+
|
|
688
|
+
opts = {
|
|
689
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
690
|
+
}
|
|
691
|
+
|
|
692
|
+
begin
|
|
693
|
+
#Get a heart beat rule.
|
|
694
|
+
result = api_instance.get_heartbeat_rules_rule_id(rule_id, opts)
|
|
695
|
+
p result
|
|
696
|
+
rescue PureCloud::ApiError => e
|
|
697
|
+
puts "Exception when calling AlertingApi->get_heartbeat_rules_rule_id: #{e}"
|
|
698
|
+
end
|
|
699
|
+
~~~
|
|
700
|
+
|
|
701
|
+
### Parameters
|
|
702
|
+
|
|
703
|
+
Name | Type | Description | Notes
|
|
704
|
+
------------- | ------------- | ------------- | -------------
|
|
705
|
+
**rule_id** | **String**| Rule ID |
|
|
706
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
707
|
+
{: class="table table-striped"}
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
### Return type
|
|
711
|
+
|
|
712
|
+
[**HeartBeatRule**](HeartBeatRule.html)
|
|
713
|
+
|
|
714
|
+
### HTTP request headers
|
|
715
|
+
|
|
716
|
+
- **Content-Type**: application/json
|
|
717
|
+
- **Accept**: application/json
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
<a name="get_interactionstats_alerts"></a>
|
|
722
|
+
|
|
723
|
+
## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_interactionstats_alerts(opts)
|
|
724
|
+
|
|
725
|
+
Get interaction stats alert list.
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
### Example
|
|
730
|
+
~~~ruby
|
|
731
|
+
# load the gem
|
|
732
|
+
require 'purecloud'
|
|
733
|
+
# setup authorization
|
|
734
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
735
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
736
|
+
environment = "mypurecloud.com"
|
|
737
|
+
|
|
738
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
739
|
+
|
|
740
|
+
PureCloud.configure do |config|
|
|
741
|
+
config.access_token = @authToken
|
|
742
|
+
end
|
|
743
|
+
|
|
744
|
+
api_instance = PureCloud::AlertingApi.new
|
|
745
|
+
|
|
746
|
+
opts = {
|
|
747
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
begin
|
|
751
|
+
#Get interaction stats alert list.
|
|
752
|
+
result = api_instance.get_interactionstats_alerts(opts)
|
|
753
|
+
p result
|
|
754
|
+
rescue PureCloud::ApiError => e
|
|
755
|
+
puts "Exception when calling AlertingApi->get_interactionstats_alerts: #{e}"
|
|
756
|
+
end
|
|
757
|
+
~~~
|
|
758
|
+
|
|
759
|
+
### Parameters
|
|
760
|
+
|
|
761
|
+
Name | Type | Description | Notes
|
|
762
|
+
------------- | ------------- | ------------- | -------------
|
|
763
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
764
|
+
{: class="table table-striped"}
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
### Return type
|
|
768
|
+
|
|
769
|
+
[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html)
|
|
770
|
+
|
|
771
|
+
### HTTP request headers
|
|
772
|
+
|
|
773
|
+
- **Content-Type**: application/json
|
|
774
|
+
- **Accept**: application/json
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
<a name="get_interactionstats_alerts_alert_id"></a>
|
|
779
|
+
|
|
780
|
+
## -[**InteractionStatsAlert**](InteractionStatsAlert.html) get_interactionstats_alerts_alert_id(alert_id, opts)
|
|
781
|
+
|
|
782
|
+
Get an interaction stats alert
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
### Example
|
|
787
|
+
~~~ruby
|
|
788
|
+
# load the gem
|
|
789
|
+
require 'purecloud'
|
|
790
|
+
# setup authorization
|
|
791
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
792
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
793
|
+
environment = "mypurecloud.com"
|
|
794
|
+
|
|
795
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
796
|
+
|
|
797
|
+
PureCloud.configure do |config|
|
|
798
|
+
config.access_token = @authToken
|
|
799
|
+
end
|
|
800
|
+
|
|
801
|
+
api_instance = PureCloud::AlertingApi.new
|
|
802
|
+
|
|
803
|
+
alert_id = "alert_id_example" # String | Alert ID
|
|
804
|
+
|
|
805
|
+
opts = {
|
|
806
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
807
|
+
}
|
|
808
|
+
|
|
809
|
+
begin
|
|
810
|
+
#Get an interaction stats alert
|
|
811
|
+
result = api_instance.get_interactionstats_alerts_alert_id(alert_id, opts)
|
|
812
|
+
p result
|
|
813
|
+
rescue PureCloud::ApiError => e
|
|
814
|
+
puts "Exception when calling AlertingApi->get_interactionstats_alerts_alert_id: #{e}"
|
|
815
|
+
end
|
|
816
|
+
~~~
|
|
817
|
+
|
|
818
|
+
### Parameters
|
|
819
|
+
|
|
820
|
+
Name | Type | Description | Notes
|
|
821
|
+
------------- | ------------- | ------------- | -------------
|
|
822
|
+
**alert_id** | **String**| Alert ID |
|
|
823
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
824
|
+
{: class="table table-striped"}
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
### Return type
|
|
828
|
+
|
|
829
|
+
[**InteractionStatsAlert**](InteractionStatsAlert.html)
|
|
830
|
+
|
|
831
|
+
### HTTP request headers
|
|
832
|
+
|
|
833
|
+
- **Content-Type**: application/json
|
|
834
|
+
- **Accept**: application/json
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
<a name="get_interactionstats_alerts_unread"></a>
|
|
839
|
+
|
|
840
|
+
## -[**UnreadMetric**](UnreadMetric.html) get_interactionstats_alerts_unread
|
|
841
|
+
|
|
842
|
+
Gets user unread count of interaction stats alerts.
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
### Example
|
|
847
|
+
~~~ruby
|
|
848
|
+
# load the gem
|
|
849
|
+
require 'purecloud'
|
|
850
|
+
# setup authorization
|
|
851
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
852
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
853
|
+
environment = "mypurecloud.com"
|
|
854
|
+
|
|
855
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
856
|
+
|
|
857
|
+
PureCloud.configure do |config|
|
|
858
|
+
config.access_token = @authToken
|
|
859
|
+
end
|
|
860
|
+
|
|
861
|
+
api_instance = PureCloud::AlertingApi.new
|
|
862
|
+
|
|
863
|
+
begin
|
|
864
|
+
#Gets user unread count of interaction stats alerts.
|
|
865
|
+
result = api_instance.get_interactionstats_alerts_unread
|
|
866
|
+
p result
|
|
867
|
+
rescue PureCloud::ApiError => e
|
|
868
|
+
puts "Exception when calling AlertingApi->get_interactionstats_alerts_unread: #{e}"
|
|
869
|
+
end
|
|
870
|
+
~~~
|
|
871
|
+
|
|
872
|
+
### Parameters
|
|
873
|
+
This endpoint does not need any parameter.
|
|
874
|
+
{: class="table table-striped"}
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
### Return type
|
|
878
|
+
|
|
879
|
+
[**UnreadMetric**](UnreadMetric.html)
|
|
880
|
+
|
|
881
|
+
### HTTP request headers
|
|
882
|
+
|
|
883
|
+
- **Content-Type**: application/json
|
|
884
|
+
- **Accept**: application/json
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
<a name="get_interactionstats_rules"></a>
|
|
889
|
+
|
|
890
|
+
## -[**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html) get_interactionstats_rules(opts)
|
|
891
|
+
|
|
892
|
+
Get an interaction stats rule list.
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
### Example
|
|
897
|
+
~~~ruby
|
|
898
|
+
# load the gem
|
|
899
|
+
require 'purecloud'
|
|
900
|
+
# setup authorization
|
|
901
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
902
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
903
|
+
environment = "mypurecloud.com"
|
|
904
|
+
|
|
905
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
906
|
+
|
|
907
|
+
PureCloud.configure do |config|
|
|
908
|
+
config.access_token = @authToken
|
|
909
|
+
end
|
|
910
|
+
|
|
911
|
+
api_instance = PureCloud::AlertingApi.new
|
|
912
|
+
|
|
913
|
+
opts = {
|
|
914
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
915
|
+
}
|
|
916
|
+
|
|
917
|
+
begin
|
|
918
|
+
#Get an interaction stats rule list.
|
|
919
|
+
result = api_instance.get_interactionstats_rules(opts)
|
|
920
|
+
p result
|
|
921
|
+
rescue PureCloud::ApiError => e
|
|
922
|
+
puts "Exception when calling AlertingApi->get_interactionstats_rules: #{e}"
|
|
923
|
+
end
|
|
924
|
+
~~~
|
|
925
|
+
|
|
926
|
+
### Parameters
|
|
927
|
+
|
|
928
|
+
Name | Type | Description | Notes
|
|
929
|
+
------------- | ------------- | ------------- | -------------
|
|
930
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
931
|
+
{: class="table table-striped"}
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
### Return type
|
|
935
|
+
|
|
936
|
+
[**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html)
|
|
937
|
+
|
|
938
|
+
### HTTP request headers
|
|
939
|
+
|
|
940
|
+
- **Content-Type**: application/json
|
|
941
|
+
- **Accept**: application/json
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
<a name="get_interactionstats_rules_rule_id"></a>
|
|
946
|
+
|
|
947
|
+
## -[**InteractionStatsRule**](InteractionStatsRule.html) get_interactionstats_rules_rule_id(rule_id, opts)
|
|
948
|
+
|
|
949
|
+
Get an interaction stats rule.
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
### Example
|
|
954
|
+
~~~ruby
|
|
955
|
+
# load the gem
|
|
956
|
+
require 'purecloud'
|
|
957
|
+
# setup authorization
|
|
958
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
959
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
960
|
+
environment = "mypurecloud.com"
|
|
961
|
+
|
|
962
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
963
|
+
|
|
964
|
+
PureCloud.configure do |config|
|
|
965
|
+
config.access_token = @authToken
|
|
966
|
+
end
|
|
967
|
+
|
|
968
|
+
api_instance = PureCloud::AlertingApi.new
|
|
969
|
+
|
|
970
|
+
rule_id = "rule_id_example" # String | Rule ID
|
|
971
|
+
|
|
972
|
+
opts = {
|
|
973
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
974
|
+
}
|
|
975
|
+
|
|
976
|
+
begin
|
|
977
|
+
#Get an interaction stats rule.
|
|
978
|
+
result = api_instance.get_interactionstats_rules_rule_id(rule_id, opts)
|
|
979
|
+
p result
|
|
980
|
+
rescue PureCloud::ApiError => e
|
|
981
|
+
puts "Exception when calling AlertingApi->get_interactionstats_rules_rule_id: #{e}"
|
|
982
|
+
end
|
|
983
|
+
~~~
|
|
984
|
+
|
|
985
|
+
### Parameters
|
|
986
|
+
|
|
987
|
+
Name | Type | Description | Notes
|
|
988
|
+
------------- | ------------- | ------------- | -------------
|
|
989
|
+
**rule_id** | **String**| Rule ID |
|
|
990
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
991
|
+
{: class="table table-striped"}
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
### Return type
|
|
995
|
+
|
|
996
|
+
[**InteractionStatsRule**](InteractionStatsRule.html)
|
|
997
|
+
|
|
998
|
+
### HTTP request headers
|
|
999
|
+
|
|
1000
|
+
- **Content-Type**: application/json
|
|
1001
|
+
- **Accept**: application/json
|
|
254
1002
|
|
|
255
|
-
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
<a name="get_routingstatus_alerts"></a>
|
|
1006
|
+
|
|
1007
|
+
## -[**RoutingStatusAlertContainer**](RoutingStatusAlertContainer.html) get_routingstatus_alerts(opts)
|
|
1008
|
+
|
|
1009
|
+
Get routing status alert list.
|
|
256
1010
|
|
|
257
1011
|
|
|
258
1012
|
|
|
@@ -273,23 +1027,30 @@ end
|
|
|
273
1027
|
|
|
274
1028
|
api_instance = PureCloud::AlertingApi.new
|
|
275
1029
|
|
|
1030
|
+
opts = {
|
|
1031
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1032
|
+
}
|
|
1033
|
+
|
|
276
1034
|
begin
|
|
277
|
-
#Get
|
|
278
|
-
result = api_instance.
|
|
1035
|
+
#Get routing status alert list.
|
|
1036
|
+
result = api_instance.get_routingstatus_alerts(opts)
|
|
279
1037
|
p result
|
|
280
1038
|
rescue PureCloud::ApiError => e
|
|
281
|
-
puts "Exception when calling AlertingApi->
|
|
1039
|
+
puts "Exception when calling AlertingApi->get_routingstatus_alerts: #{e}"
|
|
282
1040
|
end
|
|
283
1041
|
~~~
|
|
284
1042
|
|
|
285
1043
|
### Parameters
|
|
286
|
-
|
|
1044
|
+
|
|
1045
|
+
Name | Type | Description | Notes
|
|
1046
|
+
------------- | ------------- | ------------- | -------------
|
|
1047
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
287
1048
|
{: class="table table-striped"}
|
|
288
1049
|
|
|
289
1050
|
|
|
290
1051
|
### Return type
|
|
291
1052
|
|
|
292
|
-
[**
|
|
1053
|
+
[**RoutingStatusAlertContainer**](RoutingStatusAlertContainer.html)
|
|
293
1054
|
|
|
294
1055
|
### HTTP request headers
|
|
295
1056
|
|
|
@@ -298,11 +1059,11 @@ This endpoint does not need any parameter.
|
|
|
298
1059
|
|
|
299
1060
|
|
|
300
1061
|
|
|
301
|
-
<a name="
|
|
1062
|
+
<a name="get_routingstatus_alerts_alert_id"></a>
|
|
302
1063
|
|
|
303
|
-
## -[**
|
|
1064
|
+
## -[**RoutingStatusAlert**](RoutingStatusAlert.html) get_routingstatus_alerts_alert_id(alert_id, opts)
|
|
304
1065
|
|
|
305
|
-
Get a
|
|
1066
|
+
Get a routing status alert
|
|
306
1067
|
|
|
307
1068
|
|
|
308
1069
|
|
|
@@ -325,13 +1086,16 @@ api_instance = PureCloud::AlertingApi.new
|
|
|
325
1086
|
|
|
326
1087
|
alert_id = "alert_id_example" # String | Alert ID
|
|
327
1088
|
|
|
1089
|
+
opts = {
|
|
1090
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1091
|
+
}
|
|
328
1092
|
|
|
329
1093
|
begin
|
|
330
|
-
#Get a
|
|
331
|
-
result = api_instance.
|
|
1094
|
+
#Get a routing status alert
|
|
1095
|
+
result = api_instance.get_routingstatus_alerts_alert_id(alert_id, opts)
|
|
332
1096
|
p result
|
|
333
1097
|
rescue PureCloud::ApiError => e
|
|
334
|
-
puts "Exception when calling AlertingApi->
|
|
1098
|
+
puts "Exception when calling AlertingApi->get_routingstatus_alerts_alert_id: #{e}"
|
|
335
1099
|
end
|
|
336
1100
|
~~~
|
|
337
1101
|
|
|
@@ -340,12 +1104,13 @@ end
|
|
|
340
1104
|
Name | Type | Description | Notes
|
|
341
1105
|
------------- | ------------- | ------------- | -------------
|
|
342
1106
|
**alert_id** | **String**| Alert ID |
|
|
1107
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
343
1108
|
{: class="table table-striped"}
|
|
344
1109
|
|
|
345
1110
|
|
|
346
1111
|
### Return type
|
|
347
1112
|
|
|
348
|
-
[**
|
|
1113
|
+
[**RoutingStatusAlert**](RoutingStatusAlert.html)
|
|
349
1114
|
|
|
350
1115
|
### HTTP request headers
|
|
351
1116
|
|
|
@@ -354,11 +1119,11 @@ Name | Type | Description | Notes
|
|
|
354
1119
|
|
|
355
1120
|
|
|
356
1121
|
|
|
357
|
-
<a name="
|
|
1122
|
+
<a name="get_routingstatus_rules"></a>
|
|
358
1123
|
|
|
359
|
-
## -[**
|
|
1124
|
+
## -[**RoutingStatusRuleContainer**](RoutingStatusRuleContainer.html) get_routingstatus_rules(opts)
|
|
360
1125
|
|
|
361
|
-
Get a
|
|
1126
|
+
Get a routing status rule list.
|
|
362
1127
|
|
|
363
1128
|
|
|
364
1129
|
|
|
@@ -379,23 +1144,30 @@ end
|
|
|
379
1144
|
|
|
380
1145
|
api_instance = PureCloud::AlertingApi.new
|
|
381
1146
|
|
|
1147
|
+
opts = {
|
|
1148
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1149
|
+
}
|
|
1150
|
+
|
|
382
1151
|
begin
|
|
383
|
-
#Get a
|
|
384
|
-
result = api_instance.
|
|
1152
|
+
#Get a routing status rule list.
|
|
1153
|
+
result = api_instance.get_routingstatus_rules(opts)
|
|
385
1154
|
p result
|
|
386
1155
|
rescue PureCloud::ApiError => e
|
|
387
|
-
puts "Exception when calling AlertingApi->
|
|
1156
|
+
puts "Exception when calling AlertingApi->get_routingstatus_rules: #{e}"
|
|
388
1157
|
end
|
|
389
1158
|
~~~
|
|
390
1159
|
|
|
391
1160
|
### Parameters
|
|
392
|
-
|
|
1161
|
+
|
|
1162
|
+
Name | Type | Description | Notes
|
|
1163
|
+
------------- | ------------- | ------------- | -------------
|
|
1164
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
393
1165
|
{: class="table table-striped"}
|
|
394
1166
|
|
|
395
1167
|
|
|
396
1168
|
### Return type
|
|
397
1169
|
|
|
398
|
-
[**
|
|
1170
|
+
[**RoutingStatusRuleContainer**](RoutingStatusRuleContainer.html)
|
|
399
1171
|
|
|
400
1172
|
### HTTP request headers
|
|
401
1173
|
|
|
@@ -404,11 +1176,11 @@ This endpoint does not need any parameter.
|
|
|
404
1176
|
|
|
405
1177
|
|
|
406
1178
|
|
|
407
|
-
<a name="
|
|
1179
|
+
<a name="get_routingstatus_rules_rule_id"></a>
|
|
408
1180
|
|
|
409
|
-
## -[**
|
|
1181
|
+
## -[**RoutingStatusRule**](RoutingStatusRule.html) get_routingstatus_rules_rule_id(rule_id, opts)
|
|
410
1182
|
|
|
411
|
-
Get a
|
|
1183
|
+
Get a routing status rule.
|
|
412
1184
|
|
|
413
1185
|
|
|
414
1186
|
|
|
@@ -431,13 +1203,16 @@ api_instance = PureCloud::AlertingApi.new
|
|
|
431
1203
|
|
|
432
1204
|
rule_id = "rule_id_example" # String | Rule ID
|
|
433
1205
|
|
|
1206
|
+
opts = {
|
|
1207
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1208
|
+
}
|
|
434
1209
|
|
|
435
1210
|
begin
|
|
436
|
-
#Get a
|
|
437
|
-
result = api_instance.
|
|
1211
|
+
#Get a routing status rule.
|
|
1212
|
+
result = api_instance.get_routingstatus_rules_rule_id(rule_id, opts)
|
|
438
1213
|
p result
|
|
439
1214
|
rescue PureCloud::ApiError => e
|
|
440
|
-
puts "Exception when calling AlertingApi->
|
|
1215
|
+
puts "Exception when calling AlertingApi->get_routingstatus_rules_rule_id: #{e}"
|
|
441
1216
|
end
|
|
442
1217
|
~~~
|
|
443
1218
|
|
|
@@ -446,12 +1221,13 @@ end
|
|
|
446
1221
|
Name | Type | Description | Notes
|
|
447
1222
|
------------- | ------------- | ------------- | -------------
|
|
448
1223
|
**rule_id** | **String**| Rule ID |
|
|
1224
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
449
1225
|
{: class="table table-striped"}
|
|
450
1226
|
|
|
451
1227
|
|
|
452
1228
|
### Return type
|
|
453
1229
|
|
|
454
|
-
[**
|
|
1230
|
+
[**RoutingStatusRule**](RoutingStatusRule.html)
|
|
455
1231
|
|
|
456
1232
|
### HTTP request headers
|
|
457
1233
|
|
|
@@ -460,11 +1236,11 @@ Name | Type | Description | Notes
|
|
|
460
1236
|
|
|
461
1237
|
|
|
462
1238
|
|
|
463
|
-
<a name="
|
|
1239
|
+
<a name="get_userpresence_alerts"></a>
|
|
464
1240
|
|
|
465
|
-
## -[**
|
|
1241
|
+
## -[**UserPresenceAlertContainer**](UserPresenceAlertContainer.html) get_userpresence_alerts(opts)
|
|
466
1242
|
|
|
467
|
-
Get
|
|
1243
|
+
Get user presence alert list.
|
|
468
1244
|
|
|
469
1245
|
|
|
470
1246
|
|
|
@@ -485,23 +1261,30 @@ end
|
|
|
485
1261
|
|
|
486
1262
|
api_instance = PureCloud::AlertingApi.new
|
|
487
1263
|
|
|
1264
|
+
opts = {
|
|
1265
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1266
|
+
}
|
|
1267
|
+
|
|
488
1268
|
begin
|
|
489
|
-
#Get
|
|
490
|
-
result = api_instance.
|
|
1269
|
+
#Get user presence alert list.
|
|
1270
|
+
result = api_instance.get_userpresence_alerts(opts)
|
|
491
1271
|
p result
|
|
492
1272
|
rescue PureCloud::ApiError => e
|
|
493
|
-
puts "Exception when calling AlertingApi->
|
|
1273
|
+
puts "Exception when calling AlertingApi->get_userpresence_alerts: #{e}"
|
|
494
1274
|
end
|
|
495
1275
|
~~~
|
|
496
1276
|
|
|
497
1277
|
### Parameters
|
|
498
|
-
|
|
1278
|
+
|
|
1279
|
+
Name | Type | Description | Notes
|
|
1280
|
+
------------- | ------------- | ------------- | -------------
|
|
1281
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
499
1282
|
{: class="table table-striped"}
|
|
500
1283
|
|
|
501
1284
|
|
|
502
1285
|
### Return type
|
|
503
1286
|
|
|
504
|
-
[**
|
|
1287
|
+
[**UserPresenceAlertContainer**](UserPresenceAlertContainer.html)
|
|
505
1288
|
|
|
506
1289
|
### HTTP request headers
|
|
507
1290
|
|
|
@@ -510,11 +1293,11 @@ This endpoint does not need any parameter.
|
|
|
510
1293
|
|
|
511
1294
|
|
|
512
1295
|
|
|
513
|
-
<a name="
|
|
1296
|
+
<a name="get_userpresence_alerts_alert_id"></a>
|
|
514
1297
|
|
|
515
|
-
## -[**
|
|
1298
|
+
## -[**UserPresenceAlert**](UserPresenceAlert.html) get_userpresence_alerts_alert_id(alert_id, opts)
|
|
516
1299
|
|
|
517
|
-
Get
|
|
1300
|
+
Get a user presence alert
|
|
518
1301
|
|
|
519
1302
|
|
|
520
1303
|
|
|
@@ -537,13 +1320,16 @@ api_instance = PureCloud::AlertingApi.new
|
|
|
537
1320
|
|
|
538
1321
|
alert_id = "alert_id_example" # String | Alert ID
|
|
539
1322
|
|
|
1323
|
+
opts = {
|
|
1324
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1325
|
+
}
|
|
540
1326
|
|
|
541
1327
|
begin
|
|
542
|
-
#Get
|
|
543
|
-
result = api_instance.
|
|
1328
|
+
#Get a user presence alert
|
|
1329
|
+
result = api_instance.get_userpresence_alerts_alert_id(alert_id, opts)
|
|
544
1330
|
p result
|
|
545
1331
|
rescue PureCloud::ApiError => e
|
|
546
|
-
puts "Exception when calling AlertingApi->
|
|
1332
|
+
puts "Exception when calling AlertingApi->get_userpresence_alerts_alert_id: #{e}"
|
|
547
1333
|
end
|
|
548
1334
|
~~~
|
|
549
1335
|
|
|
@@ -552,12 +1338,13 @@ end
|
|
|
552
1338
|
Name | Type | Description | Notes
|
|
553
1339
|
------------- | ------------- | ------------- | -------------
|
|
554
1340
|
**alert_id** | **String**| Alert ID |
|
|
1341
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
555
1342
|
{: class="table table-striped"}
|
|
556
1343
|
|
|
557
1344
|
|
|
558
1345
|
### Return type
|
|
559
1346
|
|
|
560
|
-
[**
|
|
1347
|
+
[**UserPresenceAlert**](UserPresenceAlert.html)
|
|
561
1348
|
|
|
562
1349
|
### HTTP request headers
|
|
563
1350
|
|
|
@@ -566,11 +1353,11 @@ Name | Type | Description | Notes
|
|
|
566
1353
|
|
|
567
1354
|
|
|
568
1355
|
|
|
569
|
-
<a name="
|
|
1356
|
+
<a name="get_userpresence_rules"></a>
|
|
570
1357
|
|
|
571
|
-
## -[**
|
|
1358
|
+
## -[**UserPresenceRuleContainer**](UserPresenceRuleContainer.html) get_userpresence_rules(opts)
|
|
572
1359
|
|
|
573
|
-
|
|
1360
|
+
Get a user presence rule list.
|
|
574
1361
|
|
|
575
1362
|
|
|
576
1363
|
|
|
@@ -591,23 +1378,30 @@ end
|
|
|
591
1378
|
|
|
592
1379
|
api_instance = PureCloud::AlertingApi.new
|
|
593
1380
|
|
|
1381
|
+
opts = {
|
|
1382
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1383
|
+
}
|
|
1384
|
+
|
|
594
1385
|
begin
|
|
595
|
-
#
|
|
596
|
-
result = api_instance.
|
|
1386
|
+
#Get a user presence rule list.
|
|
1387
|
+
result = api_instance.get_userpresence_rules(opts)
|
|
597
1388
|
p result
|
|
598
1389
|
rescue PureCloud::ApiError => e
|
|
599
|
-
puts "Exception when calling AlertingApi->
|
|
1390
|
+
puts "Exception when calling AlertingApi->get_userpresence_rules: #{e}"
|
|
600
1391
|
end
|
|
601
1392
|
~~~
|
|
602
1393
|
|
|
603
1394
|
### Parameters
|
|
604
|
-
|
|
1395
|
+
|
|
1396
|
+
Name | Type | Description | Notes
|
|
1397
|
+
------------- | ------------- | ------------- | -------------
|
|
1398
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
605
1399
|
{: class="table table-striped"}
|
|
606
1400
|
|
|
607
1401
|
|
|
608
1402
|
### Return type
|
|
609
1403
|
|
|
610
|
-
[**
|
|
1404
|
+
[**UserPresenceRuleContainer**](UserPresenceRuleContainer.html)
|
|
611
1405
|
|
|
612
1406
|
### HTTP request headers
|
|
613
1407
|
|
|
@@ -616,11 +1410,11 @@ This endpoint does not need any parameter.
|
|
|
616
1410
|
|
|
617
1411
|
|
|
618
1412
|
|
|
619
|
-
<a name="
|
|
1413
|
+
<a name="get_userpresence_rules_rule_id"></a>
|
|
620
1414
|
|
|
621
|
-
## -[**
|
|
1415
|
+
## -[**UserPresenceRule**](UserPresenceRule.html) get_userpresence_rules_rule_id(rule_id, opts)
|
|
622
1416
|
|
|
623
|
-
Get
|
|
1417
|
+
Get a user presence rule.
|
|
624
1418
|
|
|
625
1419
|
|
|
626
1420
|
|
|
@@ -641,23 +1435,33 @@ end
|
|
|
641
1435
|
|
|
642
1436
|
api_instance = PureCloud::AlertingApi.new
|
|
643
1437
|
|
|
1438
|
+
rule_id = "rule_id_example" # String | Rule ID
|
|
1439
|
+
|
|
1440
|
+
opts = {
|
|
1441
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1442
|
+
}
|
|
1443
|
+
|
|
644
1444
|
begin
|
|
645
|
-
#Get
|
|
646
|
-
result = api_instance.
|
|
1445
|
+
#Get a user presence rule.
|
|
1446
|
+
result = api_instance.get_userpresence_rules_rule_id(rule_id, opts)
|
|
647
1447
|
p result
|
|
648
1448
|
rescue PureCloud::ApiError => e
|
|
649
|
-
puts "Exception when calling AlertingApi->
|
|
1449
|
+
puts "Exception when calling AlertingApi->get_userpresence_rules_rule_id: #{e}"
|
|
650
1450
|
end
|
|
651
1451
|
~~~
|
|
652
1452
|
|
|
653
1453
|
### Parameters
|
|
654
|
-
|
|
1454
|
+
|
|
1455
|
+
Name | Type | Description | Notes
|
|
1456
|
+
------------- | ------------- | ------------- | -------------
|
|
1457
|
+
**rule_id** | **String**| Rule ID |
|
|
1458
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
655
1459
|
{: class="table table-striped"}
|
|
656
1460
|
|
|
657
1461
|
|
|
658
1462
|
### Return type
|
|
659
1463
|
|
|
660
|
-
[**
|
|
1464
|
+
[**UserPresenceRule**](UserPresenceRule.html)
|
|
661
1465
|
|
|
662
1466
|
### HTTP request headers
|
|
663
1467
|
|
|
@@ -666,11 +1470,11 @@ This endpoint does not need any parameter.
|
|
|
666
1470
|
|
|
667
1471
|
|
|
668
1472
|
|
|
669
|
-
<a name="
|
|
1473
|
+
<a name="post_heartbeat_rules"></a>
|
|
670
1474
|
|
|
671
|
-
## -[**
|
|
1475
|
+
## -[**HeartBeatRule**](HeartBeatRule.html) post_heartbeat_rules(body, opts)
|
|
672
1476
|
|
|
673
|
-
|
|
1477
|
+
Create a heart beat rule.
|
|
674
1478
|
|
|
675
1479
|
|
|
676
1480
|
|
|
@@ -691,15 +1495,18 @@ end
|
|
|
691
1495
|
|
|
692
1496
|
api_instance = PureCloud::AlertingApi.new
|
|
693
1497
|
|
|
694
|
-
|
|
1498
|
+
body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule
|
|
695
1499
|
|
|
1500
|
+
opts = {
|
|
1501
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1502
|
+
}
|
|
696
1503
|
|
|
697
1504
|
begin
|
|
698
|
-
#
|
|
699
|
-
result = api_instance.
|
|
1505
|
+
#Create a heart beat rule.
|
|
1506
|
+
result = api_instance.post_heartbeat_rules(body, opts)
|
|
700
1507
|
p result
|
|
701
1508
|
rescue PureCloud::ApiError => e
|
|
702
|
-
puts "Exception when calling AlertingApi->
|
|
1509
|
+
puts "Exception when calling AlertingApi->post_heartbeat_rules: #{e}"
|
|
703
1510
|
end
|
|
704
1511
|
~~~
|
|
705
1512
|
|
|
@@ -707,7 +1514,68 @@ end
|
|
|
707
1514
|
|
|
708
1515
|
Name | Type | Description | Notes
|
|
709
1516
|
------------- | ------------- | ------------- | -------------
|
|
710
|
-
**
|
|
1517
|
+
**body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule |
|
|
1518
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
1519
|
+
{: class="table table-striped"}
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
### Return type
|
|
1523
|
+
|
|
1524
|
+
[**HeartBeatRule**](HeartBeatRule.html)
|
|
1525
|
+
|
|
1526
|
+
### HTTP request headers
|
|
1527
|
+
|
|
1528
|
+
- **Content-Type**: application/json
|
|
1529
|
+
- **Accept**: application/json
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
<a name="post_interactionstats_rules"></a>
|
|
1534
|
+
|
|
1535
|
+
## -[**InteractionStatsRule**](InteractionStatsRule.html) post_interactionstats_rules(body, opts)
|
|
1536
|
+
|
|
1537
|
+
Create an interaction stats rule.
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
### Example
|
|
1542
|
+
~~~ruby
|
|
1543
|
+
# load the gem
|
|
1544
|
+
require 'purecloud'
|
|
1545
|
+
# setup authorization
|
|
1546
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1547
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1548
|
+
environment = "mypurecloud.com"
|
|
1549
|
+
|
|
1550
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1551
|
+
|
|
1552
|
+
PureCloud.configure do |config|
|
|
1553
|
+
config.access_token = @authToken
|
|
1554
|
+
end
|
|
1555
|
+
|
|
1556
|
+
api_instance = PureCloud::AlertingApi.new
|
|
1557
|
+
|
|
1558
|
+
body = PureCloud::InteractionStatsRule.new # InteractionStatsRule | AlertingRule
|
|
1559
|
+
|
|
1560
|
+
opts = {
|
|
1561
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1562
|
+
}
|
|
1563
|
+
|
|
1564
|
+
begin
|
|
1565
|
+
#Create an interaction stats rule.
|
|
1566
|
+
result = api_instance.post_interactionstats_rules(body, opts)
|
|
1567
|
+
p result
|
|
1568
|
+
rescue PureCloud::ApiError => e
|
|
1569
|
+
puts "Exception when calling AlertingApi->post_interactionstats_rules: #{e}"
|
|
1570
|
+
end
|
|
1571
|
+
~~~
|
|
1572
|
+
|
|
1573
|
+
### Parameters
|
|
1574
|
+
|
|
1575
|
+
Name | Type | Description | Notes
|
|
1576
|
+
------------- | ------------- | ------------- | -------------
|
|
1577
|
+
**body** | [**InteractionStatsRule**](InteractionStatsRule.html)| AlertingRule |
|
|
1578
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
711
1579
|
{: class="table table-striped"}
|
|
712
1580
|
|
|
713
1581
|
|
|
@@ -722,11 +1590,11 @@ Name | Type | Description | Notes
|
|
|
722
1590
|
|
|
723
1591
|
|
|
724
1592
|
|
|
725
|
-
<a name="
|
|
1593
|
+
<a name="post_routingstatus_rules"></a>
|
|
726
1594
|
|
|
727
|
-
## -[**
|
|
1595
|
+
## -[**RoutingStatusRule**](RoutingStatusRule.html) post_routingstatus_rules(body, opts)
|
|
728
1596
|
|
|
729
|
-
Create a
|
|
1597
|
+
Create a routing status rule.
|
|
730
1598
|
|
|
731
1599
|
|
|
732
1600
|
|
|
@@ -747,15 +1615,18 @@ end
|
|
|
747
1615
|
|
|
748
1616
|
api_instance = PureCloud::AlertingApi.new
|
|
749
1617
|
|
|
750
|
-
body = PureCloud::
|
|
1618
|
+
body = PureCloud::RoutingStatusRule.new # RoutingStatusRule | RoutingStatusRule
|
|
751
1619
|
|
|
1620
|
+
opts = {
|
|
1621
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1622
|
+
}
|
|
752
1623
|
|
|
753
1624
|
begin
|
|
754
|
-
#Create a
|
|
755
|
-
result = api_instance.
|
|
1625
|
+
#Create a routing status rule.
|
|
1626
|
+
result = api_instance.post_routingstatus_rules(body, opts)
|
|
756
1627
|
p result
|
|
757
1628
|
rescue PureCloud::ApiError => e
|
|
758
|
-
puts "Exception when calling AlertingApi->
|
|
1629
|
+
puts "Exception when calling AlertingApi->post_routingstatus_rules: #{e}"
|
|
759
1630
|
end
|
|
760
1631
|
~~~
|
|
761
1632
|
|
|
@@ -763,13 +1634,14 @@ end
|
|
|
763
1634
|
|
|
764
1635
|
Name | Type | Description | Notes
|
|
765
1636
|
------------- | ------------- | ------------- | -------------
|
|
766
|
-
**body** | [**
|
|
1637
|
+
**body** | [**RoutingStatusRule**](RoutingStatusRule.html)| RoutingStatusRule |
|
|
1638
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
767
1639
|
{: class="table table-striped"}
|
|
768
1640
|
|
|
769
1641
|
|
|
770
1642
|
### Return type
|
|
771
1643
|
|
|
772
|
-
[**
|
|
1644
|
+
[**RoutingStatusRule**](RoutingStatusRule.html)
|
|
773
1645
|
|
|
774
1646
|
### HTTP request headers
|
|
775
1647
|
|
|
@@ -778,11 +1650,11 @@ Name | Type | Description | Notes
|
|
|
778
1650
|
|
|
779
1651
|
|
|
780
1652
|
|
|
781
|
-
<a name="
|
|
1653
|
+
<a name="post_userpresence_rules"></a>
|
|
782
1654
|
|
|
783
|
-
## -[**
|
|
1655
|
+
## -[**UserPresenceRule**](UserPresenceRule.html) post_userpresence_rules(body, opts)
|
|
784
1656
|
|
|
785
|
-
Create
|
|
1657
|
+
Create a user presence rule.
|
|
786
1658
|
|
|
787
1659
|
|
|
788
1660
|
|
|
@@ -803,15 +1675,18 @@ end
|
|
|
803
1675
|
|
|
804
1676
|
api_instance = PureCloud::AlertingApi.new
|
|
805
1677
|
|
|
806
|
-
body = PureCloud::
|
|
1678
|
+
body = PureCloud::UserPresenceRule.new # UserPresenceRule | UserPresenceRule
|
|
807
1679
|
|
|
1680
|
+
opts = {
|
|
1681
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1682
|
+
}
|
|
808
1683
|
|
|
809
1684
|
begin
|
|
810
|
-
#Create
|
|
811
|
-
result = api_instance.
|
|
1685
|
+
#Create a user presence rule.
|
|
1686
|
+
result = api_instance.post_userpresence_rules(body, opts)
|
|
812
1687
|
p result
|
|
813
1688
|
rescue PureCloud::ApiError => e
|
|
814
|
-
puts "Exception when calling AlertingApi->
|
|
1689
|
+
puts "Exception when calling AlertingApi->post_userpresence_rules: #{e}"
|
|
815
1690
|
end
|
|
816
1691
|
~~~
|
|
817
1692
|
|
|
@@ -819,13 +1694,14 @@ end
|
|
|
819
1694
|
|
|
820
1695
|
Name | Type | Description | Notes
|
|
821
1696
|
------------- | ------------- | ------------- | -------------
|
|
822
|
-
**body** | [**
|
|
1697
|
+
**body** | [**UserPresenceRule**](UserPresenceRule.html)| UserPresenceRule |
|
|
1698
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
823
1699
|
{: class="table table-striped"}
|
|
824
1700
|
|
|
825
1701
|
|
|
826
1702
|
### Return type
|
|
827
1703
|
|
|
828
|
-
[**
|
|
1704
|
+
[**UserPresenceRule**](UserPresenceRule.html)
|
|
829
1705
|
|
|
830
1706
|
### HTTP request headers
|
|
831
1707
|
|
|
@@ -836,7 +1712,7 @@ Name | Type | Description | Notes
|
|
|
836
1712
|
|
|
837
1713
|
<a name="put_heartbeat_rules_rule_id"></a>
|
|
838
1714
|
|
|
839
|
-
## -[**HeartBeatRule**](HeartBeatRule.html) put_heartbeat_rules_rule_id(rule_id, body)
|
|
1715
|
+
## -[**HeartBeatRule**](HeartBeatRule.html) put_heartbeat_rules_rule_id(rule_id, body, opts)
|
|
840
1716
|
|
|
841
1717
|
Update a heart beat rule
|
|
842
1718
|
|
|
@@ -863,10 +1739,13 @@ rule_id = "rule_id_example" # String | Rule ID
|
|
|
863
1739
|
|
|
864
1740
|
body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule
|
|
865
1741
|
|
|
1742
|
+
opts = {
|
|
1743
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1744
|
+
}
|
|
866
1745
|
|
|
867
1746
|
begin
|
|
868
1747
|
#Update a heart beat rule
|
|
869
|
-
result = api_instance.put_heartbeat_rules_rule_id(rule_id, body)
|
|
1748
|
+
result = api_instance.put_heartbeat_rules_rule_id(rule_id, body, opts)
|
|
870
1749
|
p result
|
|
871
1750
|
rescue PureCloud::ApiError => e
|
|
872
1751
|
puts "Exception when calling AlertingApi->put_heartbeat_rules_rule_id: #{e}"
|
|
@@ -879,6 +1758,7 @@ Name | Type | Description | Notes
|
|
|
879
1758
|
------------- | ------------- | ------------- | -------------
|
|
880
1759
|
**rule_id** | **String**| Rule ID |
|
|
881
1760
|
**body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule |
|
|
1761
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
882
1762
|
{: class="table table-striped"}
|
|
883
1763
|
|
|
884
1764
|
|
|
@@ -895,7 +1775,7 @@ Name | Type | Description | Notes
|
|
|
895
1775
|
|
|
896
1776
|
<a name="put_interactionstats_alerts_alert_id"></a>
|
|
897
1777
|
|
|
898
|
-
## -[**UnreadStatus**](UnreadStatus.html) put_interactionstats_alerts_alert_id(alert_id, body)
|
|
1778
|
+
## -[**UnreadStatus**](UnreadStatus.html) put_interactionstats_alerts_alert_id(alert_id, body, opts)
|
|
899
1779
|
|
|
900
1780
|
Update an interaction stats alert read status
|
|
901
1781
|
|
|
@@ -922,10 +1802,13 @@ alert_id = "alert_id_example" # String | Alert ID
|
|
|
922
1802
|
|
|
923
1803
|
body = PureCloud::UnreadStatus.new # UnreadStatus | InteractionStatsAlert
|
|
924
1804
|
|
|
1805
|
+
opts = {
|
|
1806
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1807
|
+
}
|
|
925
1808
|
|
|
926
1809
|
begin
|
|
927
1810
|
#Update an interaction stats alert read status
|
|
928
|
-
result = api_instance.put_interactionstats_alerts_alert_id(alert_id, body)
|
|
1811
|
+
result = api_instance.put_interactionstats_alerts_alert_id(alert_id, body, opts)
|
|
929
1812
|
p result
|
|
930
1813
|
rescue PureCloud::ApiError => e
|
|
931
1814
|
puts "Exception when calling AlertingApi->put_interactionstats_alerts_alert_id: #{e}"
|
|
@@ -938,6 +1821,7 @@ Name | Type | Description | Notes
|
|
|
938
1821
|
------------- | ------------- | ------------- | -------------
|
|
939
1822
|
**alert_id** | **String**| Alert ID |
|
|
940
1823
|
**body** | [**UnreadStatus**](UnreadStatus.html)| InteractionStatsAlert |
|
|
1824
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
941
1825
|
{: class="table table-striped"}
|
|
942
1826
|
|
|
943
1827
|
|
|
@@ -954,7 +1838,7 @@ Name | Type | Description | Notes
|
|
|
954
1838
|
|
|
955
1839
|
<a name="put_interactionstats_rules_rule_id"></a>
|
|
956
1840
|
|
|
957
|
-
## -[**InteractionStatsRule**](InteractionStatsRule.html) put_interactionstats_rules_rule_id(rule_id, body)
|
|
1841
|
+
## -[**InteractionStatsRule**](InteractionStatsRule.html) put_interactionstats_rules_rule_id(rule_id, body, opts)
|
|
958
1842
|
|
|
959
1843
|
Update an interaction stats rule
|
|
960
1844
|
|
|
@@ -981,10 +1865,13 @@ rule_id = "rule_id_example" # String | Rule ID
|
|
|
981
1865
|
|
|
982
1866
|
body = PureCloud::InteractionStatsRule.new # InteractionStatsRule | AlertingRule
|
|
983
1867
|
|
|
1868
|
+
opts = {
|
|
1869
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1870
|
+
}
|
|
984
1871
|
|
|
985
1872
|
begin
|
|
986
1873
|
#Update an interaction stats rule
|
|
987
|
-
result = api_instance.put_interactionstats_rules_rule_id(rule_id, body)
|
|
1874
|
+
result = api_instance.put_interactionstats_rules_rule_id(rule_id, body, opts)
|
|
988
1875
|
p result
|
|
989
1876
|
rescue PureCloud::ApiError => e
|
|
990
1877
|
puts "Exception when calling AlertingApi->put_interactionstats_rules_rule_id: #{e}"
|
|
@@ -997,6 +1884,7 @@ Name | Type | Description | Notes
|
|
|
997
1884
|
------------- | ------------- | ------------- | -------------
|
|
998
1885
|
**rule_id** | **String**| Rule ID |
|
|
999
1886
|
**body** | [**InteractionStatsRule**](InteractionStatsRule.html)| AlertingRule |
|
|
1887
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
1000
1888
|
{: class="table table-striped"}
|
|
1001
1889
|
|
|
1002
1890
|
|
|
@@ -1011,3 +1899,129 @@ Name | Type | Description | Notes
|
|
|
1011
1899
|
|
|
1012
1900
|
|
|
1013
1901
|
|
|
1902
|
+
<a name="put_routingstatus_rules_rule_id"></a>
|
|
1903
|
+
|
|
1904
|
+
## -[**RoutingStatusRule**](RoutingStatusRule.html) put_routingstatus_rules_rule_id(rule_id, body, opts)
|
|
1905
|
+
|
|
1906
|
+
Update a routing status rule
|
|
1907
|
+
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
### Example
|
|
1911
|
+
~~~ruby
|
|
1912
|
+
# load the gem
|
|
1913
|
+
require 'purecloud'
|
|
1914
|
+
# setup authorization
|
|
1915
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1916
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1917
|
+
environment = "mypurecloud.com"
|
|
1918
|
+
|
|
1919
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1920
|
+
|
|
1921
|
+
PureCloud.configure do |config|
|
|
1922
|
+
config.access_token = @authToken
|
|
1923
|
+
end
|
|
1924
|
+
|
|
1925
|
+
api_instance = PureCloud::AlertingApi.new
|
|
1926
|
+
|
|
1927
|
+
rule_id = "rule_id_example" # String | Rule ID
|
|
1928
|
+
|
|
1929
|
+
body = PureCloud::RoutingStatusRule.new # RoutingStatusRule | RoutingStatusRule
|
|
1930
|
+
|
|
1931
|
+
opts = {
|
|
1932
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1933
|
+
}
|
|
1934
|
+
|
|
1935
|
+
begin
|
|
1936
|
+
#Update a routing status rule
|
|
1937
|
+
result = api_instance.put_routingstatus_rules_rule_id(rule_id, body, opts)
|
|
1938
|
+
p result
|
|
1939
|
+
rescue PureCloud::ApiError => e
|
|
1940
|
+
puts "Exception when calling AlertingApi->put_routingstatus_rules_rule_id: #{e}"
|
|
1941
|
+
end
|
|
1942
|
+
~~~
|
|
1943
|
+
|
|
1944
|
+
### Parameters
|
|
1945
|
+
|
|
1946
|
+
Name | Type | Description | Notes
|
|
1947
|
+
------------- | ------------- | ------------- | -------------
|
|
1948
|
+
**rule_id** | **String**| Rule ID |
|
|
1949
|
+
**body** | [**RoutingStatusRule**](RoutingStatusRule.html)| RoutingStatusRule |
|
|
1950
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
1951
|
+
{: class="table table-striped"}
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
### Return type
|
|
1955
|
+
|
|
1956
|
+
[**RoutingStatusRule**](RoutingStatusRule.html)
|
|
1957
|
+
|
|
1958
|
+
### HTTP request headers
|
|
1959
|
+
|
|
1960
|
+
- **Content-Type**: application/json
|
|
1961
|
+
- **Accept**: application/json
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
|
|
1965
|
+
<a name="put_userpresence_rules_rule_id"></a>
|
|
1966
|
+
|
|
1967
|
+
## -[**UserPresenceRule**](UserPresenceRule.html) put_userpresence_rules_rule_id(rule_id, body, opts)
|
|
1968
|
+
|
|
1969
|
+
Update a user presence rule
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
### Example
|
|
1974
|
+
~~~ruby
|
|
1975
|
+
# load the gem
|
|
1976
|
+
require 'purecloud'
|
|
1977
|
+
# setup authorization
|
|
1978
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1979
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1980
|
+
environment = "mypurecloud.com"
|
|
1981
|
+
|
|
1982
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1983
|
+
|
|
1984
|
+
PureCloud.configure do |config|
|
|
1985
|
+
config.access_token = @authToken
|
|
1986
|
+
end
|
|
1987
|
+
|
|
1988
|
+
api_instance = PureCloud::AlertingApi.new
|
|
1989
|
+
|
|
1990
|
+
rule_id = "rule_id_example" # String | Rule ID
|
|
1991
|
+
|
|
1992
|
+
body = PureCloud::UserPresenceRule.new # UserPresenceRule | UserPresenceRule
|
|
1993
|
+
|
|
1994
|
+
opts = {
|
|
1995
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1996
|
+
}
|
|
1997
|
+
|
|
1998
|
+
begin
|
|
1999
|
+
#Update a user presence rule
|
|
2000
|
+
result = api_instance.put_userpresence_rules_rule_id(rule_id, body, opts)
|
|
2001
|
+
p result
|
|
2002
|
+
rescue PureCloud::ApiError => e
|
|
2003
|
+
puts "Exception when calling AlertingApi->put_userpresence_rules_rule_id: #{e}"
|
|
2004
|
+
end
|
|
2005
|
+
~~~
|
|
2006
|
+
|
|
2007
|
+
### Parameters
|
|
2008
|
+
|
|
2009
|
+
Name | Type | Description | Notes
|
|
2010
|
+
------------- | ------------- | ------------- | -------------
|
|
2011
|
+
**rule_id** | **String**| Rule ID |
|
|
2012
|
+
**body** | [**UserPresenceRule**](UserPresenceRule.html)| UserPresenceRule |
|
|
2013
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
2014
|
+
{: class="table table-striped"}
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
### Return type
|
|
2018
|
+
|
|
2019
|
+
[**UserPresenceRule**](UserPresenceRule.html)
|
|
2020
|
+
|
|
2021
|
+
### HTTP request headers
|
|
2022
|
+
|
|
2023
|
+
- **Content-Type**: application/json
|
|
2024
|
+
- **Accept**: application/json
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
|