purecloud 0.67.1 → 0.68.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (424) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/bin/notificationMappings.json +4 -4
  4. data/config-ruby.json +1 -1
  5. data/doc_out/ActivityCode.html.md +20 -0
  6. data/doc_out/ActivityCodeContainer.html.md +13 -0
  7. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  8. data/doc_out/AlertingApi.html.md +137 -35
  9. data/doc_out/AnalyticsApi.html.md +89 -23
  10. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  11. data/doc_out/AttemptLimitsNotification.html.md +2 -1
  12. data/doc_out/AttributeEntityListing.html.md +2 -2
  13. data/doc_out/AttributesApi.html.md +25 -7
  14. data/doc_out/AuthorizationApi.html.md +69 -18
  15. data/doc_out/CalibrationEntityListing.html.md +2 -2
  16. data/doc_out/CallConversationEntityListing.html.md +2 -2
  17. data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
  18. data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
  19. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  20. data/doc_out/CallableTimeSetNotification.html.md +1 -1
  21. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  22. data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
  23. data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
  24. data/doc_out/CampaignEntityListing.html.md +2 -2
  25. data/doc_out/CampaignNotification.html.md +2 -2
  26. data/doc_out/{CampaignNotificationError.html.md → CampaignNotificationRestErrorDetail.html.md} +2 -2
  27. data/doc_out/CampaignProgressNotification.html.md +1 -1
  28. data/doc_out/CampaignRuleEntityListing.html.md +2 -2
  29. data/doc_out/CampaignRuleNotification.html.md +1 -1
  30. data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
  31. data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +2 -3
  32. data/doc_out/CampaignRuleNotificationUriReference.html.md +14 -0
  33. data/doc_out/CampaignScheduleNotification.html.md +2 -2
  34. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  35. data/doc_out/CampaignSequenceNotification.html.md +2 -2
  36. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  37. data/doc_out/ChannelEntityListing.html.md +2 -2
  38. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  39. data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
  40. data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
  41. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  42. data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
  43. data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
  44. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  45. data/doc_out/ContactListEntityListing.html.md +2 -2
  46. data/doc_out/ContactListNotification.html.md +2 -2
  47. data/doc_out/{ContactListNotificationPhoneColumn_.html.md → ContactListNotificationContactPhoneNumberColumn.html.md} +2 -2
  48. data/doc_out/ContentManagementApi.html.md +153 -39
  49. data/doc_out/ConversationEntityListing.html.md +2 -2
  50. data/doc_out/ConversationsApi.html.md +421 -76
  51. data/doc_out/CreateEmailRequest.html.md +23 -0
  52. data/doc_out/CreateWebChatRequest.html.md +19 -0
  53. data/doc_out/DIDEntityListing.html.md +2 -2
  54. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  55. data/doc_out/DecisionsFileMetadataEntityListing.html.md +2 -2
  56. data/doc_out/DncListEntityListing.html.md +2 -2
  57. data/doc_out/DncListNotification.html.md +1 -1
  58. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  59. data/doc_out/DocumentDataV2Notification.html.md +26 -0
  60. data/doc_out/{RecordingDataNotificationUserData.html.md → DocumentDataV2NotificationCreatedBy.html.md} +2 -2
  61. data/doc_out/DocumentDataV2NotificationLockData.html.md +15 -0
  62. data/doc_out/DocumentDataV2NotificationLockInfo.html.md +15 -0
  63. data/doc_out/{DocumentDataNotificationUserData.html.md → DocumentDataV2NotificationUserData.html.md} +2 -2
  64. data/doc_out/{DocumentDataNotificationWorkspace.html.md → DocumentDataV2NotificationWorkspace.html.md} +2 -2
  65. data/doc_out/{DocumentDataNotificationWorkspaceData.html.md → DocumentDataV2NotificationWorkspaceData.html.md} +2 -2
  66. data/doc_out/DocumentEntityListing.html.md +2 -2
  67. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  68. data/doc_out/DomainEntityListing.html.md +2 -2
  69. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  70. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  71. data/doc_out/DomainOrganizationRole.html.md +1 -1
  72. data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
  73. data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
  74. data/doc_out/EdgeEntityListing.html.md +2 -2
  75. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  76. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  77. data/doc_out/EdgeRebootParameters.html.md +13 -0
  78. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  79. data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
  80. data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
  81. data/doc_out/EmailMessageListing.html.md +2 -2
  82. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  83. data/doc_out/EndpointEntityListing.html.md +2 -2
  84. data/doc_out/Entry.html.md +2 -2
  85. data/doc_out/EntryFeatureBoolean.html.md +14 -0
  86. data/doc_out/EvaluationEntityListing.html.md +2 -2
  87. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  88. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  89. data/doc_out/ExtensionEntityListing.html.md +2 -2
  90. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  91. data/doc_out/FaxApi.html.md +25 -7
  92. data/doc_out/FaxDataV2Notification.html.md +29 -0
  93. data/doc_out/FaxDataV2NotificationLockData.html.md +15 -0
  94. data/doc_out/FaxDataV2NotificationLockInfo.html.md +15 -0
  95. data/doc_out/{FaxDataNotificationUserData.html.md → FaxDataV2NotificationUserData.html.md} +2 -2
  96. data/doc_out/{FaxDataNotificationWorkspaceData.html.md → FaxDataV2NotificationWorkspaceData.html.md} +2 -2
  97. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  98. data/doc_out/GeolocationApi.html.md +17 -5
  99. data/doc_out/GreetingListing.html.md +2 -2
  100. data/doc_out/GreetingsApi.html.md +65 -17
  101. data/doc_out/GroupEntityListing.html.md +2 -2
  102. data/doc_out/GroupsApi.html.md +45 -12
  103. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  104. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  105. data/doc_out/IdentityProviderApi.html.md +89 -23
  106. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  107. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  108. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  109. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  110. data/doc_out/JsonNode.html.md +2 -2
  111. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  112. data/doc_out/LanguageEntityListing.html.md +2 -2
  113. data/doc_out/LanguagesApi.html.md +41 -11
  114. data/doc_out/LibraryEntityListing.html.md +2 -2
  115. data/doc_out/LineBaseEntityListing.html.md +2 -2
  116. data/doc_out/LineEntityListing.html.md +2 -2
  117. data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
  118. data/doc_out/LocationsApi.html.md +17 -5
  119. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  120. data/doc_out/NotificationsApi.html.md +29 -8
  121. data/doc_out/OAuthApi.html.md +25 -7
  122. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  123. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  124. data/doc_out/Organization.html.md +1 -0
  125. data/doc_out/OrganizationApi.html.md +70 -3
  126. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  127. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  128. data/doc_out/OrphanRecordingListing.html.md +2 -2
  129. data/doc_out/OutOfOfficeNotification.html.md +1 -1
  130. data/doc_out/OutboundApi.html.md +323 -95
  131. data/doc_out/OutboundRouteBaseEntityListing.html.md +2 -2
  132. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  133. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  134. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  135. data/doc_out/PhoneEntityListing.html.md +2 -2
  136. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  137. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  138. data/doc_out/PolicyEntityListing.html.md +2 -2
  139. data/doc_out/PresenceApi.html.md +33 -9
  140. data/doc_out/QualityApi.html.md +128 -33
  141. data/doc_out/QualityAuditPage.html.md +2 -2
  142. data/doc_out/QueueEntityListing.html.md +2 -2
  143. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  144. data/doc_out/RecordingApi.html.md +133 -34
  145. data/doc_out/RecordingDataV2Notification.html.md +29 -0
  146. data/doc_out/{RecordingDataNotificationConversationData.html.md → RecordingDataV2NotificationConversationData.html.md} +2 -2
  147. data/doc_out/RecordingDataV2NotificationLockData.html.md +15 -0
  148. data/doc_out/RecordingDataV2NotificationLockInfo.html.md +15 -0
  149. data/doc_out/{DocumentDataNotificationCreatedBy.html.md → RecordingDataV2NotificationUserData.html.md} +2 -2
  150. data/doc_out/{RecordingDataNotificationWorkspaceData.html.md → RecordingDataV2NotificationWorkspaceData.html.md} +2 -2
  151. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  152. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  153. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  154. data/doc_out/ResponseEntityList.html.md +2 -2
  155. data/doc_out/ResponseEntityListing.html.md +2 -2
  156. data/doc_out/ResponseManagementApi.html.md +45 -12
  157. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  158. data/doc_out/ResponseSetNotification.html.md +1 -1
  159. data/doc_out/RoutingApi.html.md +193 -49
  160. data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
  161. data/doc_out/RoutingStatusRuleContainer.html.md +2 -2
  162. data/doc_out/RuleSetEntityListing.html.md +2 -2
  163. data/doc_out/RuleSetNotification.html.md +1 -1
  164. data/doc_out/RuleSetNotificationCondition.html.md +1 -1
  165. data/doc_out/RuleSetNotificationConditions.html.md +1 -1
  166. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  167. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  168. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  169. data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
  170. data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
  171. data/doc_out/ScriptEntityListing.html.md +2 -2
  172. data/doc_out/ScriptsApi.html.md +37 -10
  173. data/doc_out/SearchApi.html.md +49 -13
  174. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  175. data/doc_out/SequenceScheduleNotification.html.md +2 -2
  176. data/doc_out/ShareEntityListing.html.md +2 -2
  177. data/doc_out/SiteEntityListing.html.md +2 -2
  178. data/doc_out/SkillEntityListing.html.md +2 -2
  179. data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
  180. data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
  181. data/doc_out/StationEntityListing.html.md +2 -2
  182. data/doc_out/StationsApi.html.md +13 -4
  183. data/doc_out/SuggestApi.html.md +17 -5
  184. data/doc_out/TagValueEntityListing.html.md +2 -2
  185. data/doc_out/TelephonyProvidersEdgeApi.html.md +479 -121
  186. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  187. data/doc_out/TokensApi.html.md +5 -2
  188. data/doc_out/TrunkBaseEntityListing.html.md +2 -2
  189. data/doc_out/TrunkEntityListing.html.md +2 -2
  190. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  191. data/doc_out/UserEntityListing.html.md +2 -2
  192. data/doc_out/UserListScheduleRequestBody.html.md +15 -0
  193. data/doc_out/UserPresenceAlertContainer.html.md +2 -2
  194. data/doc_out/UserPresenceRuleContainer.html.md +2 -2
  195. data/doc_out/UserQueueEntityListing.html.md +2 -2
  196. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  197. data/doc_out/UserRecordingsApi.html.md +25 -7
  198. data/doc_out/UserSchedule.html.md +14 -0
  199. data/doc_out/UserScheduleActivity.html.md +18 -0
  200. data/doc_out/UserScheduleContainer.html.md +14 -0
  201. data/doc_out/UserScheduleFullDayTimeOffMarker.html.md +17 -0
  202. data/doc_out/UserScheduleShift.html.md +15 -0
  203. data/doc_out/UserSkillEntityListing.html.md +2 -2
  204. data/doc_out/UsersApi.html.md +169 -43
  205. data/doc_out/UtilitiesApi.html.md +13 -4
  206. data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
  207. data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
  208. data/doc_out/VoicemailApi.html.md +89 -23
  209. data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
  210. data/doc_out/WfmUserEntityListing.html.md +13 -0
  211. data/doc_out/WorkforceManagementApi.html.md +227 -13
  212. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  213. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  214. data/doc_out/WrapUpCodeMappingNotification.html.md +0 -1
  215. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  216. data/doc_out/index.html.md +3 -3
  217. data/lib/purecloud.rb +34 -20
  218. data/lib/purecloud/api/conversations_api.rb +120 -0
  219. data/lib/purecloud/api/organization_api.rb +57 -0
  220. data/lib/purecloud/api/outbound_api.rb +9 -9
  221. data/lib/purecloud/api/quality_api.rb +7 -0
  222. data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -1
  223. data/lib/purecloud/api/workforce_management_api.rb +185 -3
  224. data/lib/purecloud/api_client.rb +1 -1
  225. data/lib/purecloud/models/activity_code.rb +253 -0
  226. data/lib/purecloud/models/activity_code_container.rb +169 -0
  227. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  228. data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
  229. data/lib/purecloud/models/attempt_limits_notification.rb +24 -14
  230. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  231. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  232. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  233. data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
  234. data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
  235. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  236. data/lib/purecloud/models/callable_time_set_notification.rb +13 -13
  237. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  238. data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
  239. data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
  240. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  241. data/lib/purecloud/models/campaign_notification.rb +15 -15
  242. data/lib/purecloud/models/{campaign_notification_error.rb → campaign_notification_rest_error_detail.rb} +1 -1
  243. data/lib/purecloud/models/campaign_progress_notification.rb +1 -1
  244. data/lib/purecloud/models/campaign_rule_entity_listing.rb +17 -17
  245. data/lib/purecloud/models/campaign_rule_notification.rb +14 -14
  246. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +2 -2
  247. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +3 -13
  248. data/lib/purecloud/models/campaign_rule_notification_uri_reference.rb +175 -0
  249. data/lib/purecloud/models/campaign_schedule_notification.rb +14 -14
  250. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  251. data/lib/purecloud/models/campaign_sequence_notification.rb +15 -15
  252. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  253. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  254. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  255. data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
  256. data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
  257. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
  258. data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
  259. data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
  260. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  261. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  262. data/lib/purecloud/models/contact_list_notification.rb +14 -14
  263. data/lib/purecloud/models/{contact_list_notification_phone_column_.rb → contact_list_notification_contact_phone_number_column.rb} +1 -1
  264. data/lib/purecloud/models/contact_list_notification_import_status.rb +1 -1
  265. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  266. data/lib/purecloud/models/create_email_request.rb +280 -0
  267. data/lib/purecloud/models/create_web_chat_request.rb +236 -0
  268. data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +17 -17
  269. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  270. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  271. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  272. data/lib/purecloud/models/dnc_list_notification.rb +14 -14
  273. data/lib/purecloud/models/dnc_list_notification_import_status.rb +1 -1
  274. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  275. data/lib/purecloud/models/{document_data_notification.rb → document_data_v2_notification.rb} +9 -29
  276. data/lib/purecloud/models/{recording_data_notification_user_data.rb → document_data_v2_notification_created_by.rb} +1 -1
  277. data/lib/purecloud/models/{document_data_notification_lock_info.rb → document_data_v2_notification_lock_data.rb} +4 -4
  278. data/lib/purecloud/models/{document_data_notification_lock_data.rb → document_data_v2_notification_lock_info.rb} +4 -4
  279. data/lib/purecloud/models/{document_data_notification_user_data.rb → document_data_v2_notification_user_data.rb} +1 -1
  280. data/lib/purecloud/models/{document_data_notification_workspace.rb → document_data_v2_notification_workspace.rb} +1 -1
  281. data/lib/purecloud/models/{document_data_notification_workspace_data.rb → document_data_v2_notification_workspace_data.rb} +1 -1
  282. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  283. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
  284. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  285. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  286. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  287. data/lib/purecloud/models/domain_organization_role.rb +11 -11
  288. data/lib/purecloud/models/domain_organization_role_create.rb +11 -11
  289. data/lib/purecloud/models/domain_organization_role_update.rb +11 -11
  290. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  291. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  292. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  293. data/lib/purecloud/models/edge_reboot_parameters.rb +166 -0
  294. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  295. data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
  296. data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
  297. data/lib/purecloud/models/email_message_listing.rb +17 -17
  298. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  299. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  300. data/lib/purecloud/models/entry.rb +8 -10
  301. data/lib/purecloud/models/entry_feature_boolean.rb +184 -0
  302. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  303. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  304. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  305. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  306. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  307. data/lib/purecloud/models/{fax_data_notification.rb → fax_data_v2_notification.rb} +9 -29
  308. data/lib/purecloud/models/{fax_data_notification_lock_info.rb → fax_data_v2_notification_lock_data.rb} +4 -4
  309. data/lib/purecloud/models/{fax_data_notification_lock_data.rb → fax_data_v2_notification_lock_info.rb} +4 -4
  310. data/lib/purecloud/models/{fax_data_notification_user_data.rb → fax_data_v2_notification_user_data.rb} +1 -1
  311. data/lib/purecloud/models/{fax_data_notification_workspace_data.rb → fax_data_v2_notification_workspace_data.rb} +1 -1
  312. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  313. data/lib/purecloud/models/greeting_listing.rb +17 -17
  314. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  315. data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
  316. data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
  317. data/lib/purecloud/models/import_status_notification.rb +1 -1
  318. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  319. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  320. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  321. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  322. data/lib/purecloud/models/json_node.rb +24 -24
  323. data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
  324. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  325. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  326. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  327. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  328. data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
  329. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  330. data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
  331. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  332. data/lib/purecloud/models/organization.rb +17 -4
  333. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  334. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  335. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  336. data/lib/purecloud/models/out_of_office_notification.rb +1 -1
  337. data/lib/purecloud/models/outbound_route_base_entity_listing.rb +17 -17
  338. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  339. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  340. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  341. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  342. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  343. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  344. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  345. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  346. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  347. data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
  348. data/lib/purecloud/models/{recording_data_notification.rb → recording_data_v2_notification.rb} +10 -30
  349. data/lib/purecloud/models/{recording_data_notification_conversation_data.rb → recording_data_v2_notification_conversation_data.rb} +1 -1
  350. data/lib/purecloud/models/recording_data_v2_notification_lock_data.rb +185 -0
  351. data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +185 -0
  352. data/lib/purecloud/models/{document_data_notification_created_by.rb → recording_data_v2_notification_user_data.rb} +1 -1
  353. data/lib/purecloud/models/{recording_data_notification_workspace_data.rb → recording_data_v2_notification_workspace_data.rb} +1 -1
  354. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  355. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  356. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  357. data/lib/purecloud/models/response_entity_list.rb +17 -17
  358. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  359. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  360. data/lib/purecloud/models/response_set_notification.rb +13 -13
  361. data/lib/purecloud/models/routing_status_alert_container.rb +17 -17
  362. data/lib/purecloud/models/routing_status_rule_container.rb +17 -17
  363. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  364. data/lib/purecloud/models/rule_set_notification.rb +1 -1
  365. data/lib/purecloud/models/rule_set_notification_condition.rb +11 -11
  366. data/lib/purecloud/models/rule_set_notification_conditions.rb +18 -18
  367. data/lib/purecloud/models/rule_set_notification_rule.rb +9 -0
  368. data/lib/purecloud/models/rule_set_notification_rules.rb +9 -0
  369. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  370. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  371. data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
  372. data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
  373. data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
  374. data/lib/purecloud/models/script_entity_listing.rb +17 -17
  375. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  376. data/lib/purecloud/models/sequence_schedule_notification.rb +14 -14
  377. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  378. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  379. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  380. data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
  381. data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
  382. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  383. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  384. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  385. data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
  386. data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
  387. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  388. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  389. data/lib/purecloud/models/user_list_schedule_request_body.rb +191 -0
  390. data/lib/purecloud/models/user_presence_alert_container.rb +17 -17
  391. data/lib/purecloud/models/user_presence_rule_container.rb +17 -17
  392. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  393. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  394. data/lib/purecloud/models/user_schedule.rb +182 -0
  395. data/lib/purecloud/models/user_schedule_activity.rb +222 -0
  396. data/lib/purecloud/models/user_schedule_container.rb +180 -0
  397. data/lib/purecloud/models/user_schedule_full_day_time_off_marker.rb +211 -0
  398. data/lib/purecloud/models/user_schedule_shift.rb +191 -0
  399. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  400. data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
  401. data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
  402. data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
  403. data/lib/purecloud/models/wfm_user_entity_listing.rb +167 -0
  404. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  405. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  406. data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +4 -14
  407. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  408. data/lib/purecloud/version.rb +1 -1
  409. data/newVersion.md +1 -1
  410. data/swagger.json +1 -1
  411. data/swagger_template/api_doc.mustache +5 -2
  412. data/version.json +1 -1
  413. metadata +70 -42
  414. data/doc_out/DocumentDataNotification.html.md +0 -28
  415. data/doc_out/DocumentDataNotificationLockData.html.md +0 -15
  416. data/doc_out/DocumentDataNotificationLockInfo.html.md +0 -15
  417. data/doc_out/FaxDataNotification.html.md +0 -31
  418. data/doc_out/FaxDataNotificationLockData.html.md +0 -15
  419. data/doc_out/FaxDataNotificationLockInfo.html.md +0 -15
  420. data/doc_out/RecordingDataNotification.html.md +0 -31
  421. data/doc_out/RecordingDataNotificationLockData.html.md +0 -15
  422. data/doc_out/RecordingDataNotificationLockInfo.html.md +0 -15
  423. data/lib/purecloud/models/recording_data_notification_lock_data.rb +0 -185
  424. data/lib/purecloud/models/recording_data_notification_lock_info.rb +0 -185
@@ -11,11 +11,11 @@ title: QualityAuditPage
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: QueueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: QueueMemberEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -6,41 +6,41 @@ title: RecordingApi
6
6
 
7
7
  All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
- Method | HTTP request | Description
9
+ Method | Description
10
10
  ------------- | ------------- | -------------
11
- |[**delete_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#delete_conversation_id_recordings_recording_id_annotations_annotation_id) | **DELETE** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} | Delete annotation|
12
- |[**delete_mediaretentionpolicies**](RecordingApi.html#delete_mediaretentionpolicies) | **DELETE** /api/v2/recording/mediaretentionpolicies | Delete media retention policies|
13
- |[**delete_mediaretentionpolicies_policy_id**](RecordingApi.html#delete_mediaretentionpolicies_policy_id) | **DELETE** /api/v2/recording/mediaretentionpolicies/{policyId} | Delete a media retention policy|
14
- |[**delete_orphan_id**](RecordingApi.html#delete_orphan_id) | **DELETE** /api/v2/orphanrecordings/{orphanId} | Deletes a single orphan recording|
15
- |[**get_conversation_id_recordings**](RecordingApi.html#get_conversation_id_recordings) | **GET** /api/v2/conversations/{conversationId}/recordings | Get all of a Conversation's Recordings.|
16
- |[**get_conversation_id_recordings_recording_id**](RecordingApi.html#get_conversation_id_recordings_recording_id) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId} | Gets a specific recording.|
17
- |[**get_conversation_id_recordings_recording_id_annotations**](RecordingApi.html#get_conversation_id_recordings_recording_id_annotations) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations | Get annotations for recording|
18
- |[**get_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#get_conversation_id_recordings_recording_id_annotations_annotation_id) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} | Get annotation|
19
- |[**get_localkeys_settings**](RecordingApi.html#get_localkeys_settings) | **GET** /api/v2/recording/localkeys/settings | gets a list local key settings data|
20
- |[**get_localkeys_settings_settings_id**](RecordingApi.html#get_localkeys_settings_settings_id) | **GET** /api/v2/recording/localkeys/settings/{settingsId} | Get the local encryption settings|
21
- |[**get_mediaretentionpolicies**](RecordingApi.html#get_mediaretentionpolicies) | **GET** /api/v2/recording/mediaretentionpolicies | Gets media retention policy list with query options to filter on name and enabled.|
22
- |[**get_mediaretentionpolicies_policy_id**](RecordingApi.html#get_mediaretentionpolicies_policy_id) | **GET** /api/v2/recording/mediaretentionpolicies/{policyId} | Get a media retention policy|
23
- |[**get_orphan_id**](RecordingApi.html#get_orphan_id) | **GET** /api/v2/orphanrecordings/{orphanId} | Gets a single orphan recording|
24
- |[**get_orphan_id_media**](RecordingApi.html#get_orphan_id_media) | **GET** /api/v2/orphanrecordings/{orphanId}/media | Gets the media of a single orphan recording|
25
- |[**get_orphanrecordings**](RecordingApi.html#get_orphanrecordings) | **GET** /api/v2/orphanrecordings | Gets all orphan recordings|
26
- |[**get_recordingkeys**](RecordingApi.html#get_recordingkeys) | **GET** /api/v2/recording/recordingkeys | Get encryption key list|
27
- |[**get_recordingkeys_rotationschedule**](RecordingApi.html#get_recordingkeys_rotationschedule) | **GET** /api/v2/recording/recordingkeys/rotationschedule | Get key rotation schedule|
28
- |[**get_settings**](RecordingApi.html#get_settings) | **GET** /api/v2/recording/settings | Get the Recording Settings for the Organization|
29
- |[**gets_screensessions**](RecordingApi.html#gets_screensessions) | **GET** /api/v2/recordings/screensessions | Retrieves a paged listing of screen recording sessions|
30
- |[**patch_mediaretentionpolicies_policy_id**](RecordingApi.html#patch_mediaretentionpolicies_policy_id) | **PATCH** /api/v2/recording/mediaretentionpolicies/{policyId} | Patch a media retention policy|
31
- |[**patchs_screensessions_recordingsession_id**](RecordingApi.html#patchs_screensessions_recordingsession_id) | **PATCH** /api/v2/recordings/screensessions/{recordingSessionId} | Update a screen recording session|
32
- |[**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|
33
- |[**post_localkeys**](RecordingApi.html#post_localkeys) | **POST** /api/v2/recording/localkeys | create a local recording key|
34
- |[**post_localkeys_settings**](RecordingApi.html#post_localkeys_settings) | **POST** /api/v2/recording/localkeys/settings | create settings for local key creation|
35
- |[**post_mediaretentionpolicies**](RecordingApi.html#post_mediaretentionpolicies) | **POST** /api/v2/recording/mediaretentionpolicies | Create media retention policy|
36
- |[**post_recordingkeys**](RecordingApi.html#post_recordingkeys) | **POST** /api/v2/recording/recordingkeys | Create encryption key|
37
- |[**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.|
38
- |[**put_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#put_conversation_id_recordings_recording_id_annotations_annotation_id) | **PUT** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} | Update annotation|
39
- |[**put_localkeys_settings_settings_id**](RecordingApi.html#put_localkeys_settings_settings_id) | **PUT** /api/v2/recording/localkeys/settings/{settingsId} | Update the local encryption settings|
40
- |[**put_mediaretentionpolicies_policy_id**](RecordingApi.html#put_mediaretentionpolicies_policy_id) | **PUT** /api/v2/recording/mediaretentionpolicies/{policyId} | Update a media retention policy|
41
- |[**put_orphan_id**](RecordingApi.html#put_orphan_id) | **PUT** /api/v2/orphanrecordings/{orphanId} | Updates an orphan recording to a regular recording with retention values|
42
- |[**put_recordingkeys_rotationschedule**](RecordingApi.html#put_recordingkeys_rotationschedule) | **PUT** /api/v2/recording/recordingkeys/rotationschedule | Update key rotation schedule|
43
- |[**put_settings**](RecordingApi.html#put_settings) | **PUT** /api/v2/recording/settings | Update the Recording Settings for the Organization|
11
+ [**delete_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#delete_conversation_id_recordings_recording_id_annotations_annotation_id) | Delete annotation
12
+ [**delete_mediaretentionpolicies**](RecordingApi.html#delete_mediaretentionpolicies) | Delete media retention policies
13
+ [**delete_mediaretentionpolicies_policy_id**](RecordingApi.html#delete_mediaretentionpolicies_policy_id) | Delete a media retention policy
14
+ [**delete_orphan_id**](RecordingApi.html#delete_orphan_id) | Deletes a single orphan recording
15
+ [**get_conversation_id_recordings**](RecordingApi.html#get_conversation_id_recordings) | Get all of a Conversation's Recordings.
16
+ [**get_conversation_id_recordings_recording_id**](RecordingApi.html#get_conversation_id_recordings_recording_id) | Gets a specific recording.
17
+ [**get_conversation_id_recordings_recording_id_annotations**](RecordingApi.html#get_conversation_id_recordings_recording_id_annotations) | Get annotations for recording
18
+ [**get_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#get_conversation_id_recordings_recording_id_annotations_annotation_id) | Get annotation
19
+ [**get_localkeys_settings**](RecordingApi.html#get_localkeys_settings) | gets a list local key settings data
20
+ [**get_localkeys_settings_settings_id**](RecordingApi.html#get_localkeys_settings_settings_id) | Get the local encryption settings
21
+ [**get_mediaretentionpolicies**](RecordingApi.html#get_mediaretentionpolicies) | Gets media retention policy list with query options to filter on name and enabled.
22
+ [**get_mediaretentionpolicies_policy_id**](RecordingApi.html#get_mediaretentionpolicies_policy_id) | Get a media retention policy
23
+ [**get_orphan_id**](RecordingApi.html#get_orphan_id) | Gets a single orphan recording
24
+ [**get_orphan_id_media**](RecordingApi.html#get_orphan_id_media) | Gets the media of a single orphan recording
25
+ [**get_orphanrecordings**](RecordingApi.html#get_orphanrecordings) | Gets all orphan recordings
26
+ [**get_recordingkeys**](RecordingApi.html#get_recordingkeys) | Get encryption key list
27
+ [**get_recordingkeys_rotationschedule**](RecordingApi.html#get_recordingkeys_rotationschedule) | Get key rotation schedule
28
+ [**get_settings**](RecordingApi.html#get_settings) | Get the Recording Settings for the Organization
29
+ [**gets_screensessions**](RecordingApi.html#gets_screensessions) | Retrieves a paged listing of screen recording sessions
30
+ [**patch_mediaretentionpolicies_policy_id**](RecordingApi.html#patch_mediaretentionpolicies_policy_id) | Patch a media retention policy
31
+ [**patchs_screensessions_recordingsession_id**](RecordingApi.html#patchs_screensessions_recordingsession_id) | Update a screen recording session
32
+ [**post_conversation_id_recordings_recording_id_annotations**](RecordingApi.html#post_conversation_id_recordings_recording_id_annotations) | Create annotation
33
+ [**post_localkeys**](RecordingApi.html#post_localkeys) | create a local recording key
34
+ [**post_localkeys_settings**](RecordingApi.html#post_localkeys_settings) | create settings for local key creation
35
+ [**post_mediaretentionpolicies**](RecordingApi.html#post_mediaretentionpolicies) | Create media retention policy
36
+ [**post_recordingkeys**](RecordingApi.html#post_recordingkeys) | Create encryption key
37
+ [**put_conversation_id_recordings_recording_id**](RecordingApi.html#put_conversation_id_recordings_recording_id) | Updates the retention records on a recording.
38
+ [**put_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#put_conversation_id_recordings_recording_id_annotations_annotation_id) | Update annotation
39
+ [**put_localkeys_settings_settings_id**](RecordingApi.html#put_localkeys_settings_settings_id) | Update the local encryption settings
40
+ [**put_mediaretentionpolicies_policy_id**](RecordingApi.html#put_mediaretentionpolicies_policy_id) | Update a media retention policy
41
+ [**put_orphan_id**](RecordingApi.html#put_orphan_id) | Updates an orphan recording to a regular recording with retention values
42
+ [**put_recordingkeys_rotationschedule**](RecordingApi.html#put_recordingkeys_rotationschedule) | Update key rotation schedule
43
+ [**put_settings**](RecordingApi.html#put_settings) | Update the Recording Settings for the Organization
44
44
  {: class="table table-striped"}
45
45
 
46
46
  <a name="delete_conversation_id_recordings_recording_id_annotations_annotation_id"></a>
@@ -51,6 +51,9 @@ Delete annotation
51
51
 
52
52
 
53
53
 
54
+ Wraps DELETE /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}
55
+
56
+
54
57
  ### Example
55
58
  ~~~ruby
56
59
  # load the gem
@@ -112,6 +115,9 @@ Delete media retention policies
112
115
 
113
116
  Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
114
117
 
118
+ Wraps DELETE /api/v2/recording/mediaretentionpolicies
119
+
120
+
115
121
  ### Example
116
122
  ~~~ruby
117
123
  # load the gem
@@ -168,6 +174,9 @@ Delete a media retention policy
168
174
 
169
175
 
170
176
 
177
+ Wraps DELETE /api/v2/recording/mediaretentionpolicies/{policyId}
178
+
179
+
171
180
  ### Example
172
181
  ~~~ruby
173
182
  # load the gem
@@ -224,6 +233,9 @@ Deletes a single orphan recording
224
233
 
225
234
 
226
235
 
236
+ Wraps DELETE /api/v2/orphanrecordings/{orphanId}
237
+
238
+
227
239
  ### Example
228
240
  ~~~ruby
229
241
  # load the gem
@@ -280,6 +292,9 @@ Get all of a Conversation's Recordings.
280
292
 
281
293
 
282
294
 
295
+ Wraps GET /api/v2/conversations/{conversationId}/recordings
296
+
297
+
283
298
  ### Example
284
299
  ~~~ruby
285
300
  # load the gem
@@ -342,6 +357,9 @@ Gets a specific recording.
342
357
 
343
358
 
344
359
 
360
+ Wraps GET /api/v2/conversations/{conversationId}/recordings/{recordingId}
361
+
362
+
345
363
  ### Example
346
364
  ~~~ruby
347
365
  # load the gem
@@ -409,6 +427,9 @@ Get annotations for recording
409
427
 
410
428
 
411
429
 
430
+ Wraps GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations
431
+
432
+
412
433
  ### Example
413
434
  ~~~ruby
414
435
  # load the gem
@@ -468,6 +489,9 @@ Get annotation
468
489
 
469
490
 
470
491
 
492
+ Wraps GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}
493
+
494
+
471
495
  ### Example
472
496
  ~~~ruby
473
497
  # load the gem
@@ -530,6 +554,9 @@ gets a list local key settings data
530
554
 
531
555
 
532
556
 
557
+ Wraps GET /api/v2/recording/localkeys/settings
558
+
559
+
533
560
  ### Example
534
561
  ~~~ruby
535
562
  # load the gem
@@ -580,6 +607,9 @@ Get the local encryption settings
580
607
 
581
608
 
582
609
 
610
+ Wraps GET /api/v2/recording/localkeys/settings/{settingsId}
611
+
612
+
583
613
  ### Example
584
614
  ~~~ruby
585
615
  # load the gem
@@ -636,6 +666,9 @@ Gets media retention policy list with query options to filter on name and enable
636
666
 
637
667
  for a less verbose response, add summary=true to this endpoint
638
668
 
669
+ Wraps GET /api/v2/recording/mediaretentionpolicies
670
+
671
+
639
672
  ### Example
640
673
  ~~~ruby
641
674
  # load the gem
@@ -711,6 +744,9 @@ Get a media retention policy
711
744
 
712
745
 
713
746
 
747
+ Wraps GET /api/v2/recording/mediaretentionpolicies/{policyId}
748
+
749
+
714
750
  ### Example
715
751
  ~~~ruby
716
752
  # load the gem
@@ -767,6 +803,9 @@ Gets a single orphan recording
767
803
 
768
804
 
769
805
 
806
+ Wraps GET /api/v2/orphanrecordings/{orphanId}
807
+
808
+
770
809
  ### Example
771
810
  ~~~ruby
772
811
  # load the gem
@@ -823,6 +862,9 @@ Gets the media of a single orphan recording
823
862
 
824
863
  A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
825
864
 
865
+ Wraps GET /api/v2/orphanrecordings/{orphanId}/media
866
+
867
+
826
868
  ### Example
827
869
  ~~~ruby
828
870
  # load the gem
@@ -887,6 +929,9 @@ Gets all orphan recordings
887
929
 
888
930
 
889
931
 
932
+ Wraps GET /api/v2/orphanrecordings
933
+
934
+
890
935
  ### Example
891
936
  ~~~ruby
892
937
  # load the gem
@@ -956,6 +1001,9 @@ Get encryption key list
956
1001
 
957
1002
 
958
1003
 
1004
+ Wraps GET /api/v2/recording/recordingkeys
1005
+
1006
+
959
1007
  ### Example
960
1008
  ~~~ruby
961
1009
  # load the gem
@@ -1015,6 +1063,9 @@ Get key rotation schedule
1015
1063
 
1016
1064
 
1017
1065
 
1066
+ Wraps GET /api/v2/recording/recordingkeys/rotationschedule
1067
+
1068
+
1018
1069
  ### Example
1019
1070
  ~~~ruby
1020
1071
  # load the gem
@@ -1065,6 +1116,9 @@ Get the Recording Settings for the Organization
1065
1116
 
1066
1117
 
1067
1118
 
1119
+ Wraps GET /api/v2/recording/settings
1120
+
1121
+
1068
1122
  ### Example
1069
1123
  ~~~ruby
1070
1124
  # load the gem
@@ -1122,6 +1176,9 @@ Retrieves a paged listing of screen recording sessions
1122
1176
 
1123
1177
 
1124
1178
 
1179
+ Wraps GET /api/v2/recordings/screensessions
1180
+
1181
+
1125
1182
  ### Example
1126
1183
  ~~~ruby
1127
1184
  # load the gem
@@ -1181,6 +1238,9 @@ Patch a media retention policy
1181
1238
 
1182
1239
 
1183
1240
 
1241
+ Wraps PATCH /api/v2/recording/mediaretentionpolicies/{policyId}
1242
+
1243
+
1184
1244
  ### Example
1185
1245
  ~~~ruby
1186
1246
  # load the gem
@@ -1240,6 +1300,9 @@ Update a screen recording session
1240
1300
 
1241
1301
 
1242
1302
 
1303
+ Wraps PATCH /api/v2/recordings/screensessions/{recordingSessionId}
1304
+
1305
+
1243
1306
  ### Example
1244
1307
  ~~~ruby
1245
1308
  # load the gem
@@ -1299,6 +1362,9 @@ Create annotation
1299
1362
 
1300
1363
 
1301
1364
 
1365
+ Wraps POST /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations
1366
+
1367
+
1302
1368
  ### Example
1303
1369
  ~~~ruby
1304
1370
  # load the gem
@@ -1361,6 +1427,9 @@ create a local recording key
1361
1427
 
1362
1428
 
1363
1429
 
1430
+ Wraps POST /api/v2/recording/localkeys
1431
+
1432
+
1364
1433
  ### Example
1365
1434
  ~~~ruby
1366
1435
  # load the gem
@@ -1417,6 +1486,9 @@ create settings for local key creation
1417
1486
 
1418
1487
 
1419
1488
 
1489
+ Wraps POST /api/v2/recording/localkeys/settings
1490
+
1491
+
1420
1492
  ### Example
1421
1493
  ~~~ruby
1422
1494
  # load the gem
@@ -1473,6 +1545,9 @@ Create media retention policy
1473
1545
 
1474
1546
 
1475
1547
 
1548
+ Wraps POST /api/v2/recording/mediaretentionpolicies
1549
+
1550
+
1476
1551
  ### Example
1477
1552
  ~~~ruby
1478
1553
  # load the gem
@@ -1529,6 +1604,9 @@ Create encryption key
1529
1604
 
1530
1605
 
1531
1606
 
1607
+ Wraps POST /api/v2/recording/recordingkeys
1608
+
1609
+
1532
1610
  ### Example
1533
1611
  ~~~ruby
1534
1612
  # load the gem
@@ -1579,6 +1657,9 @@ Updates the retention records on a recording.
1579
1657
 
1580
1658
  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.
1581
1659
 
1660
+ Wraps PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}
1661
+
1662
+
1582
1663
  ### Example
1583
1664
  ~~~ruby
1584
1665
  # load the gem
@@ -1641,6 +1722,9 @@ Update annotation
1641
1722
 
1642
1723
 
1643
1724
 
1725
+ Wraps PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}
1726
+
1727
+
1644
1728
  ### Example
1645
1729
  ~~~ruby
1646
1730
  # load the gem
@@ -1706,6 +1790,9 @@ Update the local encryption settings
1706
1790
 
1707
1791
 
1708
1792
 
1793
+ Wraps PUT /api/v2/recording/localkeys/settings/{settingsId}
1794
+
1795
+
1709
1796
  ### Example
1710
1797
  ~~~ruby
1711
1798
  # load the gem
@@ -1765,6 +1852,9 @@ Update a media retention policy
1765
1852
 
1766
1853
 
1767
1854
 
1855
+ Wraps PUT /api/v2/recording/mediaretentionpolicies/{policyId}
1856
+
1857
+
1768
1858
  ### Example
1769
1859
  ~~~ruby
1770
1860
  # load the gem
@@ -1824,6 +1914,9 @@ Updates an orphan recording to a regular recording with retention values
1824
1914
 
1825
1915
  If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.
1826
1916
 
1917
+ Wraps PUT /api/v2/orphanrecordings/{orphanId}
1918
+
1919
+
1827
1920
  ### Example
1828
1921
  ~~~ruby
1829
1922
  # load the gem
@@ -1884,6 +1977,9 @@ Update key rotation schedule
1884
1977
 
1885
1978
 
1886
1979
 
1980
+ Wraps PUT /api/v2/recording/recordingkeys/rotationschedule
1981
+
1982
+
1887
1983
  ### Example
1888
1984
  ~~~ruby
1889
1985
  # load the gem
@@ -1940,6 +2036,9 @@ Update the Recording Settings for the Organization
1940
2036
 
1941
2037
 
1942
2038
 
2039
+ Wraps PUT /api/v2/recording/settings
2040
+
2041
+
1943
2042
  ### Example
1944
2043
  ~~~ruby
1945
2044
  # load the gem
@@ -0,0 +1,29 @@
1
+ ---
2
+ title: RecordingDataV2Notification
3
+ ---
4
+ ## PureCloud::RecordingDataV2Notification
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **date_created** | **DateTime** | | [optional] |
13
+ | **date_modified** | **DateTime** | | [optional] |
14
+ | **workspace** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) | | [optional] |
15
+ | **created_by** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
16
+ | **content_type** | **String** | | [optional] |
17
+ | **content_length** | **Integer** | | [optional] |
18
+ | **filename** | **String** | | [optional] |
19
+ | **change_number** | **Integer** | | [optional] |
20
+ | **date_uploaded** | **DateTime** | | [optional] |
21
+ | **uploaded_by** | [**RecordingDataV2NotificationUserData**](RecordingDataV2NotificationUserData.html) | | [optional] |
22
+ | **lock_info** | [**RecordingDataV2NotificationLockInfo**](RecordingDataV2NotificationLockInfo.html) | | [optional] |
23
+ | **self_uri** | **String** | | [optional] |
24
+ | **duration_millieconds** | **Integer** | | [optional] |
25
+ | **conversation** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) | | [optional] |
26
+ | **read** | **BOOLEAN** | | [optional] |
27
+ {: class="table table-striped"}
28
+
29
+