purecloudplatformclientv2 86.0.0 → 91.0.0

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 (241) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AnalyticsEvaluation.md +1 -1
  4. data/docs/ApiUsageQuery.md +16 -0
  5. data/docs/ApiUsageQueryResult.md +14 -0
  6. data/docs/ApiUsageRow.md +25 -0
  7. data/docs/ArchitectApi.md +132 -0
  8. data/docs/AuditApi.md +60 -0
  9. data/docs/AuditQueryEntity.md +14 -0
  10. data/docs/AuditQueryExecutionStatusResponse.md +1 -0
  11. data/docs/AuditQueryRequest.md +1 -0
  12. data/docs/AuditQueryService.md +14 -0
  13. data/docs/AuditQueryServiceMapping.md +13 -0
  14. data/docs/AuditQuerySort.md +14 -0
  15. data/docs/BuAgentScheduleActivity.md +2 -0
  16. data/docs/BuRescheduleRequest.md +2 -2
  17. data/docs/CoachingAnnotation.md +21 -0
  18. data/docs/CoachingAnnotationCreateRequest.md +14 -0
  19. data/docs/CoachingAnnotationList.md +22 -0
  20. data/docs/CoachingApi.md +1132 -0
  21. data/docs/CoachingAppointmentReference.md +14 -0
  22. data/docs/CoachingAppointmentResponse.md +27 -0
  23. data/docs/CoachingAppointmentResponseList.md +22 -0
  24. data/docs/CoachingAppointmentStatusDto.md +16 -0
  25. data/docs/CoachingAppointmentStatusDtoList.md +17 -0
  26. data/docs/CoachingNotification.md +23 -0
  27. data/docs/CoachingNotificationList.md +22 -0
  28. data/docs/ConversationAggregationQuery.md +1 -1
  29. data/docs/ConversationEventTopicCall.md +1 -0
  30. data/docs/ConversationEventTopicCallback.md +1 -0
  31. data/docs/ConversationEventTopicChat.md +1 -0
  32. data/docs/ConversationEventTopicCobrowse.md +1 -0
  33. data/docs/ConversationEventTopicEmail.md +1 -0
  34. data/docs/ConversationEventTopicMessage.md +1 -0
  35. data/docs/ConversationEventTopicScreenshare.md +1 -0
  36. data/docs/ConversationEventTopicSocialExpression.md +1 -0
  37. data/docs/ConversationEventTopicVideo.md +1 -0
  38. data/docs/ConversationReference.md +14 -0
  39. data/docs/CreateCoachingAppointmentRequest.md +20 -0
  40. data/docs/CreateQueueRequest.md +1 -0
  41. data/docs/DocumentReference.md +14 -0
  42. data/docs/EntityListing.md +5 -1
  43. data/docs/EvaluationAggregationQuery.md +1 -1
  44. data/docs/ExternalContact.md +2 -0
  45. data/docs/ExternalOrganization.md +2 -0
  46. data/docs/FlowAggregationQuery.md +1 -1
  47. data/docs/FlowExecutionLaunchRequest.md +16 -0
  48. data/docs/FlowExecutionLaunchResponse.md +16 -0
  49. data/docs/FlowRuntimeExecution.md +23 -0
  50. data/docs/GenericSAML.md +22 -0
  51. data/docs/GroupsApi.md +4 -4
  52. data/docs/IdentityProviderApi.md +187 -0
  53. data/docs/IpAddressAuthentication.md +13 -0
  54. data/docs/KnowledgeSearchResponse.md +1 -1
  55. data/docs/NluDomainVersion.md +1 -0
  56. data/docs/OAuthApi.md +208 -0
  57. data/docs/OrganizationApi.md +126 -0
  58. data/docs/Prompt.md +2 -2
  59. data/docs/Queue.md +1 -0
  60. data/docs/QueueConversationEventTopicCall.md +1 -0
  61. data/docs/QueueConversationEventTopicCallback.md +1 -0
  62. data/docs/QueueConversationEventTopicChat.md +1 -0
  63. data/docs/QueueConversationEventTopicCobrowse.md +1 -0
  64. data/docs/QueueConversationEventTopicEmail.md +1 -0
  65. data/docs/QueueConversationEventTopicMessage.md +1 -0
  66. data/docs/QueueConversationEventTopicScreenshare.md +1 -0
  67. data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
  68. data/docs/QueueConversationEventTopicVideo.md +1 -0
  69. data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
  70. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  71. data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
  72. data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
  73. data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
  74. data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
  75. data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
  76. data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
  77. data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
  78. data/docs/QueueConversationVideoEventTopicCall.md +1 -0
  79. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  80. data/docs/QueueConversationVideoEventTopicChat.md +1 -0
  81. data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
  82. data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
  83. data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
  84. data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
  85. data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
  86. data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
  87. data/docs/QueueRequest.md +1 -0
  88. data/docs/RecordingApi.md +12 -0
  89. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  90. data/docs/ScimEmail.md +1 -1
  91. data/docs/SurveyAggregationQuery.md +1 -1
  92. data/docs/UpdateCoachingAppointmentRequest.md +18 -0
  93. data/docs/UploadUrlRequest.md +1 -0
  94. data/docs/UsageApi.md +144 -0
  95. data/docs/UsageExecutionResult.md +14 -0
  96. data/docs/UserAggregationQuery.md +1 -1
  97. data/docs/UserQueue.md +1 -0
  98. data/docs/UsersApi.md +5 -5
  99. data/docs/ViewFilter.md +2 -0
  100. data/docs/VoicemailMessagesTopicOwner.md +13 -0
  101. data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
  102. data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
  103. data/docs/WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md +14 -0
  104. data/docs/WemLearningAssignmentRuleRunTopicLearningModuleReference.md +14 -0
  105. data/docs/WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.md +13 -0
  106. data/docs/WemLearningAssignmentTopicLearningAssignmentNotification.md +22 -0
  107. data/docs/WemLearningAssignmentTopicLearningModuleReference.md +14 -0
  108. data/docs/WemLearningAssignmentTopicUserReference.md +13 -0
  109. data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
  110. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
  111. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
  112. data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
  113. data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
  114. data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
  115. data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
  116. data/docs/WorkforceManagementApi.md +3 -3
  117. data/lib/purecloudplatformclientv2.rb +44 -0
  118. data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
  119. data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
  120. data/lib/purecloudplatformclientv2/api/coaching_api.rb +1296 -0
  121. data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
  122. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
  123. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
  124. data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
  125. data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
  126. data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
  127. data/lib/purecloudplatformclientv2/api/users_api.rb +4 -4
  128. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
  129. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  130. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  131. data/lib/purecloudplatformclientv2/models/api_usage_query.rb +303 -0
  132. data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
  133. data/lib/purecloudplatformclientv2/models/api_usage_row.rb +514 -0
  134. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  135. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +244 -0
  136. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +34 -6
  137. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +34 -6
  138. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +244 -0
  139. data/lib/purecloudplatformclientv2/models/audit_query_service_mapping.rb +204 -0
  140. data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
  141. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
  142. data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
  143. data/lib/purecloudplatformclientv2/models/coaching_annotation.rb +429 -0
  144. data/lib/purecloudplatformclientv2/models/coaching_annotation_create_request.rb +252 -0
  145. data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +428 -0
  146. data/lib/purecloudplatformclientv2/models/coaching_appointment_reference.rb +228 -0
  147. data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +587 -0
  148. data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +428 -0
  149. data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto.rb +299 -0
  150. data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto_list.rb +303 -0
  151. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +504 -0
  152. data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +428 -0
  153. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  154. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
  155. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +2 -2
  156. data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
  157. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  158. data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
  159. data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
  160. data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
  161. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
  162. data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
  163. data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
  164. data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
  165. data/lib/purecloudplatformclientv2/models/conversation_reference.rb +228 -0
  166. data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +426 -0
  167. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
  168. data/lib/purecloudplatformclientv2/models/document_reference.rb +228 -0
  169. data/lib/purecloudplatformclientv2/models/entity_listing.rb +104 -4
  170. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
  171. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  172. data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
  173. data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
  174. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  175. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
  176. data/lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb +288 -0
  177. data/lib/purecloudplatformclientv2/models/flow_execution_launch_response.rb +281 -0
  178. data/lib/purecloudplatformclientv2/models/flow_runtime_execution.rb +494 -0
  179. data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
  180. data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
  181. data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
  182. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +41 -1
  183. data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
  184. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
  185. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
  186. data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
  187. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
  188. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  189. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
  190. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
  191. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
  192. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
  193. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
  194. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
  195. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
  196. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
  197. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  198. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
  199. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
  200. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
  201. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
  202. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
  203. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
  204. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
  205. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
  206. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  207. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
  208. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
  209. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
  210. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
  211. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
  212. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
  213. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
  214. data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
  215. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
  216. data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
  217. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
  218. data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +337 -0
  219. data/lib/purecloudplatformclientv2/models/upload_url_request.rb +43 -4
  220. data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
  221. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
  222. data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
  223. data/lib/purecloudplatformclientv2/models/view_filter.rb +58 -4
  224. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
  225. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
  226. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
  227. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_assignment_rule_run_notification.rb +228 -0
  228. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_module_reference.rb +226 -0
  229. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_wem_learning_assignments_created.rb +201 -0
  230. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_assignment_notification.rb +440 -0
  231. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_module_reference.rb +226 -0
  232. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_user_reference.rb +201 -0
  233. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
  234. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
  235. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
  236. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
  237. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
  238. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
  239. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
  240. data/lib/purecloudplatformclientv2/version.rb +1 -1
  241. metadata +90 -2
@@ -272,7 +272,7 @@ module PureCloud
272
272
 
273
273
 
274
274
 
275
- allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement"]
275
+ allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement", "WorkforceManagement"]
276
276
  if @service_name && !allowed_values.include?(@service_name)
277
277
  return false
278
278
  end
@@ -289,7 +289,7 @@ module PureCloud
289
289
 
290
290
 
291
291
 
292
- allowed_values = ["Create", "View", "Update", "Delete", "Download", "MemberAdd", "MemberUpdate", "MemberRemove", "Read", "ApplyProtection", "RevokeProtection", "UpdateRetention", "ReadAll", "Execute", "Publish", "Authorize", "Deauthorize", "Authenticate", "ChangePassword"]
292
+ allowed_values = ["Create", "View", "Update", "Delete", "Download", "MemberAdd", "MemberUpdate", "MemberRemove", "Read", "ApplyProtection", "RevokeProtection", "UpdateRetention", "ReadAll", "Execute", "Publish", "Unpublish", "Authorize", "Deauthorize", "Authenticate", "ChangePassword"]
293
293
  if @action && !allowed_values.include?(@action)
294
294
  return false
295
295
  end
@@ -302,7 +302,7 @@ module PureCloud
302
302
 
303
303
 
304
304
 
305
- allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "OAuthClient", "OAuthClientAuthorization", "AuthOrganization", "AuthUser", "BulkActions", "Feedback", "Topic", "Program", "Segment", "Outcome", "ClickstreamSettings"]
305
+ allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "OAuthClient", "OAuthClientAuthorization", "AuthOrganization", "AuthUser", "BulkActions", "Feedback", "Topic", "Program", "Segment", "Outcome", "ClickstreamSettings", "Schedule"]
306
306
  if @entity_type && !allowed_values.include?(@entity_type)
307
307
  return false
308
308
  end
@@ -344,7 +344,7 @@ module PureCloud
344
344
  # Custom attribute writer method checking allowed values (enum).
345
345
  # @param [Object] service_name Object to be assigned
346
346
  def service_name=(service_name)
347
- allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement"]
347
+ allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement", "WorkforceManagement"]
348
348
  if service_name && !allowed_values.include?(service_name)
349
349
  fail ArgumentError, "invalid value for 'service_name', must be one of #{allowed_values}."
350
350
  end
@@ -368,7 +368,7 @@ module PureCloud
368
368
  # Custom attribute writer method checking allowed values (enum).
369
369
  # @param [Object] action Object to be assigned
370
370
  def action=(action)
371
- allowed_values = ["Create", "View", "Update", "Delete", "Download", "MemberAdd", "MemberUpdate", "MemberRemove", "Read", "ApplyProtection", "RevokeProtection", "UpdateRetention", "ReadAll", "Execute", "Publish", "Authorize", "Deauthorize", "Authenticate", "ChangePassword"]
371
+ allowed_values = ["Create", "View", "Update", "Delete", "Download", "MemberAdd", "MemberUpdate", "MemberRemove", "Read", "ApplyProtection", "RevokeProtection", "UpdateRetention", "ReadAll", "Execute", "Publish", "Unpublish", "Authorize", "Deauthorize", "Authenticate", "ChangePassword"]
372
372
  if action && !allowed_values.include?(action)
373
373
  fail ArgumentError, "invalid value for 'action', must be one of #{allowed_values}."
374
374
  end
@@ -387,7 +387,7 @@ module PureCloud
387
387
  # Custom attribute writer method checking allowed values (enum).
388
388
  # @param [Object] entity_type Object to be assigned
389
389
  def entity_type=(entity_type)
390
- allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "OAuthClient", "OAuthClientAuthorization", "AuthOrganization", "AuthUser", "BulkActions", "Feedback", "Topic", "Program", "Segment", "Outcome", "ClickstreamSettings"]
390
+ allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "OAuthClient", "OAuthClientAuthorization", "AuthOrganization", "AuthUser", "BulkActions", "Feedback", "Topic", "Program", "Segment", "Outcome", "ClickstreamSettings", "Schedule"]
391
391
  if entity_type && !allowed_values.include?(entity_type)
392
392
  fail ArgumentError, "invalid value for 'entity_type', must be one of #{allowed_values}."
393
393
  end
@@ -0,0 +1,244 @@
1
+ =begin
2
+ PureCloud Platform API
3
+
4
+ With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: DeveloperEvangelists@genesys.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: UNLICENSED
11
+ https://help.mypurecloud.com/articles/terms-and-conditions/
12
+
13
+ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
14
+
15
+ =end
16
+
17
+ require 'date'
18
+
19
+ module PureCloud
20
+ class AuditQueryEntity
21
+ # Name of the Entity
22
+ attr_accessor :name
23
+
24
+ # List of Actions
25
+ attr_accessor :actions
26
+
27
+ # Attribute mapping from ruby-style variable name to JSON key.
28
+ def self.attribute_map
29
+ {
30
+
31
+ :'name' => :'name',
32
+
33
+ :'actions' => :'actions'
34
+
35
+ }
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.swagger_types
40
+ {
41
+
42
+ :'name' => :'String',
43
+
44
+ :'actions' => :'Array<String>'
45
+
46
+ }
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ return unless attributes.is_a?(Hash)
53
+
54
+ # convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
56
+
57
+
58
+ if attributes.has_key?(:'name')
59
+
60
+
61
+ self.name = attributes[:'name']
62
+
63
+
64
+ end
65
+
66
+
67
+ if attributes.has_key?(:'actions')
68
+
69
+ if (value = attributes[:'actions']).is_a?(Array)
70
+ self.actions = value
71
+ end
72
+
73
+
74
+
75
+ end
76
+
77
+
78
+ end
79
+
80
+ # Show invalid properties with the reasons. Usually used together with valid?
81
+ # @return Array for valid properies with the reasons
82
+ def list_invalid_properties
83
+ invalid_properties = Array.new
84
+
85
+
86
+ return invalid_properties
87
+ end
88
+
89
+ # Check to see if the all the properties in the model are valid
90
+ # @return true if the model is valid
91
+ def valid?
92
+
93
+
94
+
95
+ allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "OAuthClient", "OAuthClientAuthorization", "AuthOrganization", "AuthUser", "BulkActions", "Feedback", "Topic", "Program", "Segment", "Outcome", "ClickstreamSettings", "Schedule"]
96
+ if @name && !allowed_values.include?(@name)
97
+ return false
98
+ end
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+ end
107
+
108
+
109
+
110
+ # Custom attribute writer method checking allowed values (enum).
111
+ # @param [Object] name Object to be assigned
112
+ def name=(name)
113
+ allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "OAuthClient", "OAuthClientAuthorization", "AuthOrganization", "AuthUser", "BulkActions", "Feedback", "Topic", "Program", "Segment", "Outcome", "ClickstreamSettings", "Schedule"]
114
+ if name && !allowed_values.include?(name)
115
+ fail ArgumentError, "invalid value for 'name', must be one of #{allowed_values}."
116
+ end
117
+ @name = name
118
+ end
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ # Checks equality by comparing each attribute.
129
+ # @param [Object] Object to be compared
130
+ def ==(o)
131
+ return true if self.equal?(o)
132
+ self.class == o.class &&
133
+ name == o.name &&
134
+ actions == o.actions
135
+ end
136
+
137
+ # @see the `==` method
138
+ # @param [Object] Object to be compared
139
+ def eql?(o)
140
+ self == o
141
+ end
142
+
143
+ # Calculates hash code according to all attributes.
144
+ # @return [Fixnum] Hash code
145
+ def hash
146
+ [name, actions].hash
147
+ end
148
+
149
+ # build the object from hash
150
+ def build_from_hash(attributes)
151
+ return nil unless attributes.is_a?(Hash)
152
+ self.class.swagger_types.each_pair do |key, type|
153
+ if type =~ /^Array<(.*)>/i
154
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
155
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
156
+ else
157
+ #TODO show warning in debug mode
158
+ end
159
+ elsif !attributes[self.class.attribute_map[key]].nil?
160
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
161
+ else
162
+ # data not found in attributes(hash), not an issue as the data can be optional
163
+ end
164
+ end
165
+
166
+ self
167
+ end
168
+
169
+ def _deserialize(type, value)
170
+ case type.to_sym
171
+ when :DateTime
172
+ DateTime.parse(value)
173
+ when :Date
174
+ Date.parse(value)
175
+ when :String
176
+ value.to_s
177
+ when :Integer
178
+ value.to_i
179
+ when :Float
180
+ value.to_f
181
+ when :BOOLEAN
182
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
183
+ true
184
+ else
185
+ false
186
+ end
187
+ when :Object
188
+ # generic object (usually a Hash), return directly
189
+ value
190
+ when /\AArray<(?<inner_type>.+)>\z/
191
+ inner_type = Regexp.last_match[:inner_type]
192
+ value.map { |v| _deserialize(inner_type, v) }
193
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
194
+ k_type = Regexp.last_match[:k_type]
195
+ v_type = Regexp.last_match[:v_type]
196
+ {}.tap do |hash|
197
+ value.each do |k, v|
198
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
199
+ end
200
+ end
201
+ else # model
202
+ _model = Object.const_get("PureCloud").const_get(type).new
203
+ _model.build_from_hash(value)
204
+ end
205
+ end
206
+
207
+ def to_s
208
+ to_hash.to_s
209
+ end
210
+
211
+ # to_body is an alias to to_body (backward compatibility))
212
+ def to_body
213
+ to_hash
214
+ end
215
+
216
+ # return the object in the form of hash
217
+ def to_hash
218
+ hash = {}
219
+ self.class.attribute_map.each_pair do |attr, param|
220
+ value = self.send(attr)
221
+ next if value.nil?
222
+ hash[param] = _to_hash(value)
223
+ end
224
+ hash
225
+ end
226
+
227
+ # Method to output non-array value in the form of hash
228
+ # For object, use to_hash. Otherwise, just return the value
229
+ def _to_hash(value)
230
+ if value.is_a?(Array)
231
+ value.compact.map{ |v| _to_hash(v) }
232
+ elsif value.is_a?(Hash)
233
+ {}.tap do |hash|
234
+ value.each { |k, v| hash[k] = _to_hash(v) }
235
+ end
236
+ elsif value.respond_to? :to_hash
237
+ value.to_hash
238
+ else
239
+ value
240
+ end
241
+ end
242
+
243
+ end
244
+ end
@@ -36,6 +36,9 @@ module PureCloud
36
36
  # Filters for the audit query.
37
37
  attr_accessor :filters
38
38
 
39
+ # Sort parameter for the audit query.
40
+ attr_accessor :sort
41
+
39
42
  # Attribute mapping from ruby-style variable name to JSON key.
40
43
  def self.attribute_map
41
44
  {
@@ -50,7 +53,9 @@ module PureCloud
50
53
 
51
54
  :'service_name' => :'serviceName',
52
55
 
53
- :'filters' => :'filters'
56
+ :'filters' => :'filters',
57
+
58
+ :'sort' => :'sort'
54
59
 
55
60
  }
56
61
  end
@@ -69,7 +74,9 @@ module PureCloud
69
74
 
70
75
  :'service_name' => :'String',
71
76
 
72
- :'filters' => :'Array<AuditQueryFilter>'
77
+ :'filters' => :'Array<AuditQueryFilter>',
78
+
79
+ :'sort' => :'Array<AuditQuerySort>'
73
80
 
74
81
  }
75
82
  end
@@ -139,6 +146,17 @@ module PureCloud
139
146
  end
140
147
 
141
148
 
149
+ if attributes.has_key?(:'sort')
150
+
151
+ if (value = attributes[:'sort']).is_a?(Array)
152
+ self.sort = value
153
+ end
154
+
155
+
156
+
157
+ end
158
+
159
+
142
160
  end
143
161
 
144
162
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -177,7 +195,7 @@ module PureCloud
177
195
 
178
196
 
179
197
 
180
- allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement"]
198
+ allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement", "WorkforceManagement"]
181
199
  if @service_name && !allowed_values.include?(@service_name)
182
200
  return false
183
201
  end
@@ -188,6 +206,10 @@ module PureCloud
188
206
 
189
207
 
190
208
 
209
+
210
+
211
+
212
+
191
213
  end
192
214
 
193
215
 
@@ -224,7 +246,7 @@ module PureCloud
224
246
  # Custom attribute writer method checking allowed values (enum).
225
247
  # @param [Object] service_name Object to be assigned
226
248
  def service_name=(service_name)
227
- allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement"]
249
+ allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement", "WorkforceManagement"]
228
250
  if service_name && !allowed_values.include?(service_name)
229
251
  fail ArgumentError, "invalid value for 'service_name', must be one of #{allowed_values}."
230
252
  end
@@ -239,6 +261,11 @@ module PureCloud
239
261
 
240
262
 
241
263
 
264
+
265
+
266
+
267
+
268
+
242
269
  # Checks equality by comparing each attribute.
243
270
  # @param [Object] Object to be compared
244
271
  def ==(o)
@@ -249,7 +276,8 @@ module PureCloud
249
276
  start_date == o.start_date &&
250
277
  interval == o.interval &&
251
278
  service_name == o.service_name &&
252
- filters == o.filters
279
+ filters == o.filters &&
280
+ sort == o.sort
253
281
  end
254
282
 
255
283
  # @see the `==` method
@@ -261,7 +289,7 @@ module PureCloud
261
289
  # Calculates hash code according to all attributes.
262
290
  # @return [Fixnum] Hash code
263
291
  def hash
264
- [id, state, start_date, interval, service_name, filters].hash
292
+ [id, state, start_date, interval, service_name, filters, sort].hash
265
293
  end
266
294
 
267
295
  # build the object from hash
@@ -27,6 +27,9 @@ module PureCloud
27
27
  # Additional filters for the query.
28
28
  attr_accessor :filters
29
29
 
30
+ # Sort parameter for the query.
31
+ attr_accessor :sort
32
+
30
33
  # Attribute mapping from ruby-style variable name to JSON key.
31
34
  def self.attribute_map
32
35
  {
@@ -35,7 +38,9 @@ module PureCloud
35
38
 
36
39
  :'service_name' => :'serviceName',
37
40
 
38
- :'filters' => :'filters'
41
+ :'filters' => :'filters',
42
+
43
+ :'sort' => :'sort'
39
44
 
40
45
  }
41
46
  end
@@ -48,7 +53,9 @@ module PureCloud
48
53
 
49
54
  :'service_name' => :'String',
50
55
 
51
- :'filters' => :'Array<AuditQueryFilter>'
56
+ :'filters' => :'Array<AuditQueryFilter>',
57
+
58
+ :'sort' => :'Array<AuditQuerySort>'
52
59
 
53
60
  }
54
61
  end
@@ -91,6 +98,17 @@ module PureCloud
91
98
  end
92
99
 
93
100
 
101
+ if attributes.has_key?(:'sort')
102
+
103
+ if (value = attributes[:'sort']).is_a?(Array)
104
+ self.sort = value
105
+ end
106
+
107
+
108
+
109
+ end
110
+
111
+
94
112
  end
95
113
 
96
114
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -122,7 +140,7 @@ module PureCloud
122
140
 
123
141
 
124
142
 
125
- allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement"]
143
+ allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement", "WorkforceManagement"]
126
144
  if @service_name && !allowed_values.include?(@service_name)
127
145
  return false
128
146
  end
@@ -133,6 +151,10 @@ module PureCloud
133
151
 
134
152
 
135
153
 
154
+
155
+
156
+
157
+
136
158
  end
137
159
 
138
160
 
@@ -145,7 +167,7 @@ module PureCloud
145
167
  # Custom attribute writer method checking allowed values (enum).
146
168
  # @param [Object] service_name Object to be assigned
147
169
  def service_name=(service_name)
148
- allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement"]
170
+ allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement", "WorkforceManagement"]
149
171
  if service_name && !allowed_values.include?(service_name)
150
172
  fail ArgumentError, "invalid value for 'service_name', must be one of #{allowed_values}."
151
173
  end
@@ -160,6 +182,11 @@ module PureCloud
160
182
 
161
183
 
162
184
 
185
+
186
+
187
+
188
+
189
+
163
190
  # Checks equality by comparing each attribute.
164
191
  # @param [Object] Object to be compared
165
192
  def ==(o)
@@ -167,7 +194,8 @@ module PureCloud
167
194
  self.class == o.class &&
168
195
  interval == o.interval &&
169
196
  service_name == o.service_name &&
170
- filters == o.filters
197
+ filters == o.filters &&
198
+ sort == o.sort
171
199
  end
172
200
 
173
201
  # @see the `==` method
@@ -179,7 +207,7 @@ module PureCloud
179
207
  # Calculates hash code according to all attributes.
180
208
  # @return [Fixnum] Hash code
181
209
  def hash
182
- [interval, service_name, filters].hash
210
+ [interval, service_name, filters, sort].hash
183
211
  end
184
212
 
185
213
  # build the object from hash