purecloudplatformclientv2 71.0.0 → 72.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (430) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +3 -3
  4. data/docs/AgentActivityEntityListing.md +3 -3
  5. data/docs/AnalyticsApi.md +267 -0
  6. data/docs/AnalyticsUserDetailsAsyncQueryResponse.md +14 -0
  7. data/docs/AsyncConversationQuery.md +1 -1
  8. data/docs/AsyncUserDetailsQuery.md +18 -0
  9. data/docs/AttemptLimitsEntityListing.md +3 -3
  10. data/docs/AuditApi.md +216 -0
  11. data/docs/AuditLogMessage.md +24 -0
  12. data/docs/AuditQueryExecutionResultsResponse.md +16 -0
  13. data/docs/AuditQueryExecutionStatusResponse.md +18 -0
  14. data/docs/AuditQueryFilter.md +14 -0
  15. data/docs/AuditQueryRequest.md +15 -0
  16. data/docs/AuthzDivisionEntityListing.md +3 -3
  17. data/docs/CalibrationEntityListing.md +3 -3
  18. data/docs/CallConversationEntityListing.md +3 -3
  19. data/docs/CallHistoryConversationEntityListing.md +3 -3
  20. data/docs/CallableTimeSetEntityListing.md +3 -3
  21. data/docs/CallbackConversationEntityListing.md +3 -3
  22. data/docs/CampaignDivisionViewListing.md +3 -3
  23. data/docs/CampaignEntityListing.md +3 -3
  24. data/docs/CampaignRuleEntityListing.md +3 -3
  25. data/docs/CampaignSequenceEntityListing.md +3 -3
  26. data/docs/CertificateAuthorityEntityListing.md +3 -3
  27. data/docs/ChatConversationEntityListing.md +3 -3
  28. data/docs/ClientAppEntityListing.md +3 -3
  29. data/docs/CobrowseConversationEntityListing.md +3 -3
  30. data/docs/CommandStatusEntityListing.md +3 -3
  31. data/docs/ConsumedResourcesEntityListing.md +3 -3
  32. data/docs/ConsumingResourcesEntityListing.md +3 -3
  33. data/docs/ContactListDivisionViewListing.md +3 -3
  34. data/docs/ContactListEntityListing.md +3 -3
  35. data/docs/ContactListFilterEntityListing.md +3 -3
  36. data/docs/ContactListing.md +3 -3
  37. data/docs/ConversationAggregationQuery.md +1 -1
  38. data/docs/ConversationEntityListing.md +3 -3
  39. data/docs/ConversationQuery.md +1 -1
  40. data/docs/CredentialInfoListing.md +3 -3
  41. data/docs/CredentialTypeListing.md +3 -3
  42. data/docs/DIDEntityListing.md +3 -3
  43. data/docs/DIDPoolEntityListing.md +3 -3
  44. data/docs/DataTableRowEntityListing.md +3 -3
  45. data/docs/DataTablesDomainEntityListing.md +3 -3
  46. data/docs/DependencyObjectEntityListing.md +3 -3
  47. data/docs/DependencyTypeEntityListing.md +3 -3
  48. data/docs/DialerEventEntityListing.md +3 -3
  49. data/docs/DialogflowAgentSummaryEntityListing.md +3 -3
  50. data/docs/DirectoryUserDevicesListing.md +3 -3
  51. data/docs/DncListDivisionViewListing.md +3 -3
  52. data/docs/DncListEntityListing.md +3 -3
  53. data/docs/DocumentAuditEntityListing.md +3 -3
  54. data/docs/DocumentEntityListing.md +3 -3
  55. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +3 -3
  56. data/docs/DomainEntityListing.md +3 -3
  57. data/docs/DomainEntityListingEvaluationForm.md +3 -3
  58. data/docs/DomainEntityListingQueryResult.md +3 -3
  59. data/docs/DomainEntityListingSurveyForm.md +3 -3
  60. data/docs/EdgeEntityListing.md +3 -3
  61. data/docs/EdgeGroupEntityListing.md +3 -3
  62. data/docs/EdgeLineEntityListing.md +3 -3
  63. data/docs/EmailConversationEntityListing.md +3 -3
  64. data/docs/EmailMessageListing.md +3 -3
  65. data/docs/EmergencyGroupListing.md +3 -3
  66. data/docs/EncryptionKeyEntityListing.md +3 -3
  67. data/docs/EvaluationAggregationQuery.md +1 -1
  68. data/docs/EvaluationEntityListing.md +3 -3
  69. data/docs/EvaluationFormEntityListing.md +3 -3
  70. data/docs/EvaluatorActivityEntityListing.md +3 -3
  71. data/docs/ExtensionEntityListing.md +3 -3
  72. data/docs/ExtensionPoolEntityListing.md +3 -3
  73. data/docs/ExternalOrganizationListing.md +3 -3
  74. data/docs/FacebookIntegrationEntityListing.md +3 -3
  75. data/docs/FaxDocumentEntityListing.md +3 -3
  76. data/docs/FlowAggregationQuery.md +1 -1
  77. data/docs/FlowDivisionViewEntityListing.md +3 -3
  78. data/docs/FlowEntityListing.md +3 -3
  79. data/docs/FlowOutcomeListing.md +3 -3
  80. data/docs/FlowVersionEntityListing.md +3 -3
  81. data/docs/GDPRRequestEntityListing.md +3 -3
  82. data/docs/GDPRSubjectEntityListing.md +3 -3
  83. data/docs/GreetingListing.md +3 -3
  84. data/docs/GroupEntityListing.md +3 -3
  85. data/docs/GroupProfileEntityListing.md +3 -3
  86. data/docs/IVREntityListing.md +3 -3
  87. data/docs/InboundDomainEntityListing.md +3 -3
  88. data/docs/InboundRouteEntityListing.md +3 -3
  89. data/docs/IntegrationEntityListing.md +3 -3
  90. data/docs/IntegrationEventEntityListing.md +3 -3
  91. data/docs/IntegrationTypeEntityListing.md +3 -3
  92. data/docs/InteractionStatsAlertContainer.md +3 -3
  93. data/docs/InteractionStatsRuleContainer.md +3 -3
  94. data/docs/KeywordSetEntityListing.md +3 -3
  95. data/docs/LanguageEntityListing.md +3 -3
  96. data/docs/LexBotAliasEntityListing.md +3 -3
  97. data/docs/LexBotEntityListing.md +3 -3
  98. data/docs/LibraryEntityListing.md +3 -3
  99. data/docs/LineBaseEntityListing.md +3 -3
  100. data/docs/LineEntityListing.md +3 -3
  101. data/docs/LineIntegrationEntityListing.md +3 -3
  102. data/docs/LocationEntityListing.md +3 -3
  103. data/docs/LogicalInterfaceEntityListing.md +3 -3
  104. data/docs/ManagementUnitListing.md +3 -3
  105. data/docs/MessageConversationEntityListing.md +3 -3
  106. data/docs/MessagingIntegrationEntityListing.md +3 -3
  107. data/docs/MessagingStickerEntityListing.md +3 -3
  108. data/docs/NoteListing.md +3 -3
  109. data/docs/OAuthApi.md +261 -0
  110. data/docs/OAuthAuthorization.md +20 -0
  111. data/docs/OAuthAuthorizationListing.md +14 -0
  112. data/docs/OAuthClientEntityListing.md +3 -3
  113. data/docs/OAuthProviderEntityListing.md +3 -3
  114. data/docs/OAuthScope.md +15 -0
  115. data/docs/OAuthScopeListing.md +14 -0
  116. data/docs/OrganizationPresenceEntityListing.md +3 -3
  117. data/docs/OrganizationRoleEntityListing.md +3 -3
  118. data/docs/OrphanRecordingListing.md +3 -3
  119. data/docs/OutboundRouteBaseEntityListing.md +3 -3
  120. data/docs/OutboundRouteEntityListing.md +3 -3
  121. data/docs/PermissionCollectionEntityListing.md +3 -3
  122. data/docs/PhoneBaseEntityListing.md +3 -3
  123. data/docs/PhoneEntityListing.md +3 -3
  124. data/docs/PhoneMetaBaseEntityListing.md +3 -3
  125. data/docs/PhysicalInterfaceEntityListing.md +3 -3
  126. data/docs/PolicyEntityListing.md +3 -3
  127. data/docs/PromptAssetEntityListing.md +3 -3
  128. data/docs/PromptEntityListing.md +3 -3
  129. data/docs/PropertyChange.md +15 -0
  130. data/docs/QualityAuditPage.md +3 -3
  131. data/docs/QueueEntityListing.md +3 -3
  132. data/docs/QueueMemberEntityListing.md +3 -3
  133. data/docs/QueueUserEventTopicQueueMember.md +4 -4
  134. data/docs/RecipientListing.md +3 -3
  135. data/docs/RecordingApi.md +0 -134
  136. data/docs/RecordingJobEntityListing.md +3 -3
  137. data/docs/RelationshipListing.md +3 -3
  138. data/docs/ReportMetaDataEntityListing.md +3 -3
  139. data/docs/ReportRunEntryEntityDomainListing.md +3 -3
  140. data/docs/ReportSchedule.md +1 -1
  141. data/docs/ReportScheduleEntityListing.md +3 -3
  142. data/docs/ReportingExportJobListing.md +3 -3
  143. data/docs/ReportingExportJobRequest.md +3 -3
  144. data/docs/ReportingExportJobResponse.md +3 -3
  145. data/docs/ResponseEntityList.md +3 -3
  146. data/docs/ResponseEntityListing.md +3 -3
  147. data/docs/ResponseSetEntityListing.md +3 -3
  148. data/docs/RuleSetEntityListing.md +3 -3
  149. data/docs/Schedule.md +2 -2
  150. data/docs/ScheduleEntityListing.md +3 -3
  151. data/docs/ScheduleGroupEntityListing.md +3 -3
  152. data/docs/SchemaCategoryEntityListing.md +3 -3
  153. data/docs/SchemaReferenceEntityListing.md +3 -3
  154. data/docs/ScreenRecordingSessionListing.md +3 -3
  155. data/docs/ScriptEntityListing.md +3 -3
  156. data/docs/SecurityProfileEntityListing.md +3 -3
  157. data/docs/SendAgentlessOutboundMessageRequest.md +1 -1
  158. data/docs/ShareEntityListing.md +3 -3
  159. data/docs/SiteEntityListing.md +3 -3
  160. data/docs/SkillEntityListing.md +3 -3
  161. data/docs/SmsAddressEntityListing.md +3 -3
  162. data/docs/SmsPhoneNumberEntityListing.md +3 -3
  163. data/docs/StationEntityListing.md +3 -3
  164. data/docs/SubjectDivisionGrantsEntityListing.md +3 -3
  165. data/docs/SurveyAggregationQuery.md +1 -1
  166. data/docs/SurveyFormEntityListing.md +3 -3
  167. data/docs/SystemPromptAssetEntityListing.md +3 -3
  168. data/docs/SystemPromptEntityListing.md +3 -3
  169. data/docs/TagValueEntityListing.md +3 -3
  170. data/docs/TextMessageListing.md +3 -3
  171. data/docs/TimeZoneEntityListing.md +3 -3
  172. data/docs/TrunkBaseEntityListing.md +3 -3
  173. data/docs/TrunkEntityListing.md +3 -3
  174. data/docs/TrunkMetabaseEntityListing.md +3 -3
  175. data/docs/TrustEntityListing.md +3 -3
  176. data/docs/TrustUserEntityListing.md +3 -3
  177. data/docs/TrustorEntityListing.md +3 -3
  178. data/docs/TtsEngineEntityListing.md +3 -3
  179. data/docs/TtsVoiceEntityListing.md +3 -3
  180. data/docs/TwitterIntegrationEntityListing.md +3 -3
  181. data/docs/UserActionCategoryEntityListing.md +3 -3
  182. data/docs/UserAggregationQuery.md +1 -1
  183. data/docs/UserDetailsQuery.md +1 -1
  184. data/docs/UserEntityListing.md +3 -3
  185. data/docs/UserLanguageEntityListing.md +3 -3
  186. data/docs/UserProfileEntityListing.md +3 -3
  187. data/docs/UserQueueEntityListing.md +3 -3
  188. data/docs/UserRecordingEntityListing.md +3 -3
  189. data/docs/UserSkillEntityListing.md +3 -3
  190. data/docs/UsersApi.md +267 -0
  191. data/docs/Utilization.md +1 -1
  192. data/docs/VoicemailMessageEntityListing.md +3 -3
  193. data/docs/WebChatMemberInfoEntityList.md +3 -3
  194. data/docs/WfmBuScheduleQueryResultTopicBuScheduleSearchResultNotification.md +15 -0
  195. data/docs/WfmBuScheduleRunTopicBuScheduleReference.md +14 -0
  196. data/docs/WfmBuScheduleRunTopicBuScheduleRun.md +18 -0
  197. data/docs/WfmBuScheduleRunTopicBuSchedulingRunProgressNotification.md +17 -0
  198. data/docs/WfmBuScheduleRunTopicLocalDate.md +16 -0
  199. data/docs/{TimeZone.md → WfmBuScheduleRunTopicUserReference.md} +2 -5
  200. data/docs/WfmBuScheduleSearchResultTopicBuScheduleSearchResultNotification.md +15 -0
  201. data/docs/WfmBuScheduleTopicBuManagementUnitScheduleSummary.md +17 -0
  202. data/docs/WfmBuScheduleTopicBuScheduleGenerationResultSummary.md +15 -0
  203. data/docs/WfmBuScheduleTopicBuScheduleMetadata.md +21 -0
  204. data/docs/WfmBuScheduleTopicBuScheduleNotification.md +16 -0
  205. data/docs/WfmBuScheduleTopicBuShortTermForecastReference.md +15 -0
  206. data/docs/WfmBuScheduleTopicLocalDate.md +16 -0
  207. data/docs/{QueueUserEventTopicUserReference.md → WfmBuScheduleTopicManagementUnit.md} +2 -2
  208. data/docs/WfmBuScheduleTopicUserReference.md +13 -0
  209. data/docs/WfmBuScheduleTopicWfmVersionedEntityMetadata.md +15 -0
  210. data/docs/WhatsAppIntegrationEntityListing.md +3 -3
  211. data/docs/WorkspaceEntityListing.md +3 -3
  212. data/docs/WorkspaceMemberEntityListing.md +3 -3
  213. data/docs/WrapupCodeEntityListing.md +3 -3
  214. data/lib/purecloudplatformclientv2.rb +29 -3
  215. data/lib/purecloudplatformclientv2/api/analytics_api.rb +268 -0
  216. data/lib/purecloudplatformclientv2/api/audit_api.rb +240 -0
  217. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +258 -0
  218. data/lib/purecloudplatformclientv2/api/recording_api.rb +0 -136
  219. data/lib/purecloudplatformclientv2/api/users_api.rb +268 -0
  220. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  221. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +24 -24
  222. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +24 -24
  223. data/lib/purecloudplatformclientv2/models/analytics_user_details_async_query_response.rb +229 -0
  224. data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +5 -0
  225. data/lib/purecloudplatformclientv2/models/async_query_status.rb +2 -2
  226. data/lib/purecloudplatformclientv2/models/async_user_details_query.rb +357 -0
  227. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +24 -24
  228. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +536 -0
  229. data/lib/purecloudplatformclientv2/models/{time_zone.rb → audit_query_execution_results_response.rb} +31 -25
  230. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +362 -0
  231. data/lib/purecloudplatformclientv2/models/audit_query_filter.rb +252 -0
  232. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +280 -0
  233. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +24 -24
  234. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +24 -24
  235. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +24 -24
  236. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +24 -24
  237. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +24 -24
  238. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +24 -24
  239. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +24 -24
  240. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +24 -24
  241. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +24 -24
  242. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +24 -24
  243. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +24 -24
  244. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +24 -24
  245. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +24 -24
  246. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +24 -24
  247. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +24 -24
  248. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +24 -24
  249. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +24 -24
  250. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +24 -24
  251. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +24 -24
  252. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +24 -24
  253. data/lib/purecloudplatformclientv2/models/contact_listing.rb +24 -24
  254. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +5 -0
  255. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +24 -24
  256. data/lib/purecloudplatformclientv2/models/conversation_query.rb +5 -0
  257. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +24 -24
  258. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +24 -24
  259. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +24 -24
  260. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +24 -24
  261. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +24 -24
  262. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +24 -24
  263. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +24 -24
  264. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +24 -24
  265. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +24 -24
  266. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +24 -24
  267. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +24 -24
  268. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +24 -24
  269. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +24 -24
  270. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +24 -24
  271. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +24 -24
  272. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +24 -24
  273. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +24 -24
  274. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +24 -24
  275. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +24 -24
  276. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +24 -24
  277. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +24 -24
  278. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +24 -24
  279. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +24 -24
  280. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +24 -24
  281. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +24 -24
  282. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +24 -24
  283. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +24 -24
  284. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +5 -0
  285. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +24 -24
  286. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +24 -24
  287. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +24 -24
  288. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +24 -24
  289. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +24 -24
  290. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +24 -24
  291. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +24 -24
  292. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +24 -24
  293. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +5 -0
  294. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +24 -24
  295. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +24 -24
  296. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +24 -24
  297. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +24 -24
  298. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +24 -24
  299. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +24 -24
  300. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +24 -24
  301. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +24 -24
  302. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +24 -24
  303. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +24 -24
  304. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +24 -24
  305. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +24 -24
  306. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +24 -24
  307. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +24 -24
  308. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +24 -24
  309. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +24 -24
  310. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +24 -24
  311. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +24 -24
  312. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +24 -24
  313. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +24 -24
  314. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +24 -24
  315. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +24 -24
  316. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +24 -24
  317. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +24 -24
  318. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +24 -24
  319. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +24 -24
  320. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +24 -24
  321. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +24 -24
  322. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +24 -24
  323. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +24 -24
  324. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +24 -24
  325. data/lib/purecloudplatformclientv2/models/note_listing.rb +24 -24
  326. data/lib/purecloudplatformclientv2/models/o_auth_authorization.rb +381 -0
  327. data/lib/purecloudplatformclientv2/models/o_auth_authorization_listing.rb +228 -0
  328. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +24 -24
  329. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +24 -24
  330. data/lib/purecloudplatformclientv2/models/o_auth_scope.rb +253 -0
  331. data/lib/purecloudplatformclientv2/models/o_auth_scope_listing.rb +228 -0
  332. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +24 -24
  333. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +24 -24
  334. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +24 -24
  335. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +24 -24
  336. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +24 -24
  337. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +24 -24
  338. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +24 -24
  339. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +24 -24
  340. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +24 -24
  341. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +24 -24
  342. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +24 -24
  343. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +24 -24
  344. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +24 -24
  345. data/lib/purecloudplatformclientv2/models/property_change.rb +258 -0
  346. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +24 -24
  347. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +24 -24
  348. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +24 -24
  349. data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +31 -31
  350. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +24 -24
  351. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +24 -24
  352. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +24 -24
  353. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +24 -24
  354. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +24 -24
  355. data/lib/purecloudplatformclientv2/models/report_schedule.rb +5 -0
  356. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +24 -24
  357. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +24 -24
  358. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +12 -2
  359. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +12 -2
  360. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +24 -24
  361. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +24 -24
  362. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +24 -24
  363. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +24 -24
  364. data/lib/purecloudplatformclientv2/models/schedule.rb +10 -0
  365. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +24 -24
  366. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +24 -24
  367. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +24 -24
  368. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +24 -24
  369. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +24 -24
  370. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +24 -24
  371. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +24 -24
  372. data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +1 -1
  373. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +24 -24
  374. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +24 -24
  375. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +24 -24
  376. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +24 -24
  377. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +24 -24
  378. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +24 -24
  379. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +24 -24
  380. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +5 -0
  381. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +24 -24
  382. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +24 -24
  383. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +24 -24
  384. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +24 -24
  385. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +24 -24
  386. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +24 -24
  387. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +24 -24
  388. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +24 -24
  389. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +24 -24
  390. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +24 -24
  391. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +24 -24
  392. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +24 -24
  393. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +24 -24
  394. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +24 -24
  395. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +24 -24
  396. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +24 -24
  397. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +5 -0
  398. data/lib/purecloudplatformclientv2/models/user_details_query.rb +5 -0
  399. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +24 -24
  400. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +24 -24
  401. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +24 -24
  402. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +24 -24
  403. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +24 -24
  404. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +24 -24
  405. data/lib/purecloudplatformclientv2/models/utilization.rb +1 -1
  406. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +24 -24
  407. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +24 -24
  408. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_query_result_topic_bu_schedule_search_result_notification.rb +251 -0
  409. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_schedule_reference.rb +226 -0
  410. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_schedule_run.rb +326 -0
  411. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_scheduling_run_progress_notification.rb +315 -0
  412. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_local_date.rb +276 -0
  413. data/lib/purecloudplatformclientv2/models/{conversation_deletion_protection_query.rb → wfm_bu_schedule_run_topic_user_reference.rb} +8 -16
  414. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_search_result_topic_bu_schedule_search_result_notification.rb +251 -0
  415. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_management_unit_schedule_summary.rb +303 -0
  416. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_schedule_generation_result_summary.rb +251 -0
  417. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_schedule_metadata.rb +403 -0
  418. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_schedule_notification.rb +304 -0
  419. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_short_term_forecast_reference.rb +251 -0
  420. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_local_date.rb +276 -0
  421. data/lib/purecloudplatformclientv2/models/{queue_user_event_topic_user_reference.rb → wfm_bu_schedule_topic_management_unit.rb} +1 -1
  422. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_user_reference.rb +201 -0
  423. data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_wfm_versioned_entity_metadata.rb +251 -0
  424. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +24 -24
  425. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +24 -24
  426. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +24 -24
  427. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +24 -24
  428. data/lib/purecloudplatformclientv2/version.rb +1 -1
  429. metadata +60 -8
  430. data/docs/ConversationDeletionProtectionQuery.md +0 -13
@@ -88,6 +88,126 @@ module PureCloud
88
88
  return data, status_code, headers
89
89
  end
90
90
 
91
+ # Get a client that is authorized by the resource owner
92
+ #
93
+ # @param client_id The ID of client
94
+ # @param [Hash] opts the optional parameters
95
+ # @return [OAuthAuthorization]
96
+ def get_oauth_authorization(client_id, opts = {})
97
+ data, _status_code, _headers = get_oauth_authorization_with_http_info(client_id, opts)
98
+ return data
99
+ end
100
+
101
+ # Get a client that is authorized by the resource owner
102
+ #
103
+ # @param client_id The ID of client
104
+ # @param [Hash] opts the optional parameters
105
+ # @return [Array<(OAuthAuthorization, Fixnum, Hash)>] OAuthAuthorization data, response status code and response headers
106
+ def get_oauth_authorization_with_http_info(client_id, opts = {})
107
+ if @api_client.config.debugging
108
+ @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_authorization ..."
109
+ end
110
+
111
+
112
+ # verify the required parameter 'client_id' is set
113
+ fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthApi.get_oauth_authorization" if client_id.nil?
114
+
115
+
116
+
117
+
118
+
119
+ # resource path
120
+ local_var_path = "/api/v2/oauth/authorizations/{clientId}".sub('{format}','json').sub('{' + 'clientId' + '}', client_id.to_s)
121
+
122
+ # query parameters
123
+ query_params = {}
124
+
125
+ # header parameters
126
+ header_params = {}
127
+
128
+ # HTTP header 'Accept' (if needed)
129
+ local_header_accept = ['application/json']
130
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
131
+
132
+ # HTTP header 'Content-Type'
133
+ local_header_content_type = ['application/json']
134
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
135
+
136
+ # form parameters
137
+ form_params = {}
138
+
139
+ # http body (model)
140
+ post_body = nil
141
+
142
+ auth_names = ['PureCloud OAuth']
143
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
144
+ :header_params => header_params,
145
+ :query_params => query_params,
146
+ :form_params => form_params,
147
+ :body => post_body,
148
+ :auth_names => auth_names,
149
+ :return_type => 'OAuthAuthorization')
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: OAuthApi#get_oauth_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # List clients that are authorized by the resource owner
157
+ #
158
+ # @param [Hash] opts the optional parameters
159
+ # @return [OAuthAuthorizationListing]
160
+ def get_oauth_authorizations(opts = {})
161
+ data, _status_code, _headers = get_oauth_authorizations_with_http_info(opts)
162
+ return data
163
+ end
164
+
165
+ # List clients that are authorized by the resource owner
166
+ #
167
+ # @param [Hash] opts the optional parameters
168
+ # @return [Array<(OAuthAuthorizationListing, Fixnum, Hash)>] OAuthAuthorizationListing data, response status code and response headers
169
+ def get_oauth_authorizations_with_http_info(opts = {})
170
+ if @api_client.config.debugging
171
+ @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_authorizations ..."
172
+ end
173
+
174
+ # resource path
175
+ local_var_path = "/api/v2/oauth/authorizations".sub('{format}','json')
176
+
177
+ # query parameters
178
+ query_params = {}
179
+
180
+ # header parameters
181
+ header_params = {}
182
+
183
+ # HTTP header 'Accept' (if needed)
184
+ local_header_accept = ['application/json']
185
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
186
+
187
+ # HTTP header 'Content-Type'
188
+ local_header_content_type = ['application/json']
189
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
190
+
191
+ # form parameters
192
+ form_params = {}
193
+
194
+ # http body (model)
195
+ post_body = nil
196
+
197
+ auth_names = ['PureCloud OAuth']
198
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
199
+ :header_params => header_params,
200
+ :query_params => query_params,
201
+ :form_params => form_params,
202
+ :body => post_body,
203
+ :auth_names => auth_names,
204
+ :return_type => 'OAuthAuthorizationListing')
205
+ if @api_client.config.debugging
206
+ @api_client.config.logger.debug "API called: OAuthApi#get_oauth_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
207
+ end
208
+ return data, status_code, headers
209
+ end
210
+
91
211
  # Get OAuth Client
92
212
  #
93
213
  # @param client_id Client ID
@@ -208,6 +328,144 @@ module PureCloud
208
328
  return data, status_code, headers
209
329
  end
210
330
 
331
+ # An OAuth scope
332
+ #
333
+ # @param scope_id Scope ID
334
+ # @param [Hash] opts the optional parameters
335
+ # @option opts [String] :accept_language The language with which to display the scope description. (default to en-us)
336
+ # @return [OAuthScope]
337
+ def get_oauth_scope(scope_id, opts = {})
338
+ data, _status_code, _headers = get_oauth_scope_with_http_info(scope_id, opts)
339
+ return data
340
+ end
341
+
342
+ # An OAuth scope
343
+ #
344
+ # @param scope_id Scope ID
345
+ # @param [Hash] opts the optional parameters
346
+ # @option opts [String] :accept_language The language with which to display the scope description.
347
+ # @return [Array<(OAuthScope, Fixnum, Hash)>] OAuthScope data, response status code and response headers
348
+ def get_oauth_scope_with_http_info(scope_id, opts = {})
349
+ if @api_client.config.debugging
350
+ @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_scope ..."
351
+ end
352
+
353
+
354
+ # verify the required parameter 'scope_id' is set
355
+ fail ArgumentError, "Missing the required parameter 'scope_id' when calling OAuthApi.get_oauth_scope" if scope_id.nil?
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+ # resource path
368
+ local_var_path = "/api/v2/oauth/scopes/{scopeId}".sub('{format}','json').sub('{' + 'scopeId' + '}', scope_id.to_s)
369
+
370
+ # query parameters
371
+ query_params = {}
372
+
373
+ # header parameters
374
+ header_params = {}
375
+
376
+ # HTTP header 'Accept' (if needed)
377
+ local_header_accept = ['application/json']
378
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
379
+
380
+ # HTTP header 'Content-Type'
381
+ local_header_content_type = ['application/json']
382
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
383
+ header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']
384
+
385
+ # form parameters
386
+ form_params = {}
387
+
388
+ # http body (model)
389
+ post_body = nil
390
+
391
+ auth_names = ['PureCloud OAuth']
392
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
393
+ :header_params => header_params,
394
+ :query_params => query_params,
395
+ :form_params => form_params,
396
+ :body => post_body,
397
+ :auth_names => auth_names,
398
+ :return_type => 'OAuthScope')
399
+ if @api_client.config.debugging
400
+ @api_client.config.logger.debug "API called: OAuthApi#get_oauth_scope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
401
+ end
402
+ return data, status_code, headers
403
+ end
404
+
405
+ # The list of OAuth scopes
406
+ #
407
+ # @param [Hash] opts the optional parameters
408
+ # @option opts [String] :accept_language The language with which to display the scope descriptions. (default to en-us)
409
+ # @return [OAuthScopeListing]
410
+ def get_oauth_scopes(opts = {})
411
+ data, _status_code, _headers = get_oauth_scopes_with_http_info(opts)
412
+ return data
413
+ end
414
+
415
+ # The list of OAuth scopes
416
+ #
417
+ # @param [Hash] opts the optional parameters
418
+ # @option opts [String] :accept_language The language with which to display the scope descriptions.
419
+ # @return [Array<(OAuthScopeListing, Fixnum, Hash)>] OAuthScopeListing data, response status code and response headers
420
+ def get_oauth_scopes_with_http_info(opts = {})
421
+ if @api_client.config.debugging
422
+ @api_client.config.logger.debug "Calling API: OAuthApi.get_oauth_scopes ..."
423
+ end
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+ # resource path
432
+ local_var_path = "/api/v2/oauth/scopes".sub('{format}','json')
433
+
434
+ # query parameters
435
+ query_params = {}
436
+
437
+ # header parameters
438
+ header_params = {}
439
+
440
+ # HTTP header 'Accept' (if needed)
441
+ local_header_accept = ['application/json']
442
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
443
+
444
+ # HTTP header 'Content-Type'
445
+ local_header_content_type = ['application/json']
446
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
447
+ header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']
448
+
449
+ # form parameters
450
+ form_params = {}
451
+
452
+ # http body (model)
453
+ post_body = nil
454
+
455
+ auth_names = ['PureCloud OAuth']
456
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
457
+ :header_params => header_params,
458
+ :query_params => query_params,
459
+ :form_params => form_params,
460
+ :body => post_body,
461
+ :auth_names => auth_names,
462
+ :return_type => 'OAuthScopeListing')
463
+ if @api_client.config.debugging
464
+ @api_client.config.logger.debug "API called: OAuthApi#get_oauth_scopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
465
+ end
466
+ return data, status_code, headers
467
+ end
468
+
211
469
  # Regenerate Client Secret
212
470
  # This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.
213
471
  # @param client_id Client ID
@@ -2609,71 +2609,6 @@ module PureCloud
2609
2609
  return data, status_code, headers
2610
2610
  end
2611
2611
 
2612
- # Get a list of conversations with protected recordings
2613
- #
2614
- # @param body conversationIds
2615
- # @param [Hash] opts the optional parameters
2616
- # @return [Array<AddressableEntityRef>]
2617
- def post_recordings_deletionprotection(body, opts = {})
2618
- data, _status_code, _headers = post_recordings_deletionprotection_with_http_info(body, opts)
2619
- return data
2620
- end
2621
-
2622
- # Get a list of conversations with protected recordings
2623
- #
2624
- # @param body conversationIds
2625
- # @param [Hash] opts the optional parameters
2626
- # @return [Array<(Array<AddressableEntityRef>, Fixnum, Hash)>] Array<AddressableEntityRef> data, response status code and response headers
2627
- def post_recordings_deletionprotection_with_http_info(body, opts = {})
2628
- if @api_client.config.debugging
2629
- @api_client.config.logger.debug "Calling API: RecordingApi.post_recordings_deletionprotection ..."
2630
- end
2631
-
2632
-
2633
- # verify the required parameter 'body' is set
2634
- fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_recordings_deletionprotection" if body.nil?
2635
-
2636
-
2637
-
2638
-
2639
-
2640
- # resource path
2641
- local_var_path = "/api/v2/recordings/deletionprotection".sub('{format}','json')
2642
-
2643
- # query parameters
2644
- query_params = {}
2645
-
2646
- # header parameters
2647
- header_params = {}
2648
-
2649
- # HTTP header 'Accept' (if needed)
2650
- local_header_accept = ['application/json']
2651
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2652
-
2653
- # HTTP header 'Content-Type'
2654
- local_header_content_type = ['application/json']
2655
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2656
-
2657
- # form parameters
2658
- form_params = {}
2659
-
2660
- # http body (model)
2661
- post_body = @api_client.object_to_http_body(body)
2662
-
2663
- auth_names = ['PureCloud OAuth']
2664
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2665
- :header_params => header_params,
2666
- :query_params => query_params,
2667
- :form_params => form_params,
2668
- :body => post_body,
2669
- :auth_names => auth_names,
2670
- :return_type => 'Array<AddressableEntityRef>')
2671
- if @api_client.config.debugging
2672
- @api_client.config.logger.debug "API called: RecordingApi#post_recordings_deletionprotection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2673
- end
2674
- return data, status_code, headers
2675
- end
2676
-
2677
2612
  # Updates the retention records on a recording.
2678
2613
  # 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. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.
2679
2614
  # @param conversation_id Conversation ID
@@ -3281,76 +3216,5 @@ module PureCloud
3281
3216
  end
3282
3217
  return data, status_code, headers
3283
3218
  end
3284
-
3285
- # Apply or revoke recording protection for conversations
3286
- #
3287
- # @param [Hash] opts the optional parameters
3288
- # @option opts [BOOLEAN] :protect Check for apply, uncheck for revoke (each action requires the respective permission) (default to true)
3289
- # @option opts [ConversationDeletionProtectionQuery] :body
3290
- # @return [nil]
3291
- def put_recordings_deletionprotection(opts = {})
3292
- put_recordings_deletionprotection_with_http_info(opts)
3293
- return nil
3294
- end
3295
-
3296
- # Apply or revoke recording protection for conversations
3297
- #
3298
- # @param [Hash] opts the optional parameters
3299
- # @option opts [BOOLEAN] :protect Check for apply, uncheck for revoke (each action requires the respective permission)
3300
- # @option opts [ConversationDeletionProtectionQuery] :body
3301
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3302
- def put_recordings_deletionprotection_with_http_info(opts = {})
3303
- if @api_client.config.debugging
3304
- @api_client.config.logger.debug "Calling API: RecordingApi.put_recordings_deletionprotection ..."
3305
- end
3306
-
3307
-
3308
-
3309
-
3310
-
3311
-
3312
-
3313
-
3314
-
3315
-
3316
-
3317
-
3318
-
3319
- # resource path
3320
- local_var_path = "/api/v2/recordings/deletionprotection".sub('{format}','json')
3321
-
3322
- # query parameters
3323
- query_params = {}
3324
- query_params[:'protect'] = opts[:'protect'] if opts[:'protect']
3325
-
3326
- # header parameters
3327
- header_params = {}
3328
-
3329
- # HTTP header 'Accept' (if needed)
3330
- local_header_accept = ['application/json']
3331
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3332
-
3333
- # HTTP header 'Content-Type'
3334
- local_header_content_type = ['application/json']
3335
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3336
-
3337
- # form parameters
3338
- form_params = {}
3339
-
3340
- # http body (model)
3341
- post_body = @api_client.object_to_http_body(opts[:'body'])
3342
-
3343
- auth_names = ['PureCloud OAuth']
3344
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3345
- :header_params => header_params,
3346
- :query_params => query_params,
3347
- :form_params => form_params,
3348
- :body => post_body,
3349
- :auth_names => auth_names)
3350
- if @api_client.config.debugging
3351
- @api_client.config.logger.debug "API called: RecordingApi#put_recordings_deletionprotection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3352
- end
3353
- return data, status_code, headers
3354
- end
3355
3219
  end
3356
3220
  end
@@ -24,6 +24,70 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
+ # Delete/cancel an async request
28
+ #
29
+ # @param job_id jobId
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [nil]
32
+ def delete_analytics_users_details_job(job_id, opts = {})
33
+ delete_analytics_users_details_job_with_http_info(job_id, opts)
34
+ return nil
35
+ end
36
+
37
+ # Delete/cancel an async request
38
+ #
39
+ # @param job_id jobId
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
42
+ def delete_analytics_users_details_job_with_http_info(job_id, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_analytics_users_details_job ..."
45
+ end
46
+
47
+
48
+ # verify the required parameter 'job_id' is set
49
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling UsersApi.delete_analytics_users_details_job" if job_id.nil?
50
+
51
+
52
+
53
+
54
+
55
+ # resource path
56
+ local_var_path = "/api/v2/analytics/users/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+
64
+ # HTTP header 'Accept' (if needed)
65
+ local_header_accept = ['application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
68
+ # HTTP header 'Content-Type'
69
+ local_header_content_type = ['application/json']
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = nil
77
+
78
+ auth_names = ['PureCloud OAuth']
79
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
80
+ :header_params => header_params,
81
+ :query_params => query_params,
82
+ :form_params => form_params,
83
+ :body => post_body,
84
+ :auth_names => auth_names)
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: UsersApi#delete_analytics_users_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+
27
91
  # Delete a grant of a role in a division
28
92
  #
29
93
  # @param subject_id Subject ID (user or group)
@@ -513,6 +577,145 @@ module PureCloud
513
577
  return data, status_code, headers
514
578
  end
515
579
 
580
+ # Get status for async query for user details
581
+ #
582
+ # @param job_id jobId
583
+ # @param [Hash] opts the optional parameters
584
+ # @return [AsyncQueryStatus]
585
+ def get_analytics_users_details_job(job_id, opts = {})
586
+ data, _status_code, _headers = get_analytics_users_details_job_with_http_info(job_id, opts)
587
+ return data
588
+ end
589
+
590
+ # Get status for async query for user details
591
+ #
592
+ # @param job_id jobId
593
+ # @param [Hash] opts the optional parameters
594
+ # @return [Array<(AsyncQueryStatus, Fixnum, Hash)>] AsyncQueryStatus data, response status code and response headers
595
+ def get_analytics_users_details_job_with_http_info(job_id, opts = {})
596
+ if @api_client.config.debugging
597
+ @api_client.config.logger.debug "Calling API: UsersApi.get_analytics_users_details_job ..."
598
+ end
599
+
600
+
601
+ # verify the required parameter 'job_id' is set
602
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling UsersApi.get_analytics_users_details_job" if job_id.nil?
603
+
604
+
605
+
606
+
607
+
608
+ # resource path
609
+ local_var_path = "/api/v2/analytics/users/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
610
+
611
+ # query parameters
612
+ query_params = {}
613
+
614
+ # header parameters
615
+ header_params = {}
616
+
617
+ # HTTP header 'Accept' (if needed)
618
+ local_header_accept = ['application/json']
619
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
620
+
621
+ # HTTP header 'Content-Type'
622
+ local_header_content_type = ['application/json']
623
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
624
+
625
+ # form parameters
626
+ form_params = {}
627
+
628
+ # http body (model)
629
+ post_body = nil
630
+
631
+ auth_names = ['PureCloud OAuth']
632
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
633
+ :header_params => header_params,
634
+ :query_params => query_params,
635
+ :form_params => form_params,
636
+ :body => post_body,
637
+ :auth_names => auth_names,
638
+ :return_type => 'AsyncQueryStatus')
639
+ if @api_client.config.debugging
640
+ @api_client.config.logger.debug "API called: UsersApi#get_analytics_users_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
641
+ end
642
+ return data, status_code, headers
643
+ end
644
+
645
+ # Fetch a page of results for an async query
646
+ #
647
+ # @param job_id jobId
648
+ # @param [Hash] opts the optional parameters
649
+ # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
650
+ # @return [AnalyticsUserDetailsAsyncQueryResponse]
651
+ def get_analytics_users_details_job_results(job_id, opts = {})
652
+ data, _status_code, _headers = get_analytics_users_details_job_results_with_http_info(job_id, opts)
653
+ return data
654
+ end
655
+
656
+ # Fetch a page of results for an async query
657
+ #
658
+ # @param job_id jobId
659
+ # @param [Hash] opts the optional parameters
660
+ # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
661
+ # @return [Array<(AnalyticsUserDetailsAsyncQueryResponse, Fixnum, Hash)>] AnalyticsUserDetailsAsyncQueryResponse data, response status code and response headers
662
+ def get_analytics_users_details_job_results_with_http_info(job_id, opts = {})
663
+ if @api_client.config.debugging
664
+ @api_client.config.logger.debug "Calling API: UsersApi.get_analytics_users_details_job_results ..."
665
+ end
666
+
667
+
668
+ # verify the required parameter 'job_id' is set
669
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling UsersApi.get_analytics_users_details_job_results" if job_id.nil?
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+ # resource path
682
+ local_var_path = "/api/v2/analytics/users/details/jobs/{jobId}/results".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
683
+
684
+ # query parameters
685
+ query_params = {}
686
+ query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
687
+
688
+ # header parameters
689
+ header_params = {}
690
+
691
+ # HTTP header 'Accept' (if needed)
692
+ local_header_accept = ['application/json']
693
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
694
+
695
+ # HTTP header 'Content-Type'
696
+ local_header_content_type = ['application/json']
697
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
698
+
699
+ # form parameters
700
+ form_params = {}
701
+
702
+ # http body (model)
703
+ post_body = nil
704
+
705
+ auth_names = ['PureCloud OAuth']
706
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
707
+ :header_params => header_params,
708
+ :query_params => query_params,
709
+ :form_params => form_params,
710
+ :body => post_body,
711
+ :auth_names => auth_names,
712
+ :return_type => 'AnalyticsUserDetailsAsyncQueryResponse')
713
+ if @api_client.config.debugging
714
+ @api_client.config.logger.debug "API called: UsersApi#get_analytics_users_details_job_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
715
+ end
716
+ return data, status_code, headers
717
+ end
718
+
516
719
  # Returns whether or not current user can perform the specified action(s).
517
720
  #
518
721
  # @param permission The permission string, including the object to access, e.g. routing:queue:view
@@ -3336,6 +3539,71 @@ module PureCloud
3336
3539
  return data, status_code, headers
3337
3540
  end
3338
3541
 
3542
+ # Query for user details asynchronously
3543
+ #
3544
+ # @param body query
3545
+ # @param [Hash] opts the optional parameters
3546
+ # @return [AsyncQueryResponse]
3547
+ def post_analytics_users_details_jobs(body, opts = {})
3548
+ data, _status_code, _headers = post_analytics_users_details_jobs_with_http_info(body, opts)
3549
+ return data
3550
+ end
3551
+
3552
+ # Query for user details asynchronously
3553
+ #
3554
+ # @param body query
3555
+ # @param [Hash] opts the optional parameters
3556
+ # @return [Array<(AsyncQueryResponse, Fixnum, Hash)>] AsyncQueryResponse data, response status code and response headers
3557
+ def post_analytics_users_details_jobs_with_http_info(body, opts = {})
3558
+ if @api_client.config.debugging
3559
+ @api_client.config.logger.debug "Calling API: UsersApi.post_analytics_users_details_jobs ..."
3560
+ end
3561
+
3562
+
3563
+ # verify the required parameter 'body' is set
3564
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_analytics_users_details_jobs" if body.nil?
3565
+
3566
+
3567
+
3568
+
3569
+
3570
+ # resource path
3571
+ local_var_path = "/api/v2/analytics/users/details/jobs".sub('{format}','json')
3572
+
3573
+ # query parameters
3574
+ query_params = {}
3575
+
3576
+ # header parameters
3577
+ header_params = {}
3578
+
3579
+ # HTTP header 'Accept' (if needed)
3580
+ local_header_accept = ['application/json']
3581
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3582
+
3583
+ # HTTP header 'Content-Type'
3584
+ local_header_content_type = ['application/json']
3585
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3586
+
3587
+ # form parameters
3588
+ form_params = {}
3589
+
3590
+ # http body (model)
3591
+ post_body = @api_client.object_to_http_body(body)
3592
+
3593
+ auth_names = ['PureCloud OAuth']
3594
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3595
+ :header_params => header_params,
3596
+ :query_params => query_params,
3597
+ :form_params => form_params,
3598
+ :body => post_body,
3599
+ :auth_names => auth_names,
3600
+ :return_type => 'AsyncQueryResponse')
3601
+ if @api_client.config.debugging
3602
+ @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_details_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3603
+ end
3604
+ return data, status_code, headers
3605
+ end
3606
+
3339
3607
  # Query for user details
3340
3608
  #
3341
3609
  # @param body query