purecloudplatformclientv2 12.0.0 → 13.0.0

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.
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
@@ -1,24 +0,0 @@
1
- ---
2
- title: HeartBeatAlert
3
- ---
4
- ## PureCloud::HeartBeatAlert
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | Name of the rule | |
12
- | **sender_id** | **String** | The value that identifies the sender of the heartbeat. | |
13
- | **heart_beat_timeout_in_minutes** | **Integer** | The number of minutes to wait before alerting missing heartbeats. | |
14
- | **rule_id** | **String** | The id of the rule. | |
15
- | **start_date** | **DateTime** | The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
16
- | **end_date** | **DateTime** | The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
17
- | **notification_users** | [**Array<User>**](User.html) | The ids of users who were notified of alarm state change. | |
18
- | **alert_types** | **Array<String>** | A collection of notification methods. | |
19
- | **rule_type** | **String** | The type of heartbeat rule that generated the alert | |
20
- | **rule_uri** | **String** | | [optional] |
21
- | **self_uri** | **String** | The URI for this object | [optional] |
22
- {: class="table table-striped"}
23
-
24
-
@@ -1,22 +0,0 @@
1
- ---
2
- title: HeartBeatAlertContainer
3
- ---
4
- ## PureCloud::HeartBeatAlertContainer
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array<HeartBeatAlert>**](HeartBeatAlert.html) | | [optional] |
11
- | **page_size** | **Integer** | | [optional] |
12
- | **page_number** | **Integer** | | [optional] |
13
- | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
- | **last_uri** | **String** | | [optional] |
19
- | **page_count** | **Integer** | | [optional] |
20
- {: class="table table-striped"}
21
-
22
-
@@ -1,22 +0,0 @@
1
- ---
2
- title: HeartBeatRule
3
- ---
4
- ## PureCloud::HeartBeatRule
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | Name of the rule | |
12
- | **sender_id** | **String** | The value that identifies the sender of the heartbeat. | |
13
- | **heart_beat_timeout_in_minutes** | **Integer** | The number of minutes to wait before alerting missing heartbeats. | |
14
- | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
15
- | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
16
- | **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
17
- | **alert_types** | **Array<String>** | A collection of notification methods. | |
18
- | **rule_type** | **String** | The type of system the will be generating the heartbeat. | |
19
- | **self_uri** | **String** | The URI for this object | [optional] |
20
- {: class="table table-striped"}
21
-
22
-
@@ -1,22 +0,0 @@
1
- ---
2
- title: HeartBeatRuleContainer
3
- ---
4
- ## PureCloud::HeartBeatRuleContainer
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array<HeartBeatRule>**](HeartBeatRule.html) | | [optional] |
11
- | **page_size** | **Integer** | | [optional] |
12
- | **page_number** | **Integer** | | [optional] |
13
- | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
- | **last_uri** | **String** | | [optional] |
19
- | **page_count** | **Integer** | | [optional] |
20
- {: class="table table-striped"}
21
-
22
-
@@ -1,23 +0,0 @@
1
- ---
2
- title: RoutingStatusAlert
3
- ---
4
- ## PureCloud::RoutingStatusAlert
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | Name of the rule | |
12
- | **agent** | [**User**](User.html) | The agent whose routing status will be watched. | |
13
- | **routing_status** | **String** | The routing status on which to alert. | |
14
- | **routing_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the agent's routing status. | |
15
- | **rule_id** | **String** | The id of the rule. | |
16
- | **start_date** | **DateTime** | The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
17
- | **end_date** | **DateTime** | The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
18
- | **notification_users** | [**Array<User>**](User.html) | The ids of users who were notified of alarm state change. | |
19
- | **alert_types** | **Array<String>** | A collection of notification methods. | |
20
- | **self_uri** | **String** | The URI for this object | [optional] |
21
- {: class="table table-striped"}
22
-
23
-
@@ -1,22 +0,0 @@
1
- ---
2
- title: RoutingStatusAlertContainer
3
- ---
4
- ## PureCloud::RoutingStatusAlertContainer
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array<RoutingStatusAlert>**](RoutingStatusAlert.html) | | [optional] |
11
- | **page_size** | **Integer** | | [optional] |
12
- | **page_number** | **Integer** | | [optional] |
13
- | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
- | **last_uri** | **String** | | [optional] |
19
- | **page_count** | **Integer** | | [optional] |
20
- {: class="table table-striped"}
21
-
22
-
@@ -1,22 +0,0 @@
1
- ---
2
- title: RoutingStatusRule
3
- ---
4
- ## PureCloud::RoutingStatusRule
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | Name of the rule | |
12
- | **agent** | [**User**](User.html) | The agent whose routing status will be watched. | |
13
- | **routing_status** | **String** | The routing status on which to alert. | |
14
- | **routing_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the agent's routing status. | |
15
- | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
16
- | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
17
- | **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
18
- | **alert_types** | **Array<String>** | A collection of notification methods. | |
19
- | **self_uri** | **String** | The URI for this object | [optional] |
20
- {: class="table table-striped"}
21
-
22
-
@@ -1,22 +0,0 @@
1
- ---
2
- title: RoutingStatusRuleContainer
3
- ---
4
- ## PureCloud::RoutingStatusRuleContainer
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array<RoutingStatusRule>**](RoutingStatusRule.html) | | [optional] |
11
- | **page_size** | **Integer** | | [optional] |
12
- | **page_number** | **Integer** | | [optional] |
13
- | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
- | **last_uri** | **String** | | [optional] |
19
- | **page_count** | **Integer** | | [optional] |
20
- {: class="table table-striped"}
21
-
22
-
@@ -1,25 +0,0 @@
1
- ---
2
- title: UserPresenceAlert
3
- ---
4
- ## PureCloud::UserPresenceAlert
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | Name of the rule | |
12
- | **presence_user** | [**User**](User.html) | The user whose presence will be watched. | |
13
- | **presence_type** | **String** | Indicates to which presence type the presence value belongs. | |
14
- | **presence_value** | **String** | The Org's UUID or Systems enum constance indicating the presence of concern. | |
15
- | **presence_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the user's presence. | |
16
- | **rule_id** | **String** | The id of the rule. | |
17
- | **start_date** | **DateTime** | The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
18
- | **end_date** | **DateTime** | The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
19
- | **notification_users** | [**Array<User>**](User.html) | The ids of users who were notified of alarm state change. | |
20
- | **alert_types** | **Array<String>** | A collection of notification methods. | |
21
- | **rule_uri** | **String** | | [optional] |
22
- | **self_uri** | **String** | The URI for this object | [optional] |
23
- {: class="table table-striped"}
24
-
25
-
@@ -1,22 +0,0 @@
1
- ---
2
- title: UserPresenceAlertContainer
3
- ---
4
- ## PureCloud::UserPresenceAlertContainer
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array<UserPresenceAlert>**](UserPresenceAlert.html) | | [optional] |
11
- | **page_size** | **Integer** | | [optional] |
12
- | **page_number** | **Integer** | | [optional] |
13
- | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
- | **last_uri** | **String** | | [optional] |
19
- | **page_count** | **Integer** | | [optional] |
20
- {: class="table table-striped"}
21
-
22
-
@@ -1,23 +0,0 @@
1
- ---
2
- title: UserPresenceRule
3
- ---
4
- ## PureCloud::UserPresenceRule
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | Name of the rule | |
12
- | **presence_user** | [**User**](User.html) | The user whose presence will be watched. | |
13
- | **presence_type** | **String** | Indicates to which presence type the presence value belongs. | |
14
- | **presence_value** | **String** | The Org's UUID or Systems enum constance indicating the presence of concern. | |
15
- | **presence_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the user's presence. | |
16
- | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
17
- | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
18
- | **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
19
- | **alert_types** | **Array<String>** | A collection of notification methods. | |
20
- | **self_uri** | **String** | The URI for this object | [optional] |
21
- {: class="table table-striped"}
22
-
23
-
@@ -1,22 +0,0 @@
1
- ---
2
- title: UserPresenceRuleContainer
3
- ---
4
- ## PureCloud::UserPresenceRuleContainer
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array<UserPresenceRule>**](UserPresenceRule.html) | | [optional] |
11
- | **page_size** | **Integer** | | [optional] |
12
- | **page_number** | **Integer** | | [optional] |
13
- | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
- | **last_uri** | **String** | | [optional] |
19
- | **page_count** | **Integer** | | [optional] |
20
- {: class="table table-striped"}
21
-
22
-
@@ -1,545 +0,0 @@
1
- =begin
2
- PureCloud Platform API
3
-
4
- With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
-
6
- OpenAPI spec version: v2
7
- Contact: DeveloperEvangelists@genesys.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
-
10
- License: ININ
11
- http://www.inin.com
12
-
13
- Terms of Service: https://developer.mypurecloud.com/tos
14
-
15
- =end
16
-
17
- require 'date'
18
-
19
- module PureCloud
20
- class HeartBeatAlert
21
- # The globally unique identifier for the object.
22
- attr_accessor :id
23
-
24
- # Name of the rule
25
- attr_accessor :name
26
-
27
- # The value that identifies the sender of the heartbeat.
28
- attr_accessor :sender_id
29
-
30
- # The number of minutes to wait before alerting missing heartbeats.
31
- attr_accessor :heart_beat_timeout_in_minutes
32
-
33
- # The id of the rule.
34
- attr_accessor :rule_id
35
-
36
- # The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
37
- attr_accessor :start_date
38
-
39
- # The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
40
- attr_accessor :end_date
41
-
42
- # The ids of users who were notified of alarm state change.
43
- attr_accessor :notification_users
44
-
45
- # A collection of notification methods.
46
- attr_accessor :alert_types
47
-
48
- # The type of heartbeat rule that generated the alert
49
- attr_accessor :rule_type
50
-
51
- attr_accessor :rule_uri
52
-
53
- # The URI for this object
54
- attr_accessor :self_uri
55
-
56
- # Attribute mapping from ruby-style variable name to JSON key.
57
- def self.attribute_map
58
- {
59
-
60
- :'id' => :'id',
61
-
62
- :'name' => :'name',
63
-
64
- :'sender_id' => :'senderId',
65
-
66
- :'heart_beat_timeout_in_minutes' => :'heartBeatTimeoutInMinutes',
67
-
68
- :'rule_id' => :'ruleId',
69
-
70
- :'start_date' => :'startDate',
71
-
72
- :'end_date' => :'endDate',
73
-
74
- :'notification_users' => :'notificationUsers',
75
-
76
- :'alert_types' => :'alertTypes',
77
-
78
- :'rule_type' => :'ruleType',
79
-
80
- :'rule_uri' => :'ruleUri',
81
-
82
- :'self_uri' => :'selfUri'
83
-
84
- }
85
- end
86
-
87
- # Attribute type mapping.
88
- def self.swagger_types
89
- {
90
-
91
- :'id' => :'String',
92
-
93
- :'name' => :'String',
94
-
95
- :'sender_id' => :'String',
96
-
97
- :'heart_beat_timeout_in_minutes' => :'Integer',
98
-
99
- :'rule_id' => :'String',
100
-
101
- :'start_date' => :'DateTime',
102
-
103
- :'end_date' => :'DateTime',
104
-
105
- :'notification_users' => :'Array<User>',
106
-
107
- :'alert_types' => :'Array<String>',
108
-
109
- :'rule_type' => :'String',
110
-
111
- :'rule_uri' => :'String',
112
-
113
- :'self_uri' => :'String'
114
-
115
- }
116
- end
117
-
118
- # Initializes the object
119
- # @param [Hash] attributes Model attributes in the form of hash
120
- def initialize(attributes = {})
121
- return unless attributes.is_a?(Hash)
122
-
123
- # convert string to symbol for hash key
124
- attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
125
-
126
-
127
- if attributes.has_key?(:'id')
128
-
129
-
130
- self.id = attributes[:'id']
131
-
132
-
133
- end
134
-
135
-
136
- if attributes.has_key?(:'name')
137
-
138
-
139
- self.name = attributes[:'name']
140
-
141
-
142
- end
143
-
144
-
145
- if attributes.has_key?(:'senderId')
146
-
147
-
148
- self.sender_id = attributes[:'senderId']
149
-
150
-
151
- end
152
-
153
-
154
- if attributes.has_key?(:'heartBeatTimeoutInMinutes')
155
-
156
-
157
- self.heart_beat_timeout_in_minutes = attributes[:'heartBeatTimeoutInMinutes']
158
-
159
-
160
- end
161
-
162
-
163
- if attributes.has_key?(:'ruleId')
164
-
165
-
166
- self.rule_id = attributes[:'ruleId']
167
-
168
-
169
- end
170
-
171
-
172
- if attributes.has_key?(:'startDate')
173
-
174
-
175
- self.start_date = attributes[:'startDate']
176
-
177
-
178
- end
179
-
180
-
181
- if attributes.has_key?(:'endDate')
182
-
183
-
184
- self.end_date = attributes[:'endDate']
185
-
186
-
187
- end
188
-
189
-
190
- if attributes.has_key?(:'notificationUsers')
191
-
192
- if (value = attributes[:'notificationUsers']).is_a?(Array)
193
- self.notification_users = value
194
- end
195
-
196
-
197
-
198
- end
199
-
200
-
201
- if attributes.has_key?(:'alertTypes')
202
-
203
- if (value = attributes[:'alertTypes']).is_a?(Array)
204
- self.alert_types = value
205
- end
206
-
207
-
208
-
209
- end
210
-
211
-
212
- if attributes.has_key?(:'ruleType')
213
-
214
-
215
- self.rule_type = attributes[:'ruleType']
216
-
217
-
218
- end
219
-
220
-
221
- if attributes.has_key?(:'ruleUri')
222
-
223
-
224
- self.rule_uri = attributes[:'ruleUri']
225
-
226
-
227
- end
228
-
229
-
230
- if attributes.has_key?(:'selfUri')
231
-
232
-
233
- self.self_uri = attributes[:'selfUri']
234
-
235
-
236
- end
237
-
238
-
239
- end
240
-
241
- # Show invalid properties with the reasons. Usually used together with valid?
242
- # @return Array for valid properies with the reasons
243
- def list_invalid_properties
244
- invalid_properties = Array.new
245
-
246
-
247
- return invalid_properties
248
- end
249
-
250
- # Check to see if the all the properties in the model are valid
251
- # @return true if the model is valid
252
- def valid?
253
-
254
-
255
-
256
-
257
-
258
-
259
- if @name.nil?
260
- return false
261
- end
262
-
263
-
264
-
265
-
266
-
267
-
268
- if @sender_id.nil?
269
- return false
270
- end
271
-
272
-
273
-
274
-
275
-
276
-
277
- if @heart_beat_timeout_in_minutes.nil?
278
- return false
279
- end
280
-
281
-
282
-
283
-
284
-
285
-
286
- if @rule_id.nil?
287
- return false
288
- end
289
-
290
-
291
-
292
-
293
-
294
-
295
- if @start_date.nil?
296
- return false
297
- end
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
- if @notification_users.nil?
309
- return false
310
- end
311
-
312
-
313
-
314
-
315
-
316
-
317
- if @alert_types.nil?
318
- return false
319
- end
320
-
321
-
322
-
323
-
324
-
325
-
326
- if @rule_type.nil?
327
- return false
328
- end
329
-
330
-
331
-
332
- allowed_values = ["EDGE"]
333
- if @rule_type && !allowed_values.include?(@rule_type)
334
- return false
335
- end
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
- end
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
- # Custom attribute writer method checking allowed values (enum).
397
- # @param [Object] rule_type Object to be assigned
398
- def rule_type=(rule_type)
399
- allowed_values = ["EDGE"]
400
- if rule_type && !allowed_values.include?(rule_type)
401
- fail ArgumentError, "invalid value for 'rule_type', must be one of #{allowed_values}."
402
- end
403
- @rule_type = rule_type
404
- end
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
- # Checks equality by comparing each attribute.
420
- # @param [Object] Object to be compared
421
- def ==(o)
422
- return true if self.equal?(o)
423
- self.class == o.class &&
424
- id == o.id &&
425
- name == o.name &&
426
- sender_id == o.sender_id &&
427
- heart_beat_timeout_in_minutes == o.heart_beat_timeout_in_minutes &&
428
- rule_id == o.rule_id &&
429
- start_date == o.start_date &&
430
- end_date == o.end_date &&
431
- notification_users == o.notification_users &&
432
- alert_types == o.alert_types &&
433
- rule_type == o.rule_type &&
434
- rule_uri == o.rule_uri &&
435
- self_uri == o.self_uri
436
- end
437
-
438
- # @see the `==` method
439
- # @param [Object] Object to be compared
440
- def eql?(o)
441
- self == o
442
- end
443
-
444
- # Calculates hash code according to all attributes.
445
- # @return [Fixnum] Hash code
446
- def hash
447
- [id, name, sender_id, heart_beat_timeout_in_minutes, rule_id, start_date, end_date, notification_users, alert_types, rule_type, rule_uri, self_uri].hash
448
- end
449
-
450
- # build the object from hash
451
- def build_from_hash(attributes)
452
- return nil unless attributes.is_a?(Hash)
453
- self.class.swagger_types.each_pair do |key, type|
454
- if type =~ /^Array<(.*)>/i
455
- if attributes[self.class.attribute_map[key]].is_a?(Array)
456
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
457
- else
458
- #TODO show warning in debug mode
459
- end
460
- elsif !attributes[self.class.attribute_map[key]].nil?
461
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
462
- else
463
- # data not found in attributes(hash), not an issue as the data can be optional
464
- end
465
- end
466
-
467
- self
468
- end
469
-
470
- def _deserialize(type, value)
471
- case type.to_sym
472
- when :DateTime
473
- DateTime.parse(value)
474
- when :Date
475
- Date.parse(value)
476
- when :String
477
- value.to_s
478
- when :Integer
479
- value.to_i
480
- when :Float
481
- value.to_f
482
- when :BOOLEAN
483
- if value.to_s =~ /^(true|t|yes|y|1)$/i
484
- true
485
- else
486
- false
487
- end
488
- when :Object
489
- # generic object (usually a Hash), return directly
490
- value
491
- when /\AArray<(?<inner_type>.+)>\z/
492
- inner_type = Regexp.last_match[:inner_type]
493
- value.map { |v| _deserialize(inner_type, v) }
494
- when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
495
- k_type = Regexp.last_match[:k_type]
496
- v_type = Regexp.last_match[:v_type]
497
- {}.tap do |hash|
498
- value.each do |k, v|
499
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
500
- end
501
- end
502
- else # model
503
- _model = Object.const_get("PureCloud").const_get(type).new
504
- _model.build_from_hash(value)
505
- end
506
- end
507
-
508
- def to_s
509
- to_hash.to_s
510
- end
511
-
512
- # to_body is an alias to to_body (backward compatibility))
513
- def to_body
514
- to_hash
515
- end
516
-
517
- # return the object in the form of hash
518
- def to_hash
519
- hash = {}
520
- self.class.attribute_map.each_pair do |attr, param|
521
- value = self.send(attr)
522
- next if value.nil?
523
- hash[param] = _to_hash(value)
524
- end
525
- hash
526
- end
527
-
528
- # Method to output non-array value in the form of hash
529
- # For object, use to_hash. Otherwise, just return the value
530
- def _to_hash(value)
531
- if value.is_a?(Array)
532
- value.compact.map{ |v| _to_hash(v) }
533
- elsif value.is_a?(Hash)
534
- {}.tap do |hash|
535
- value.each { |k, v| hash[k] = _to_hash(v) }
536
- end
537
- elsif value.respond_to? :to_hash
538
- value.to_hash
539
- else
540
- value
541
- end
542
- end
543
-
544
- end
545
- end