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: WorkspaceEntityListing
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: WorkspaceMemberEntityListing
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: WrapupCodeEntityListing
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"}
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
9
9
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
10
10
 
11
11
  - API version: v2
12
- - Package version: 0.56.1
13
- - Build date: 2016-10-31T18:49:21.498Z
12
+ - Package version: 0.57.1
13
+ - Build date: 2016-11-08T15:47:51.115Z
14
14
 
15
15
  For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
16
16
 
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
18
18
 
19
19
  ### from rubygems.org
20
20
 
21
- gem 'purecloud', '~> 0.56.1'
21
+ gem 'purecloud', '~> 0.57.1'
22
22
 
23
23
  ### Install from Git
24
24
 
data/lib/purecloud.rb CHANGED
@@ -346,18 +346,8 @@ require 'purecloud/models/fax_status'
346
346
  require 'purecloud/models/fax_summary'
347
347
  require 'purecloud/models/field_config'
348
348
  require 'purecloud/models/field_list'
349
- require 'purecloud/models/forecast'
350
349
  require 'purecloud/models/forecast_creation'
351
350
  require 'purecloud/models/forecast_creation_completion'
352
- require 'purecloud/models/forecast_dimensions'
353
- require 'purecloud/models/forecast_entry'
354
- require 'purecloud/models/forecast_filter_attributes'
355
- require 'purecloud/models/forecast_metadata'
356
- require 'purecloud/models/forecast_metadata_entity_listing'
357
- require 'purecloud/models/forecast_modification'
358
- require 'purecloud/models/forecast_modification_creation'
359
- require 'purecloud/models/forecast_search_criteria'
360
- require 'purecloud/models/forecast_search_request'
361
351
  require 'purecloud/models/geolocation'
362
352
  require 'purecloud/models/geolocation_settings'
363
353
  require 'purecloud/models/greeting'
@@ -409,6 +399,9 @@ require 'purecloud/models/line_base'
409
399
  require 'purecloud/models/line_base_entity_listing'
410
400
  require 'purecloud/models/line_entity_listing'
411
401
  require 'purecloud/models/line_status'
402
+ require 'purecloud/models/local_encryption_configuration'
403
+ require 'purecloud/models/local_encryption_configuration_listing'
404
+ require 'purecloud/models/local_encryption_key_request'
412
405
  require 'purecloud/models/location'
413
406
  require 'purecloud/models/location_address'
414
407
  require 'purecloud/models/location_emergency_number'
@@ -679,7 +672,6 @@ require 'purecloud/api/alerting_api'
679
672
  require 'purecloud/api/analytics_api'
680
673
  require 'purecloud/api/attributes_api'
681
674
  require 'purecloud/api/authorization_api'
682
- require 'purecloud/api/configuration_api'
683
675
  require 'purecloud/api/content_management_api'
684
676
  require 'purecloud/api/conversations_api'
685
677
  require 'purecloud/api/fax_api'
@@ -556,6 +556,121 @@ module PureCloud
556
556
  return data, status_code, headers
557
557
  end
558
558
 
559
+ # gets a list local key settings data
560
+ #
561
+ # @param [Hash] opts the optional parameters
562
+ # @return [LocalEncryptionConfigurationListing]
563
+ def get_localkeys_settings(opts = {})
564
+ data, status_code, headers = get_localkeys_settings_with_http_info(opts)
565
+ return data
566
+ end
567
+
568
+ # gets a list local key settings data
569
+ #
570
+ # @param [Hash] opts the optional parameters
571
+ # @return [Array<(LocalEncryptionConfigurationListing, Fixnum, Hash)>] LocalEncryptionConfigurationListing data, response status code and response headers
572
+ def get_localkeys_settings_with_http_info(opts = {})
573
+ if @api_client.config.debugging
574
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_localkeys_settings ..."
575
+ end
576
+
577
+ # resource path
578
+ local_var_path = "/api/v2/recording/localkeys/settings".sub('{format}','json')
579
+
580
+ # query parameters
581
+ query_params = {}
582
+
583
+ # header parameters
584
+ header_params = {}
585
+
586
+ # HTTP header 'Accept' (if needed)
587
+ _header_accept = ['application/json']
588
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
589
+
590
+ # HTTP header 'Content-Type'
591
+ _header_content_type = ['application/json']
592
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
593
+
594
+ # form parameters
595
+ form_params = {}
596
+
597
+ # http body (model)
598
+ post_body = nil
599
+
600
+ auth_names = ['PureCloud Auth']
601
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
602
+ :header_params => header_params,
603
+ :query_params => query_params,
604
+ :form_params => form_params,
605
+ :body => post_body,
606
+ :auth_names => auth_names,
607
+ :return_type => 'LocalEncryptionConfigurationListing')
608
+ if @api_client.config.debugging
609
+ @api_client.config.logger.debug "API called: RecordingApi#get_localkeys_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
610
+ end
611
+ return data, status_code, headers
612
+ end
613
+
614
+ # Get the local encryption settings
615
+ #
616
+ # @param settings_id Settings Id
617
+ # @param [Hash] opts the optional parameters
618
+ # @return [LocalEncryptionConfiguration]
619
+ def get_localkeys_settings_settings_id(settings_id, opts = {})
620
+ data, status_code, headers = get_localkeys_settings_settings_id_with_http_info(settings_id, opts)
621
+ return data
622
+ end
623
+
624
+ # Get the local encryption settings
625
+ #
626
+ # @param settings_id Settings Id
627
+ # @param [Hash] opts the optional parameters
628
+ # @return [Array<(LocalEncryptionConfiguration, Fixnum, Hash)>] LocalEncryptionConfiguration data, response status code and response headers
629
+ def get_localkeys_settings_settings_id_with_http_info(settings_id, opts = {})
630
+ if @api_client.config.debugging
631
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_localkeys_settings_settings_id ..."
632
+ end
633
+
634
+ # verify the required parameter 'settings_id' is set
635
+ fail "Missing the required parameter 'settings_id' when calling get_localkeys_settings_settings_id" if settings_id.nil?
636
+
637
+ # resource path
638
+ local_var_path = "/api/v2/recording/localkeys/settings/{settingsId}".sub('{format}','json').sub('{' + 'settingsId' + '}', settings_id.to_s)
639
+
640
+ # query parameters
641
+ query_params = {}
642
+
643
+ # header parameters
644
+ header_params = {}
645
+
646
+ # HTTP header 'Accept' (if needed)
647
+ _header_accept = ['application/json']
648
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
649
+
650
+ # HTTP header 'Content-Type'
651
+ _header_content_type = ['application/json']
652
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
653
+
654
+ # form parameters
655
+ form_params = {}
656
+
657
+ # http body (model)
658
+ post_body = nil
659
+
660
+ auth_names = ['PureCloud Auth']
661
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
662
+ :header_params => header_params,
663
+ :query_params => query_params,
664
+ :form_params => form_params,
665
+ :body => post_body,
666
+ :auth_names => auth_names,
667
+ :return_type => 'LocalEncryptionConfiguration')
668
+ if @api_client.config.debugging
669
+ @api_client.config.logger.debug "API called: RecordingApi#get_localkeys_settings_settings_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
670
+ end
671
+ return data, status_code, headers
672
+ end
673
+
559
674
  # Gets media retention policy list with query options to filter on name and enabled.
560
675
  # for a less verbose response, add summary=true to this endpoint
561
676
  # @param [Hash] opts the optional parameters
@@ -834,6 +949,122 @@ module PureCloud
834
949
  return data, status_code, headers
835
950
  end
836
951
 
952
+ # Get encryption key list
953
+ #
954
+ # @param [Hash] opts the optional parameters
955
+ # @option opts [Integer] :page_size Page size (default to 25)
956
+ # @option opts [Integer] :page_number Page number (default to 1)
957
+ # @return [EncryptionKeyEntityListing]
958
+ def get_recordingkeys(opts = {})
959
+ data, status_code, headers = get_recordingkeys_with_http_info(opts)
960
+ return data
961
+ end
962
+
963
+ # Get encryption key list
964
+ #
965
+ # @param [Hash] opts the optional parameters
966
+ # @option opts [Integer] :page_size Page size
967
+ # @option opts [Integer] :page_number Page number
968
+ # @return [Array<(EncryptionKeyEntityListing, Fixnum, Hash)>] EncryptionKeyEntityListing data, response status code and response headers
969
+ def get_recordingkeys_with_http_info(opts = {})
970
+ if @api_client.config.debugging
971
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_recordingkeys ..."
972
+ end
973
+
974
+ # resource path
975
+ local_var_path = "/api/v2/recording/recordingkeys".sub('{format}','json')
976
+
977
+ # query parameters
978
+ query_params = {}
979
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
980
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
981
+
982
+ # header parameters
983
+ header_params = {}
984
+
985
+ # HTTP header 'Accept' (if needed)
986
+ _header_accept = ['application/json']
987
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
988
+
989
+ # HTTP header 'Content-Type'
990
+ _header_content_type = ['application/json']
991
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
992
+
993
+ # form parameters
994
+ form_params = {}
995
+
996
+ # http body (model)
997
+ post_body = nil
998
+
999
+ auth_names = ['PureCloud Auth']
1000
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1001
+ :header_params => header_params,
1002
+ :query_params => query_params,
1003
+ :form_params => form_params,
1004
+ :body => post_body,
1005
+ :auth_names => auth_names,
1006
+ :return_type => 'EncryptionKeyEntityListing')
1007
+ if @api_client.config.debugging
1008
+ @api_client.config.logger.debug "API called: RecordingApi#get_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1009
+ end
1010
+ return data, status_code, headers
1011
+ end
1012
+
1013
+ # Get key rotation schedule
1014
+ #
1015
+ # @param [Hash] opts the optional parameters
1016
+ # @return [KeyRotationSchedule]
1017
+ def get_recordingkeys_rotationschedule(opts = {})
1018
+ data, status_code, headers = get_recordingkeys_rotationschedule_with_http_info(opts)
1019
+ return data
1020
+ end
1021
+
1022
+ # Get key rotation schedule
1023
+ #
1024
+ # @param [Hash] opts the optional parameters
1025
+ # @return [Array<(KeyRotationSchedule, Fixnum, Hash)>] KeyRotationSchedule data, response status code and response headers
1026
+ def get_recordingkeys_rotationschedule_with_http_info(opts = {})
1027
+ if @api_client.config.debugging
1028
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_recordingkeys_rotationschedule ..."
1029
+ end
1030
+
1031
+ # resource path
1032
+ local_var_path = "/api/v2/recording/recordingkeys/rotationschedule".sub('{format}','json')
1033
+
1034
+ # query parameters
1035
+ query_params = {}
1036
+
1037
+ # header parameters
1038
+ header_params = {}
1039
+
1040
+ # HTTP header 'Accept' (if needed)
1041
+ _header_accept = ['application/json']
1042
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1043
+
1044
+ # HTTP header 'Content-Type'
1045
+ _header_content_type = ['application/json']
1046
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1047
+
1048
+ # form parameters
1049
+ form_params = {}
1050
+
1051
+ # http body (model)
1052
+ post_body = nil
1053
+
1054
+ auth_names = ['PureCloud Auth']
1055
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1056
+ :header_params => header_params,
1057
+ :query_params => query_params,
1058
+ :form_params => form_params,
1059
+ :body => post_body,
1060
+ :auth_names => auth_names,
1061
+ :return_type => 'KeyRotationSchedule')
1062
+ if @api_client.config.debugging
1063
+ @api_client.config.logger.debug "API called: RecordingApi#get_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1064
+ end
1065
+ return data, status_code, headers
1066
+ end
1067
+
837
1068
  # Get the Recording Settings for the Organization
838
1069
  #
839
1070
  # @param [Hash] opts the optional parameters
@@ -1149,6 +1380,126 @@ module PureCloud
1149
1380
  return data, status_code, headers
1150
1381
  end
1151
1382
 
1383
+ # create a local recording key
1384
+ #
1385
+ # @param body Local Encryption body
1386
+ # @param [Hash] opts the optional parameters
1387
+ # @return [EncryptionKey]
1388
+ def post_localkeys(body, opts = {})
1389
+ data, status_code, headers = post_localkeys_with_http_info(body, opts)
1390
+ return data
1391
+ end
1392
+
1393
+ # create a local recording key
1394
+ #
1395
+ # @param body Local Encryption body
1396
+ # @param [Hash] opts the optional parameters
1397
+ # @return [Array<(EncryptionKey, Fixnum, Hash)>] EncryptionKey data, response status code and response headers
1398
+ def post_localkeys_with_http_info(body, opts = {})
1399
+ if @api_client.config.debugging
1400
+ @api_client.config.logger.debug "Calling API: RecordingApi#post_localkeys ..."
1401
+ end
1402
+
1403
+ # verify the required parameter 'body' is set
1404
+ fail "Missing the required parameter 'body' when calling post_localkeys" if body.nil?
1405
+
1406
+ # resource path
1407
+ local_var_path = "/api/v2/recording/localkeys".sub('{format}','json')
1408
+
1409
+ # query parameters
1410
+ query_params = {}
1411
+
1412
+ # header parameters
1413
+ header_params = {}
1414
+
1415
+ # HTTP header 'Accept' (if needed)
1416
+ _header_accept = ['application/json']
1417
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1418
+
1419
+ # HTTP header 'Content-Type'
1420
+ _header_content_type = ['application/json']
1421
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1422
+
1423
+ # form parameters
1424
+ form_params = {}
1425
+
1426
+ # http body (model)
1427
+ post_body = @api_client.object_to_http_body(body)
1428
+
1429
+ auth_names = ['PureCloud Auth']
1430
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1431
+ :header_params => header_params,
1432
+ :query_params => query_params,
1433
+ :form_params => form_params,
1434
+ :body => post_body,
1435
+ :auth_names => auth_names,
1436
+ :return_type => 'EncryptionKey')
1437
+ if @api_client.config.debugging
1438
+ @api_client.config.logger.debug "API called: RecordingApi#post_localkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1439
+ end
1440
+ return data, status_code, headers
1441
+ end
1442
+
1443
+ # create settings for local key creation
1444
+ #
1445
+ # @param body Local Encryption Configuration
1446
+ # @param [Hash] opts the optional parameters
1447
+ # @return [LocalEncryptionConfiguration]
1448
+ def post_localkeys_settings(body, opts = {})
1449
+ data, status_code, headers = post_localkeys_settings_with_http_info(body, opts)
1450
+ return data
1451
+ end
1452
+
1453
+ # create settings for local key creation
1454
+ #
1455
+ # @param body Local Encryption Configuration
1456
+ # @param [Hash] opts the optional parameters
1457
+ # @return [Array<(LocalEncryptionConfiguration, Fixnum, Hash)>] LocalEncryptionConfiguration data, response status code and response headers
1458
+ def post_localkeys_settings_with_http_info(body, opts = {})
1459
+ if @api_client.config.debugging
1460
+ @api_client.config.logger.debug "Calling API: RecordingApi#post_localkeys_settings ..."
1461
+ end
1462
+
1463
+ # verify the required parameter 'body' is set
1464
+ fail "Missing the required parameter 'body' when calling post_localkeys_settings" if body.nil?
1465
+
1466
+ # resource path
1467
+ local_var_path = "/api/v2/recording/localkeys/settings".sub('{format}','json')
1468
+
1469
+ # query parameters
1470
+ query_params = {}
1471
+
1472
+ # header parameters
1473
+ header_params = {}
1474
+
1475
+ # HTTP header 'Accept' (if needed)
1476
+ _header_accept = ['application/json']
1477
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1478
+
1479
+ # HTTP header 'Content-Type'
1480
+ _header_content_type = ['application/json']
1481
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1482
+
1483
+ # form parameters
1484
+ form_params = {}
1485
+
1486
+ # http body (model)
1487
+ post_body = @api_client.object_to_http_body(body)
1488
+
1489
+ auth_names = ['PureCloud Auth']
1490
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1491
+ :header_params => header_params,
1492
+ :query_params => query_params,
1493
+ :form_params => form_params,
1494
+ :body => post_body,
1495
+ :auth_names => auth_names,
1496
+ :return_type => 'LocalEncryptionConfiguration')
1497
+ if @api_client.config.debugging
1498
+ @api_client.config.logger.debug "API called: RecordingApi#post_localkeys_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1499
+ end
1500
+ return data, status_code, headers
1501
+ end
1502
+
1152
1503
  # Create media retention policy
1153
1504
  #
1154
1505
  # @param body Policy
@@ -1209,6 +1560,61 @@ module PureCloud
1209
1560
  return data, status_code, headers
1210
1561
  end
1211
1562
 
1563
+ # Create encryption key
1564
+ #
1565
+ # @param [Hash] opts the optional parameters
1566
+ # @return [EncryptionKey]
1567
+ def post_recordingkeys(opts = {})
1568
+ data, status_code, headers = post_recordingkeys_with_http_info(opts)
1569
+ return data
1570
+ end
1571
+
1572
+ # Create encryption key
1573
+ #
1574
+ # @param [Hash] opts the optional parameters
1575
+ # @return [Array<(EncryptionKey, Fixnum, Hash)>] EncryptionKey data, response status code and response headers
1576
+ def post_recordingkeys_with_http_info(opts = {})
1577
+ if @api_client.config.debugging
1578
+ @api_client.config.logger.debug "Calling API: RecordingApi#post_recordingkeys ..."
1579
+ end
1580
+
1581
+ # resource path
1582
+ local_var_path = "/api/v2/recording/recordingkeys".sub('{format}','json')
1583
+
1584
+ # query parameters
1585
+ query_params = {}
1586
+
1587
+ # header parameters
1588
+ header_params = {}
1589
+
1590
+ # HTTP header 'Accept' (if needed)
1591
+ _header_accept = ['application/json']
1592
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1593
+
1594
+ # HTTP header 'Content-Type'
1595
+ _header_content_type = ['application/json']
1596
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1597
+
1598
+ # form parameters
1599
+ form_params = {}
1600
+
1601
+ # http body (model)
1602
+ post_body = nil
1603
+
1604
+ auth_names = ['PureCloud Auth']
1605
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1606
+ :header_params => header_params,
1607
+ :query_params => query_params,
1608
+ :form_params => form_params,
1609
+ :body => post_body,
1610
+ :auth_names => auth_names,
1611
+ :return_type => 'EncryptionKey')
1612
+ if @api_client.config.debugging
1613
+ @api_client.config.logger.debug "API called: RecordingApi#post_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1614
+ end
1615
+ return data, status_code, headers
1616
+ end
1617
+
1212
1618
  # Updates the retention records on a recording.
1213
1619
  # 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.
1214
1620
  # @param conversation_id Conversation ID
@@ -1353,6 +1759,71 @@ module PureCloud
1353
1759
  return data, status_code, headers
1354
1760
  end
1355
1761
 
1762
+ # Update the local encryption settings
1763
+ #
1764
+ # @param settings_id Settings Id
1765
+ # @param body Local Encryption metadata
1766
+ # @param [Hash] opts the optional parameters
1767
+ # @return [LocalEncryptionConfiguration]
1768
+ def put_localkeys_settings_settings_id(settings_id, body, opts = {})
1769
+ data, status_code, headers = put_localkeys_settings_settings_id_with_http_info(settings_id, body, opts)
1770
+ return data
1771
+ end
1772
+
1773
+ # Update the local encryption settings
1774
+ #
1775
+ # @param settings_id Settings Id
1776
+ # @param body Local Encryption metadata
1777
+ # @param [Hash] opts the optional parameters
1778
+ # @return [Array<(LocalEncryptionConfiguration, Fixnum, Hash)>] LocalEncryptionConfiguration data, response status code and response headers
1779
+ def put_localkeys_settings_settings_id_with_http_info(settings_id, body, opts = {})
1780
+ if @api_client.config.debugging
1781
+ @api_client.config.logger.debug "Calling API: RecordingApi#put_localkeys_settings_settings_id ..."
1782
+ end
1783
+
1784
+ # verify the required parameter 'settings_id' is set
1785
+ fail "Missing the required parameter 'settings_id' when calling put_localkeys_settings_settings_id" if settings_id.nil?
1786
+
1787
+ # verify the required parameter 'body' is set
1788
+ fail "Missing the required parameter 'body' when calling put_localkeys_settings_settings_id" if body.nil?
1789
+
1790
+ # resource path
1791
+ local_var_path = "/api/v2/recording/localkeys/settings/{settingsId}".sub('{format}','json').sub('{' + 'settingsId' + '}', settings_id.to_s)
1792
+
1793
+ # query parameters
1794
+ query_params = {}
1795
+
1796
+ # header parameters
1797
+ header_params = {}
1798
+
1799
+ # HTTP header 'Accept' (if needed)
1800
+ _header_accept = ['application/json']
1801
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1802
+
1803
+ # HTTP header 'Content-Type'
1804
+ _header_content_type = ['application/json']
1805
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1806
+
1807
+ # form parameters
1808
+ form_params = {}
1809
+
1810
+ # http body (model)
1811
+ post_body = @api_client.object_to_http_body(body)
1812
+
1813
+ auth_names = ['PureCloud Auth']
1814
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1815
+ :header_params => header_params,
1816
+ :query_params => query_params,
1817
+ :form_params => form_params,
1818
+ :body => post_body,
1819
+ :auth_names => auth_names,
1820
+ :return_type => 'LocalEncryptionConfiguration')
1821
+ if @api_client.config.debugging
1822
+ @api_client.config.logger.debug "API called: RecordingApi#put_localkeys_settings_settings_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1823
+ end
1824
+ return data, status_code, headers
1825
+ end
1826
+
1356
1827
  # Update a media retention policy
1357
1828
  #
1358
1829
  # @param policy_id Policy ID
@@ -1418,6 +1889,66 @@ module PureCloud
1418
1889
  return data, status_code, headers
1419
1890
  end
1420
1891
 
1892
+ # Update key rotation schedule
1893
+ #
1894
+ # @param body KeyRotationSchedule
1895
+ # @param [Hash] opts the optional parameters
1896
+ # @return [KeyRotationSchedule]
1897
+ def put_recordingkeys_rotationschedule(body, opts = {})
1898
+ data, status_code, headers = put_recordingkeys_rotationschedule_with_http_info(body, opts)
1899
+ return data
1900
+ end
1901
+
1902
+ # Update key rotation schedule
1903
+ #
1904
+ # @param body KeyRotationSchedule
1905
+ # @param [Hash] opts the optional parameters
1906
+ # @return [Array<(KeyRotationSchedule, Fixnum, Hash)>] KeyRotationSchedule data, response status code and response headers
1907
+ def put_recordingkeys_rotationschedule_with_http_info(body, opts = {})
1908
+ if @api_client.config.debugging
1909
+ @api_client.config.logger.debug "Calling API: RecordingApi#put_recordingkeys_rotationschedule ..."
1910
+ end
1911
+
1912
+ # verify the required parameter 'body' is set
1913
+ fail "Missing the required parameter 'body' when calling put_recordingkeys_rotationschedule" if body.nil?
1914
+
1915
+ # resource path
1916
+ local_var_path = "/api/v2/recording/recordingkeys/rotationschedule".sub('{format}','json')
1917
+
1918
+ # query parameters
1919
+ query_params = {}
1920
+
1921
+ # header parameters
1922
+ header_params = {}
1923
+
1924
+ # HTTP header 'Accept' (if needed)
1925
+ _header_accept = ['application/json']
1926
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1927
+
1928
+ # HTTP header 'Content-Type'
1929
+ _header_content_type = ['application/json']
1930
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1931
+
1932
+ # form parameters
1933
+ form_params = {}
1934
+
1935
+ # http body (model)
1936
+ post_body = @api_client.object_to_http_body(body)
1937
+
1938
+ auth_names = ['PureCloud Auth']
1939
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1940
+ :header_params => header_params,
1941
+ :query_params => query_params,
1942
+ :form_params => form_params,
1943
+ :body => post_body,
1944
+ :auth_names => auth_names,
1945
+ :return_type => 'KeyRotationSchedule')
1946
+ if @api_client.config.debugging
1947
+ @api_client.config.logger.debug "API called: RecordingApi#put_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1948
+ end
1949
+ return data, status_code, headers
1950
+ end
1951
+
1421
1952
  # Update the Recording Settings for the Organization
1422
1953
  #
1423
1954
  # @param body Recording settings