purecloud 0.56.1 → 0.57.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 (243) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  5. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  6. data/doc_out/AttributeEntityListing.html.md +2 -2
  7. data/doc_out/CalibrationEntityListing.html.md +2 -2
  8. data/doc_out/CallConversationEntityListing.html.md +2 -2
  9. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  10. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  11. data/doc_out/CampaignEntityListing.html.md +2 -2
  12. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  13. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  14. data/doc_out/ChannelEntityListing.html.md +2 -2
  15. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  16. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  17. data/doc_out/Cobrowsesession.html.md +1 -0
  18. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  19. data/doc_out/ContactListEntityListing.html.md +2 -2
  20. data/doc_out/ConversationEntityListing.html.md +2 -2
  21. data/doc_out/DIDEntityListing.html.md +2 -2
  22. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  23. data/doc_out/DncListEntityListing.html.md +2 -2
  24. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  25. data/doc_out/DocumentEntityListing.html.md +2 -2
  26. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  27. data/doc_out/DomainEntityListing.html.md +2 -2
  28. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  29. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  30. data/doc_out/EdgeEntityListing.html.md +2 -2
  31. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  32. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  33. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  34. data/doc_out/EmailMessageListing.html.md +2 -2
  35. data/doc_out/EncryptionKey.html.md +4 -4
  36. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  37. data/doc_out/EndpointEntityListing.html.md +2 -2
  38. data/doc_out/EvaluationEntityListing.html.md +2 -2
  39. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  40. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  41. data/doc_out/ExtensionEntityListing.html.md +2 -2
  42. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  43. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  44. data/doc_out/ForecastCreation.html.md +1 -0
  45. data/doc_out/ForecastCreationCompletion.html.md +2 -1
  46. data/doc_out/GroupEntityListing.html.md +2 -2
  47. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  48. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  49. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  50. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  51. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  52. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  53. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  54. data/doc_out/LanguageEntityListing.html.md +2 -2
  55. data/doc_out/LibraryEntityListing.html.md +2 -2
  56. data/doc_out/LineBaseEntityListing.html.md +2 -2
  57. data/doc_out/LineEntityListing.html.md +2 -2
  58. data/doc_out/LocalEncryptionConfiguration.html.md +18 -0
  59. data/doc_out/{ForecastMetadataEntityListing.html.md → LocalEncryptionConfigurationListing.html.md} +5 -5
  60. data/doc_out/LocalEncryptionKeyRequest.html.md +15 -0
  61. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  62. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  63. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  64. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  65. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  66. data/doc_out/OrphanRecordingListing.html.md +2 -2
  67. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  68. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  69. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  70. data/doc_out/PhoneEntityListing.html.md +2 -2
  71. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  72. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  73. data/doc_out/PolicyEntityListing.html.md +2 -2
  74. data/doc_out/QualityAuditPage.html.md +2 -2
  75. data/doc_out/QueueEntityListing.html.md +2 -2
  76. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  77. data/doc_out/RecordingApi.html.md +501 -0
  78. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  79. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  80. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  81. data/doc_out/ResponseEntityList.html.md +2 -2
  82. data/doc_out/ResponseEntityListing.html.md +2 -2
  83. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  84. data/doc_out/RuleSetEntityListing.html.md +2 -2
  85. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  86. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  87. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  88. data/doc_out/Screenshare.html.md +1 -0
  89. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  90. data/doc_out/ShareEntityListing.html.md +2 -2
  91. data/doc_out/SiteEntityListing.html.md +2 -2
  92. data/doc_out/SkillEntityListing.html.md +2 -2
  93. data/doc_out/StationEntityListing.html.md +2 -2
  94. data/doc_out/TagValueEntityListing.html.md +2 -2
  95. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  96. data/doc_out/TrunkBaseEntityListing.html.md +2 -2
  97. data/doc_out/TrunkEntityListing.html.md +2 -2
  98. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  99. data/doc_out/User.html.md +1 -0
  100. data/doc_out/UserEntityListing.html.md +2 -2
  101. data/doc_out/UserMe.html.md +2 -0
  102. data/doc_out/UserQueueEntityListing.html.md +2 -2
  103. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  104. data/doc_out/UserSkillEntityListing.html.md +2 -2
  105. data/doc_out/UsersEntityListing.html.md +2 -2
  106. data/doc_out/WorkforceManagementApi.html.md +0 -406
  107. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  108. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  109. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  110. data/doc_out/index.html.md +3 -3
  111. data/lib/purecloud.rb +3 -11
  112. data/lib/purecloud/api/recording_api.rb +531 -0
  113. data/lib/purecloud/api/workforce_management_api.rb +0 -433
  114. data/lib/purecloud/api_client.rb +1 -1
  115. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  116. data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
  117. data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
  118. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  119. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  120. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  121. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  122. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  123. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  124. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  125. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  126. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  127. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  128. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
  129. data/lib/purecloud/models/cobrowsesession.rb +17 -4
  130. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  131. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  132. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  133. data/lib/purecloud/models/dialer_action.rb +1 -1
  134. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  135. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  136. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  137. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  138. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  139. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
  140. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  141. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  142. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  143. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  144. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  145. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  146. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  147. data/lib/purecloud/models/email_message_listing.rb +17 -17
  148. data/lib/purecloud/models/encryption_key.rb +4 -1
  149. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  150. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  151. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  152. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  153. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  154. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  155. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  156. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  157. data/lib/purecloud/models/forecast_creation.rb +15 -4
  158. data/lib/purecloud/models/forecast_creation_completion.rb +18 -7
  159. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  160. data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
  161. data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
  162. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  163. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  164. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  165. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  166. data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
  167. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  168. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  169. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  170. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  171. data/lib/purecloud/models/{forecast.rb → local_encryption_configuration.rb} +51 -32
  172. data/lib/purecloud/models/{forecast_metadata_entity_listing.rb → local_encryption_configuration_listing.rb} +19 -19
  173. data/lib/purecloud/models/{forecast_filter_attributes.rb → local_encryption_key_request.rb} +23 -26
  174. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  175. data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
  176. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  177. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  178. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  179. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  180. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  181. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  182. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  183. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  184. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  185. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  186. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  187. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  188. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  189. data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
  190. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  191. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  192. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  193. data/lib/purecloud/models/response_entity_list.rb +17 -17
  194. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  195. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  196. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  197. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  198. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  199. data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
  200. data/lib/purecloud/models/screenshare.rb +17 -4
  201. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  202. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  203. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  204. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  205. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  206. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  207. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  208. data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
  209. data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
  210. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  211. data/lib/purecloud/models/user.rb +11 -1
  212. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  213. data/lib/purecloud/models/user_me.rb +24 -1
  214. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  215. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  216. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  217. data/lib/purecloud/models/users_entity_listing.rb +17 -17
  218. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  219. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  220. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  221. data/lib/purecloud/version.rb +1 -1
  222. data/newVersion.md +1 -1
  223. data/swagger.json +1 -1
  224. data/version.json +1 -1
  225. metadata +8 -24
  226. data/doc_out/ConfigurationApi.html.md +0 -231
  227. data/doc_out/Forecast.html.md +0 -16
  228. data/doc_out/ForecastDimensions.html.md +0 -15
  229. data/doc_out/ForecastEntry.html.md +0 -15
  230. data/doc_out/ForecastFilterAttributes.html.md +0 -15
  231. data/doc_out/ForecastMetadata.html.md +0 -22
  232. data/doc_out/ForecastModification.html.md +0 -27
  233. data/doc_out/ForecastModificationCreation.html.md +0 -25
  234. data/doc_out/ForecastSearchCriteria.html.md +0 -20
  235. data/doc_out/ForecastSearchRequest.html.md +0 -20
  236. data/lib/purecloud/api/configuration_api.rb +0 -258
  237. data/lib/purecloud/models/forecast_dimensions.rb +0 -197
  238. data/lib/purecloud/models/forecast_entry.rb +0 -199
  239. data/lib/purecloud/models/forecast_metadata.rb +0 -284
  240. data/lib/purecloud/models/forecast_modification.rb +0 -339
  241. data/lib/purecloud/models/forecast_modification_creation.rb +0 -317
  242. data/lib/purecloud/models/forecast_search_criteria.rb +0 -267
  243. data/lib/purecloud/models/forecast_search_request.rb +0 -259
@@ -11,10 +11,10 @@ title: OrganizationRoleEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: OrphanRecordingListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: OutboundRouteEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: PermissionCollectionEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: PhoneBaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: PhoneEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: PhoneMetaBaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: PhysicalInterfaceEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: PolicyEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: QualityAuditPage
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: QueueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -11,10 +11,10 @@ title: QueueMemberEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
16
- | **next_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -16,19 +16,28 @@ Method | HTTP request | Description
16
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
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
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|
19
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.|
20
22
  |[**get_mediaretentionpolicies_policy_id**](RecordingApi.html#get_mediaretentionpolicies_policy_id) | **GET** /api/v2/recording/mediaretentionpolicies/{policyId} | Get a media retention policy|
21
23
  |[**get_orphan_id**](RecordingApi.html#get_orphan_id) | **GET** /api/v2/orphanrecordings/{orphanId} | Gets a single orphan recording|
22
24
  |[**get_orphanrecordings**](RecordingApi.html#get_orphanrecordings) | **GET** /api/v2/orphanrecordings | Gets all orphan recordings|
25
+ |[**get_recordingkeys**](RecordingApi.html#get_recordingkeys) | **GET** /api/v2/recording/recordingkeys | Get encryption key list|
26
+ |[**get_recordingkeys_rotationschedule**](RecordingApi.html#get_recordingkeys_rotationschedule) | **GET** /api/v2/recording/recordingkeys/rotationschedule | Get key rotation schedule|
23
27
  |[**get_settings**](RecordingApi.html#get_settings) | **GET** /api/v2/recording/settings | Get the Recording Settings for the Organization|
24
28
  |[**gets_screensessions**](RecordingApi.html#gets_screensessions) | **GET** /api/v2/recordings/screensessions | Retrieves a paged listing of screen recording sessions|
25
29
  |[**patch_mediaretentionpolicies_policy_id**](RecordingApi.html#patch_mediaretentionpolicies_policy_id) | **PATCH** /api/v2/recording/mediaretentionpolicies/{policyId} | Patch a media retention policy|
26
30
  |[**patchs_screensessions_recordingsession_id**](RecordingApi.html#patchs_screensessions_recordingsession_id) | **PATCH** /api/v2/recordings/screensessions/{recordingSessionId} | Update a screen recording session|
27
31
  |[**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|
32
+ |[**post_localkeys**](RecordingApi.html#post_localkeys) | **POST** /api/v2/recording/localkeys | create a local recording key|
33
+ |[**post_localkeys_settings**](RecordingApi.html#post_localkeys_settings) | **POST** /api/v2/recording/localkeys/settings | create settings for local key creation|
28
34
  |[**post_mediaretentionpolicies**](RecordingApi.html#post_mediaretentionpolicies) | **POST** /api/v2/recording/mediaretentionpolicies | Create media retention policy|
35
+ |[**post_recordingkeys**](RecordingApi.html#post_recordingkeys) | **POST** /api/v2/recording/recordingkeys | Create encryption key|
29
36
  |[**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.|
30
37
  |[**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|
38
+ |[**put_localkeys_settings_settings_id**](RecordingApi.html#put_localkeys_settings_settings_id) | **PUT** /api/v2/recording/localkeys/settings/{settingsId} | Update the local encryption settings|
31
39
  |[**put_mediaretentionpolicies_policy_id**](RecordingApi.html#put_mediaretentionpolicies_policy_id) | **PUT** /api/v2/recording/mediaretentionpolicies/{policyId} | Update a media retention policy|
40
+ |[**put_recordingkeys_rotationschedule**](RecordingApi.html#put_recordingkeys_rotationschedule) | **PUT** /api/v2/recording/recordingkeys/rotationschedule | Update key rotation schedule|
32
41
  |[**put_settings**](RecordingApi.html#put_settings) | **PUT** /api/v2/recording/settings | Update the Recording Settings for the Organization|
33
42
  {: class="table table-striped"}
34
43
 
@@ -510,6 +519,112 @@ Name | Type | Description | Notes
510
519
 
511
520
 
512
521
 
522
+ <a name="get_localkeys_settings"></a>
523
+
524
+ ## -[**LocalEncryptionConfigurationListing**](LocalEncryptionConfigurationListing.html) get_localkeys_settings
525
+
526
+ gets a list local key settings data
527
+
528
+
529
+
530
+ ### Example
531
+ ~~~ruby
532
+ # load the gem
533
+ require 'purecloud'
534
+ # setup authorization
535
+ @secret = ENV['PURECLOUD_SECRET']
536
+ @id = ENV['PURECLOUD_CLIENT_ID']
537
+ environment = "mypurecloud.com"
538
+
539
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
540
+
541
+ PureCloud.configure do |config|
542
+ config.access_token = @authToken
543
+ end
544
+
545
+ api_instance = PureCloud::RecordingApi.new
546
+
547
+ begin
548
+ #gets a list local key settings data
549
+ result = api_instance.get_localkeys_settings
550
+ p result
551
+ rescue PureCloud::ApiError => e
552
+ puts "Exception when calling RecordingApi->get_localkeys_settings: #{e}"
553
+ end
554
+ ~~~
555
+
556
+ ### Parameters
557
+ This endpoint does not need any parameter.
558
+ {: class="table table-striped"}
559
+
560
+
561
+ ### Return type
562
+
563
+ [**LocalEncryptionConfigurationListing**](LocalEncryptionConfigurationListing.html)
564
+
565
+ ### HTTP request headers
566
+
567
+ - **Content-Type**: application/json
568
+ - **Accept**: application/json
569
+
570
+
571
+
572
+ <a name="get_localkeys_settings_settings_id"></a>
573
+
574
+ ## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) get_localkeys_settings_settings_id(settings_id)
575
+
576
+ Get the local encryption settings
577
+
578
+
579
+
580
+ ### Example
581
+ ~~~ruby
582
+ # load the gem
583
+ require 'purecloud'
584
+ # setup authorization
585
+ @secret = ENV['PURECLOUD_SECRET']
586
+ @id = ENV['PURECLOUD_CLIENT_ID']
587
+ environment = "mypurecloud.com"
588
+
589
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
590
+
591
+ PureCloud.configure do |config|
592
+ config.access_token = @authToken
593
+ end
594
+
595
+ api_instance = PureCloud::RecordingApi.new
596
+
597
+ settings_id = "settings_id_example" # String | Settings Id
598
+
599
+
600
+ begin
601
+ #Get the local encryption settings
602
+ result = api_instance.get_localkeys_settings_settings_id(settings_id)
603
+ p result
604
+ rescue PureCloud::ApiError => e
605
+ puts "Exception when calling RecordingApi->get_localkeys_settings_settings_id: #{e}"
606
+ end
607
+ ~~~
608
+
609
+ ### Parameters
610
+
611
+ Name | Type | Description | Notes
612
+ ------------- | ------------- | ------------- | -------------
613
+ **settings_id** | **String**| Settings Id |
614
+ {: class="table table-striped"}
615
+
616
+
617
+ ### Return type
618
+
619
+ [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html)
620
+
621
+ ### HTTP request headers
622
+
623
+ - **Content-Type**: application/json
624
+ - **Accept**: application/json
625
+
626
+
627
+
513
628
  <a name="get_mediaretentionpolicies"></a>
514
629
 
515
630
  ## -[**PolicyEntityListing**](PolicyEntityListing.html) get_mediaretentionpolicies(opts)
@@ -764,6 +879,115 @@ Name | Type | Description | Notes
764
879
 
765
880
 
766
881
 
882
+ <a name="get_recordingkeys"></a>
883
+
884
+ ## -[**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html) get_recordingkeys(opts)
885
+
886
+ Get encryption key list
887
+
888
+
889
+
890
+ ### Example
891
+ ~~~ruby
892
+ # load the gem
893
+ require 'purecloud'
894
+ # setup authorization
895
+ @secret = ENV['PURECLOUD_SECRET']
896
+ @id = ENV['PURECLOUD_CLIENT_ID']
897
+ environment = "mypurecloud.com"
898
+
899
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
900
+
901
+ PureCloud.configure do |config|
902
+ config.access_token = @authToken
903
+ end
904
+
905
+ api_instance = PureCloud::RecordingApi.new
906
+
907
+ opts = {
908
+ page_size: 25, # Integer | Page size
909
+ page_number: 1 # Integer | Page number
910
+ }
911
+
912
+ begin
913
+ #Get encryption key list
914
+ result = api_instance.get_recordingkeys(opts)
915
+ p result
916
+ rescue PureCloud::ApiError => e
917
+ puts "Exception when calling RecordingApi->get_recordingkeys: #{e}"
918
+ end
919
+ ~~~
920
+
921
+ ### Parameters
922
+
923
+ Name | Type | Description | Notes
924
+ ------------- | ------------- | ------------- | -------------
925
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
926
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
927
+ {: class="table table-striped"}
928
+
929
+
930
+ ### Return type
931
+
932
+ [**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html)
933
+
934
+ ### HTTP request headers
935
+
936
+ - **Content-Type**: application/json
937
+ - **Accept**: application/json
938
+
939
+
940
+
941
+ <a name="get_recordingkeys_rotationschedule"></a>
942
+
943
+ ## -[**KeyRotationSchedule**](KeyRotationSchedule.html) get_recordingkeys_rotationschedule
944
+
945
+ Get key rotation schedule
946
+
947
+
948
+
949
+ ### Example
950
+ ~~~ruby
951
+ # load the gem
952
+ require 'purecloud'
953
+ # setup authorization
954
+ @secret = ENV['PURECLOUD_SECRET']
955
+ @id = ENV['PURECLOUD_CLIENT_ID']
956
+ environment = "mypurecloud.com"
957
+
958
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
959
+
960
+ PureCloud.configure do |config|
961
+ config.access_token = @authToken
962
+ end
963
+
964
+ api_instance = PureCloud::RecordingApi.new
965
+
966
+ begin
967
+ #Get key rotation schedule
968
+ result = api_instance.get_recordingkeys_rotationschedule
969
+ p result
970
+ rescue PureCloud::ApiError => e
971
+ puts "Exception when calling RecordingApi->get_recordingkeys_rotationschedule: #{e}"
972
+ end
973
+ ~~~
974
+
975
+ ### Parameters
976
+ This endpoint does not need any parameter.
977
+ {: class="table table-striped"}
978
+
979
+
980
+ ### Return type
981
+
982
+ [**KeyRotationSchedule**](KeyRotationSchedule.html)
983
+
984
+ ### HTTP request headers
985
+
986
+ - **Content-Type**: application/json
987
+ - **Accept**: application/json
988
+
989
+
990
+
767
991
  <a name="get_settings"></a>
768
992
 
769
993
  ## -[**RecordingSettings**](RecordingSettings.html) get_settings(opts)
@@ -1060,6 +1284,118 @@ Name | Type | Description | Notes
1060
1284
 
1061
1285
 
1062
1286
 
1287
+ <a name="post_localkeys"></a>
1288
+
1289
+ ## -[**EncryptionKey**](EncryptionKey.html) post_localkeys(body)
1290
+
1291
+ create a local recording key
1292
+
1293
+
1294
+
1295
+ ### Example
1296
+ ~~~ruby
1297
+ # load the gem
1298
+ require 'purecloud'
1299
+ # setup authorization
1300
+ @secret = ENV['PURECLOUD_SECRET']
1301
+ @id = ENV['PURECLOUD_CLIENT_ID']
1302
+ environment = "mypurecloud.com"
1303
+
1304
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1305
+
1306
+ PureCloud.configure do |config|
1307
+ config.access_token = @authToken
1308
+ end
1309
+
1310
+ api_instance = PureCloud::RecordingApi.new
1311
+
1312
+ body = PureCloud::LocalEncryptionKeyRequest.new # LocalEncryptionKeyRequest | Local Encryption body
1313
+
1314
+
1315
+ begin
1316
+ #create a local recording key
1317
+ result = api_instance.post_localkeys(body)
1318
+ p result
1319
+ rescue PureCloud::ApiError => e
1320
+ puts "Exception when calling RecordingApi->post_localkeys: #{e}"
1321
+ end
1322
+ ~~~
1323
+
1324
+ ### Parameters
1325
+
1326
+ Name | Type | Description | Notes
1327
+ ------------- | ------------- | ------------- | -------------
1328
+ **body** | [**LocalEncryptionKeyRequest**](LocalEncryptionKeyRequest.html)| Local Encryption body |
1329
+ {: class="table table-striped"}
1330
+
1331
+
1332
+ ### Return type
1333
+
1334
+ [**EncryptionKey**](EncryptionKey.html)
1335
+
1336
+ ### HTTP request headers
1337
+
1338
+ - **Content-Type**: application/json
1339
+ - **Accept**: application/json
1340
+
1341
+
1342
+
1343
+ <a name="post_localkeys_settings"></a>
1344
+
1345
+ ## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) post_localkeys_settings(body)
1346
+
1347
+ create settings for local key creation
1348
+
1349
+
1350
+
1351
+ ### Example
1352
+ ~~~ruby
1353
+ # load the gem
1354
+ require 'purecloud'
1355
+ # setup authorization
1356
+ @secret = ENV['PURECLOUD_SECRET']
1357
+ @id = ENV['PURECLOUD_CLIENT_ID']
1358
+ environment = "mypurecloud.com"
1359
+
1360
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1361
+
1362
+ PureCloud.configure do |config|
1363
+ config.access_token = @authToken
1364
+ end
1365
+
1366
+ api_instance = PureCloud::RecordingApi.new
1367
+
1368
+ body = PureCloud::LocalEncryptionConfiguration.new # LocalEncryptionConfiguration | Local Encryption Configuration
1369
+
1370
+
1371
+ begin
1372
+ #create settings for local key creation
1373
+ result = api_instance.post_localkeys_settings(body)
1374
+ p result
1375
+ rescue PureCloud::ApiError => e
1376
+ puts "Exception when calling RecordingApi->post_localkeys_settings: #{e}"
1377
+ end
1378
+ ~~~
1379
+
1380
+ ### Parameters
1381
+
1382
+ Name | Type | Description | Notes
1383
+ ------------- | ------------- | ------------- | -------------
1384
+ **body** | [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html)| Local Encryption Configuration |
1385
+ {: class="table table-striped"}
1386
+
1387
+
1388
+ ### Return type
1389
+
1390
+ [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html)
1391
+
1392
+ ### HTTP request headers
1393
+
1394
+ - **Content-Type**: application/json
1395
+ - **Accept**: application/json
1396
+
1397
+
1398
+
1063
1399
  <a name="post_mediaretentionpolicies"></a>
1064
1400
 
1065
1401
  ## -[**Policy**](Policy.html) post_mediaretentionpolicies(body)
@@ -1116,6 +1452,56 @@ Name | Type | Description | Notes
1116
1452
 
1117
1453
 
1118
1454
 
1455
+ <a name="post_recordingkeys"></a>
1456
+
1457
+ ## -[**EncryptionKey**](EncryptionKey.html) post_recordingkeys
1458
+
1459
+ Create encryption key
1460
+
1461
+
1462
+
1463
+ ### Example
1464
+ ~~~ruby
1465
+ # load the gem
1466
+ require 'purecloud'
1467
+ # setup authorization
1468
+ @secret = ENV['PURECLOUD_SECRET']
1469
+ @id = ENV['PURECLOUD_CLIENT_ID']
1470
+ environment = "mypurecloud.com"
1471
+
1472
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1473
+
1474
+ PureCloud.configure do |config|
1475
+ config.access_token = @authToken
1476
+ end
1477
+
1478
+ api_instance = PureCloud::RecordingApi.new
1479
+
1480
+ begin
1481
+ #Create encryption key
1482
+ result = api_instance.post_recordingkeys
1483
+ p result
1484
+ rescue PureCloud::ApiError => e
1485
+ puts "Exception when calling RecordingApi->post_recordingkeys: #{e}"
1486
+ end
1487
+ ~~~
1488
+
1489
+ ### Parameters
1490
+ This endpoint does not need any parameter.
1491
+ {: class="table table-striped"}
1492
+
1493
+
1494
+ ### Return type
1495
+
1496
+ [**EncryptionKey**](EncryptionKey.html)
1497
+
1498
+ ### HTTP request headers
1499
+
1500
+ - **Content-Type**: application/json
1501
+ - **Accept**: application/json
1502
+
1503
+
1504
+
1119
1505
  <a name="put_conversation_id_recordings_recording_id"></a>
1120
1506
 
1121
1507
  ## - put_conversation_id_recordings_recording_id(conversation_id, recording_id, body)
@@ -1242,6 +1628,65 @@ Name | Type | Description | Notes
1242
1628
 
1243
1629
 
1244
1630
 
1631
+ <a name="put_localkeys_settings_settings_id"></a>
1632
+
1633
+ ## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) put_localkeys_settings_settings_id(settings_id, body)
1634
+
1635
+ Update the local encryption settings
1636
+
1637
+
1638
+
1639
+ ### Example
1640
+ ~~~ruby
1641
+ # load the gem
1642
+ require 'purecloud'
1643
+ # setup authorization
1644
+ @secret = ENV['PURECLOUD_SECRET']
1645
+ @id = ENV['PURECLOUD_CLIENT_ID']
1646
+ environment = "mypurecloud.com"
1647
+
1648
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1649
+
1650
+ PureCloud.configure do |config|
1651
+ config.access_token = @authToken
1652
+ end
1653
+
1654
+ api_instance = PureCloud::RecordingApi.new
1655
+
1656
+ settings_id = "settings_id_example" # String | Settings Id
1657
+
1658
+ body = PureCloud::LocalEncryptionConfiguration.new # LocalEncryptionConfiguration | Local Encryption metadata
1659
+
1660
+
1661
+ begin
1662
+ #Update the local encryption settings
1663
+ result = api_instance.put_localkeys_settings_settings_id(settings_id, body)
1664
+ p result
1665
+ rescue PureCloud::ApiError => e
1666
+ puts "Exception when calling RecordingApi->put_localkeys_settings_settings_id: #{e}"
1667
+ end
1668
+ ~~~
1669
+
1670
+ ### Parameters
1671
+
1672
+ Name | Type | Description | Notes
1673
+ ------------- | ------------- | ------------- | -------------
1674
+ **settings_id** | **String**| Settings Id |
1675
+ **body** | [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html)| Local Encryption metadata |
1676
+ {: class="table table-striped"}
1677
+
1678
+
1679
+ ### Return type
1680
+
1681
+ [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html)
1682
+
1683
+ ### HTTP request headers
1684
+
1685
+ - **Content-Type**: application/json
1686
+ - **Accept**: application/json
1687
+
1688
+
1689
+
1245
1690
  <a name="put_mediaretentionpolicies_policy_id"></a>
1246
1691
 
1247
1692
  ## -[**Policy**](Policy.html) put_mediaretentionpolicies_policy_id(policy_id, body)
@@ -1301,6 +1746,62 @@ Name | Type | Description | Notes
1301
1746
 
1302
1747
 
1303
1748
 
1749
+ <a name="put_recordingkeys_rotationschedule"></a>
1750
+
1751
+ ## -[**KeyRotationSchedule**](KeyRotationSchedule.html) put_recordingkeys_rotationschedule(body)
1752
+
1753
+ Update key rotation schedule
1754
+
1755
+
1756
+
1757
+ ### Example
1758
+ ~~~ruby
1759
+ # load the gem
1760
+ require 'purecloud'
1761
+ # setup authorization
1762
+ @secret = ENV['PURECLOUD_SECRET']
1763
+ @id = ENV['PURECLOUD_CLIENT_ID']
1764
+ environment = "mypurecloud.com"
1765
+
1766
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1767
+
1768
+ PureCloud.configure do |config|
1769
+ config.access_token = @authToken
1770
+ end
1771
+
1772
+ api_instance = PureCloud::RecordingApi.new
1773
+
1774
+ body = PureCloud::KeyRotationSchedule.new # KeyRotationSchedule | KeyRotationSchedule
1775
+
1776
+
1777
+ begin
1778
+ #Update key rotation schedule
1779
+ result = api_instance.put_recordingkeys_rotationschedule(body)
1780
+ p result
1781
+ rescue PureCloud::ApiError => e
1782
+ puts "Exception when calling RecordingApi->put_recordingkeys_rotationschedule: #{e}"
1783
+ end
1784
+ ~~~
1785
+
1786
+ ### Parameters
1787
+
1788
+ Name | Type | Description | Notes
1789
+ ------------- | ------------- | ------------- | -------------
1790
+ **body** | [**KeyRotationSchedule**](KeyRotationSchedule.html)| KeyRotationSchedule |
1791
+ {: class="table table-striped"}
1792
+
1793
+
1794
+ ### Return type
1795
+
1796
+ [**KeyRotationSchedule**](KeyRotationSchedule.html)
1797
+
1798
+ ### HTTP request headers
1799
+
1800
+ - **Content-Type**: application/json
1801
+ - **Accept**: application/json
1802
+
1803
+
1804
+
1304
1805
  <a name="put_settings"></a>
1305
1806
 
1306
1807
  ## -[**RecordingSettings**](RecordingSettings.html) put_settings(body)