purecloudplatformclientv2 12.0.0 → 13.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (270) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AgentActivityEntityListing.md +2 -2
  4. data/docs/AlertingApi.md +78 -1575
  5. data/docs/ArchitectApi.md +75 -0
  6. data/docs/AttemptLimitsEntityListing.md +2 -2
  7. data/docs/AttributeEntityListing.md +2 -2
  8. data/docs/CalibrationEntityListing.md +2 -2
  9. data/docs/CallConversationEntityListing.md +2 -2
  10. data/docs/CallableTimeSetEntityListing.md +2 -2
  11. data/docs/CallbackConversationEntityListing.md +2 -2
  12. data/docs/CampaignEntityListing.md +2 -2
  13. data/docs/CampaignRuleEntityListing.md +2 -2
  14. data/docs/CampaignSequenceEntityListing.md +2 -2
  15. data/docs/CertificateAuthorityEntityListing.md +2 -2
  16. data/docs/ChatConversationEntityListing.md +2 -2
  17. data/docs/CobrowseConversationEntityListing.md +2 -2
  18. data/docs/CommandStatusEntityListing.md +2 -2
  19. data/docs/ConsumedResourcesEntityListing.md +2 -2
  20. data/docs/ConsumingResourcesEntityListing.md +2 -2
  21. data/docs/ContactListEntityListing.md +2 -2
  22. data/docs/ContactListFilterEntityListing.md +2 -2
  23. data/docs/ContactListing.md +2 -2
  24. data/docs/ConversationEntityListing.md +2 -2
  25. data/docs/DIDEntityListing.md +2 -2
  26. data/docs/DIDPoolEntityListing.md +2 -2
  27. data/docs/DependencyObjectEntityListing.md +2 -2
  28. data/docs/DependencyTypeEntityListing.md +2 -2
  29. data/docs/DialerEventEntityListing.md +2 -2
  30. data/docs/DncListEntityListing.md +2 -2
  31. data/docs/DocumentAuditEntityListing.md +2 -2
  32. data/docs/DocumentEntityListing.md +2 -2
  33. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
  34. data/docs/DomainEntityListing.md +2 -2
  35. data/docs/DomainEntityListingEvaluationForm.md +2 -2
  36. data/docs/DomainEntityListingQueryResult.md +2 -2
  37. data/docs/EdgeEntityListing.md +2 -2
  38. data/docs/EdgeGroupEntityListing.md +2 -2
  39. data/docs/EdgeLineEntityListing.md +2 -2
  40. data/docs/EmailConversationEntityListing.md +2 -2
  41. data/docs/EmailMessageListing.md +2 -2
  42. data/docs/EncryptionKeyEntityListing.md +2 -2
  43. data/docs/EndpointEntityListing.md +2 -2
  44. data/docs/EvaluationEntityListing.md +2 -2
  45. data/docs/EvaluationFormEntityListing.md +2 -2
  46. data/docs/EvaluatorActivityEntityListing.md +2 -2
  47. data/docs/ExtensionEntityListing.md +2 -2
  48. data/docs/ExtensionPoolEntityListing.md +2 -2
  49. data/docs/ExternalContactsApi.md +2 -0
  50. data/docs/ExternalOrganizationListing.md +2 -2
  51. data/docs/FaxDocumentEntityListing.md +2 -2
  52. data/docs/FlowEntityListing.md +2 -2
  53. data/docs/FlowVersionEntityListing.md +2 -2
  54. data/docs/GreetingListing.md +2 -2
  55. data/docs/GroupEntityListing.md +2 -2
  56. data/docs/HistoryEntry.md +17 -0
  57. data/docs/HistoryListing.md +21 -0
  58. data/docs/InboundDomain.md +1 -1
  59. data/docs/InboundDomainEntityListing.md +2 -2
  60. data/docs/InboundRouteEntityListing.md +2 -2
  61. data/docs/InteractionStatsAlertContainer.md +2 -2
  62. data/docs/InteractionStatsRuleContainer.md +2 -2
  63. data/docs/KeywordSetEntityListing.md +2 -2
  64. data/docs/LanguageEntityListing.md +2 -2
  65. data/docs/LibraryEntityListing.md +2 -2
  66. data/docs/LineBaseEntityListing.md +2 -2
  67. data/docs/LineEntityListing.md +2 -2
  68. data/docs/LocationEntityListing.md +2 -2
  69. data/docs/LogicalInterfaceEntityListing.md +2 -2
  70. data/docs/NoteListing.md +2 -2
  71. data/docs/OAuthClientEntityListing.md +2 -2
  72. data/docs/OAuthProviderEntityListing.md +2 -2
  73. data/docs/OrganizationPresenceEntityListing.md +2 -2
  74. data/docs/OrganizationRoleEntityListing.md +2 -2
  75. data/docs/OrphanRecordingListing.md +2 -2
  76. data/docs/OutboundApi.md +2 -2
  77. data/docs/OutboundRouteBaseEntityListing.md +2 -2
  78. data/docs/OutboundRouteEntityListing.md +2 -2
  79. data/docs/PermissionCollectionEntityListing.md +2 -2
  80. data/docs/PhoneBaseEntityListing.md +2 -2
  81. data/docs/PhoneEntityListing.md +2 -2
  82. data/docs/PhoneMetaBaseEntityListing.md +2 -2
  83. data/docs/PhysicalInterfaceEntityListing.md +2 -2
  84. data/docs/PolicyEntityListing.md +2 -2
  85. data/docs/PromptAssetEntityListing.md +2 -2
  86. data/docs/PromptEntityListing.md +2 -2
  87. data/docs/QualityAuditPage.md +2 -2
  88. data/docs/QueueEntityListing.md +2 -2
  89. data/docs/QueueMemberEntityListing.md +2 -2
  90. data/docs/RelationshipListing.md +2 -2
  91. data/docs/ReportMetaDataEntityListing.md +2 -2
  92. data/docs/ReportRunEntryEntityDomainListing.md +2 -2
  93. data/docs/ReportScheduleEntityListing.md +2 -2
  94. data/docs/ResponseEntityList.md +2 -2
  95. data/docs/ResponseEntityListing.md +2 -2
  96. data/docs/ResponseSetEntityListing.md +2 -2
  97. data/docs/RuleSetEntityListing.md +2 -2
  98. data/docs/SchemaCategoryEntityListing.md +2 -2
  99. data/docs/SchemaReferenceEntityListing.md +2 -2
  100. data/docs/ScreenRecordingSessionListing.md +2 -2
  101. data/docs/ScriptEntityListing.md +2 -2
  102. data/docs/SecurityProfileEntityListing.md +2 -2
  103. data/docs/ShareEntityListing.md +2 -2
  104. data/docs/SiteEntityListing.md +2 -2
  105. data/docs/SkillEntityListing.md +2 -2
  106. data/docs/StationEntityListing.md +2 -2
  107. data/docs/SystemPromptAssetEntityListing.md +2 -2
  108. data/docs/SystemPromptEntityListing.md +2 -2
  109. data/docs/TagValueEntityListing.md +2 -2
  110. data/docs/TimeZoneEntityListing.md +2 -2
  111. data/docs/TrunkBaseEntityListing.md +2 -2
  112. data/docs/TrunkEntityListing.md +2 -2
  113. data/docs/TrunkMetabaseEntityListing.md +2 -2
  114. data/docs/UserEntityListing.md +2 -2
  115. data/docs/UserQueueEntityListing.md +2 -2
  116. data/docs/UserRecordingEntityListing.md +2 -2
  117. data/docs/UserSkillEntityListing.md +2 -2
  118. data/docs/Voicemail.md +1 -0
  119. data/docs/VoicemailMessageEntityListing.md +2 -2
  120. data/docs/WorkspaceEntityListing.md +2 -2
  121. data/docs/WorkspaceMemberEntityListing.md +2 -2
  122. data/docs/WrapupCodeEntityListing.md +2 -2
  123. data/lib/purecloudplatformclientv2.rb +2 -12
  124. data/lib/purecloudplatformclientv2/api/alerting_api.rb +133 -1819
  125. data/lib/purecloudplatformclientv2/api/architect_api.rb +124 -0
  126. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +9 -0
  127. data/lib/purecloudplatformclientv2/api/outbound_api.rb +2 -2
  128. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +25 -25
  129. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +25 -25
  130. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +25 -25
  131. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +25 -25
  132. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +25 -25
  133. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +25 -25
  134. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +25 -25
  135. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +25 -25
  136. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +25 -25
  137. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +25 -25
  138. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +25 -25
  139. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +25 -25
  140. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +25 -25
  141. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +25 -25
  142. data/lib/purecloudplatformclientv2/models/condition.rb +2 -2
  143. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +25 -25
  144. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +25 -25
  145. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +25 -25
  146. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +25 -25
  147. data/lib/purecloudplatformclientv2/models/contact_listing.rb +25 -25
  148. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +25 -25
  149. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +25 -25
  150. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +25 -25
  151. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +25 -25
  152. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +25 -25
  153. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +25 -25
  154. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +25 -25
  155. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +25 -25
  156. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +25 -25
  157. data/lib/purecloudplatformclientv2/models/documentation_search_criteria.rb +2 -2
  158. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +25 -25
  159. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +25 -25
  160. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +25 -25
  161. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +25 -25
  162. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +25 -25
  163. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +25 -25
  164. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +25 -25
  165. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +25 -25
  166. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +25 -25
  167. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +25 -25
  168. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +25 -25
  169. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +25 -25
  170. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +25 -25
  171. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +25 -25
  172. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +25 -25
  173. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +25 -25
  174. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +25 -25
  175. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +25 -25
  176. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +25 -25
  177. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +25 -25
  178. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +25 -25
  179. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +25 -25
  180. data/lib/purecloudplatformclientv2/models/{heart_beat_alert_container.rb → history_entry.rb} +48 -159
  181. data/lib/purecloudplatformclientv2/models/{heart_beat_rule_container.rb → history_listing.rb} +27 -52
  182. data/lib/purecloudplatformclientv2/models/inbound_domain.rb +1 -1
  183. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +25 -25
  184. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +25 -25
  185. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +25 -25
  186. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +25 -25
  187. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +25 -25
  188. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +25 -25
  189. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +25 -25
  190. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +25 -25
  191. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +25 -25
  192. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +25 -25
  193. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +25 -25
  194. data/lib/purecloudplatformclientv2/models/note_listing.rb +25 -25
  195. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +25 -25
  196. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +25 -25
  197. data/lib/purecloudplatformclientv2/models/operation.rb +2 -2
  198. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +25 -25
  199. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +25 -25
  200. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +25 -25
  201. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +25 -25
  202. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +25 -25
  203. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +25 -25
  204. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +25 -25
  205. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +25 -25
  206. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +25 -25
  207. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +25 -25
  208. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +25 -25
  209. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +25 -25
  210. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +25 -25
  211. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +25 -25
  212. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +25 -25
  213. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +25 -25
  214. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +25 -25
  215. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +25 -25
  216. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +25 -25
  217. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +25 -25
  218. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +25 -25
  219. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +25 -25
  220. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +25 -25
  221. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +25 -25
  222. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +25 -25
  223. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +25 -25
  224. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +25 -25
  225. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +25 -25
  226. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +25 -25
  227. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +25 -25
  228. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +25 -25
  229. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +25 -25
  230. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +25 -25
  231. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +25 -25
  232. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +25 -25
  233. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +25 -25
  234. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +25 -25
  235. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +25 -25
  236. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +25 -25
  237. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +25 -25
  238. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +25 -25
  239. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +25 -25
  240. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +25 -25
  241. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +25 -25
  242. data/lib/purecloudplatformclientv2/models/voicemail.rb +44 -4
  243. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +25 -25
  244. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +25 -25
  245. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +25 -25
  246. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +25 -25
  247. data/lib/purecloudplatformclientv2/version.rb +1 -1
  248. metadata +6 -26
  249. data/docs/HeartBeatAlert.md +0 -24
  250. data/docs/HeartBeatAlertContainer.md +0 -22
  251. data/docs/HeartBeatRule.md +0 -22
  252. data/docs/HeartBeatRuleContainer.md +0 -22
  253. data/docs/RoutingStatusAlert.md +0 -23
  254. data/docs/RoutingStatusAlertContainer.md +0 -22
  255. data/docs/RoutingStatusRule.md +0 -22
  256. data/docs/RoutingStatusRuleContainer.md +0 -22
  257. data/docs/UserPresenceAlert.md +0 -25
  258. data/docs/UserPresenceAlertContainer.md +0 -22
  259. data/docs/UserPresenceRule.md +0 -23
  260. data/docs/UserPresenceRuleContainer.md +0 -22
  261. data/lib/purecloudplatformclientv2/models/heart_beat_alert.rb +0 -545
  262. data/lib/purecloudplatformclientv2/models/heart_beat_rule.rb +0 -489
  263. data/lib/purecloudplatformclientv2/models/routing_status_alert.rb +0 -520
  264. data/lib/purecloudplatformclientv2/models/routing_status_alert_container.rb +0 -428
  265. data/lib/purecloudplatformclientv2/models/routing_status_rule.rb +0 -489
  266. data/lib/purecloudplatformclientv2/models/routing_status_rule_container.rb +0 -428
  267. data/lib/purecloudplatformclientv2/models/user_presence_alert.rb +0 -576
  268. data/lib/purecloudplatformclientv2/models/user_presence_alert_container.rb +0 -428
  269. data/lib/purecloudplatformclientv2/models/user_presence_rule.rb +0 -520
  270. data/lib/purecloudplatformclientv2/models/user_presence_rule_container.rb +0 -428
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: bde0c5d99e033a79bd4e04e746027d7373516fd5
4
- data.tar.gz: 06af94a0572d11b8810bf1310b109756209a530d
3
+ metadata.gz: 3e1729cc42116f79251f41a6ee79716def7f8b5d
4
+ data.tar.gz: b39e93d20bb000a7279b49efc37938a7e7684478
5
5
  SHA512:
6
- metadata.gz: c1a060be46276fb44dd93fecb882f1bfc6915790e26fb46a48578a6574da8d1fccdd64216547b0bed51a993576dbb2be5025af9872ffe522561a4ccc198eaaa1
7
- data.tar.gz: ffc5601aaf893df2f5d40c27f186cdf9d83683098b35c13d9581d9abbff6e4a25ba50c54a96ebcb306fca32139bfb8d6e6e6178dc8a9e0284ab39eba7cb63bcf
6
+ metadata.gz: 22e76c3a76e01815d66dc93dfae899f782d475fa7b638d12c1adb7898ba7f0c24c7e545daaa41b494e9b5fd1526d9511915e84dc1061af0d8170cffdb6387ef7
7
+ data.tar.gz: e35b0e0730294c02e4383545fb42c9deabbe913ccc471b8a0c406336d130972de4739a5e82cbcd52091a5d75fbb218ca3903fa817b624224860e6b70aa14b007
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: PureCloud Ruby Gem
3
3
  ---
4
- ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=12.0.0)
4
+ ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=13.0.0)
5
5
 
6
6
  Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
7
7
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
10
10
  ### from rubygems.org
11
11
 
12
12
  ~~~ ruby
13
- gem install 'purecloudplatformclientv2', '~> 12.0.0'
13
+ gem install 'purecloudplatformclientv2', '~> 13.0.0'
14
14
  ~~~
15
15
 
16
16
  ### Install from Git
@@ -39,10 +39,10 @@ alert_id = "alert_id_example" # String | Alert ID
39
39
 
40
40
 
41
41
  begin
42
- #Delete a heart beat alert
43
- api_instance.delete_alerting_heartbeat_alert(alert_id)
42
+ #Delete an interaction stats alert
43
+ api_instance.delete_alerting_interactionstats_alert(alert_id)
44
44
  rescue PureCloud::ApiError => e
45
- puts "Exception when calling AlertingApi->delete_alerting_heartbeat_alert: #{e}"
45
+ puts "Exception when calling AlertingApi->delete_alerting_interactionstats_alert: #{e}"
46
46
  end
47
47
 
48
48
  ~~~
@@ -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
- | **first_uri** | **String** | | [optional] |
16
14
  | **previous_uri** | **String** | | [optional] |
17
15
  | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **self_uri** | **String** | | [optional] |
18
+ | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/AlertingApi.md CHANGED
@@ -8,1369 +8,27 @@ All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
9
  Method | Description
10
10
  ------------- | ------------- | -------------
11
- [**delete_alerting_heartbeat_alert**](AlertingApi.html#delete_alerting_heartbeat_alert) | Delete a heart beat alert
12
- [**delete_alerting_heartbeat_rule**](AlertingApi.html#delete_alerting_heartbeat_rule) | Delete a heart beat rule.
13
11
  [**delete_alerting_interactionstats_alert**](AlertingApi.html#delete_alerting_interactionstats_alert) | Delete an interaction stats alert
14
12
  [**delete_alerting_interactionstats_rule**](AlertingApi.html#delete_alerting_interactionstats_rule) | Delete an interaction stats rule.
15
- [**delete_alerting_routingstatus_alert**](AlertingApi.html#delete_alerting_routingstatus_alert) | Delete a routing status alert
16
- [**delete_alerting_routingstatus_rule**](AlertingApi.html#delete_alerting_routingstatus_rule) | Delete a routing status rule.
17
- [**delete_alerting_userpresence_alert**](AlertingApi.html#delete_alerting_userpresence_alert) | Delete a user presence alert
18
- [**delete_alerting_userpresence_rule**](AlertingApi.html#delete_alerting_userpresence_rule) | Delete a user presence rule.
19
- [**get_alerting_heartbeat_alert**](AlertingApi.html#get_alerting_heartbeat_alert) | Get a heart beat alert
20
- [**get_alerting_heartbeat_alerts**](AlertingApi.html#get_alerting_heartbeat_alerts) | Get heart beat alert list.
21
- [**get_alerting_heartbeat_rule**](AlertingApi.html#get_alerting_heartbeat_rule) | Get a heart beat rule.
22
- [**get_alerting_heartbeat_rules**](AlertingApi.html#get_alerting_heartbeat_rules) | Get a heart beat rule list.
23
13
  [**get_alerting_interactionstats_alert**](AlertingApi.html#get_alerting_interactionstats_alert) | Get an interaction stats alert
24
14
  [**get_alerting_interactionstats_alerts**](AlertingApi.html#get_alerting_interactionstats_alerts) | Get interaction stats alert list.
25
15
  [**get_alerting_interactionstats_alerts_unread**](AlertingApi.html#get_alerting_interactionstats_alerts_unread) | Gets user unread count of interaction stats alerts.
26
16
  [**get_alerting_interactionstats_rule**](AlertingApi.html#get_alerting_interactionstats_rule) | Get an interaction stats rule.
27
17
  [**get_alerting_interactionstats_rules**](AlertingApi.html#get_alerting_interactionstats_rules) | Get an interaction stats rule list.
28
- [**get_alerting_routingstatus_alert**](AlertingApi.html#get_alerting_routingstatus_alert) | Get a routing status alert
29
- [**get_alerting_routingstatus_alerts**](AlertingApi.html#get_alerting_routingstatus_alerts) | Get routing status alert list.
30
- [**get_alerting_routingstatus_rule**](AlertingApi.html#get_alerting_routingstatus_rule) | Get a routing status rule.
31
- [**get_alerting_routingstatus_rules**](AlertingApi.html#get_alerting_routingstatus_rules) | Get a routing status rule list.
32
- [**get_alerting_userpresence_alert**](AlertingApi.html#get_alerting_userpresence_alert) | Get a user presence alert
33
- [**get_alerting_userpresence_alerts**](AlertingApi.html#get_alerting_userpresence_alerts) | Get user presence alert list.
34
- [**get_alerting_userpresence_rule**](AlertingApi.html#get_alerting_userpresence_rule) | Get a user presence rule.
35
- [**get_alerting_userpresence_rules**](AlertingApi.html#get_alerting_userpresence_rules) | Get a user presence rule list.
36
- [**post_alerting_heartbeat_rules**](AlertingApi.html#post_alerting_heartbeat_rules) | Create a heart beat rule.
37
18
  [**post_alerting_interactionstats_rules**](AlertingApi.html#post_alerting_interactionstats_rules) | Create an interaction stats rule.
38
- [**post_alerting_routingstatus_rules**](AlertingApi.html#post_alerting_routingstatus_rules) | Create a routing status rule.
39
- [**post_alerting_userpresence_rules**](AlertingApi.html#post_alerting_userpresence_rules) | Create a user presence rule.
40
- [**put_alerting_heartbeat_rule**](AlertingApi.html#put_alerting_heartbeat_rule) | Update a heart beat rule
41
19
  [**put_alerting_interactionstats_alert**](AlertingApi.html#put_alerting_interactionstats_alert) | Update an interaction stats alert read status
42
20
  [**put_alerting_interactionstats_rule**](AlertingApi.html#put_alerting_interactionstats_rule) | Update an interaction stats rule
43
- [**put_alerting_routingstatus_rule**](AlertingApi.html#put_alerting_routingstatus_rule) | Update a routing status rule
44
- [**put_alerting_userpresence_rule**](AlertingApi.html#put_alerting_userpresence_rule) | Update a user presence rule
45
21
  {: class="table table-striped"}
46
22
 
47
- <a name="delete_alerting_heartbeat_alert"></a>
48
-
49
- ## - delete_alerting_heartbeat_alert(alert_id)
50
-
51
- Delete a heart beat alert
52
-
53
-
54
-
55
- Wraps DELETE /api/v2/alerting/heartbeat/alerts/{alertId}
56
-
57
-
58
- ### Example
59
- ~~~ruby
60
- # load the gem
61
- require 'purecloudplatformclientv2'
62
- # setup authorization
63
- @secret = ENV['PURECLOUD_SECRET']
64
- @id = ENV['PURECLOUD_CLIENT_ID']
65
- environment = "mypurecloud.com"
66
-
67
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
68
-
69
- PureCloud.configure do |config|
70
- config.access_token = @authToken
71
- end
72
-
73
- api_instance = PureCloud::AlertingApi.new
74
-
75
- alert_id = "alert_id_example" # String | Alert ID
76
-
77
-
78
- begin
79
- #Delete a heart beat alert
80
- api_instance.delete_alerting_heartbeat_alert(alert_id)
81
- rescue PureCloud::ApiError => e
82
- puts "Exception when calling AlertingApi->delete_alerting_heartbeat_alert: #{e}"
83
- end
84
- ~~~
85
-
86
- ### Parameters
87
-
88
- Name | Type | Description | Notes
89
- ------------- | ------------- | ------------- | -------------
90
- **alert_id** | **String**| Alert ID | |
91
- {: class="table table-striped"}
92
-
93
-
94
- ### Return type
95
-
96
- nil (empty response body)
97
-
98
- ### HTTP request headers
99
-
100
- - **Content-Type**: application/json
101
- - **Accept**: application/json
102
-
103
-
104
-
105
- <a name="delete_alerting_heartbeat_rule"></a>
106
-
107
- ## - delete_alerting_heartbeat_rule(rule_id)
108
-
109
- Delete a heart beat rule.
110
-
111
-
112
-
113
- Wraps DELETE /api/v2/alerting/heartbeat/rules/{ruleId}
114
-
115
-
116
- ### Example
117
- ~~~ruby
118
- # load the gem
119
- require 'purecloudplatformclientv2'
120
- # setup authorization
121
- @secret = ENV['PURECLOUD_SECRET']
122
- @id = ENV['PURECLOUD_CLIENT_ID']
123
- environment = "mypurecloud.com"
124
-
125
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
126
-
127
- PureCloud.configure do |config|
128
- config.access_token = @authToken
129
- end
130
-
131
- api_instance = PureCloud::AlertingApi.new
132
-
133
- rule_id = "rule_id_example" # String | Rule ID
134
-
135
-
136
- begin
137
- #Delete a heart beat rule.
138
- api_instance.delete_alerting_heartbeat_rule(rule_id)
139
- rescue PureCloud::ApiError => e
140
- puts "Exception when calling AlertingApi->delete_alerting_heartbeat_rule: #{e}"
141
- end
142
- ~~~
143
-
144
- ### Parameters
145
-
146
- Name | Type | Description | Notes
147
- ------------- | ------------- | ------------- | -------------
148
- **rule_id** | **String**| Rule ID | |
149
- {: class="table table-striped"}
150
-
151
-
152
- ### Return type
153
-
154
- nil (empty response body)
155
-
156
- ### HTTP request headers
157
-
158
- - **Content-Type**: application/json
159
- - **Accept**: application/json
160
-
161
-
162
-
163
- <a name="delete_alerting_interactionstats_alert"></a>
164
-
165
- ## - delete_alerting_interactionstats_alert(alert_id)
166
-
167
- Delete an interaction stats alert
168
-
169
-
170
-
171
- Wraps DELETE /api/v2/alerting/interactionstats/alerts/{alertId}
172
-
173
-
174
- ### Example
175
- ~~~ruby
176
- # load the gem
177
- require 'purecloudplatformclientv2'
178
- # setup authorization
179
- @secret = ENV['PURECLOUD_SECRET']
180
- @id = ENV['PURECLOUD_CLIENT_ID']
181
- environment = "mypurecloud.com"
182
-
183
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
184
-
185
- PureCloud.configure do |config|
186
- config.access_token = @authToken
187
- end
188
-
189
- api_instance = PureCloud::AlertingApi.new
190
-
191
- alert_id = "alert_id_example" # String | Alert ID
192
-
193
-
194
- begin
195
- #Delete an interaction stats alert
196
- api_instance.delete_alerting_interactionstats_alert(alert_id)
197
- rescue PureCloud::ApiError => e
198
- puts "Exception when calling AlertingApi->delete_alerting_interactionstats_alert: #{e}"
199
- end
200
- ~~~
201
-
202
- ### Parameters
203
-
204
- Name | Type | Description | Notes
205
- ------------- | ------------- | ------------- | -------------
206
- **alert_id** | **String**| Alert ID | |
207
- {: class="table table-striped"}
208
-
209
-
210
- ### Return type
211
-
212
- nil (empty response body)
213
-
214
- ### HTTP request headers
215
-
216
- - **Content-Type**: application/json
217
- - **Accept**: application/json
218
-
219
-
220
-
221
- <a name="delete_alerting_interactionstats_rule"></a>
222
-
223
- ## - delete_alerting_interactionstats_rule(rule_id)
224
-
225
- Delete an interaction stats rule.
226
-
227
-
228
-
229
- Wraps DELETE /api/v2/alerting/interactionstats/rules/{ruleId}
230
-
231
-
232
- ### Example
233
- ~~~ruby
234
- # load the gem
235
- require 'purecloudplatformclientv2'
236
- # setup authorization
237
- @secret = ENV['PURECLOUD_SECRET']
238
- @id = ENV['PURECLOUD_CLIENT_ID']
239
- environment = "mypurecloud.com"
240
-
241
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
242
-
243
- PureCloud.configure do |config|
244
- config.access_token = @authToken
245
- end
246
-
247
- api_instance = PureCloud::AlertingApi.new
248
-
249
- rule_id = "rule_id_example" # String | Rule ID
250
-
251
-
252
- begin
253
- #Delete an interaction stats rule.
254
- api_instance.delete_alerting_interactionstats_rule(rule_id)
255
- rescue PureCloud::ApiError => e
256
- puts "Exception when calling AlertingApi->delete_alerting_interactionstats_rule: #{e}"
257
- end
258
- ~~~
259
-
260
- ### Parameters
261
-
262
- Name | Type | Description | Notes
263
- ------------- | ------------- | ------------- | -------------
264
- **rule_id** | **String**| Rule ID | |
265
- {: class="table table-striped"}
266
-
267
-
268
- ### Return type
269
-
270
- nil (empty response body)
271
-
272
- ### HTTP request headers
273
-
274
- - **Content-Type**: application/json
275
- - **Accept**: application/json
276
-
277
-
278
-
279
- <a name="delete_alerting_routingstatus_alert"></a>
280
-
281
- ## - delete_alerting_routingstatus_alert(alert_id)
282
-
283
- Delete a routing status alert
284
-
285
-
286
-
287
- Wraps DELETE /api/v2/alerting/routingstatus/alerts/{alertId}
288
-
289
-
290
- ### Example
291
- ~~~ruby
292
- # load the gem
293
- require 'purecloudplatformclientv2'
294
- # setup authorization
295
- @secret = ENV['PURECLOUD_SECRET']
296
- @id = ENV['PURECLOUD_CLIENT_ID']
297
- environment = "mypurecloud.com"
298
-
299
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
300
-
301
- PureCloud.configure do |config|
302
- config.access_token = @authToken
303
- end
304
-
305
- api_instance = PureCloud::AlertingApi.new
306
-
307
- alert_id = "alert_id_example" # String | Alert ID
308
-
309
-
310
- begin
311
- #Delete a routing status alert
312
- api_instance.delete_alerting_routingstatus_alert(alert_id)
313
- rescue PureCloud::ApiError => e
314
- puts "Exception when calling AlertingApi->delete_alerting_routingstatus_alert: #{e}"
315
- end
316
- ~~~
317
-
318
- ### Parameters
319
-
320
- Name | Type | Description | Notes
321
- ------------- | ------------- | ------------- | -------------
322
- **alert_id** | **String**| Alert ID | |
323
- {: class="table table-striped"}
324
-
325
-
326
- ### Return type
327
-
328
- nil (empty response body)
329
-
330
- ### HTTP request headers
331
-
332
- - **Content-Type**: application/json
333
- - **Accept**: application/json
334
-
335
-
336
-
337
- <a name="delete_alerting_routingstatus_rule"></a>
338
-
339
- ## - delete_alerting_routingstatus_rule(rule_id)
340
-
341
- Delete a routing status rule.
342
-
343
-
344
-
345
- Wraps DELETE /api/v2/alerting/routingstatus/rules/{ruleId}
346
-
347
-
348
- ### Example
349
- ~~~ruby
350
- # load the gem
351
- require 'purecloudplatformclientv2'
352
- # setup authorization
353
- @secret = ENV['PURECLOUD_SECRET']
354
- @id = ENV['PURECLOUD_CLIENT_ID']
355
- environment = "mypurecloud.com"
356
-
357
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
358
-
359
- PureCloud.configure do |config|
360
- config.access_token = @authToken
361
- end
362
-
363
- api_instance = PureCloud::AlertingApi.new
364
-
365
- rule_id = "rule_id_example" # String | Rule ID
366
-
367
-
368
- begin
369
- #Delete a routing status rule.
370
- api_instance.delete_alerting_routingstatus_rule(rule_id)
371
- rescue PureCloud::ApiError => e
372
- puts "Exception when calling AlertingApi->delete_alerting_routingstatus_rule: #{e}"
373
- end
374
- ~~~
375
-
376
- ### Parameters
377
-
378
- Name | Type | Description | Notes
379
- ------------- | ------------- | ------------- | -------------
380
- **rule_id** | **String**| Rule ID | |
381
- {: class="table table-striped"}
382
-
383
-
384
- ### Return type
385
-
386
- nil (empty response body)
387
-
388
- ### HTTP request headers
389
-
390
- - **Content-Type**: application/json
391
- - **Accept**: application/json
392
-
393
-
394
-
395
- <a name="delete_alerting_userpresence_alert"></a>
396
-
397
- ## - delete_alerting_userpresence_alert(alert_id)
398
-
399
- Delete a user presence alert
400
-
401
-
402
-
403
- Wraps DELETE /api/v2/alerting/userpresence/alerts/{alertId}
404
-
405
-
406
- ### Example
407
- ~~~ruby
408
- # load the gem
409
- require 'purecloudplatformclientv2'
410
- # setup authorization
411
- @secret = ENV['PURECLOUD_SECRET']
412
- @id = ENV['PURECLOUD_CLIENT_ID']
413
- environment = "mypurecloud.com"
414
-
415
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
416
-
417
- PureCloud.configure do |config|
418
- config.access_token = @authToken
419
- end
420
-
421
- api_instance = PureCloud::AlertingApi.new
422
-
423
- alert_id = "alert_id_example" # String | Alert ID
424
-
425
-
426
- begin
427
- #Delete a user presence alert
428
- api_instance.delete_alerting_userpresence_alert(alert_id)
429
- rescue PureCloud::ApiError => e
430
- puts "Exception when calling AlertingApi->delete_alerting_userpresence_alert: #{e}"
431
- end
432
- ~~~
433
-
434
- ### Parameters
435
-
436
- Name | Type | Description | Notes
437
- ------------- | ------------- | ------------- | -------------
438
- **alert_id** | **String**| Alert ID | |
439
- {: class="table table-striped"}
440
-
441
-
442
- ### Return type
443
-
444
- nil (empty response body)
445
-
446
- ### HTTP request headers
447
-
448
- - **Content-Type**: application/json
449
- - **Accept**: application/json
450
-
451
-
452
-
453
- <a name="delete_alerting_userpresence_rule"></a>
454
-
455
- ## - delete_alerting_userpresence_rule(rule_id)
456
-
457
- Delete a user presence rule.
458
-
459
-
460
-
461
- Wraps DELETE /api/v2/alerting/userpresence/rules/{ruleId}
462
-
463
-
464
- ### Example
465
- ~~~ruby
466
- # load the gem
467
- require 'purecloudplatformclientv2'
468
- # setup authorization
469
- @secret = ENV['PURECLOUD_SECRET']
470
- @id = ENV['PURECLOUD_CLIENT_ID']
471
- environment = "mypurecloud.com"
472
-
473
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
474
-
475
- PureCloud.configure do |config|
476
- config.access_token = @authToken
477
- end
478
-
479
- api_instance = PureCloud::AlertingApi.new
480
-
481
- rule_id = "rule_id_example" # String | Rule ID
482
-
483
-
484
- begin
485
- #Delete a user presence rule.
486
- api_instance.delete_alerting_userpresence_rule(rule_id)
487
- rescue PureCloud::ApiError => e
488
- puts "Exception when calling AlertingApi->delete_alerting_userpresence_rule: #{e}"
489
- end
490
- ~~~
491
-
492
- ### Parameters
493
-
494
- Name | Type | Description | Notes
495
- ------------- | ------------- | ------------- | -------------
496
- **rule_id** | **String**| Rule ID | |
497
- {: class="table table-striped"}
498
-
499
-
500
- ### Return type
501
-
502
- nil (empty response body)
503
-
504
- ### HTTP request headers
505
-
506
- - **Content-Type**: application/json
507
- - **Accept**: application/json
508
-
509
-
510
-
511
- <a name="get_alerting_heartbeat_alert"></a>
512
-
513
- ## -[**HeartBeatAlert**](HeartBeatAlert.html) get_alerting_heartbeat_alert(alert_id, opts)
514
-
515
- Get a heart beat alert
516
-
517
-
518
-
519
- Wraps GET /api/v2/alerting/heartbeat/alerts/{alertId}
520
-
521
-
522
- ### Example
523
- ~~~ruby
524
- # load the gem
525
- require 'purecloudplatformclientv2'
526
- # setup authorization
527
- @secret = ENV['PURECLOUD_SECRET']
528
- @id = ENV['PURECLOUD_CLIENT_ID']
529
- environment = "mypurecloud.com"
530
-
531
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
532
-
533
- PureCloud.configure do |config|
534
- config.access_token = @authToken
535
- end
536
-
537
- api_instance = PureCloud::AlertingApi.new
538
-
539
- alert_id = "alert_id_example" # String | Alert ID
540
-
541
- opts = {
542
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
543
- }
544
-
545
- begin
546
- #Get a heart beat alert
547
- result = api_instance.get_alerting_heartbeat_alert(alert_id, opts)
548
- p result
549
- rescue PureCloud::ApiError => e
550
- puts "Exception when calling AlertingApi->get_alerting_heartbeat_alert: #{e}"
551
- end
552
- ~~~
553
-
554
- ### Parameters
555
-
556
- Name | Type | Description | Notes
557
- ------------- | ------------- | ------------- | -------------
558
- **alert_id** | **String**| Alert ID | |
559
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
560
- {: class="table table-striped"}
561
-
562
-
563
- ### Return type
564
-
565
- [**HeartBeatAlert**](HeartBeatAlert.html)
566
-
567
- ### HTTP request headers
568
-
569
- - **Content-Type**: application/json
570
- - **Accept**: application/json
571
-
572
-
573
-
574
- <a name="get_alerting_heartbeat_alerts"></a>
575
-
576
- ## -[**HeartBeatAlertContainer**](HeartBeatAlertContainer.html) get_alerting_heartbeat_alerts(opts)
577
-
578
- Get heart beat alert list.
579
-
580
-
581
-
582
- Wraps GET /api/v2/alerting/heartbeat/alerts
583
-
584
-
585
- ### Example
586
- ~~~ruby
587
- # load the gem
588
- require 'purecloudplatformclientv2'
589
- # setup authorization
590
- @secret = ENV['PURECLOUD_SECRET']
591
- @id = ENV['PURECLOUD_CLIENT_ID']
592
- environment = "mypurecloud.com"
593
-
594
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
595
-
596
- PureCloud.configure do |config|
597
- config.access_token = @authToken
598
- end
599
-
600
- api_instance = PureCloud::AlertingApi.new
601
-
602
- opts = {
603
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
604
- }
605
-
606
- begin
607
- #Get heart beat alert list.
608
- result = api_instance.get_alerting_heartbeat_alerts(opts)
609
- p result
610
- rescue PureCloud::ApiError => e
611
- puts "Exception when calling AlertingApi->get_alerting_heartbeat_alerts: #{e}"
612
- end
613
- ~~~
614
-
615
- ### Parameters
616
-
617
- Name | Type | Description | Notes
618
- ------------- | ------------- | ------------- | -------------
619
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
620
- {: class="table table-striped"}
621
-
622
-
623
- ### Return type
624
-
625
- [**HeartBeatAlertContainer**](HeartBeatAlertContainer.html)
626
-
627
- ### HTTP request headers
628
-
629
- - **Content-Type**: application/json
630
- - **Accept**: application/json
631
-
632
-
633
-
634
- <a name="get_alerting_heartbeat_rule"></a>
635
-
636
- ## -[**HeartBeatRule**](HeartBeatRule.html) get_alerting_heartbeat_rule(rule_id, opts)
637
-
638
- Get a heart beat rule.
639
-
640
-
641
-
642
- Wraps GET /api/v2/alerting/heartbeat/rules/{ruleId}
643
-
644
-
645
- ### Example
646
- ~~~ruby
647
- # load the gem
648
- require 'purecloudplatformclientv2'
649
- # setup authorization
650
- @secret = ENV['PURECLOUD_SECRET']
651
- @id = ENV['PURECLOUD_CLIENT_ID']
652
- environment = "mypurecloud.com"
653
-
654
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
655
-
656
- PureCloud.configure do |config|
657
- config.access_token = @authToken
658
- end
659
-
660
- api_instance = PureCloud::AlertingApi.new
661
-
662
- rule_id = "rule_id_example" # String | Rule ID
663
-
664
- opts = {
665
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
666
- }
667
-
668
- begin
669
- #Get a heart beat rule.
670
- result = api_instance.get_alerting_heartbeat_rule(rule_id, opts)
671
- p result
672
- rescue PureCloud::ApiError => e
673
- puts "Exception when calling AlertingApi->get_alerting_heartbeat_rule: #{e}"
674
- end
675
- ~~~
676
-
677
- ### Parameters
678
-
679
- Name | Type | Description | Notes
680
- ------------- | ------------- | ------------- | -------------
681
- **rule_id** | **String**| Rule ID | |
682
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
683
- {: class="table table-striped"}
684
-
685
-
686
- ### Return type
687
-
688
- [**HeartBeatRule**](HeartBeatRule.html)
689
-
690
- ### HTTP request headers
691
-
692
- - **Content-Type**: application/json
693
- - **Accept**: application/json
694
-
695
-
696
-
697
- <a name="get_alerting_heartbeat_rules"></a>
698
-
699
- ## -[**HeartBeatRuleContainer**](HeartBeatRuleContainer.html) get_alerting_heartbeat_rules(opts)
700
-
701
- Get a heart beat rule list.
702
-
703
-
704
-
705
- Wraps GET /api/v2/alerting/heartbeat/rules
706
-
707
-
708
- ### Example
709
- ~~~ruby
710
- # load the gem
711
- require 'purecloudplatformclientv2'
712
- # setup authorization
713
- @secret = ENV['PURECLOUD_SECRET']
714
- @id = ENV['PURECLOUD_CLIENT_ID']
715
- environment = "mypurecloud.com"
716
-
717
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
718
-
719
- PureCloud.configure do |config|
720
- config.access_token = @authToken
721
- end
722
-
723
- api_instance = PureCloud::AlertingApi.new
724
-
725
- opts = {
726
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
727
- }
728
-
729
- begin
730
- #Get a heart beat rule list.
731
- result = api_instance.get_alerting_heartbeat_rules(opts)
732
- p result
733
- rescue PureCloud::ApiError => e
734
- puts "Exception when calling AlertingApi->get_alerting_heartbeat_rules: #{e}"
735
- end
736
- ~~~
737
-
738
- ### Parameters
739
-
740
- Name | Type | Description | Notes
741
- ------------- | ------------- | ------------- | -------------
742
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
743
- {: class="table table-striped"}
744
-
745
-
746
- ### Return type
747
-
748
- [**HeartBeatRuleContainer**](HeartBeatRuleContainer.html)
749
-
750
- ### HTTP request headers
751
-
752
- - **Content-Type**: application/json
753
- - **Accept**: application/json
754
-
755
-
756
-
757
- <a name="get_alerting_interactionstats_alert"></a>
758
-
759
- ## -[**InteractionStatsAlert**](InteractionStatsAlert.html) get_alerting_interactionstats_alert(alert_id, opts)
760
-
761
- Get an interaction stats alert
762
-
763
-
764
-
765
- Wraps GET /api/v2/alerting/interactionstats/alerts/{alertId}
766
-
767
-
768
- ### Example
769
- ~~~ruby
770
- # load the gem
771
- require 'purecloudplatformclientv2'
772
- # setup authorization
773
- @secret = ENV['PURECLOUD_SECRET']
774
- @id = ENV['PURECLOUD_CLIENT_ID']
775
- environment = "mypurecloud.com"
776
-
777
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
778
-
779
- PureCloud.configure do |config|
780
- config.access_token = @authToken
781
- end
782
-
783
- api_instance = PureCloud::AlertingApi.new
784
-
785
- alert_id = "alert_id_example" # String | Alert ID
786
-
787
- opts = {
788
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
789
- }
790
-
791
- begin
792
- #Get an interaction stats alert
793
- result = api_instance.get_alerting_interactionstats_alert(alert_id, opts)
794
- p result
795
- rescue PureCloud::ApiError => e
796
- puts "Exception when calling AlertingApi->get_alerting_interactionstats_alert: #{e}"
797
- end
798
- ~~~
799
-
800
- ### Parameters
801
-
802
- Name | Type | Description | Notes
803
- ------------- | ------------- | ------------- | -------------
804
- **alert_id** | **String**| Alert ID | |
805
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
806
- {: class="table table-striped"}
807
-
808
-
809
- ### Return type
810
-
811
- [**InteractionStatsAlert**](InteractionStatsAlert.html)
812
-
813
- ### HTTP request headers
814
-
815
- - **Content-Type**: application/json
816
- - **Accept**: application/json
817
-
818
-
819
-
820
- <a name="get_alerting_interactionstats_alerts"></a>
821
-
822
- ## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_alerting_interactionstats_alerts(opts)
823
-
824
- Get interaction stats alert list.
825
-
826
-
827
-
828
- Wraps GET /api/v2/alerting/interactionstats/alerts
829
-
830
-
831
- ### Example
832
- ~~~ruby
833
- # load the gem
834
- require 'purecloudplatformclientv2'
835
- # setup authorization
836
- @secret = ENV['PURECLOUD_SECRET']
837
- @id = ENV['PURECLOUD_CLIENT_ID']
838
- environment = "mypurecloud.com"
839
-
840
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
841
-
842
- PureCloud.configure do |config|
843
- config.access_token = @authToken
844
- end
845
-
846
- api_instance = PureCloud::AlertingApi.new
847
-
848
- opts = {
849
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
850
- }
851
-
852
- begin
853
- #Get interaction stats alert list.
854
- result = api_instance.get_alerting_interactionstats_alerts(opts)
855
- p result
856
- rescue PureCloud::ApiError => e
857
- puts "Exception when calling AlertingApi->get_alerting_interactionstats_alerts: #{e}"
858
- end
859
- ~~~
860
-
861
- ### Parameters
862
-
863
- Name | Type | Description | Notes
864
- ------------- | ------------- | ------------- | -------------
865
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
866
- {: class="table table-striped"}
867
-
868
-
869
- ### Return type
870
-
871
- [**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html)
872
-
873
- ### HTTP request headers
874
-
875
- - **Content-Type**: application/json
876
- - **Accept**: application/json
877
-
878
-
879
-
880
- <a name="get_alerting_interactionstats_alerts_unread"></a>
881
-
882
- ## -[**UnreadMetric**](UnreadMetric.html) get_alerting_interactionstats_alerts_unread
883
-
884
- Gets user unread count of interaction stats alerts.
885
-
886
-
887
-
888
- Wraps GET /api/v2/alerting/interactionstats/alerts/unread
889
-
890
-
891
- ### Example
892
- ~~~ruby
893
- # load the gem
894
- require 'purecloudplatformclientv2'
895
- # setup authorization
896
- @secret = ENV['PURECLOUD_SECRET']
897
- @id = ENV['PURECLOUD_CLIENT_ID']
898
- environment = "mypurecloud.com"
899
-
900
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
901
-
902
- PureCloud.configure do |config|
903
- config.access_token = @authToken
904
- end
905
-
906
- api_instance = PureCloud::AlertingApi.new
907
-
908
- begin
909
- #Gets user unread count of interaction stats alerts.
910
- result = api_instance.get_alerting_interactionstats_alerts_unread
911
- p result
912
- rescue PureCloud::ApiError => e
913
- puts "Exception when calling AlertingApi->get_alerting_interactionstats_alerts_unread: #{e}"
914
- end
915
- ~~~
916
-
917
- ### Parameters
918
- This endpoint does not need any parameter.
919
- {: class="table table-striped"}
920
-
921
-
922
- ### Return type
923
-
924
- [**UnreadMetric**](UnreadMetric.html)
925
-
926
- ### HTTP request headers
927
-
928
- - **Content-Type**: application/json
929
- - **Accept**: application/json
930
-
931
-
932
-
933
- <a name="get_alerting_interactionstats_rule"></a>
934
-
935
- ## -[**InteractionStatsRule**](InteractionStatsRule.html) get_alerting_interactionstats_rule(rule_id, opts)
936
-
937
- Get an interaction stats rule.
938
-
939
-
940
-
941
- Wraps GET /api/v2/alerting/interactionstats/rules/{ruleId}
942
-
943
-
944
- ### Example
945
- ~~~ruby
946
- # load the gem
947
- require 'purecloudplatformclientv2'
948
- # setup authorization
949
- @secret = ENV['PURECLOUD_SECRET']
950
- @id = ENV['PURECLOUD_CLIENT_ID']
951
- environment = "mypurecloud.com"
952
-
953
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
954
-
955
- PureCloud.configure do |config|
956
- config.access_token = @authToken
957
- end
958
-
959
- api_instance = PureCloud::AlertingApi.new
960
-
961
- rule_id = "rule_id_example" # String | Rule ID
962
-
963
- opts = {
964
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
965
- }
966
-
967
- begin
968
- #Get an interaction stats rule.
969
- result = api_instance.get_alerting_interactionstats_rule(rule_id, opts)
970
- p result
971
- rescue PureCloud::ApiError => e
972
- puts "Exception when calling AlertingApi->get_alerting_interactionstats_rule: #{e}"
973
- end
974
- ~~~
975
-
976
- ### Parameters
977
-
978
- Name | Type | Description | Notes
979
- ------------- | ------------- | ------------- | -------------
980
- **rule_id** | **String**| Rule ID | |
981
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
982
- {: class="table table-striped"}
983
-
984
-
985
- ### Return type
986
-
987
- [**InteractionStatsRule**](InteractionStatsRule.html)
988
-
989
- ### HTTP request headers
990
-
991
- - **Content-Type**: application/json
992
- - **Accept**: application/json
993
-
994
-
995
-
996
- <a name="get_alerting_interactionstats_rules"></a>
997
-
998
- ## -[**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html) get_alerting_interactionstats_rules(opts)
999
-
1000
- Get an interaction stats rule list.
1001
-
1002
-
1003
-
1004
- Wraps GET /api/v2/alerting/interactionstats/rules
1005
-
1006
-
1007
- ### Example
1008
- ~~~ruby
1009
- # load the gem
1010
- require 'purecloudplatformclientv2'
1011
- # setup authorization
1012
- @secret = ENV['PURECLOUD_SECRET']
1013
- @id = ENV['PURECLOUD_CLIENT_ID']
1014
- environment = "mypurecloud.com"
1015
-
1016
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1017
-
1018
- PureCloud.configure do |config|
1019
- config.access_token = @authToken
1020
- end
1021
-
1022
- api_instance = PureCloud::AlertingApi.new
1023
-
1024
- opts = {
1025
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1026
- }
1027
-
1028
- begin
1029
- #Get an interaction stats rule list.
1030
- result = api_instance.get_alerting_interactionstats_rules(opts)
1031
- p result
1032
- rescue PureCloud::ApiError => e
1033
- puts "Exception when calling AlertingApi->get_alerting_interactionstats_rules: #{e}"
1034
- end
1035
- ~~~
1036
-
1037
- ### Parameters
1038
-
1039
- Name | Type | Description | Notes
1040
- ------------- | ------------- | ------------- | -------------
1041
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
1042
- {: class="table table-striped"}
1043
-
1044
-
1045
- ### Return type
1046
-
1047
- [**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html)
1048
-
1049
- ### HTTP request headers
1050
-
1051
- - **Content-Type**: application/json
1052
- - **Accept**: application/json
1053
-
1054
-
1055
-
1056
- <a name="get_alerting_routingstatus_alert"></a>
1057
-
1058
- ## -[**RoutingStatusAlert**](RoutingStatusAlert.html) get_alerting_routingstatus_alert(alert_id, opts)
1059
-
1060
- Get a routing status alert
1061
-
1062
-
1063
-
1064
- Wraps GET /api/v2/alerting/routingstatus/alerts/{alertId}
1065
-
1066
-
1067
- ### Example
1068
- ~~~ruby
1069
- # load the gem
1070
- require 'purecloudplatformclientv2'
1071
- # setup authorization
1072
- @secret = ENV['PURECLOUD_SECRET']
1073
- @id = ENV['PURECLOUD_CLIENT_ID']
1074
- environment = "mypurecloud.com"
1075
-
1076
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1077
-
1078
- PureCloud.configure do |config|
1079
- config.access_token = @authToken
1080
- end
1081
-
1082
- api_instance = PureCloud::AlertingApi.new
1083
-
1084
- alert_id = "alert_id_example" # String | Alert ID
1085
-
1086
- opts = {
1087
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1088
- }
1089
-
1090
- begin
1091
- #Get a routing status alert
1092
- result = api_instance.get_alerting_routingstatus_alert(alert_id, opts)
1093
- p result
1094
- rescue PureCloud::ApiError => e
1095
- puts "Exception when calling AlertingApi->get_alerting_routingstatus_alert: #{e}"
1096
- end
1097
- ~~~
1098
-
1099
- ### Parameters
1100
-
1101
- Name | Type | Description | Notes
1102
- ------------- | ------------- | ------------- | -------------
1103
- **alert_id** | **String**| Alert ID | |
1104
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, agent |
1105
- {: class="table table-striped"}
1106
-
1107
-
1108
- ### Return type
1109
-
1110
- [**RoutingStatusAlert**](RoutingStatusAlert.html)
1111
-
1112
- ### HTTP request headers
1113
-
1114
- - **Content-Type**: application/json
1115
- - **Accept**: application/json
1116
-
1117
-
1118
-
1119
- <a name="get_alerting_routingstatus_alerts"></a>
1120
-
1121
- ## -[**RoutingStatusAlertContainer**](RoutingStatusAlertContainer.html) get_alerting_routingstatus_alerts(opts)
1122
-
1123
- Get routing status alert list.
1124
-
1125
-
1126
-
1127
- Wraps GET /api/v2/alerting/routingstatus/alerts
1128
-
1129
-
1130
- ### Example
1131
- ~~~ruby
1132
- # load the gem
1133
- require 'purecloudplatformclientv2'
1134
- # setup authorization
1135
- @secret = ENV['PURECLOUD_SECRET']
1136
- @id = ENV['PURECLOUD_CLIENT_ID']
1137
- environment = "mypurecloud.com"
1138
-
1139
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1140
-
1141
- PureCloud.configure do |config|
1142
- config.access_token = @authToken
1143
- end
1144
-
1145
- api_instance = PureCloud::AlertingApi.new
1146
-
1147
- opts = {
1148
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1149
- }
1150
-
1151
- begin
1152
- #Get routing status alert list.
1153
- result = api_instance.get_alerting_routingstatus_alerts(opts)
1154
- p result
1155
- rescue PureCloud::ApiError => e
1156
- puts "Exception when calling AlertingApi->get_alerting_routingstatus_alerts: #{e}"
1157
- end
1158
- ~~~
1159
-
1160
- ### Parameters
1161
-
1162
- Name | Type | Description | Notes
1163
- ------------- | ------------- | ------------- | -------------
1164
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, agent |
1165
- {: class="table table-striped"}
1166
-
1167
-
1168
- ### Return type
1169
-
1170
- [**RoutingStatusAlertContainer**](RoutingStatusAlertContainer.html)
1171
-
1172
- ### HTTP request headers
1173
-
1174
- - **Content-Type**: application/json
1175
- - **Accept**: application/json
1176
-
1177
-
1178
-
1179
- <a name="get_alerting_routingstatus_rule"></a>
1180
-
1181
- ## -[**RoutingStatusRule**](RoutingStatusRule.html) get_alerting_routingstatus_rule(rule_id, opts)
1182
-
1183
- Get a routing status rule.
1184
-
1185
-
1186
-
1187
- Wraps GET /api/v2/alerting/routingstatus/rules/{ruleId}
1188
-
1189
-
1190
- ### Example
1191
- ~~~ruby
1192
- # load the gem
1193
- require 'purecloudplatformclientv2'
1194
- # setup authorization
1195
- @secret = ENV['PURECLOUD_SECRET']
1196
- @id = ENV['PURECLOUD_CLIENT_ID']
1197
- environment = "mypurecloud.com"
1198
-
1199
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1200
-
1201
- PureCloud.configure do |config|
1202
- config.access_token = @authToken
1203
- end
1204
-
1205
- api_instance = PureCloud::AlertingApi.new
1206
-
1207
- rule_id = "rule_id_example" # String | Rule ID
1208
-
1209
- opts = {
1210
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1211
- }
1212
-
1213
- begin
1214
- #Get a routing status rule.
1215
- result = api_instance.get_alerting_routingstatus_rule(rule_id, opts)
1216
- p result
1217
- rescue PureCloud::ApiError => e
1218
- puts "Exception when calling AlertingApi->get_alerting_routingstatus_rule: #{e}"
1219
- end
1220
- ~~~
1221
-
1222
- ### Parameters
1223
-
1224
- Name | Type | Description | Notes
1225
- ------------- | ------------- | ------------- | -------------
1226
- **rule_id** | **String**| Rule ID | |
1227
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, agent |
1228
- {: class="table table-striped"}
1229
-
1230
-
1231
- ### Return type
1232
-
1233
- [**RoutingStatusRule**](RoutingStatusRule.html)
1234
-
1235
- ### HTTP request headers
1236
-
1237
- - **Content-Type**: application/json
1238
- - **Accept**: application/json
1239
-
1240
-
1241
-
1242
- <a name="get_alerting_routingstatus_rules"></a>
1243
-
1244
- ## -[**RoutingStatusRuleContainer**](RoutingStatusRuleContainer.html) get_alerting_routingstatus_rules(opts)
1245
-
1246
- Get a routing status rule list.
1247
-
1248
-
1249
-
1250
- Wraps GET /api/v2/alerting/routingstatus/rules
1251
-
1252
-
1253
- ### Example
1254
- ~~~ruby
1255
- # load the gem
1256
- require 'purecloudplatformclientv2'
1257
- # setup authorization
1258
- @secret = ENV['PURECLOUD_SECRET']
1259
- @id = ENV['PURECLOUD_CLIENT_ID']
1260
- environment = "mypurecloud.com"
1261
-
1262
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1263
-
1264
- PureCloud.configure do |config|
1265
- config.access_token = @authToken
1266
- end
1267
-
1268
- api_instance = PureCloud::AlertingApi.new
1269
-
1270
- opts = {
1271
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1272
- }
1273
-
1274
- begin
1275
- #Get a routing status rule list.
1276
- result = api_instance.get_alerting_routingstatus_rules(opts)
1277
- p result
1278
- rescue PureCloud::ApiError => e
1279
- puts "Exception when calling AlertingApi->get_alerting_routingstatus_rules: #{e}"
1280
- end
1281
- ~~~
1282
-
1283
- ### Parameters
1284
-
1285
- Name | Type | Description | Notes
1286
- ------------- | ------------- | ------------- | -------------
1287
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, agent |
1288
- {: class="table table-striped"}
1289
-
1290
-
1291
- ### Return type
1292
-
1293
- [**RoutingStatusRuleContainer**](RoutingStatusRuleContainer.html)
1294
-
1295
- ### HTTP request headers
1296
-
1297
- - **Content-Type**: application/json
1298
- - **Accept**: application/json
1299
-
1300
-
1301
-
1302
- <a name="get_alerting_userpresence_alert"></a>
1303
-
1304
- ## -[**UserPresenceAlert**](UserPresenceAlert.html) get_alerting_userpresence_alert(alert_id, opts)
1305
-
1306
- Get a user presence alert
1307
-
1308
-
1309
-
1310
- Wraps GET /api/v2/alerting/userpresence/alerts/{alertId}
1311
-
1312
-
1313
- ### Example
1314
- ~~~ruby
1315
- # load the gem
1316
- require 'purecloudplatformclientv2'
1317
- # setup authorization
1318
- @secret = ENV['PURECLOUD_SECRET']
1319
- @id = ENV['PURECLOUD_CLIENT_ID']
1320
- environment = "mypurecloud.com"
1321
-
1322
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1323
-
1324
- PureCloud.configure do |config|
1325
- config.access_token = @authToken
1326
- end
1327
-
1328
- api_instance = PureCloud::AlertingApi.new
1329
-
1330
- alert_id = "alert_id_example" # String | Alert ID
1331
-
1332
- opts = {
1333
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1334
- }
1335
-
1336
- begin
1337
- #Get a user presence alert
1338
- result = api_instance.get_alerting_userpresence_alert(alert_id, opts)
1339
- p result
1340
- rescue PureCloud::ApiError => e
1341
- puts "Exception when calling AlertingApi->get_alerting_userpresence_alert: #{e}"
1342
- end
1343
- ~~~
1344
-
1345
- ### Parameters
1346
-
1347
- Name | Type | Description | Notes
1348
- ------------- | ------------- | ------------- | -------------
1349
- **alert_id** | **String**| Alert ID | |
1350
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, presenceUser |
1351
- {: class="table table-striped"}
1352
-
1353
-
1354
- ### Return type
1355
-
1356
- [**UserPresenceAlert**](UserPresenceAlert.html)
1357
-
1358
- ### HTTP request headers
1359
-
1360
- - **Content-Type**: application/json
1361
- - **Accept**: application/json
1362
-
1363
-
1364
-
1365
- <a name="get_alerting_userpresence_alerts"></a>
23
+ <a name="delete_alerting_interactionstats_alert"></a>
1366
24
 
1367
- ## -[**UserPresenceAlertContainer**](UserPresenceAlertContainer.html) get_alerting_userpresence_alerts(opts)
25
+ ## - delete_alerting_interactionstats_alert(alert_id)
1368
26
 
1369
- Get user presence alert list.
27
+ Delete an interaction stats alert
1370
28
 
1371
29
 
1372
30
 
1373
- Wraps GET /api/v2/alerting/userpresence/alerts
31
+ Wraps DELETE /api/v2/alerting/interactionstats/alerts/{alertId}
1374
32
 
1375
33
 
1376
34
  ### Example
@@ -1390,16 +48,14 @@ end
1390
48
 
1391
49
  api_instance = PureCloud::AlertingApi.new
1392
50
 
1393
- opts = {
1394
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1395
- }
51
+ alert_id = "alert_id_example" # String | Alert ID
52
+
1396
53
 
1397
54
  begin
1398
- #Get user presence alert list.
1399
- result = api_instance.get_alerting_userpresence_alerts(opts)
1400
- p result
55
+ #Delete an interaction stats alert
56
+ api_instance.delete_alerting_interactionstats_alert(alert_id)
1401
57
  rescue PureCloud::ApiError => e
1402
- puts "Exception when calling AlertingApi->get_alerting_userpresence_alerts: #{e}"
58
+ puts "Exception when calling AlertingApi->delete_alerting_interactionstats_alert: #{e}"
1403
59
  end
1404
60
  ~~~
1405
61
 
@@ -1407,13 +63,13 @@ end
1407
63
 
1408
64
  Name | Type | Description | Notes
1409
65
  ------------- | ------------- | ------------- | -------------
1410
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, presenceUser |
66
+ **alert_id** | **String**| Alert ID | |
1411
67
  {: class="table table-striped"}
1412
68
 
1413
69
 
1414
70
  ### Return type
1415
71
 
1416
- [**UserPresenceAlertContainer**](UserPresenceAlertContainer.html)
72
+ nil (empty response body)
1417
73
 
1418
74
  ### HTTP request headers
1419
75
 
@@ -1422,15 +78,15 @@ Name | Type | Description | Notes
1422
78
 
1423
79
 
1424
80
 
1425
- <a name="get_alerting_userpresence_rule"></a>
81
+ <a name="delete_alerting_interactionstats_rule"></a>
1426
82
 
1427
- ## -[**UserPresenceRule**](UserPresenceRule.html) get_alerting_userpresence_rule(rule_id, opts)
83
+ ## - delete_alerting_interactionstats_rule(rule_id)
1428
84
 
1429
- Get a user presence rule.
85
+ Delete an interaction stats rule.
1430
86
 
1431
87
 
1432
88
 
1433
- Wraps GET /api/v2/alerting/userpresence/rules/{ruleId}
89
+ Wraps DELETE /api/v2/alerting/interactionstats/rules/{ruleId}
1434
90
 
1435
91
 
1436
92
  ### Example
@@ -1452,16 +108,12 @@ api_instance = PureCloud::AlertingApi.new
1452
108
 
1453
109
  rule_id = "rule_id_example" # String | Rule ID
1454
110
 
1455
- opts = {
1456
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1457
- }
1458
111
 
1459
112
  begin
1460
- #Get a user presence rule.
1461
- result = api_instance.get_alerting_userpresence_rule(rule_id, opts)
1462
- p result
113
+ #Delete an interaction stats rule.
114
+ api_instance.delete_alerting_interactionstats_rule(rule_id)
1463
115
  rescue PureCloud::ApiError => e
1464
- puts "Exception when calling AlertingApi->get_alerting_userpresence_rule: #{e}"
116
+ puts "Exception when calling AlertingApi->delete_alerting_interactionstats_rule: #{e}"
1465
117
  end
1466
118
  ~~~
1467
119
 
@@ -1470,13 +122,12 @@ end
1470
122
  Name | Type | Description | Notes
1471
123
  ------------- | ------------- | ------------- | -------------
1472
124
  **rule_id** | **String**| Rule ID | |
1473
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, presenceUser |
1474
125
  {: class="table table-striped"}
1475
126
 
1476
127
 
1477
128
  ### Return type
1478
129
 
1479
- [**UserPresenceRule**](UserPresenceRule.html)
130
+ nil (empty response body)
1480
131
 
1481
132
  ### HTTP request headers
1482
133
 
@@ -1485,15 +136,15 @@ Name | Type | Description | Notes
1485
136
 
1486
137
 
1487
138
 
1488
- <a name="get_alerting_userpresence_rules"></a>
139
+ <a name="get_alerting_interactionstats_alert"></a>
1489
140
 
1490
- ## -[**UserPresenceRuleContainer**](UserPresenceRuleContainer.html) get_alerting_userpresence_rules(opts)
141
+ ## -[**InteractionStatsAlert**](InteractionStatsAlert.html) get_alerting_interactionstats_alert(alert_id, opts)
1491
142
 
1492
- Get a user presence rule list.
143
+ Get an interaction stats alert
1493
144
 
1494
145
 
1495
146
 
1496
- Wraps GET /api/v2/alerting/userpresence/rules
147
+ Wraps GET /api/v2/alerting/interactionstats/alerts/{alertId}
1497
148
 
1498
149
 
1499
150
  ### Example
@@ -1513,16 +164,18 @@ end
1513
164
 
1514
165
  api_instance = PureCloud::AlertingApi.new
1515
166
 
167
+ alert_id = "alert_id_example" # String | Alert ID
168
+
1516
169
  opts = {
1517
170
  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1518
171
  }
1519
172
 
1520
173
  begin
1521
- #Get a user presence rule list.
1522
- result = api_instance.get_alerting_userpresence_rules(opts)
174
+ #Get an interaction stats alert
175
+ result = api_instance.get_alerting_interactionstats_alert(alert_id, opts)
1523
176
  p result
1524
177
  rescue PureCloud::ApiError => e
1525
- puts "Exception when calling AlertingApi->get_alerting_userpresence_rules: #{e}"
178
+ puts "Exception when calling AlertingApi->get_alerting_interactionstats_alert: #{e}"
1526
179
  end
1527
180
  ~~~
1528
181
 
@@ -1530,13 +183,14 @@ end
1530
183
 
1531
184
  Name | Type | Description | Notes
1532
185
  ------------- | ------------- | ------------- | -------------
1533
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, presenceUser |
186
+ **alert_id** | **String**| Alert ID | |
187
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
1534
188
  {: class="table table-striped"}
1535
189
 
1536
190
 
1537
191
  ### Return type
1538
192
 
1539
- [**UserPresenceRuleContainer**](UserPresenceRuleContainer.html)
193
+ [**InteractionStatsAlert**](InteractionStatsAlert.html)
1540
194
 
1541
195
  ### HTTP request headers
1542
196
 
@@ -1545,15 +199,15 @@ Name | Type | Description | Notes
1545
199
 
1546
200
 
1547
201
 
1548
- <a name="post_alerting_heartbeat_rules"></a>
202
+ <a name="get_alerting_interactionstats_alerts"></a>
1549
203
 
1550
- ## -[**HeartBeatRule**](HeartBeatRule.html) post_alerting_heartbeat_rules(body, opts)
204
+ ## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_alerting_interactionstats_alerts(opts)
1551
205
 
1552
- Create a heart beat rule.
206
+ Get interaction stats alert list.
1553
207
 
1554
208
 
1555
209
 
1556
- Wraps POST /api/v2/alerting/heartbeat/rules
210
+ Wraps GET /api/v2/alerting/interactionstats/alerts
1557
211
 
1558
212
 
1559
213
  ### Example
@@ -1573,18 +227,16 @@ end
1573
227
 
1574
228
  api_instance = PureCloud::AlertingApi.new
1575
229
 
1576
- body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule
1577
-
1578
230
  opts = {
1579
231
  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1580
232
  }
1581
233
 
1582
234
  begin
1583
- #Create a heart beat rule.
1584
- result = api_instance.post_alerting_heartbeat_rules(body, opts)
235
+ #Get interaction stats alert list.
236
+ result = api_instance.get_alerting_interactionstats_alerts(opts)
1585
237
  p result
1586
238
  rescue PureCloud::ApiError => e
1587
- puts "Exception when calling AlertingApi->post_alerting_heartbeat_rules: #{e}"
239
+ puts "Exception when calling AlertingApi->get_alerting_interactionstats_alerts: #{e}"
1588
240
  end
1589
241
  ~~~
1590
242
 
@@ -1592,14 +244,13 @@ end
1592
244
 
1593
245
  Name | Type | Description | Notes
1594
246
  ------------- | ------------- | ------------- | -------------
1595
- **body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule | |
1596
247
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
1597
248
  {: class="table table-striped"}
1598
249
 
1599
250
 
1600
251
  ### Return type
1601
252
 
1602
- [**HeartBeatRule**](HeartBeatRule.html)
253
+ [**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html)
1603
254
 
1604
255
  ### HTTP request headers
1605
256
 
@@ -1608,15 +259,15 @@ Name | Type | Description | Notes
1608
259
 
1609
260
 
1610
261
 
1611
- <a name="post_alerting_interactionstats_rules"></a>
262
+ <a name="get_alerting_interactionstats_alerts_unread"></a>
1612
263
 
1613
- ## -[**InteractionStatsRule**](InteractionStatsRule.html) post_alerting_interactionstats_rules(body, opts)
264
+ ## -[**UnreadMetric**](UnreadMetric.html) get_alerting_interactionstats_alerts_unread
1614
265
 
1615
- Create an interaction stats rule.
266
+ Gets user unread count of interaction stats alerts.
1616
267
 
1617
268
 
1618
269
 
1619
- Wraps POST /api/v2/alerting/interactionstats/rules
270
+ Wraps GET /api/v2/alerting/interactionstats/alerts/unread
1620
271
 
1621
272
 
1622
273
  ### Example
@@ -1636,33 +287,23 @@ end
1636
287
 
1637
288
  api_instance = PureCloud::AlertingApi.new
1638
289
 
1639
- body = PureCloud::InteractionStatsRule.new # InteractionStatsRule | AlertingRule
1640
-
1641
- opts = {
1642
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1643
- }
1644
-
1645
290
  begin
1646
- #Create an interaction stats rule.
1647
- result = api_instance.post_alerting_interactionstats_rules(body, opts)
291
+ #Gets user unread count of interaction stats alerts.
292
+ result = api_instance.get_alerting_interactionstats_alerts_unread
1648
293
  p result
1649
294
  rescue PureCloud::ApiError => e
1650
- puts "Exception when calling AlertingApi->post_alerting_interactionstats_rules: #{e}"
295
+ puts "Exception when calling AlertingApi->get_alerting_interactionstats_alerts_unread: #{e}"
1651
296
  end
1652
297
  ~~~
1653
298
 
1654
299
  ### Parameters
1655
-
1656
- Name | Type | Description | Notes
1657
- ------------- | ------------- | ------------- | -------------
1658
- **body** | [**InteractionStatsRule**](InteractionStatsRule.html)| AlertingRule | |
1659
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
300
+ This endpoint does not need any parameter.
1660
301
  {: class="table table-striped"}
1661
302
 
1662
303
 
1663
304
  ### Return type
1664
305
 
1665
- [**InteractionStatsRule**](InteractionStatsRule.html)
306
+ [**UnreadMetric**](UnreadMetric.html)
1666
307
 
1667
308
  ### HTTP request headers
1668
309
 
@@ -1671,15 +312,15 @@ Name | Type | Description | Notes
1671
312
 
1672
313
 
1673
314
 
1674
- <a name="post_alerting_routingstatus_rules"></a>
315
+ <a name="get_alerting_interactionstats_rule"></a>
1675
316
 
1676
- ## -[**RoutingStatusRule**](RoutingStatusRule.html) post_alerting_routingstatus_rules(body, opts)
317
+ ## -[**InteractionStatsRule**](InteractionStatsRule.html) get_alerting_interactionstats_rule(rule_id, opts)
1677
318
 
1678
- Create a routing status rule.
319
+ Get an interaction stats rule.
1679
320
 
1680
321
 
1681
322
 
1682
- Wraps POST /api/v2/alerting/routingstatus/rules
323
+ Wraps GET /api/v2/alerting/interactionstats/rules/{ruleId}
1683
324
 
1684
325
 
1685
326
  ### Example
@@ -1699,18 +340,18 @@ end
1699
340
 
1700
341
  api_instance = PureCloud::AlertingApi.new
1701
342
 
1702
- body = PureCloud::RoutingStatusRule.new # RoutingStatusRule | RoutingStatusRule
343
+ rule_id = "rule_id_example" # String | Rule ID
1703
344
 
1704
345
  opts = {
1705
346
  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1706
347
  }
1707
348
 
1708
349
  begin
1709
- #Create a routing status rule.
1710
- result = api_instance.post_alerting_routingstatus_rules(body, opts)
350
+ #Get an interaction stats rule.
351
+ result = api_instance.get_alerting_interactionstats_rule(rule_id, opts)
1711
352
  p result
1712
353
  rescue PureCloud::ApiError => e
1713
- puts "Exception when calling AlertingApi->post_alerting_routingstatus_rules: #{e}"
354
+ puts "Exception when calling AlertingApi->get_alerting_interactionstats_rule: #{e}"
1714
355
  end
1715
356
  ~~~
1716
357
 
@@ -1718,14 +359,14 @@ end
1718
359
 
1719
360
  Name | Type | Description | Notes
1720
361
  ------------- | ------------- | ------------- | -------------
1721
- **body** | [**RoutingStatusRule**](RoutingStatusRule.html)| RoutingStatusRule | |
1722
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, agent |
362
+ **rule_id** | **String**| Rule ID | |
363
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
1723
364
  {: class="table table-striped"}
1724
365
 
1725
366
 
1726
367
  ### Return type
1727
368
 
1728
- [**RoutingStatusRule**](RoutingStatusRule.html)
369
+ [**InteractionStatsRule**](InteractionStatsRule.html)
1729
370
 
1730
371
  ### HTTP request headers
1731
372
 
@@ -1734,15 +375,15 @@ Name | Type | Description | Notes
1734
375
 
1735
376
 
1736
377
 
1737
- <a name="post_alerting_userpresence_rules"></a>
378
+ <a name="get_alerting_interactionstats_rules"></a>
1738
379
 
1739
- ## -[**UserPresenceRule**](UserPresenceRule.html) post_alerting_userpresence_rules(body, opts)
380
+ ## -[**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html) get_alerting_interactionstats_rules(opts)
1740
381
 
1741
- Create a user presence rule.
382
+ Get an interaction stats rule list.
1742
383
 
1743
384
 
1744
385
 
1745
- Wraps POST /api/v2/alerting/userpresence/rules
386
+ Wraps GET /api/v2/alerting/interactionstats/rules
1746
387
 
1747
388
 
1748
389
  ### Example
@@ -1762,18 +403,16 @@ end
1762
403
 
1763
404
  api_instance = PureCloud::AlertingApi.new
1764
405
 
1765
- body = PureCloud::UserPresenceRule.new # UserPresenceRule | UserPresenceRule
1766
-
1767
406
  opts = {
1768
407
  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1769
408
  }
1770
409
 
1771
410
  begin
1772
- #Create a user presence rule.
1773
- result = api_instance.post_alerting_userpresence_rules(body, opts)
411
+ #Get an interaction stats rule list.
412
+ result = api_instance.get_alerting_interactionstats_rules(opts)
1774
413
  p result
1775
414
  rescue PureCloud::ApiError => e
1776
- puts "Exception when calling AlertingApi->post_alerting_userpresence_rules: #{e}"
415
+ puts "Exception when calling AlertingApi->get_alerting_interactionstats_rules: #{e}"
1777
416
  end
1778
417
  ~~~
1779
418
 
@@ -1781,14 +420,13 @@ end
1781
420
 
1782
421
  Name | Type | Description | Notes
1783
422
  ------------- | ------------- | ------------- | -------------
1784
- **body** | [**UserPresenceRule**](UserPresenceRule.html)| UserPresenceRule | |
1785
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, presenceUser |
423
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
1786
424
  {: class="table table-striped"}
1787
425
 
1788
426
 
1789
427
  ### Return type
1790
428
 
1791
- [**UserPresenceRule**](UserPresenceRule.html)
429
+ [**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html)
1792
430
 
1793
431
  ### HTTP request headers
1794
432
 
@@ -1797,15 +435,15 @@ Name | Type | Description | Notes
1797
435
 
1798
436
 
1799
437
 
1800
- <a name="put_alerting_heartbeat_rule"></a>
438
+ <a name="post_alerting_interactionstats_rules"></a>
1801
439
 
1802
- ## -[**HeartBeatRule**](HeartBeatRule.html) put_alerting_heartbeat_rule(rule_id, body, opts)
440
+ ## -[**InteractionStatsRule**](InteractionStatsRule.html) post_alerting_interactionstats_rules(body, opts)
1803
441
 
1804
- Update a heart beat rule
442
+ Create an interaction stats rule.
1805
443
 
1806
444
 
1807
445
 
1808
- Wraps PUT /api/v2/alerting/heartbeat/rules/{ruleId}
446
+ Wraps POST /api/v2/alerting/interactionstats/rules
1809
447
 
1810
448
 
1811
449
  ### Example
@@ -1825,20 +463,18 @@ end
1825
463
 
1826
464
  api_instance = PureCloud::AlertingApi.new
1827
465
 
1828
- rule_id = "rule_id_example" # String | Rule ID
1829
-
1830
- body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule
466
+ body = PureCloud::InteractionStatsRule.new # InteractionStatsRule | AlertingRule
1831
467
 
1832
468
  opts = {
1833
469
  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1834
470
  }
1835
471
 
1836
472
  begin
1837
- #Update a heart beat rule
1838
- result = api_instance.put_alerting_heartbeat_rule(rule_id, body, opts)
473
+ #Create an interaction stats rule.
474
+ result = api_instance.post_alerting_interactionstats_rules(body, opts)
1839
475
  p result
1840
476
  rescue PureCloud::ApiError => e
1841
- puts "Exception when calling AlertingApi->put_alerting_heartbeat_rule: #{e}"
477
+ puts "Exception when calling AlertingApi->post_alerting_interactionstats_rules: #{e}"
1842
478
  end
1843
479
  ~~~
1844
480
 
@@ -1846,15 +482,14 @@ end
1846
482
 
1847
483
  Name | Type | Description | Notes
1848
484
  ------------- | ------------- | ------------- | -------------
1849
- **rule_id** | **String**| Rule ID | |
1850
- **body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule | |
485
+ **body** | [**InteractionStatsRule**](InteractionStatsRule.html)| AlertingRule | |
1851
486
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
1852
487
  {: class="table table-striped"}
1853
488
 
1854
489
 
1855
490
  ### Return type
1856
491
 
1857
- [**HeartBeatRule**](HeartBeatRule.html)
492
+ [**InteractionStatsRule**](InteractionStatsRule.html)
1858
493
 
1859
494
  ### HTTP request headers
1860
495
 
@@ -1995,135 +630,3 @@ Name | Type | Description | Notes
1995
630
 
1996
631
 
1997
632
 
1998
- <a name="put_alerting_routingstatus_rule"></a>
1999
-
2000
- ## -[**RoutingStatusRule**](RoutingStatusRule.html) put_alerting_routingstatus_rule(rule_id, body, opts)
2001
-
2002
- Update a routing status rule
2003
-
2004
-
2005
-
2006
- Wraps PUT /api/v2/alerting/routingstatus/rules/{ruleId}
2007
-
2008
-
2009
- ### Example
2010
- ~~~ruby
2011
- # load the gem
2012
- require 'purecloudplatformclientv2'
2013
- # setup authorization
2014
- @secret = ENV['PURECLOUD_SECRET']
2015
- @id = ENV['PURECLOUD_CLIENT_ID']
2016
- environment = "mypurecloud.com"
2017
-
2018
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2019
-
2020
- PureCloud.configure do |config|
2021
- config.access_token = @authToken
2022
- end
2023
-
2024
- api_instance = PureCloud::AlertingApi.new
2025
-
2026
- rule_id = "rule_id_example" # String | Rule ID
2027
-
2028
- body = PureCloud::RoutingStatusRule.new # RoutingStatusRule | RoutingStatusRule
2029
-
2030
- opts = {
2031
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
2032
- }
2033
-
2034
- begin
2035
- #Update a routing status rule
2036
- result = api_instance.put_alerting_routingstatus_rule(rule_id, body, opts)
2037
- p result
2038
- rescue PureCloud::ApiError => e
2039
- puts "Exception when calling AlertingApi->put_alerting_routingstatus_rule: #{e}"
2040
- end
2041
- ~~~
2042
-
2043
- ### Parameters
2044
-
2045
- Name | Type | Description | Notes
2046
- ------------- | ------------- | ------------- | -------------
2047
- **rule_id** | **String**| Rule ID | |
2048
- **body** | [**RoutingStatusRule**](RoutingStatusRule.html)| RoutingStatusRule | |
2049
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, agent |
2050
- {: class="table table-striped"}
2051
-
2052
-
2053
- ### Return type
2054
-
2055
- [**RoutingStatusRule**](RoutingStatusRule.html)
2056
-
2057
- ### HTTP request headers
2058
-
2059
- - **Content-Type**: application/json
2060
- - **Accept**: application/json
2061
-
2062
-
2063
-
2064
- <a name="put_alerting_userpresence_rule"></a>
2065
-
2066
- ## -[**UserPresenceRule**](UserPresenceRule.html) put_alerting_userpresence_rule(rule_id, body, opts)
2067
-
2068
- Update a user presence rule
2069
-
2070
-
2071
-
2072
- Wraps PUT /api/v2/alerting/userpresence/rules/{ruleId}
2073
-
2074
-
2075
- ### Example
2076
- ~~~ruby
2077
- # load the gem
2078
- require 'purecloudplatformclientv2'
2079
- # setup authorization
2080
- @secret = ENV['PURECLOUD_SECRET']
2081
- @id = ENV['PURECLOUD_CLIENT_ID']
2082
- environment = "mypurecloud.com"
2083
-
2084
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2085
-
2086
- PureCloud.configure do |config|
2087
- config.access_token = @authToken
2088
- end
2089
-
2090
- api_instance = PureCloud::AlertingApi.new
2091
-
2092
- rule_id = "rule_id_example" # String | Rule ID
2093
-
2094
- body = PureCloud::UserPresenceRule.new # UserPresenceRule | UserPresenceRule
2095
-
2096
- opts = {
2097
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
2098
- }
2099
-
2100
- begin
2101
- #Update a user presence rule
2102
- result = api_instance.put_alerting_userpresence_rule(rule_id, body, opts)
2103
- p result
2104
- rescue PureCloud::ApiError => e
2105
- puts "Exception when calling AlertingApi->put_alerting_userpresence_rule: #{e}"
2106
- end
2107
- ~~~
2108
-
2109
- ### Parameters
2110
-
2111
- Name | Type | Description | Notes
2112
- ------------- | ------------- | ------------- | -------------
2113
- **rule_id** | **String**| Rule ID | |
2114
- **body** | [**UserPresenceRule**](UserPresenceRule.html)| UserPresenceRule | |
2115
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers, presenceUser |
2116
- {: class="table table-striped"}
2117
-
2118
-
2119
- ### Return type
2120
-
2121
- [**UserPresenceRule**](UserPresenceRule.html)
2122
-
2123
- ### HTTP request headers
2124
-
2125
- - **Content-Type**: application/json
2126
- - **Accept**: application/json
2127
-
2128
-
2129
-