purecloud 0.50.1 → 0.51.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (644) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -6
  3. data/bin/notificationMappings.json +96 -0
  4. data/config-ruby.json +1 -1
  5. data/doc_out/AcwSettings.html.md +2 -2
  6. data/doc_out/Address.html.md +17 -0
  7. data/doc_out/Agent.html.md +1 -1
  8. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  9. data/doc_out/AlertingApi.html.md +445 -0
  10. data/doc_out/AttemptLimits.html.md +22 -0
  11. data/doc_out/AttemptLimitsEntityListing.html.md +22 -0
  12. data/doc_out/Attribute.html.md +1 -1
  13. data/doc_out/AttributeEntityListing.html.md +2 -2
  14. data/doc_out/AuditEntity.html.md +4 -4
  15. data/doc_out/AuditFacet.html.md +2 -2
  16. data/doc_out/AuditFilter.html.md +4 -4
  17. data/doc_out/AuditMessage.html.md +14 -14
  18. data/doc_out/AuditSearchResult.html.md +4 -4
  19. data/doc_out/AuditUser.html.md +3 -3
  20. data/doc_out/AuthorizationApi.html.md +2 -2
  21. data/doc_out/AvailableTopicEntityListing.html.md +2 -2
  22. data/doc_out/CalibrationCreate.html.md +28 -0
  23. data/doc_out/CalibrationEntityListing.html.md +2 -2
  24. data/doc_out/Call.html.md +17 -17
  25. data/doc_out/CallCommand.html.md +1 -1
  26. data/doc_out/CallConversationEntityListing.html.md +2 -2
  27. data/doc_out/CallConversationNotification.html.md +17 -0
  28. data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +44 -0
  29. data/doc_out/CallConversationNotificationDetail.html.md +16 -0
  30. data/doc_out/CallConversationNotificationErrorBody.html.md +22 -0
  31. data/doc_out/CallConversationNotificationErrorInfo.html.md +22 -0
  32. data/doc_out/CallConversationNotificationFaxStatus.html.md +20 -0
  33. data/doc_out/CallConversationNotificationParticipants.html.md +44 -0
  34. data/doc_out/CallConversationNotificationUriReference.html.md +14 -0
  35. data/doc_out/CallMediaParticipant.html.md +6 -3
  36. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  37. data/doc_out/Callback.html.md +16 -16
  38. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  39. data/doc_out/CallbackConversationNotification.html.md +16 -0
  40. data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +39 -0
  41. data/doc_out/CallbackConversationNotificationDetail.html.md +16 -0
  42. data/doc_out/CallbackConversationNotificationDialerPreview.html.md +18 -0
  43. data/doc_out/CallbackConversationNotificationErrorBody.html.md +22 -0
  44. data/doc_out/CallbackConversationNotificationErrorInfo.html.md +22 -0
  45. data/doc_out/CallbackConversationNotificationErrorInfoDetails.html.md +16 -0
  46. data/doc_out/CallbackConversationNotificationParticipants.html.md +39 -0
  47. data/doc_out/CallbackConversationNotificationPhoneNumberColumn.html.md +15 -0
  48. data/doc_out/CallbackConversationNotificationUriReference.html.md +14 -0
  49. data/doc_out/CallbackConversationNotificationUser.html.md +14 -0
  50. data/doc_out/CallbackMediaParticipant.html.md +6 -3
  51. data/doc_out/Campaign.html.md +1 -0
  52. data/doc_out/CampaignEntityListing.html.md +2 -2
  53. data/doc_out/CampaignInteraction.html.md +33 -0
  54. data/doc_out/CampaignInteractions.html.md +17 -0
  55. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  56. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  57. data/doc_out/Change.html.md +3 -3
  58. data/doc_out/ChannelEntityListing.html.md +2 -2
  59. data/doc_out/ChannelTopicEntityListing.html.md +2 -2
  60. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  61. data/doc_out/ChatConversationNotification.html.md +16 -0
  62. data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +34 -0
  63. data/doc_out/ChatConversationNotificationDetail.html.md +16 -0
  64. data/doc_out/ChatConversationNotificationErrorBody.html.md +22 -0
  65. data/doc_out/ChatConversationNotificationErrorInfo.html.md +22 -0
  66. data/doc_out/ChatConversationNotificationParticipants.html.md +34 -0
  67. data/doc_out/ChatConversationNotificationUriReference.html.md +14 -0
  68. data/doc_out/ChatMediaParticipant.html.md +6 -3
  69. data/doc_out/CobrowseConversation.html.md +17 -0
  70. data/doc_out/CobrowseConversationEntityListing.html.md +22 -0
  71. data/doc_out/CobrowseConversationNotification.html.md +16 -0
  72. data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +38 -0
  73. data/doc_out/CobrowseConversationNotificationDetail.html.md +16 -0
  74. data/doc_out/CobrowseConversationNotificationErrorBody.html.md +22 -0
  75. data/doc_out/CobrowseConversationNotificationErrorInfo.html.md +22 -0
  76. data/doc_out/CobrowseConversationNotificationParticipants.html.md +38 -0
  77. data/doc_out/CobrowseConversationNotificationUriReference.html.md +14 -0
  78. data/doc_out/CobrowseMediaParticipant.html.md +41 -0
  79. data/doc_out/Cobrowsesession.html.md +23 -0
  80. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  81. data/doc_out/ContactListEntityListing.html.md +2 -2
  82. data/doc_out/ContactSort.html.md +1 -1
  83. data/doc_out/ContentManagementApi.html.md +34 -33
  84. data/doc_out/ConversationChat.html.md +12 -11
  85. data/doc_out/ConversationEntityListing.html.md +2 -2
  86. data/doc_out/ConversationNotification.html.md +17 -0
  87. data/doc_out/ConversationNotificationAddress.html.md +18 -0
  88. data/doc_out/ConversationNotificationCall.html.md +31 -0
  89. data/doc_out/ConversationNotificationCallback.html.md +28 -0
  90. data/doc_out/ConversationNotificationCallbacks.html.md +28 -0
  91. data/doc_out/ConversationNotificationCalls.html.md +31 -0
  92. data/doc_out/ConversationNotificationChat.html.md +21 -0
  93. data/doc_out/ConversationNotificationChats.html.md +21 -0
  94. data/doc_out/ConversationNotificationCobrowse.html.md +25 -0
  95. data/doc_out/ConversationNotificationCobrowsesessions.html.md +25 -0
  96. data/doc_out/ConversationNotificationDialerPreview.html.md +18 -0
  97. data/doc_out/ConversationNotificationDialerPreviewPhoneNumberColumns.html.md +15 -0
  98. data/doc_out/ConversationNotificationDisconnectReason.html.md +15 -0
  99. data/doc_out/ConversationNotificationDisconnectReasons.html.md +15 -0
  100. data/doc_out/ConversationNotificationEmail.html.md +23 -0
  101. data/doc_out/ConversationNotificationEmails.html.md +23 -0
  102. data/doc_out/ConversationNotificationErrorDetails.html.md +20 -0
  103. data/doc_out/ConversationNotificationErrorInfo.html.md +20 -0
  104. data/doc_out/ConversationNotificationFaxStatus.html.md +20 -0
  105. data/doc_out/ConversationNotificationParticipant.html.md +39 -0
  106. data/doc_out/ConversationNotificationParticipants.html.md +39 -0
  107. data/doc_out/ConversationNotificationPhoneNumberColumn.html.md +15 -0
  108. data/doc_out/ConversationNotificationScreenShare.html.md +21 -0
  109. data/doc_out/ConversationNotificationScreenShares.html.md +21 -0
  110. data/doc_out/ConversationNotificationSelf.html.md +18 -0
  111. data/doc_out/ConversationNotificationSocialExpression.html.md +25 -0
  112. data/doc_out/ConversationNotificationSocialExpressions.html.md +25 -0
  113. data/doc_out/ConversationNotificationVideo.html.md +24 -0
  114. data/doc_out/ConversationNotificationVideos.html.md +24 -0
  115. data/doc_out/ConversationNotificationWrapup.html.md +18 -0
  116. data/doc_out/ConversationsApi.html.md +707 -161
  117. data/doc_out/CreateCallbackCommand.html.md +1 -1
  118. data/doc_out/CreateShareRequest.html.md +3 -3
  119. data/doc_out/DIDEntityListing.html.md +2 -2
  120. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  121. data/doc_out/DialerAuditRequest.html.md +4 -4
  122. data/doc_out/DialerContact.html.md +1 -1
  123. data/doc_out/DialerPreview.html.md +4 -4
  124. data/doc_out/DisconnectReason.html.md +3 -3
  125. data/doc_out/DncList.html.md +1 -2
  126. data/doc_out/DncListEntityListing.html.md +2 -2
  127. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  128. data/doc_out/DocumentEntityListing.html.md +2 -2
  129. data/doc_out/DocumentUpdate.html.md +1 -1
  130. data/doc_out/DocumentUpload.html.md +2 -2
  131. data/doc_out/DomainCapabilities.html.md +5 -3
  132. data/doc_out/DomainEdgeSoftwareVersionDto.html.md +1 -1
  133. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +22 -0
  134. data/doc_out/DomainEntityListing.html.md +2 -2
  135. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  136. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  137. data/doc_out/DomainLogicalInterface.html.md +5 -8
  138. data/doc_out/DomainNetworkAddress.html.md +4 -4
  139. data/doc_out/DomainNetworkRoute.html.md +5 -5
  140. data/doc_out/DomainOrganizationRoleCreate.html.md +22 -0
  141. data/doc_out/Edge.html.md +2 -1
  142. data/doc_out/EdgeEntityListing.html.md +2 -2
  143. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  144. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  145. data/doc_out/EdgeLogsJobRequest.html.md +3 -3
  146. data/doc_out/EdgeLogsJobUploadRequest.html.md +1 -1
  147. data/doc_out/EdgeOfflineConfiguration.html.md +14 -0
  148. data/doc_out/EdgeOfflineConfigurationInterface.html.md +16 -0
  149. data/doc_out/EdgeOfflineConfigurationNetwork.html.md +13 -0
  150. data/doc_out/EdgeOfflineConfigurationResponse.html.md +13 -0
  151. data/doc_out/Email.html.md +13 -12
  152. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  153. data/doc_out/EmailConversationNotification.html.md +16 -0
  154. data/doc_out/EmailConversationNotificationDetail.html.md +16 -0
  155. data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +35 -0
  156. data/doc_out/EmailConversationNotificationErrorBody.html.md +22 -0
  157. data/doc_out/EmailConversationNotificationErrorInfo.html.md +22 -0
  158. data/doc_out/EmailConversationNotificationParticipants.html.md +35 -0
  159. data/doc_out/EmailConversationNotificationUriReference.html.md +14 -0
  160. data/doc_out/EmailMediaParticipant.html.md +6 -3
  161. data/doc_out/EmailMessage.html.md +3 -3
  162. data/doc_out/EmailMessageListing.html.md +2 -2
  163. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  164. data/doc_out/EndpointEntityListing.html.md +2 -2
  165. data/doc_out/Entry.html.md +2 -2
  166. data/doc_out/EvaluationEntityListing.html.md +2 -2
  167. data/doc_out/EvaluationForm.html.md +3 -3
  168. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  169. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  170. data/doc_out/ExtensionEntityListing.html.md +2 -2
  171. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  172. data/doc_out/FacetInfo.html.md +2 -2
  173. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  174. data/doc_out/FaxStatus.html.md +8 -8
  175. data/doc_out/Group.html.md +1 -1
  176. data/doc_out/GroupEntityListing.html.md +2 -2
  177. data/doc_out/GroupMembersUpdate.html.md +2 -2
  178. data/doc_out/GroupUpdate.html.md +22 -0
  179. data/doc_out/GroupsApi.html.md +122 -4
  180. data/doc_out/HeartBeatAlert.html.md +24 -0
  181. data/doc_out/HeartBeatAlertContainer.html.md +22 -0
  182. data/doc_out/HeartBeatAlertNotification.html.md +22 -0
  183. data/doc_out/HeartBeatAlertNotificationNotificationUser.html.md +14 -0
  184. data/doc_out/HeartBeatAlertNotificationNotificationUsers.html.md +14 -0
  185. data/doc_out/HeartBeatRule.html.md +22 -0
  186. data/doc_out/HeartBeatRuleContainer.html.md +22 -0
  187. data/doc_out/HeartBeatRuleNotification.html.md +21 -0
  188. data/doc_out/HeartBeatRuleNotificationNotificationUser.html.md +14 -0
  189. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  190. data/doc_out/InboundRoute.html.md +3 -3
  191. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  192. data/doc_out/InteractionStatAlertNotification.html.md +28 -0
  193. data/doc_out/InteractionStatAlertNotificationNotificationUser.html.md +14 -0
  194. data/doc_out/InteractionStatRuleNotification.html.md +26 -0
  195. data/doc_out/InteractionStatRuleNotificationNotificationUser.html.md +14 -0
  196. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  197. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  198. data/doc_out/JsonNode.html.md +2 -2
  199. data/doc_out/Keyword.html.md +4 -1
  200. data/doc_out/KeywordSet.html.md +1 -1
  201. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  202. data/doc_out/Language.html.md +1 -1
  203. data/doc_out/LanguageEntityListing.html.md +2 -2
  204. data/doc_out/Library.html.md +1 -1
  205. data/doc_out/LibraryEntityListing.html.md +2 -2
  206. data/doc_out/LineBaseEntityListing.html.md +2 -2
  207. data/doc_out/LineEntityListing.html.md +2 -2
  208. data/doc_out/LocationsApi.html.md +4 -4
  209. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  210. data/doc_out/MaxParticipants.html.md +1 -1
  211. data/doc_out/MetaData.html.md +15 -0
  212. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  213. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  214. data/doc_out/OrganizationPresence.html.md +1 -1
  215. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  216. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  217. data/doc_out/OrphanRecordingListing.html.md +2 -2
  218. data/doc_out/OutOfOfficeNotification.html.md +17 -0
  219. data/doc_out/OutOfOfficeNotificationUser.html.md +13 -0
  220. data/doc_out/OutboundApi.html.md +356 -0
  221. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  222. data/doc_out/Participant.html.md +28 -25
  223. data/doc_out/ParticipantAttributes.html.md +1 -1
  224. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  225. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  226. data/doc_out/PhoneEntityListing.html.md +2 -2
  227. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  228. data/doc_out/PhonesReboot.html.md +2 -2
  229. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  230. data/doc_out/PolicyCreate.html.md +24 -0
  231. data/doc_out/PolicyEntityListing.html.md +2 -2
  232. data/doc_out/PresenceApi.html.md +10 -4
  233. data/doc_out/QualityApi.html.md +16 -16
  234. data/doc_out/QualityAudit.html.md +1 -1
  235. data/doc_out/QualityAuditPage.html.md +2 -2
  236. data/doc_out/QueueEntityListing.html.md +2 -2
  237. data/doc_out/QueueMemberEntityListing.html.md +22 -0
  238. data/doc_out/RecordingApi.html.md +63 -3
  239. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  240. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  241. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  242. data/doc_out/ResponseEntityList.html.md +2 -2
  243. data/doc_out/ResponseEntityListing.html.md +2 -2
  244. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  245. data/doc_out/RoutingApi.html.md +93 -24
  246. data/doc_out/RoutingSkill.html.md +1 -1
  247. data/doc_out/RoutingStatus.html.md +3 -3
  248. data/doc_out/RuleSetEntityListing.html.md +2 -2
  249. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  250. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  251. data/doc_out/ScreenRecordingSession.html.md +3 -0
  252. data/doc_out/ScreenRecordingSessionListing.html.md +5 -0
  253. data/doc_out/ScreenRecordingSessionRequest.html.md +15 -0
  254. data/doc_out/ScreenShareConversationNotification.html.md +16 -0
  255. data/doc_out/ScreenShareConversationNotificationDetail.html.md +16 -0
  256. data/doc_out/ScreenShareConversationNotificationErrorBody.html.md +22 -0
  257. data/doc_out/ScreenShareConversationNotificationErrorInfo.html.md +22 -0
  258. data/doc_out/ScreenShareConversationNotificationParticipants.html.md +36 -0
  259. data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +36 -0
  260. data/doc_out/ScreenShareConversationNotificationUriReference.html.md +14 -0
  261. data/doc_out/Screenshare.html.md +20 -0
  262. data/doc_out/SearchApi.html.md +26 -26
  263. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  264. data/doc_out/Segment.html.md +5 -5
  265. data/doc_out/ServiceContext.html.md +1 -1
  266. data/doc_out/ShareEntityListing.html.md +2 -2
  267. data/doc_out/Site.html.md +1 -1
  268. data/doc_out/SiteEntityListing.html.md +2 -2
  269. data/doc_out/SkillEntityListing.html.md +2 -2
  270. data/doc_out/SocialConversationNotification.html.md +16 -0
  271. data/doc_out/SocialConversationNotificationDetail.html.md +16 -0
  272. data/doc_out/SocialConversationNotificationErrorBody.html.md +22 -0
  273. data/doc_out/SocialConversationNotificationErrorInfo.html.md +22 -0
  274. data/doc_out/SocialConversationNotificationParticipants.html.md +37 -0
  275. data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +37 -0
  276. data/doc_out/SocialConversationNotificationUriReference.html.md +14 -0
  277. data/doc_out/SocialExpression.html.md +13 -13
  278. data/doc_out/StationEntityListing.html.md +2 -2
  279. data/doc_out/StreetAddress.html.md +1 -1
  280. data/doc_out/SubscriberResponse.html.md +2 -2
  281. data/doc_out/SuggestApi.html.md +14 -14
  282. data/doc_out/TagValue.html.md +1 -1
  283. data/doc_out/TagValueEntityListing.html.md +2 -2
  284. data/doc_out/TelephonyProvidersEdgeApi.html.md +121 -7
  285. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  286. data/doc_out/TrunkEntityListing.html.md +2 -2
  287. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  288. data/doc_out/UserConversationSummaryNotification.html.md +19 -0
  289. data/doc_out/UserConversationSummaryNotificationCall.html.md +14 -0
  290. data/doc_out/UserConversationSummaryNotificationCallContactCenter.html.md +14 -0
  291. data/doc_out/UserConversationSummaryNotificationMediaSummary.html.md +14 -0
  292. data/doc_out/UserConversationSummaryNotificationMediaSummaryDetail.html.md +14 -0
  293. data/doc_out/UserEntityListing.html.md +2 -2
  294. data/doc_out/UserMe.html.md +1 -0
  295. data/doc_out/UserPresenceNotification.html.md +16 -0
  296. data/doc_out/UserPresenceNotificationOrganizationPresence.html.md +14 -0
  297. data/doc_out/UserPresenceNotificationPresenceDefinition.html.md +14 -0
  298. data/doc_out/UserQueueEntityListing.html.md +2 -2
  299. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  300. data/doc_out/UserRecordingsApi.html.md +6 -6
  301. data/doc_out/UserRoutingSkillPost.html.md +16 -0
  302. data/doc_out/UserSkillEntityListing.html.md +2 -2
  303. data/doc_out/UsersApi.html.md +14 -14
  304. data/doc_out/UsersEntityListing.html.md +2 -2
  305. data/doc_out/ValidateAddressRequest.html.md +1 -1
  306. data/doc_out/ValidateAddressResponse.html.md +2 -2
  307. data/doc_out/Video.html.md +10 -10
  308. data/doc_out/VideoConversationNotification.html.md +16 -0
  309. data/doc_out/VideoConversationNotificationDetail.html.md +16 -0
  310. data/doc_out/VideoConversationNotificationErrorBody.html.md +22 -0
  311. data/doc_out/VideoConversationNotificationErrorInfo.html.md +22 -0
  312. data/doc_out/VideoConversationNotificationParticipants.html.md +39 -0
  313. data/doc_out/VideoConversationNotificationUriReference.html.md +14 -0
  314. data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +39 -0
  315. data/doc_out/VmPairingInfo.html.md +16 -0
  316. data/doc_out/WorkspaceCreate.html.md +1 -1
  317. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  318. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  319. data/doc_out/Wrapup.html.md +7 -7
  320. data/doc_out/WrapupCode.html.md +1 -1
  321. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  322. data/doc_out/index.html.md +6 -6
  323. data/lib/purecloud.rb +138 -0
  324. data/lib/purecloud/api/alerting_api.rb +473 -0
  325. data/lib/purecloud/api/content_management_api.rb +49 -100
  326. data/lib/purecloud/api/conversations_api.rb +749 -164
  327. data/lib/purecloud/api/groups_api.rb +126 -4
  328. data/lib/purecloud/api/locations_api.rb +4 -4
  329. data/lib/purecloud/api/outbound_api.rb +386 -0
  330. data/lib/purecloud/api/presence_api.rb +8 -2
  331. data/lib/purecloud/api/quality_api.rb +14 -14
  332. data/lib/purecloud/api/recording_api.rb +63 -2
  333. data/lib/purecloud/api/routing_api.rb +108 -30
  334. data/lib/purecloud/api/search_api.rb +26 -26
  335. data/lib/purecloud/api/suggest_api.rb +14 -14
  336. data/lib/purecloud/api/telephony_providers_edge_api.rb +128 -8
  337. data/lib/purecloud/api/user_recordings_api.rb +9 -9
  338. data/lib/purecloud/api/users_api.rb +12 -12
  339. data/lib/purecloud/api_client.rb +1 -1
  340. data/lib/purecloud/models/acw_settings.rb +2 -0
  341. data/lib/purecloud/models/address.rb +210 -0
  342. data/lib/purecloud/models/agent.rb +1 -0
  343. data/lib/purecloud/models/agent_activity_entity_listing.rb +13 -13
  344. data/lib/purecloud/models/analytics_session.rb +1 -1
  345. data/lib/purecloud/models/attempt_limits.rb +271 -0
  346. data/lib/purecloud/models/attempt_limits_entity_listing.rb +257 -0
  347. data/lib/purecloud/models/attribute.rb +1 -0
  348. data/lib/purecloud/models/attribute_entity_listing.rb +13 -13
  349. data/lib/purecloud/models/audit_entity.rb +4 -0
  350. data/lib/purecloud/models/audit_facet.rb +2 -0
  351. data/lib/purecloud/models/audit_filter.rb +4 -0
  352. data/lib/purecloud/models/audit_message.rb +14 -0
  353. data/lib/purecloud/models/audit_search_result.rb +4 -0
  354. data/lib/purecloud/models/audit_user.rb +3 -0
  355. data/lib/purecloud/models/available_topic_entity_listing.rb +13 -13
  356. data/lib/purecloud/models/calibration_create.rb +323 -0
  357. data/lib/purecloud/models/calibration_entity_listing.rb +13 -13
  358. data/lib/purecloud/models/call.rb +18 -4
  359. data/lib/purecloud/models/call_command.rb +1 -0
  360. data/lib/purecloud/models/call_conversation_entity_listing.rb +13 -13
  361. data/lib/purecloud/models/call_conversation_notification.rb +218 -0
  362. data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +513 -0
  363. data/lib/purecloud/models/call_conversation_notification_detail.rb +195 -0
  364. data/lib/purecloud/models/call_conversation_notification_error_body.rb +261 -0
  365. data/lib/purecloud/models/call_conversation_notification_error_info.rb +261 -0
  366. data/lib/purecloud/models/call_conversation_notification_fax_status.rb +235 -0
  367. data/lib/purecloud/models/call_conversation_notification_participants.rb +513 -0
  368. data/lib/purecloud/models/call_conversation_notification_uri_reference.rb +175 -0
  369. data/lib/purecloud/models/call_media_participant.rb +38 -5
  370. data/lib/purecloud/models/callable_time_set_entity_listing.rb +13 -13
  371. data/lib/purecloud/models/callback.rb +17 -5
  372. data/lib/purecloud/models/callback_conversation_entity_listing.rb +13 -13
  373. data/lib/purecloud/models/callback_conversation_notification.rb +199 -0
  374. data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +456 -0
  375. data/lib/purecloud/models/callback_conversation_notification_detail.rb +195 -0
  376. data/lib/purecloud/models/callback_conversation_notification_dialer_preview.rb +217 -0
  377. data/lib/purecloud/models/callback_conversation_notification_error_body.rb +261 -0
  378. data/lib/purecloud/models/callback_conversation_notification_error_info.rb +261 -0
  379. data/lib/purecloud/models/callback_conversation_notification_error_info_details.rb +195 -0
  380. data/lib/purecloud/models/callback_conversation_notification_participants.rb +456 -0
  381. data/lib/purecloud/models/callback_conversation_notification_phone_number_column.rb +185 -0
  382. data/lib/purecloud/models/callback_conversation_notification_uri_reference.rb +175 -0
  383. data/lib/purecloud/models/callback_conversation_notification_user.rb +175 -0
  384. data/lib/purecloud/models/callback_media_participant.rb +38 -5
  385. data/lib/purecloud/models/campaign.rb +12 -1
  386. data/lib/purecloud/models/campaign_entity_listing.rb +13 -13
  387. data/lib/purecloud/models/campaign_interaction.rb +388 -0
  388. data/lib/purecloud/models/campaign_interactions.rb +213 -0
  389. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +13 -13
  390. data/lib/purecloud/models/certificate_authority_entity_listing.rb +13 -13
  391. data/lib/purecloud/models/change.rb +3 -0
  392. data/lib/purecloud/models/channel_entity_listing.rb +13 -13
  393. data/lib/purecloud/models/channel_topic_entity_listing.rb +13 -13
  394. data/lib/purecloud/models/chat_conversation_entity_listing.rb +13 -13
  395. data/lib/purecloud/models/chat_conversation_notification.rb +199 -0
  396. data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +404 -0
  397. data/lib/purecloud/models/chat_conversation_notification_detail.rb +195 -0
  398. data/lib/purecloud/models/chat_conversation_notification_error_body.rb +261 -0
  399. data/lib/purecloud/models/chat_conversation_notification_error_info.rb +261 -0
  400. data/lib/purecloud/models/chat_conversation_notification_participants.rb +404 -0
  401. data/lib/purecloud/models/chat_conversation_notification_uri_reference.rb +175 -0
  402. data/lib/purecloud/models/chat_media_participant.rb +38 -5
  403. data/lib/purecloud/models/cobrowse_conversation.rb +213 -0
  404. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +257 -0
  405. data/lib/purecloud/models/cobrowse_conversation_notification.rb +199 -0
  406. data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +446 -0
  407. data/lib/purecloud/models/cobrowse_conversation_notification_detail.rb +195 -0
  408. data/lib/purecloud/models/cobrowse_conversation_notification_error_body.rb +261 -0
  409. data/lib/purecloud/models/cobrowse_conversation_notification_error_info.rb +261 -0
  410. data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +446 -0
  411. data/lib/purecloud/models/cobrowse_conversation_notification_uri_reference.rb +175 -0
  412. data/lib/purecloud/models/cobrowse_media_participant.rb +511 -0
  413. data/lib/purecloud/models/cobrowsesession.rb +296 -0
  414. data/lib/purecloud/models/command_status_entity_listing.rb +13 -13
  415. data/lib/purecloud/models/contact_list_entity_listing.rb +13 -13
  416. data/lib/purecloud/models/contact_sort.rb +1 -0
  417. data/lib/purecloud/models/conversation_chat.rb +26 -7
  418. data/lib/purecloud/models/conversation_entity_listing.rb +13 -13
  419. data/lib/purecloud/models/conversation_notification.rb +207 -0
  420. data/lib/purecloud/models/conversation_notification_address.rb +215 -0
  421. data/lib/purecloud/models/conversation_notification_call.rb +383 -0
  422. data/lib/purecloud/models/conversation_notification_callback.rb +344 -0
  423. data/lib/purecloud/models/conversation_notification_callbacks.rb +344 -0
  424. data/lib/purecloud/models/conversation_notification_calls.rb +383 -0
  425. data/lib/purecloud/models/conversation_notification_chat.rb +263 -0
  426. data/lib/purecloud/models/conversation_notification_chats.rb +263 -0
  427. data/lib/purecloud/models/conversation_notification_cobrowse.rb +305 -0
  428. data/lib/purecloud/models/conversation_notification_cobrowsesessions.rb +305 -0
  429. data/lib/purecloud/models/conversation_notification_dialer_preview.rb +217 -0
  430. data/lib/purecloud/models/conversation_notification_dialer_preview_phone_number_columns.rb +185 -0
  431. data/lib/purecloud/models/conversation_notification_disconnect_reason.rb +194 -0
  432. data/lib/purecloud/models/conversation_notification_disconnect_reasons.rb +194 -0
  433. data/lib/purecloud/models/conversation_notification_email.rb +283 -0
  434. data/lib/purecloud/models/conversation_notification_emails.rb +283 -0
  435. data/lib/purecloud/models/conversation_notification_error_details.rb +237 -0
  436. data/lib/purecloud/models/conversation_notification_error_info.rb +237 -0
  437. data/lib/purecloud/models/conversation_notification_fax_status.rb +235 -0
  438. data/lib/purecloud/models/conversation_notification_participant.rb +443 -0
  439. data/lib/purecloud/models/conversation_notification_participants.rb +443 -0
  440. data/lib/purecloud/models/conversation_notification_phone_number_column.rb +185 -0
  441. data/lib/purecloud/models/conversation_notification_screen_share.rb +263 -0
  442. data/lib/purecloud/models/conversation_notification_screen_shares.rb +263 -0
  443. data/lib/purecloud/models/conversation_notification_self.rb +215 -0
  444. data/lib/purecloud/models/conversation_notification_social_expression.rb +303 -0
  445. data/lib/purecloud/models/conversation_notification_social_expressions.rb +303 -0
  446. data/lib/purecloud/models/conversation_notification_video.rb +302 -0
  447. data/lib/purecloud/models/conversation_notification_videos.rb +302 -0
  448. data/lib/purecloud/models/conversation_notification_wrapup.rb +217 -0
  449. data/lib/purecloud/models/create_callback_command.rb +1 -1
  450. data/lib/purecloud/models/create_share_request.rb +3 -0
  451. data/lib/purecloud/models/dialer_audit_request.rb +4 -0
  452. data/lib/purecloud/models/dialer_contact.rb +1 -1
  453. data/lib/purecloud/models/dialer_preview.rb +4 -0
  454. data/lib/purecloud/models/did_entity_listing.rb +13 -13
  455. data/lib/purecloud/models/did_pool_entity_listing.rb +13 -13
  456. data/lib/purecloud/models/disconnect_reason.rb +3 -0
  457. data/lib/purecloud/models/dnc_list.rb +2 -14
  458. data/lib/purecloud/models/dnc_list_entity_listing.rb +13 -13
  459. data/lib/purecloud/models/document_audit_entity_listing.rb +13 -13
  460. data/lib/purecloud/models/document_entity_listing.rb +13 -13
  461. data/lib/purecloud/models/document_update.rb +1 -0
  462. data/lib/purecloud/models/document_upload.rb +2 -0
  463. data/lib/purecloud/models/domain_capabilities.rb +33 -4
  464. data/lib/purecloud/models/domain_edge_software_version_dto.rb +13 -13
  465. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +257 -0
  466. data/lib/purecloud/models/domain_entity_listing.rb +13 -13
  467. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +13 -13
  468. data/lib/purecloud/models/domain_entity_listing_query_result.rb +13 -13
  469. data/lib/purecloud/models/domain_logical_interface.rb +25 -41
  470. data/lib/purecloud/models/domain_network_address.rb +22 -0
  471. data/lib/purecloud/models/domain_network_route.rb +14 -0
  472. data/lib/purecloud/models/domain_organization_role_create.rb +266 -0
  473. data/lib/purecloud/models/edge.rb +21 -1
  474. data/lib/purecloud/models/edge_entity_listing.rb +13 -13
  475. data/lib/purecloud/models/edge_group_entity_listing.rb +13 -13
  476. data/lib/purecloud/models/edge_line_entity_listing.rb +13 -13
  477. data/lib/purecloud/models/edge_logs_job_request.rb +3 -0
  478. data/lib/purecloud/models/edge_logs_job_upload_request.rb +1 -1
  479. data/lib/purecloud/models/edge_offline_configuration.rb +177 -0
  480. data/lib/purecloud/models/edge_offline_configuration_interface.rb +203 -0
  481. data/lib/purecloud/models/edge_offline_configuration_network.rb +166 -0
  482. data/lib/purecloud/models/edge_offline_configuration_response.rb +166 -0
  483. data/lib/purecloud/models/email.rb +28 -8
  484. data/lib/purecloud/models/email_conversation_entity_listing.rb +13 -13
  485. data/lib/purecloud/models/email_conversation_notification.rb +199 -0
  486. data/lib/purecloud/models/email_conversation_notification_detail.rb +195 -0
  487. data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +414 -0
  488. data/lib/purecloud/models/email_conversation_notification_error_body.rb +261 -0
  489. data/lib/purecloud/models/email_conversation_notification_error_info.rb +261 -0
  490. data/lib/purecloud/models/email_conversation_notification_participants.rb +414 -0
  491. data/lib/purecloud/models/email_conversation_notification_uri_reference.rb +175 -0
  492. data/lib/purecloud/models/email_media_participant.rb +38 -5
  493. data/lib/purecloud/models/email_message_listing.rb +13 -13
  494. data/lib/purecloud/models/encryption_key_entity_listing.rb +13 -13
  495. data/lib/purecloud/models/endpoint_entity_listing.rb +13 -13
  496. data/lib/purecloud/models/entry.rb +2 -0
  497. data/lib/purecloud/models/evaluation_entity_listing.rb +13 -13
  498. data/lib/purecloud/models/evaluation_form.rb +3 -0
  499. data/lib/purecloud/models/evaluation_form_entity_listing.rb +13 -13
  500. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +13 -13
  501. data/lib/purecloud/models/extension_entity_listing.rb +13 -13
  502. data/lib/purecloud/models/extension_pool_entity_listing.rb +13 -13
  503. data/lib/purecloud/models/facet_info.rb +2 -0
  504. data/lib/purecloud/models/fax_document_entity_listing.rb +13 -13
  505. data/lib/purecloud/models/fax_status.rb +8 -0
  506. data/lib/purecloud/models/group.rb +1 -0
  507. data/lib/purecloud/models/group_entity_listing.rb +13 -13
  508. data/lib/purecloud/models/group_members_update.rb +2 -0
  509. data/lib/purecloud/models/group_update.rb +286 -0
  510. data/lib/purecloud/models/heart_beat_alert.rb +299 -0
  511. data/lib/purecloud/models/heart_beat_alert_container.rb +257 -0
  512. data/lib/purecloud/models/heart_beat_alert_notification.rb +268 -0
  513. data/lib/purecloud/models/heart_beat_alert_notification_notification_user.rb +175 -0
  514. data/lib/purecloud/models/heart_beat_alert_notification_notification_users.rb +175 -0
  515. data/lib/purecloud/models/heart_beat_rule.rb +282 -0
  516. data/lib/purecloud/models/heart_beat_rule_container.rb +257 -0
  517. data/lib/purecloud/models/heart_beat_rule_notification.rb +258 -0
  518. data/lib/purecloud/models/heart_beat_rule_notification_notification_user.rb +175 -0
  519. data/lib/purecloud/models/inbound_domain_entity_listing.rb +13 -13
  520. data/lib/purecloud/models/inbound_route_entity_listing.rb +13 -13
  521. data/lib/purecloud/models/interaction_stat_alert_notification.rb +364 -0
  522. data/lib/purecloud/models/interaction_stat_alert_notification_notification_user.rb +175 -0
  523. data/lib/purecloud/models/interaction_stat_rule_notification.rb +344 -0
  524. data/lib/purecloud/models/interaction_stat_rule_notification_notification_user.rb +175 -0
  525. data/lib/purecloud/models/interaction_stats_alert_container.rb +13 -13
  526. data/lib/purecloud/models/interaction_stats_rule_container.rb +13 -13
  527. data/lib/purecloud/models/json_node.rb +20 -20
  528. data/lib/purecloud/models/keyword.rb +41 -1
  529. data/lib/purecloud/models/keyword_set.rb +1 -0
  530. data/lib/purecloud/models/keyword_set_entity_listing.rb +13 -13
  531. data/lib/purecloud/models/language.rb +1 -0
  532. data/lib/purecloud/models/language_entity_listing.rb +13 -13
  533. data/lib/purecloud/models/library.rb +1 -0
  534. data/lib/purecloud/models/library_entity_listing.rb +13 -13
  535. data/lib/purecloud/models/line_base_entity_listing.rb +13 -13
  536. data/lib/purecloud/models/line_entity_listing.rb +13 -13
  537. data/lib/purecloud/models/logical_interface_entity_listing.rb +13 -13
  538. data/lib/purecloud/models/max_participants.rb +1 -0
  539. data/lib/purecloud/models/meta_data.rb +187 -0
  540. data/lib/purecloud/models/o_auth_client_entity_listing.rb +13 -13
  541. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +13 -13
  542. data/lib/purecloud/models/organization_presence.rb +1 -0
  543. data/lib/purecloud/models/organization_presence_entity_listing.rb +13 -13
  544. data/lib/purecloud/models/organization_role_entity_listing.rb +13 -13
  545. data/lib/purecloud/models/orphan_recording_listing.rb +13 -13
  546. data/lib/purecloud/models/out_of_office_notification.rb +205 -0
  547. data/lib/purecloud/models/out_of_office_notification_user.rb +165 -0
  548. data/lib/purecloud/models/outbound_route_entity_listing.rb +13 -13
  549. data/lib/purecloud/models/participant.rb +61 -4
  550. data/lib/purecloud/models/participant_attributes.rb +1 -0
  551. data/lib/purecloud/models/permission_collection_entity_listing.rb +13 -13
  552. data/lib/purecloud/models/phone_base_entity_listing.rb +13 -13
  553. data/lib/purecloud/models/phone_entity_listing.rb +13 -13
  554. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +13 -13
  555. data/lib/purecloud/models/phones_reboot.rb +2 -0
  556. data/lib/purecloud/models/physical_interface_entity_listing.rb +13 -13
  557. data/lib/purecloud/models/policy_create.rb +285 -0
  558. data/lib/purecloud/models/policy_entity_listing.rb +13 -13
  559. data/lib/purecloud/models/quality_audit.rb +11 -11
  560. data/lib/purecloud/models/quality_audit_page.rb +13 -13
  561. data/lib/purecloud/models/queue_entity_listing.rb +13 -13
  562. data/lib/purecloud/models/queue_member_entity_listing.rb +257 -0
  563. data/lib/purecloud/models/report_meta_data_entity_listing.rb +13 -13
  564. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +13 -13
  565. data/lib/purecloud/models/report_schedule_entity_listing.rb +13 -13
  566. data/lib/purecloud/models/response_entity_list.rb +13 -13
  567. data/lib/purecloud/models/response_entity_listing.rb +13 -13
  568. data/lib/purecloud/models/response_set_entity_listing.rb +13 -13
  569. data/lib/purecloud/models/routing_skill.rb +1 -0
  570. data/lib/purecloud/models/routing_status.rb +3 -1
  571. data/lib/purecloud/models/rule_set_entity_listing.rb +13 -13
  572. data/lib/purecloud/models/schema_category_entity_listing.rb +13 -13
  573. data/lib/purecloud/models/schema_reference_entity_listing.rb +13 -13
  574. data/lib/purecloud/models/screen_recording_session.rb +36 -4
  575. data/lib/purecloud/models/screen_recording_session_listing.rb +51 -1
  576. data/lib/purecloud/models/screen_recording_session_request.rb +197 -0
  577. data/lib/purecloud/models/screen_share_conversation_notification.rb +199 -0
  578. data/lib/purecloud/models/screen_share_conversation_notification_detail.rb +195 -0
  579. data/lib/purecloud/models/screen_share_conversation_notification_error_body.rb +261 -0
  580. data/lib/purecloud/models/screen_share_conversation_notification_error_info.rb +261 -0
  581. data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +424 -0
  582. data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +424 -0
  583. data/lib/purecloud/models/screen_share_conversation_notification_uri_reference.rb +175 -0
  584. data/lib/purecloud/models/screenshare.rb +263 -0
  585. data/lib/purecloud/models/security_profile_entity_listing.rb +13 -13
  586. data/lib/purecloud/models/segment.rb +5 -2
  587. data/lib/purecloud/models/service_context.rb +1 -0
  588. data/lib/purecloud/models/share_entity_listing.rb +13 -13
  589. data/lib/purecloud/models/site.rb +1 -1
  590. data/lib/purecloud/models/site_entity_listing.rb +13 -13
  591. data/lib/purecloud/models/skill_entity_listing.rb +13 -13
  592. data/lib/purecloud/models/social_conversation_notification.rb +199 -0
  593. data/lib/purecloud/models/social_conversation_notification_detail.rb +195 -0
  594. data/lib/purecloud/models/social_conversation_notification_error_body.rb +261 -0
  595. data/lib/purecloud/models/social_conversation_notification_error_info.rb +261 -0
  596. data/lib/purecloud/models/social_conversation_notification_participants.rb +434 -0
  597. data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +434 -0
  598. data/lib/purecloud/models/social_conversation_notification_uri_reference.rb +175 -0
  599. data/lib/purecloud/models/social_expression.rb +14 -4
  600. data/lib/purecloud/models/station_entity_listing.rb +13 -13
  601. data/lib/purecloud/models/street_address.rb +1 -0
  602. data/lib/purecloud/models/subscriber_response.rb +2 -0
  603. data/lib/purecloud/models/tag_value.rb +1 -0
  604. data/lib/purecloud/models/tag_value_entity_listing.rb +13 -13
  605. data/lib/purecloud/models/time_zone_entity_listing.rb +13 -13
  606. data/lib/purecloud/models/trunk_entity_listing.rb +13 -13
  607. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +13 -13
  608. data/lib/purecloud/models/user_conversation_summary_notification.rb +225 -0
  609. data/lib/purecloud/models/user_conversation_summary_notification_call.rb +175 -0
  610. data/lib/purecloud/models/user_conversation_summary_notification_call_contact_center.rb +175 -0
  611. data/lib/purecloud/models/user_conversation_summary_notification_media_summary.rb +175 -0
  612. data/lib/purecloud/models/user_conversation_summary_notification_media_summary_detail.rb +175 -0
  613. data/lib/purecloud/models/user_entity_listing.rb +13 -13
  614. data/lib/purecloud/models/user_me.rb +14 -1
  615. data/lib/purecloud/models/user_presence_notification.rb +195 -0
  616. data/lib/purecloud/models/user_presence_notification_organization_presence.rb +175 -0
  617. data/lib/purecloud/models/user_presence_notification_presence_definition.rb +175 -0
  618. data/lib/purecloud/models/user_queue_entity_listing.rb +13 -13
  619. data/lib/purecloud/models/user_recording_entity_listing.rb +13 -13
  620. data/lib/purecloud/models/user_routing_skill_post.rb +200 -0
  621. data/lib/purecloud/models/user_skill_entity_listing.rb +13 -13
  622. data/lib/purecloud/models/users_entity_listing.rb +13 -13
  623. data/lib/purecloud/models/validate_address_request.rb +1 -1
  624. data/lib/purecloud/models/validate_address_response.rb +2 -0
  625. data/lib/purecloud/models/video.rb +11 -3
  626. data/lib/purecloud/models/video_conversation_notification.rb +199 -0
  627. data/lib/purecloud/models/video_conversation_notification_detail.rb +195 -0
  628. data/lib/purecloud/models/video_conversation_notification_error_body.rb +261 -0
  629. data/lib/purecloud/models/video_conversation_notification_error_info.rb +261 -0
  630. data/lib/purecloud/models/video_conversation_notification_participants.rb +463 -0
  631. data/lib/purecloud/models/video_conversation_notification_uri_reference.rb +175 -0
  632. data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +463 -0
  633. data/lib/purecloud/models/vm_pairing_info.rb +196 -0
  634. data/lib/purecloud/models/workspace_create.rb +1 -0
  635. data/lib/purecloud/models/workspace_entity_listing.rb +13 -13
  636. data/lib/purecloud/models/workspace_member_entity_listing.rb +13 -13
  637. data/lib/purecloud/models/wrapup.rb +7 -1
  638. data/lib/purecloud/models/wrapup_code.rb +1 -0
  639. data/lib/purecloud/models/wrapup_code_entity_listing.rb +13 -13
  640. data/lib/purecloud/version.rb +1 -1
  641. data/newVersion.md +1 -1
  642. data/swagger.json +1 -1
  643. data/version.json +1 -1
  644. metadata +279 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ad5eb361d037933395a7b58dac32a2932cc79c07
4
- data.tar.gz: e126564330d245015c84f1afd4cf54243133b083
3
+ metadata.gz: 12957fc96a3abb1a2dc6fd0cafeb2ff3de86d4ef
4
+ data.tar.gz: 618e7c5a9632f5354027e7ea3bf0f94fe1ed0dd7
5
5
  SHA512:
6
- metadata.gz: 23d94e1c67838eb931e4b3dbb5ca913682c75b75f1901fd41b4a9f0be6a54e3b3e8e10f886e4c9a1c35af3e4e14a350324602a3cc7344851cc8429dd07b1cf76
7
- data.tar.gz: 94b483755270693b9a090dd3f98a143772f8991ff88246fed66ed0436d12f4efe5d6c4fa710db3a0bf42b34a21f4212e82fd68c0f7e75b169469f7b1a0239504
6
+ metadata.gz: 68703f09f13e7ef4b907f1430291186483965ff1de278c42680c40d5ee548c1202612a6a8c42b7f23557860a677f6c15dcfaf76865eae7ee96d3ddde6be1675f
7
+ data.tar.gz: 8df94e41c96dcd3128584d368db9ce190647ea7eed20a9efc50073cb3cd3d101c79505c4dd90ce77d16016e9422427d33f0e397cd595f3f605609528949d98ff
data/README.md CHANGED
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
9
9
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
10
10
 
11
11
  - API version: v2
12
- - Package version: 0.50.1
13
- - Build date: 2016-08-14T03:13:45.449Z
12
+ - Package version: 0.51.1
13
+ - Build date: 2016-10-06T14:06:47.047Z
14
14
 
15
15
  For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
16
16
 
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
18
18
 
19
19
  ### from rubygems.org
20
20
 
21
- gem 'purecloud', '~> 0.50.1'
21
+ gem 'purecloud', '~> 0.51.1'
22
22
 
23
23
  ### Install from Git
24
24
 
@@ -47,10 +47,10 @@ alert_id = "alert_id_example" # String | Alert ID
47
47
 
48
48
 
49
49
  begin
50
- #Delete an interaction stats alert
51
- api_instance.delete_interactionstats_alerts_alert_id(alert_id)
50
+ #Delete a heart beat alert
51
+ api_instance.delete_heartbeat_alerts_alert_id(alert_id)
52
52
  rescue PureCloud::ApiError => e
53
- puts "Exception when calling AlertingApi->delete_interactionstats_alerts_alert_id: #{e}"
53
+ puts "Exception when calling AlertingApi->delete_heartbeat_alerts_alert_id: #{e}"
54
54
  end
55
55
 
56
56
  ~~~
@@ -0,0 +1,96 @@
1
+ {
2
+ "notifications": [
3
+ {
4
+ "topic": "v2.routing.queues.{id}.conversations",
5
+ "class": "ConversationNotification"
6
+ },
7
+ {
8
+ "topic": "v2.routing.queues.{id}.conversations.callbacks",
9
+ "class": "CallbackConversationNotification"
10
+ },
11
+ {
12
+ "topic": "v2.routing.queues.{id}.conversations.calls",
13
+ "class": "CallConversationNotification"
14
+ },
15
+ {
16
+ "topic": "v2.routing.queues.{id}.conversations.chats",
17
+ "class": "ChatConversationNotification"
18
+ },
19
+ {
20
+ "topic": "v2.routing.queues.{id}.conversations.cobrowseSessions",
21
+ "class": "CobrowseConversationNotification"
22
+ },
23
+ {
24
+ "topic": "v2.routing.queues.{id}.conversations.emails",
25
+ "class": "EmailConversationNotification"
26
+ },
27
+ {
28
+ "topic": "v2.routing.queues.{id}.conversations.screenshares",
29
+ "class": "ScreenShareConversationNotification"
30
+ },
31
+ {
32
+ "topic": "v2.users.{id}.alerting.heartbeat.alerts",
33
+ "class": "HeartBeatAlertNotification"
34
+ },
35
+ {
36
+ "topic": "v2.users.{id}.alerting.heartbeat.rules",
37
+ "class": "HeartBeatRuleNotification"
38
+ },
39
+ {
40
+ "topic": "v2.users.{id}.alerting.interactionstats.alerts",
41
+ "class": "InteractionStatAlertNotification"
42
+ },
43
+ {
44
+ "topic": "v2.users.{id}.alerting.interactionstats.rules",
45
+ "class": "InteractionStatRuleNotification"
46
+ },
47
+ {
48
+ "topic": "v2.users.{id}.conversations",
49
+ "class": "ConversationNotification"
50
+ },
51
+ {
52
+ "topic": "v2.users.{id}.conversations.callbacks",
53
+ "class": "CallbackConversationNotification"
54
+ },
55
+ {
56
+ "topic": "v2.users.{id}.conversations.calls",
57
+ "class": "CallConversationNotification"
58
+ },
59
+ {
60
+ "topic": "v2.users.{id}.conversations.chats",
61
+ "class": "ChatConversationNotification"
62
+ },
63
+ {
64
+ "topic": "v2.users.{id}.conversations.cobrowseSessions",
65
+ "class": "CobrowseConversationNotification"
66
+ },
67
+ {
68
+ "topic": "v2.users.{id}.conversations.emails",
69
+ "class": "EmailConversationNotification"
70
+ },
71
+ {
72
+ "topic": "v2.users.{id}.conversations.screenshares",
73
+ "class": "ScreenShareConversationNotification"
74
+ },
75
+ {
76
+ "topic": "v2.users.{id}.conversations.socialexpressions",
77
+ "class": "SocialConversationNotification"
78
+ },
79
+ {
80
+ "topic": "v2.users.{id}.conversations.videos",
81
+ "class": "VideoConversationNotification"
82
+ },
83
+ {
84
+ "topic": "v2.users.{id}.conversationsummary",
85
+ "class": "UserConversationSummaryNotification"
86
+ },
87
+ {
88
+ "topic": "v2.users.{id}.outofoffice",
89
+ "class": "OutOfOfficeNotification"
90
+ },
91
+ {
92
+ "topic": "v2.users.{id}.presence",
93
+ "class": "UserPresenceNotification"
94
+ }
95
+ ]
96
+ }
@@ -1 +1 @@
1
- {"gemVersion":"0.50.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.50.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
1
+ {"gemVersion":"0.51.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.51.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
@@ -7,8 +7,8 @@ title: AcwSettings
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **wrapup_prompt** | **String** | | [optional] |
11
- | **timeout_ms** | **Integer** | | [optional] |
10
+ | **wrapup_prompt** | **String** | This field controls how the UI prompts the agent for a wrapup. | [optional] |
11
+ | **timeout_ms** | **Integer** | The amount of time the agent can stay in ACW (Min: 1 sec, Max: 1 day). Can only be used when ACW is MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT. | [optional] |
12
12
  {: class="table table-striped"}
13
13
 
14
14
 
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: Address
3
+ ---
4
+ ## PureCloud::Address
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **name** | **String** | This will be nameRaw if present, or a locality lookup of the address field otherwise. | [optional] |
11
+ | **name_raw** | **String** | The name as close to the bits on the wire as possible. | [optional] |
12
+ | **address_normalized** | **String** | The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. | [optional] |
13
+ | **address_raw** | **String** | The address as close to the bits on the wire as possible. | [optional] |
14
+ | **address_displayable** | **String** | The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -7,7 +7,7 @@ title: Agent
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **stage** | **String** | | [optional] |
10
+ | **stage** | **String** | The current stage for this agent | [optional] |
11
11
  {: class="table table-striped"}
12
12
 
13
13
 
@@ -12,9 +12,9 @@ title: AgentActivityEntityListing
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array<AgentActivity>**](AgentActivity.html) | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
15
  | **next_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **first_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -8,18 +8,136 @@ All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
9
  Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
+ |[**delete_heartbeat_alerts_alert_id**](AlertingApi.html#delete_heartbeat_alerts_alert_id) | **DELETE** /api/v2/alerting/heartbeat/alerts/{alertId} | Delete a heart beat alert|
12
+ |[**delete_heartbeat_rules_rule_id**](AlertingApi.html#delete_heartbeat_rules_rule_id) | **DELETE** /api/v2/alerting/heartbeat/rules/{ruleId} | Delete a heart beat rule.|
11
13
  |[**delete_interactionstats_alerts_alert_id**](AlertingApi.html#delete_interactionstats_alerts_alert_id) | **DELETE** /api/v2/alerting/interactionstats/alerts/{alertId} | Delete an interaction stats alert|
12
14
  |[**delete_interactionstats_rules_rule_id**](AlertingApi.html#delete_interactionstats_rules_rule_id) | **DELETE** /api/v2/alerting/interactionstats/rules/{ruleId} | Delete an interaction stats rule.|
15
+ |[**get_heartbeat_alerts**](AlertingApi.html#get_heartbeat_alerts) | **GET** /api/v2/alerting/heartbeat/alerts | Get heart beat alert list.|
16
+ |[**get_heartbeat_alerts_alert_id**](AlertingApi.html#get_heartbeat_alerts_alert_id) | **GET** /api/v2/alerting/heartbeat/alerts/{alertId} | Get a heart beat alert|
17
+ |[**get_heartbeat_rules**](AlertingApi.html#get_heartbeat_rules) | **GET** /api/v2/alerting/heartbeat/rules | Get a heart beat rule list.|
18
+ |[**get_heartbeat_rules_rule_id**](AlertingApi.html#get_heartbeat_rules_rule_id) | **GET** /api/v2/alerting/heartbeat/rules/{ruleId} | Get a heart beat rule.|
13
19
  |[**get_interactionstats_alerts**](AlertingApi.html#get_interactionstats_alerts) | **GET** /api/v2/alerting/interactionstats/alerts | Get interaction stats alert list.|
14
20
  |[**get_interactionstats_alerts_alert_id**](AlertingApi.html#get_interactionstats_alerts_alert_id) | **GET** /api/v2/alerting/interactionstats/alerts/{alertId} | Get an interaction stats alert|
15
21
  |[**get_interactionstats_alerts_unread**](AlertingApi.html#get_interactionstats_alerts_unread) | **GET** /api/v2/alerting/interactionstats/alerts/unread | Gets user unread count of interaction stats alerts.|
16
22
  |[**get_interactionstats_rules**](AlertingApi.html#get_interactionstats_rules) | **GET** /api/v2/alerting/interactionstats/rules | Get an interaction stats rule list.|
17
23
  |[**get_interactionstats_rules_rule_id**](AlertingApi.html#get_interactionstats_rules_rule_id) | **GET** /api/v2/alerting/interactionstats/rules/{ruleId} | Get an interaction stats rule.|
24
+ |[**post_heartbeat_rules**](AlertingApi.html#post_heartbeat_rules) | **POST** /api/v2/alerting/heartbeat/rules | Create a heart beat rule.|
18
25
  |[**post_interactionstats_rules**](AlertingApi.html#post_interactionstats_rules) | **POST** /api/v2/alerting/interactionstats/rules | Create an interaction stats rule.|
26
+ |[**put_heartbeat_rules_rule_id**](AlertingApi.html#put_heartbeat_rules_rule_id) | **PUT** /api/v2/alerting/heartbeat/rules/{ruleId} | Update a heart beat rule|
19
27
  |[**put_interactionstats_alerts_alert_id**](AlertingApi.html#put_interactionstats_alerts_alert_id) | **PUT** /api/v2/alerting/interactionstats/alerts/{alertId} | Update an interaction stats alert read status|
20
28
  |[**put_interactionstats_rules_rule_id**](AlertingApi.html#put_interactionstats_rules_rule_id) | **PUT** /api/v2/alerting/interactionstats/rules/{ruleId} | Update an interaction stats rule|
21
29
  {: class="table table-striped"}
22
30
 
31
+ <a name="delete_heartbeat_alerts_alert_id"></a>
32
+
33
+ ## - delete_heartbeat_alerts_alert_id(alert_id)
34
+
35
+ Delete a heart beat alert
36
+
37
+
38
+
39
+ ### Example
40
+ ~~~ruby
41
+ # load the gem
42
+ require 'purecloud'
43
+ # setup authorization
44
+ @secret = ENV['PURECLOUD_SECRET']
45
+ @id = ENV['PURECLOUD_CLIENT_ID']
46
+ environment = "mypurecloud.com"
47
+
48
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
49
+
50
+ PureCloud.configure do |config|
51
+ config.access_token = @authToken
52
+ end
53
+
54
+ api_instance = PureCloud::AlertingApi.new
55
+
56
+ alert_id = "alert_id_example" # String | Alert ID
57
+
58
+
59
+ begin
60
+ #Delete a heart beat alert
61
+ api_instance.delete_heartbeat_alerts_alert_id(alert_id)
62
+ rescue PureCloud::ApiError => e
63
+ puts "Exception when calling AlertingApi->delete_heartbeat_alerts_alert_id: #{e}"
64
+ end
65
+ ~~~
66
+
67
+ ### Parameters
68
+
69
+ Name | Type | Description | Notes
70
+ ------------- | ------------- | ------------- | -------------
71
+ **alert_id** | **String**| Alert ID |
72
+ {: class="table table-striped"}
73
+
74
+
75
+ ### Return type
76
+
77
+ nil (empty response body)
78
+
79
+ ### HTTP request headers
80
+
81
+ - **Content-Type**: application/json
82
+ - **Accept**: application/json
83
+
84
+
85
+
86
+ <a name="delete_heartbeat_rules_rule_id"></a>
87
+
88
+ ## - delete_heartbeat_rules_rule_id(rule_id)
89
+
90
+ Delete a heart beat rule.
91
+
92
+
93
+
94
+ ### Example
95
+ ~~~ruby
96
+ # load the gem
97
+ require 'purecloud'
98
+ # setup authorization
99
+ @secret = ENV['PURECLOUD_SECRET']
100
+ @id = ENV['PURECLOUD_CLIENT_ID']
101
+ environment = "mypurecloud.com"
102
+
103
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
104
+
105
+ PureCloud.configure do |config|
106
+ config.access_token = @authToken
107
+ end
108
+
109
+ api_instance = PureCloud::AlertingApi.new
110
+
111
+ rule_id = "rule_id_example" # String | Rule ID
112
+
113
+
114
+ begin
115
+ #Delete a heart beat rule.
116
+ api_instance.delete_heartbeat_rules_rule_id(rule_id)
117
+ rescue PureCloud::ApiError => e
118
+ puts "Exception when calling AlertingApi->delete_heartbeat_rules_rule_id: #{e}"
119
+ end
120
+ ~~~
121
+
122
+ ### Parameters
123
+
124
+ Name | Type | Description | Notes
125
+ ------------- | ------------- | ------------- | -------------
126
+ **rule_id** | **String**| Rule ID |
127
+ {: class="table table-striped"}
128
+
129
+
130
+ ### Return type
131
+
132
+ nil (empty response body)
133
+
134
+ ### HTTP request headers
135
+
136
+ - **Content-Type**: application/json
137
+ - **Accept**: application/json
138
+
139
+
140
+
23
141
  <a name="delete_interactionstats_alerts_alert_id"></a>
24
142
 
25
143
  ## - delete_interactionstats_alerts_alert_id(alert_id)
@@ -130,6 +248,218 @@ nil (empty response body)
130
248
 
131
249
 
132
250
 
251
+ <a name="get_heartbeat_alerts"></a>
252
+
253
+ ## -[**HeartBeatAlertContainer**](HeartBeatAlertContainer.html) get_heartbeat_alerts
254
+
255
+ Get heart beat alert list.
256
+
257
+
258
+
259
+ ### Example
260
+ ~~~ruby
261
+ # load the gem
262
+ require 'purecloud'
263
+ # setup authorization
264
+ @secret = ENV['PURECLOUD_SECRET']
265
+ @id = ENV['PURECLOUD_CLIENT_ID']
266
+ environment = "mypurecloud.com"
267
+
268
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
269
+
270
+ PureCloud.configure do |config|
271
+ config.access_token = @authToken
272
+ end
273
+
274
+ api_instance = PureCloud::AlertingApi.new
275
+
276
+ begin
277
+ #Get heart beat alert list.
278
+ result = api_instance.get_heartbeat_alerts
279
+ p result
280
+ rescue PureCloud::ApiError => e
281
+ puts "Exception when calling AlertingApi->get_heartbeat_alerts: #{e}"
282
+ end
283
+ ~~~
284
+
285
+ ### Parameters
286
+ This endpoint does not need any parameter.
287
+ {: class="table table-striped"}
288
+
289
+
290
+ ### Return type
291
+
292
+ [**HeartBeatAlertContainer**](HeartBeatAlertContainer.html)
293
+
294
+ ### HTTP request headers
295
+
296
+ - **Content-Type**: application/json
297
+ - **Accept**: application/json
298
+
299
+
300
+
301
+ <a name="get_heartbeat_alerts_alert_id"></a>
302
+
303
+ ## -[**HeartBeatAlert**](HeartBeatAlert.html) get_heartbeat_alerts_alert_id(alert_id)
304
+
305
+ Get a heart beat alert
306
+
307
+
308
+
309
+ ### Example
310
+ ~~~ruby
311
+ # load the gem
312
+ require 'purecloud'
313
+ # setup authorization
314
+ @secret = ENV['PURECLOUD_SECRET']
315
+ @id = ENV['PURECLOUD_CLIENT_ID']
316
+ environment = "mypurecloud.com"
317
+
318
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
319
+
320
+ PureCloud.configure do |config|
321
+ config.access_token = @authToken
322
+ end
323
+
324
+ api_instance = PureCloud::AlertingApi.new
325
+
326
+ alert_id = "alert_id_example" # String | Alert ID
327
+
328
+
329
+ begin
330
+ #Get a heart beat alert
331
+ result = api_instance.get_heartbeat_alerts_alert_id(alert_id)
332
+ p result
333
+ rescue PureCloud::ApiError => e
334
+ puts "Exception when calling AlertingApi->get_heartbeat_alerts_alert_id: #{e}"
335
+ end
336
+ ~~~
337
+
338
+ ### Parameters
339
+
340
+ Name | Type | Description | Notes
341
+ ------------- | ------------- | ------------- | -------------
342
+ **alert_id** | **String**| Alert ID |
343
+ {: class="table table-striped"}
344
+
345
+
346
+ ### Return type
347
+
348
+ [**HeartBeatAlert**](HeartBeatAlert.html)
349
+
350
+ ### HTTP request headers
351
+
352
+ - **Content-Type**: application/json
353
+ - **Accept**: application/json
354
+
355
+
356
+
357
+ <a name="get_heartbeat_rules"></a>
358
+
359
+ ## -[**HeartBeatRuleContainer**](HeartBeatRuleContainer.html) get_heartbeat_rules
360
+
361
+ Get a heart beat rule list.
362
+
363
+
364
+
365
+ ### Example
366
+ ~~~ruby
367
+ # load the gem
368
+ require 'purecloud'
369
+ # setup authorization
370
+ @secret = ENV['PURECLOUD_SECRET']
371
+ @id = ENV['PURECLOUD_CLIENT_ID']
372
+ environment = "mypurecloud.com"
373
+
374
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
375
+
376
+ PureCloud.configure do |config|
377
+ config.access_token = @authToken
378
+ end
379
+
380
+ api_instance = PureCloud::AlertingApi.new
381
+
382
+ begin
383
+ #Get a heart beat rule list.
384
+ result = api_instance.get_heartbeat_rules
385
+ p result
386
+ rescue PureCloud::ApiError => e
387
+ puts "Exception when calling AlertingApi->get_heartbeat_rules: #{e}"
388
+ end
389
+ ~~~
390
+
391
+ ### Parameters
392
+ This endpoint does not need any parameter.
393
+ {: class="table table-striped"}
394
+
395
+
396
+ ### Return type
397
+
398
+ [**HeartBeatRuleContainer**](HeartBeatRuleContainer.html)
399
+
400
+ ### HTTP request headers
401
+
402
+ - **Content-Type**: application/json
403
+ - **Accept**: application/json
404
+
405
+
406
+
407
+ <a name="get_heartbeat_rules_rule_id"></a>
408
+
409
+ ## -[**HeartBeatRule**](HeartBeatRule.html) get_heartbeat_rules_rule_id(rule_id)
410
+
411
+ Get a heart beat rule.
412
+
413
+
414
+
415
+ ### Example
416
+ ~~~ruby
417
+ # load the gem
418
+ require 'purecloud'
419
+ # setup authorization
420
+ @secret = ENV['PURECLOUD_SECRET']
421
+ @id = ENV['PURECLOUD_CLIENT_ID']
422
+ environment = "mypurecloud.com"
423
+
424
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
425
+
426
+ PureCloud.configure do |config|
427
+ config.access_token = @authToken
428
+ end
429
+
430
+ api_instance = PureCloud::AlertingApi.new
431
+
432
+ rule_id = "rule_id_example" # String | Rule ID
433
+
434
+
435
+ begin
436
+ #Get a heart beat rule.
437
+ result = api_instance.get_heartbeat_rules_rule_id(rule_id)
438
+ p result
439
+ rescue PureCloud::ApiError => e
440
+ puts "Exception when calling AlertingApi->get_heartbeat_rules_rule_id: #{e}"
441
+ end
442
+ ~~~
443
+
444
+ ### Parameters
445
+
446
+ Name | Type | Description | Notes
447
+ ------------- | ------------- | ------------- | -------------
448
+ **rule_id** | **String**| Rule ID |
449
+ {: class="table table-striped"}
450
+
451
+
452
+ ### Return type
453
+
454
+ [**HeartBeatRule**](HeartBeatRule.html)
455
+
456
+ ### HTTP request headers
457
+
458
+ - **Content-Type**: application/json
459
+ - **Accept**: application/json
460
+
461
+
462
+
133
463
  <a name="get_interactionstats_alerts"></a>
134
464
 
135
465
  ## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_interactionstats_alerts
@@ -392,6 +722,62 @@ Name | Type | Description | Notes
392
722
 
393
723
 
394
724
 
725
+ <a name="post_heartbeat_rules"></a>
726
+
727
+ ## -[**HeartBeatRule**](HeartBeatRule.html) post_heartbeat_rules(body)
728
+
729
+ Create a heart beat rule.
730
+
731
+
732
+
733
+ ### Example
734
+ ~~~ruby
735
+ # load the gem
736
+ require 'purecloud'
737
+ # setup authorization
738
+ @secret = ENV['PURECLOUD_SECRET']
739
+ @id = ENV['PURECLOUD_CLIENT_ID']
740
+ environment = "mypurecloud.com"
741
+
742
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
743
+
744
+ PureCloud.configure do |config|
745
+ config.access_token = @authToken
746
+ end
747
+
748
+ api_instance = PureCloud::AlertingApi.new
749
+
750
+ body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule
751
+
752
+
753
+ begin
754
+ #Create a heart beat rule.
755
+ result = api_instance.post_heartbeat_rules(body)
756
+ p result
757
+ rescue PureCloud::ApiError => e
758
+ puts "Exception when calling AlertingApi->post_heartbeat_rules: #{e}"
759
+ end
760
+ ~~~
761
+
762
+ ### Parameters
763
+
764
+ Name | Type | Description | Notes
765
+ ------------- | ------------- | ------------- | -------------
766
+ **body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule |
767
+ {: class="table table-striped"}
768
+
769
+
770
+ ### Return type
771
+
772
+ [**HeartBeatRule**](HeartBeatRule.html)
773
+
774
+ ### HTTP request headers
775
+
776
+ - **Content-Type**: application/json
777
+ - **Accept**: application/json
778
+
779
+
780
+
395
781
  <a name="post_interactionstats_rules"></a>
396
782
 
397
783
  ## -[**InteractionStatsRule**](InteractionStatsRule.html) post_interactionstats_rules(body)
@@ -448,6 +834,65 @@ Name | Type | Description | Notes
448
834
 
449
835
 
450
836
 
837
+ <a name="put_heartbeat_rules_rule_id"></a>
838
+
839
+ ## -[**HeartBeatRule**](HeartBeatRule.html) put_heartbeat_rules_rule_id(rule_id, body)
840
+
841
+ Update a heart beat rule
842
+
843
+
844
+
845
+ ### Example
846
+ ~~~ruby
847
+ # load the gem
848
+ require 'purecloud'
849
+ # setup authorization
850
+ @secret = ENV['PURECLOUD_SECRET']
851
+ @id = ENV['PURECLOUD_CLIENT_ID']
852
+ environment = "mypurecloud.com"
853
+
854
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
855
+
856
+ PureCloud.configure do |config|
857
+ config.access_token = @authToken
858
+ end
859
+
860
+ api_instance = PureCloud::AlertingApi.new
861
+
862
+ rule_id = "rule_id_example" # String | Rule ID
863
+
864
+ body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule
865
+
866
+
867
+ begin
868
+ #Update a heart beat rule
869
+ result = api_instance.put_heartbeat_rules_rule_id(rule_id, body)
870
+ p result
871
+ rescue PureCloud::ApiError => e
872
+ puts "Exception when calling AlertingApi->put_heartbeat_rules_rule_id: #{e}"
873
+ end
874
+ ~~~
875
+
876
+ ### Parameters
877
+
878
+ Name | Type | Description | Notes
879
+ ------------- | ------------- | ------------- | -------------
880
+ **rule_id** | **String**| Rule ID |
881
+ **body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule |
882
+ {: class="table table-striped"}
883
+
884
+
885
+ ### Return type
886
+
887
+ [**HeartBeatRule**](HeartBeatRule.html)
888
+
889
+ ### HTTP request headers
890
+
891
+ - **Content-Type**: application/json
892
+ - **Accept**: application/json
893
+
894
+
895
+
451
896
  <a name="put_interactionstats_alerts_alert_id"></a>
452
897
 
453
898
  ## -[**UnreadStatus**](UnreadStatus.html) put_interactionstats_alerts_alert_id(alert_id, body)