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
@@ -12,9 +12,9 @@ title: OutboundRouteEntityListing
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array<OutboundRoute>**](OutboundRoute.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"}
@@ -7,35 +7,38 @@ title: Participant
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | | [optional] |
11
- | **start_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
12
- | **end_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
- | **connected_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
- | **name** | **String** | | [optional] |
15
- | **user_uri** | **String** | | [optional] |
16
- | **user_id** | **String** | | [optional] |
17
- | **external_contact_id** | **String** | | [optional] |
18
- | **queue_id** | **String** | | [optional] |
19
- | **group_id** | **String** | | [optional] |
20
- | **queue_name** | **String** | | [optional] |
21
- | **purpose** | **String** | | [optional] |
22
- | **participant_type** | **String** | | [optional] |
23
- | **consult_participant_id** | **String** | | [optional] |
24
- | **address** | **String** | | [optional] |
25
- | **ani** | **String** | | [optional] |
26
- | **dnis** | **String** | | [optional] |
27
- | **locale** | **String** | | [optional] |
28
- | **wrapup_required** | **BOOLEAN** | | [optional] [default to false]|
29
- | **wrapup_prompt** | **String** | | [optional] |
30
- | **wrapup_timeout_ms** | **Integer** | | [optional] |
31
- | **wrapup_skipped** | **BOOLEAN** | | [optional] [default to false]|
32
- | **wrapup** | [**Wrapup**](Wrapup.html) | | [optional] |
33
- | **monitored_participant_id** | **String** | | [optional] |
34
- | **attributes** | **Hash<String, String>** | | [optional] |
10
+ | **id** | **String** | A globally unique identifier for this conversation. | [optional] |
11
+ | **start_time** | **DateTime** | The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
12
+ | **end_time** | **DateTime** | The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **connected_time** | **DateTime** | The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **name** | **String** | A human readable name identifying the participant. | [optional] |
15
+ | **user_uri** | **String** | If this participant represents a user, then this will be an URI that can be used to fetch the user. | [optional] |
16
+ | **user_id** | **String** | If this participant represents a user, then this will be the globally unique identifier for the user. | [optional] |
17
+ | **external_contact_id** | **String** | If this participant represents an external contact, then this will be the globally unique identifier for the external contact. | [optional] |
18
+ | **external_organization_id** | **String** | If this participant represents an external org, then this will be the globally unique identifier for the external org. | [optional] |
19
+ | **queue_id** | **String** | If present, the queue id that the communication channel came in on. | [optional] |
20
+ | **group_id** | **String** | If present, group of users the participant represents. | [optional] |
21
+ | **queue_name** | **String** | If present, the queue name that the communication channel came in on. | [optional] |
22
+ | **purpose** | **String** | A well known string that specifies the purpose of this participant. | [optional] |
23
+ | **participant_type** | **String** | A well known string that specifies the type of this participant. | [optional] |
24
+ | **consult_participant_id** | **String** | If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred. | [optional] |
25
+ | **address** | **String** | The address for the this participant. For a phone call this will be the ANI. | [optional] |
26
+ | **ani** | **String** | The address for the this participant. For a phone call this will be the ANI. | [optional] |
27
+ | **dnis** | **String** | The address for the this participant. For a phone call this will be the ANI. | [optional] |
28
+ | **locale** | **String** | An ISO 639 language code specifying the locale for this participant | [optional] |
29
+ | **wrapup_required** | **BOOLEAN** | True iff this participant is required to enter wrapup for this conversation. | [optional] [default to false]|
30
+ | **wrapup_prompt** | **String** | This field controls how the UI prompts the agent for a wrapup. | [optional] |
31
+ | **wrapup_timeout_ms** | **Integer** | Specifies how long a timed ACW session will last. | [optional] |
32
+ | **wrapup_skipped** | **BOOLEAN** | The UI sets this field when the agent chooses to skip entering a wrapup for this participant. | [optional] [default to false]|
33
+ | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
34
+ | **monitored_participant_id** | **String** | If this participant is a monitor, then this will be the id of the participant that is being monitored. | [optional] |
35
+ | **attributes** | **Hash<String, String>** | Additional participant attributes | [optional] |
35
36
  | **calls** | [**Array<Call>**](Call.html) | | [optional] |
36
37
  | **callbacks** | [**Array<Callback>**](Callback.html) | | [optional] |
37
38
  | **chats** | [**Array<ConversationChat>**](ConversationChat.html) | | [optional] |
39
+ | **cobrowsesessions** | [**Array<Cobrowsesession>**](Cobrowsesession.html) | | [optional] |
38
40
  | **emails** | [**Array<Email>**](Email.html) | | [optional] |
41
+ | **screenshares** | [**Array<Screenshare>**](Screenshare.html) | | [optional] |
39
42
  | **social_expressions** | [**Array<SocialExpression>**](SocialExpression.html) | | [optional] |
40
43
  | **videos** | [**Array<Video>**](Video.html) | | [optional] |
41
44
  | **evaluations** | [**Array<Evaluation>**](Evaluation.html) | | [optional] |
@@ -7,7 +7,7 @@ title: ParticipantAttributes
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **attributes** | **Hash<String, String>** | | [optional] |
10
+ | **attributes** | **Hash<String, String>** | The map of attribute keys to values. | [optional] |
11
11
  {: class="table table-striped"}
12
12
 
13
13
 
@@ -12,9 +12,9 @@ title: PermissionCollectionEntityListing
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array<DomainPermissionCollection>**](DomainPermissionCollection.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"}
@@ -12,9 +12,9 @@ title: PhoneBaseEntityListing
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array<PhoneBase>**](PhoneBase.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"}
@@ -12,9 +12,9 @@ title: PhoneEntityListing
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array<Phone>**](Phone.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"}
@@ -12,9 +12,9 @@ title: PhoneMetaBaseEntityListing
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array<Metabase>**](Metabase.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"}
@@ -7,8 +7,8 @@ title: PhonesReboot
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **phone_ids** | **Array<String>** | | [optional] |
11
- | **site_id** | **String** | | [optional] |
10
+ | **phone_ids** | **Array<String>** | The list of phone Ids to reboot. | [optional] |
11
+ | **site_id** | **String** | ID of the site for which to reboot all phones at that site.\nno.active.edge and phone.cannot.resolve errors are ignored. | [optional] |
12
12
  {: class="table table-striped"}
13
13
 
14
14
 
@@ -12,9 +12,9 @@ title: PhysicalInterfaceEntityListing
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array<DomainPhysicalInterface>**](DomainPhysicalInterface.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"}
@@ -0,0 +1,24 @@
1
+ ---
2
+ title: PolicyCreate
3
+ ---
4
+ ## PureCloud::PolicyCreate
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | The policy name. | |
12
+ | **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **created_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **order** | **Integer** | | [optional] |
15
+ | **description** | **String** | | [optional] |
16
+ | **enabled** | **BOOLEAN** | | [optional] [default to false]|
17
+ | **media_policies** | [**MediaPolicies**](MediaPolicies.html) | Conditions and actions per media type | [optional] |
18
+ | **conditions** | [**PolicyConditions**](PolicyConditions.html) | Conditions | [optional] |
19
+ | **actions** | [**PolicyActions**](PolicyActions.html) | Actions | [optional] |
20
+ | **policy_errors** | [**PolicyErrors**](PolicyErrors.html) | | [optional] |
21
+ | **self_uri** | **String** | The URI for this object | [optional] |
22
+ {: class="table table-striped"}
23
+
24
+
@@ -12,9 +12,9 @@ title: PolicyEntityListing
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array<Policy>**](Policy.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"}
@@ -76,7 +76,7 @@ Name | Type | Description | Notes
76
76
 
77
77
  <a name="get_presence_id"></a>
78
78
 
79
- ## -[**OrganizationPresence**](OrganizationPresence.html) get_presence_id(presence_id)
79
+ ## -[**OrganizationPresence**](OrganizationPresence.html) get_presence_id(presence_id, opts)
80
80
 
81
81
  Get a Presence Definition
82
82
 
@@ -101,10 +101,13 @@ api_instance = PureCloud::PresenceApi.new
101
101
 
102
102
  presence_id = "presence_id_example" # String | Organization Presence ID
103
103
 
104
+ opts = {
105
+ locale_code: "locale_code_example" # String | The locale code to fetch for the presence definition. Use ALL to fetch everything.
106
+ }
104
107
 
105
108
  begin
106
109
  #Get a Presence Definition
107
- result = api_instance.get_presence_id(presence_id)
110
+ result = api_instance.get_presence_id(presence_id, opts)
108
111
  p result
109
112
  rescue PureCloud::ApiError => e
110
113
  puts "Exception when calling PresenceApi->get_presence_id: #{e}"
@@ -116,6 +119,7 @@ end
116
119
  Name | Type | Description | Notes
117
120
  ------------- | ------------- | ------------- | -------------
118
121
  **presence_id** | **String**| Organization Presence ID |
122
+ **locale_code** | **String**| The locale code to fetch for the presence definition. Use ALL to fetch everything. | [optional]
119
123
  {: class="table table-striped"}
120
124
 
121
125
 
@@ -158,7 +162,8 @@ api_instance = PureCloud::PresenceApi.new
158
162
  opts = {
159
163
  page_number: 1, # Integer | Page number
160
164
  page_size: 25, # Integer | Page size
161
- deleted: "false" # String | Deleted query can be true, false or all
165
+ deleted: "false", # String | Deleted query can be TRUE, FALSE or ALL
166
+ locale_code: "locale_code_example" # String | The locale code to fetch for each presence definition. Use ALL to fetch everything.
162
167
  }
163
168
 
164
169
  begin
@@ -176,7 +181,8 @@ Name | Type | Description | Notes
176
181
  ------------- | ------------- | ------------- | -------------
177
182
  **page_number** | **Integer**| Page number | [optional] [default to 1]
178
183
  **page_size** | **Integer**| Page size | [optional] [default to 25]
179
- **deleted** | **String**| Deleted query can be true, false or all | [optional] [default to false]
184
+ **deleted** | **String**| Deleted query can be TRUE, FALSE or ALL | [optional] [default to false]
185
+ **locale_code** | **String**| The locale code to fetch for each presence definition. Use ALL to fetch everything. | [optional]
180
186
  {: class="table table-striped"}
181
187
 
182
188
 
@@ -125,9 +125,9 @@ end
125
125
 
126
126
  api_instance = PureCloud::QualityApi.new
127
127
 
128
- conversation_id = "conversation_id_example" # String |
128
+ conversation_id = "conversation_id_example" # String | conversationId
129
129
 
130
- evaluation_id = "evaluation_id_example" # String |
130
+ evaluation_id = "evaluation_id_example" # String | evaluationId
131
131
 
132
132
  opts = {
133
133
  expand: "expand_example" # String | evaluatorId
@@ -146,8 +146,8 @@ end
146
146
 
147
147
  Name | Type | Description | Notes
148
148
  ------------- | ------------- | ------------- | -------------
149
- **conversation_id** | **String**| |
150
- **evaluation_id** | **String**| |
149
+ **conversation_id** | **String**| conversationId |
150
+ **evaluation_id** | **String**| evaluationId |
151
151
  **expand** | **String**| evaluatorId | [optional]
152
152
  {: class="table table-striped"}
153
153
 
@@ -643,9 +643,9 @@ end
643
643
 
644
644
  api_instance = PureCloud::QualityApi.new
645
645
 
646
- conversation_id = "conversation_id_example" # String |
646
+ conversation_id = "conversation_id_example" # String | conversationId
647
647
 
648
- evaluation_id = "evaluation_id_example" # String |
648
+ evaluation_id = "evaluation_id_example" # String | evaluationId
649
649
 
650
650
  opts = {
651
651
  expand: "expand_example" # String | agent, evaluator, evaluationForm
@@ -664,8 +664,8 @@ end
664
664
 
665
665
  Name | Type | Description | Notes
666
666
  ------------- | ------------- | ------------- | -------------
667
- **conversation_id** | **String**| |
668
- **evaluation_id** | **String**| |
667
+ **conversation_id** | **String**| conversationId |
668
+ **evaluation_id** | **String**| evaluationId |
669
669
  **expand** | **String**| agent, evaluator, evaluationForm | [optional]
670
670
  {: class="table table-striped"}
671
671
 
@@ -1301,7 +1301,7 @@ end
1301
1301
 
1302
1302
  api_instance = PureCloud::QualityApi.new
1303
1303
 
1304
- body = PureCloud::Calibration.new # Calibration | calibration
1304
+ body = PureCloud::CalibrationCreate.new # CalibrationCreate | calibration
1305
1305
 
1306
1306
  opts = {
1307
1307
  expand: "expand_example" # String | calibratorId
@@ -1320,7 +1320,7 @@ end
1320
1320
 
1321
1321
  Name | Type | Description | Notes
1322
1322
  ------------- | ------------- | ------------- | -------------
1323
- **body** | [**Calibration**](Calibration.html)| calibration |
1323
+ **body** | [**CalibrationCreate**](CalibrationCreate.html)| calibration |
1324
1324
  **expand** | **String**| calibratorId | [optional]
1325
1325
  {: class="table table-striped"}
1326
1326
 
@@ -1361,7 +1361,7 @@ end
1361
1361
 
1362
1362
  api_instance = PureCloud::QualityApi.new
1363
1363
 
1364
- conversation_id = "conversation_id_example" # String |
1364
+ conversation_id = "conversation_id_example" # String | conversationId
1365
1365
 
1366
1366
  body = PureCloud::Evaluation.new # Evaluation | evaluation
1367
1367
 
@@ -1382,7 +1382,7 @@ end
1382
1382
 
1383
1383
  Name | Type | Description | Notes
1384
1384
  ------------- | ------------- | ------------- | -------------
1385
- **conversation_id** | **String**| |
1385
+ **conversation_id** | **String**| conversationId |
1386
1386
  **body** | [**Evaluation**](Evaluation.html)| evaluation |
1387
1387
  **expand** | **String**| evaluatorId | [optional]
1388
1388
  {: class="table table-striped"}
@@ -1824,9 +1824,9 @@ end
1824
1824
 
1825
1825
  api_instance = PureCloud::QualityApi.new
1826
1826
 
1827
- conversation_id = "conversation_id_example" # String |
1827
+ conversation_id = "conversation_id_example" # String | conversationId
1828
1828
 
1829
- evaluation_id = "evaluation_id_example" # String |
1829
+ evaluation_id = "evaluation_id_example" # String | evaluationId
1830
1830
 
1831
1831
  body = PureCloud::Evaluation.new # Evaluation | evaluation
1832
1832
 
@@ -1847,8 +1847,8 @@ end
1847
1847
 
1848
1848
  Name | Type | Description | Notes
1849
1849
  ------------- | ------------- | ------------- | -------------
1850
- **conversation_id** | **String**| |
1851
- **evaluation_id** | **String**| |
1850
+ **conversation_id** | **String**| conversationId |
1851
+ **evaluation_id** | **String**| evaluationId |
1852
1852
  **body** | [**Evaluation**](Evaluation.html)| evaluation |
1853
1853
  **expand** | **String**| evaluatorId | [optional]
1854
1854
  {: class="table table-striped"}
@@ -10,8 +10,8 @@ title: QualityAudit
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **user** | [**User**](User.html) | | [optional] |
13
- | **timestamp** | **String** | | [optional] |
14
13
  | **level** | **String** | | [optional] |
14
+ | **timestamp** | **String** | | [optional] |
15
15
  | **entity** | [**AuditEntity**](AuditEntity.html) | | [optional] |
16
16
  | **action** | **String** | | [optional] |
17
17
  | **status** | **String** | | [optional] |
@@ -12,9 +12,9 @@ title: QualityAuditPage
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array&lt;QualityAudit&gt;**](QualityAudit.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"}
@@ -12,9 +12,9 @@ title: QueueEntityListing
12
12
  | **total** | **Integer** | | [optional] |
13
13
  | **entities** | [**Array&lt;Queue&gt;**](Queue.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"}
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: QueueMemberEntityListing
3
+ ---
4
+ ## PureCloud::QueueMemberEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **page_size** | **Integer** | | [optional] |
11
+ | **page_number** | **Integer** | | [optional] |
12
+ | **total** | **Integer** | | [optional] |
13
+ | **entities** | [**Array&lt;QueueMember&gt;**](QueueMember.html) | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **next_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **first_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -23,6 +23,7 @@ Method | HTTP request | Description
23
23
  |[**get_settings**](RecordingApi.html#get_settings) | **GET** /api/v2/recording/settings | Get the Recording Settings for the Organization|
24
24
  |[**gets_screensessions**](RecordingApi.html#gets_screensessions) | **GET** /api/v2/recordings/screensessions | Retrieves a paged listing of screen recording sessions|
25
25
  |[**patch_mediaretentionpolicies_policy_id**](RecordingApi.html#patch_mediaretentionpolicies_policy_id) | **PATCH** /api/v2/recording/mediaretentionpolicies/{policyId} | Patch a media retention policy|
26
+ |[**patchs_screensessions_recordingsession_id**](RecordingApi.html#patchs_screensessions_recordingsession_id) | **PATCH** /api/v2/recordings/screensessions/{recordingSessionId} | Update a screen recording session|
26
27
  |[**post_conversation_id_recordings_recording_id_annotations**](RecordingApi.html#post_conversation_id_recordings_recording_id_annotations) | **POST** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations | Create annotation|
27
28
  |[**post_mediaretentionpolicies**](RecordingApi.html#post_mediaretentionpolicies) | **POST** /api/v2/recording/mediaretentionpolicies | Create media retention policy|
28
29
  |[**put_conversation_id_recordings_recording_id**](RecordingApi.html#put_conversation_id_recordings_recording_id) | **PUT** /api/v2/conversations/{conversationId}/recordings/{recordingId} | Updates the retention records on a recording.|
@@ -938,6 +939,65 @@ Name | Type | Description | Notes
938
939
 
939
940
 
940
941
 
942
+ <a name="patchs_screensessions_recordingsession_id"></a>
943
+
944
+ ## - patchs_screensessions_recordingsession_id(recording_session_id, opts)
945
+
946
+ Update a screen recording session
947
+
948
+
949
+
950
+ ### Example
951
+ ~~~ruby
952
+ # load the gem
953
+ require 'purecloud'
954
+ # setup authorization
955
+ @secret = ENV['PURECLOUD_SECRET']
956
+ @id = ENV['PURECLOUD_CLIENT_ID']
957
+ environment = "mypurecloud.com"
958
+
959
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
960
+
961
+ PureCloud.configure do |config|
962
+ config.access_token = @authToken
963
+ end
964
+
965
+ api_instance = PureCloud::RecordingApi.new
966
+
967
+ recording_session_id = "recording_session_id_example" # String | Screen recording session ID
968
+
969
+ opts = {
970
+ body: PureCloud::ScreenRecordingSessionRequest.new # ScreenRecordingSessionRequest |
971
+ }
972
+
973
+ begin
974
+ #Update a screen recording session
975
+ api_instance.patchs_screensessions_recordingsession_id(recording_session_id, opts)
976
+ rescue PureCloud::ApiError => e
977
+ puts "Exception when calling RecordingApi->patchs_screensessions_recordingsession_id: #{e}"
978
+ end
979
+ ~~~
980
+
981
+ ### Parameters
982
+
983
+ Name | Type | Description | Notes
984
+ ------------- | ------------- | ------------- | -------------
985
+ **recording_session_id** | **String**| Screen recording session ID |
986
+ **body** | [**ScreenRecordingSessionRequest**](ScreenRecordingSessionRequest.html)| | [optional]
987
+ {: class="table table-striped"}
988
+
989
+
990
+ ### Return type
991
+
992
+ nil (empty response body)
993
+
994
+ ### HTTP request headers
995
+
996
+ - **Content-Type**: application/json
997
+ - **Accept**: application/json
998
+
999
+
1000
+
941
1001
  <a name="post_conversation_id_recordings_recording_id_annotations"></a>
942
1002
 
943
1003
  ## -[**Annotation**](Annotation.html) post_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, body)
@@ -1025,7 +1085,7 @@ end
1025
1085
 
1026
1086
  api_instance = PureCloud::RecordingApi.new
1027
1087
 
1028
- body = PureCloud::Policy.new # Policy | Policy
1088
+ body = PureCloud::PolicyCreate.new # PolicyCreate | Policy
1029
1089
 
1030
1090
 
1031
1091
  begin
@@ -1041,7 +1101,7 @@ end
1041
1101
 
1042
1102
  Name | Type | Description | Notes
1043
1103
  ------------- | ------------- | ------------- | -------------
1044
- **body** | [**Policy**](Policy.html)| Policy |
1104
+ **body** | [**PolicyCreate**](PolicyCreate.html)| Policy |
1045
1105
  {: class="table table-striped"}
1046
1106
 
1047
1107
 
@@ -1062,7 +1122,7 @@ Name | Type | Description | Notes
1062
1122
 
1063
1123
  Updates the retention records on a recording.
1064
1124
 
1065
- Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter 'restoreDays' is deprecated and will be removed in the next major version release. If 'restoreDays' is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate's time stamp in the PUT body to 10 days in the future.
1125
+ Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set.
1066
1126
 
1067
1127
  ### Example
1068
1128
  ~~~ruby