purecloud 0.52.1 → 0.53.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (335) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/bin/notificationMappings.json +8 -0
  4. data/config-ruby.json +1 -1
  5. data/doc_out/AgentActivityEntityListing.html.md +1 -1
  6. data/doc_out/AttemptLimitsEntityListing.html.md +1 -1
  7. data/doc_out/AttributeEntityListing.html.md +1 -1
  8. data/doc_out/CalibrationEntityListing.html.md +1 -1
  9. data/doc_out/Call.html.md +1 -0
  10. data/doc_out/CallConversationEntityListing.html.md +1 -1
  11. data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -0
  12. data/doc_out/CallConversationNotificationParticipants.html.md +1 -0
  13. data/doc_out/CallableContactsDiagnostic.html.md +1 -0
  14. data/doc_out/CallableTimeSetEntityListing.html.md +1 -1
  15. data/doc_out/Callback.html.md +1 -0
  16. data/doc_out/CallbackConversationEntityListing.html.md +1 -1
  17. data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -0
  18. data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -0
  19. data/doc_out/Campaign.html.md +1 -0
  20. data/doc_out/CampaignEntityListing.html.md +1 -1
  21. data/doc_out/CampaignSequenceEntityListing.html.md +1 -1
  22. data/doc_out/CertificateAuthorityEntityListing.html.md +1 -1
  23. data/doc_out/ChannelEntityListing.html.md +1 -1
  24. data/doc_out/ChatConversationEntityListing.html.md +1 -1
  25. data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -0
  26. data/doc_out/ChatConversationNotificationParticipants.html.md +1 -0
  27. data/doc_out/CobrowseConversationEntityListing.html.md +1 -1
  28. data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -0
  29. data/doc_out/CobrowseConversationNotificationParticipants.html.md +9 -8
  30. data/doc_out/Cobrowsesession.html.md +1 -0
  31. data/doc_out/CommandStatusEntityListing.html.md +1 -1
  32. data/doc_out/ContactListEntityListing.html.md +1 -1
  33. data/doc_out/ConversationEntityListing.html.md +1 -1
  34. data/doc_out/ConversationNotificationCall.html.md +1 -0
  35. data/doc_out/ConversationNotificationCallback.html.md +1 -0
  36. data/doc_out/ConversationNotificationCallbacks.html.md +1 -0
  37. data/doc_out/ConversationNotificationCalls.html.md +1 -0
  38. data/doc_out/ConversationNotificationChat.html.md +1 -0
  39. data/doc_out/ConversationNotificationChats.html.md +1 -0
  40. data/doc_out/ConversationNotificationCobrowse.html.md +1 -0
  41. data/doc_out/ConversationNotificationCobrowsesessions.html.md +1 -0
  42. data/doc_out/ConversationNotificationEmail.html.md +1 -0
  43. data/doc_out/ConversationNotificationEmails.html.md +1 -0
  44. data/doc_out/ConversationNotificationScreenShare.html.md +1 -0
  45. data/doc_out/ConversationNotificationScreenShares.html.md +1 -0
  46. data/doc_out/ConversationNotificationSocialExpression.html.md +1 -0
  47. data/doc_out/ConversationNotificationSocialExpressions.html.md +2 -1
  48. data/doc_out/DIDEntityListing.html.md +1 -1
  49. data/doc_out/DIDPoolEntityListing.html.md +1 -1
  50. data/doc_out/DncListEntityListing.html.md +1 -1
  51. data/doc_out/DocumentAuditEntityListing.html.md +1 -1
  52. data/doc_out/DocumentEntityListing.html.md +1 -1
  53. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +1 -1
  54. data/doc_out/DomainEntityListing.html.md +1 -1
  55. data/doc_out/DomainEntityListingEvaluationForm.html.md +1 -1
  56. data/doc_out/DomainEntityListingQueryResult.html.md +1 -1
  57. data/doc_out/DomainOrganizationRole.html.md +1 -0
  58. data/doc_out/DomainOrganizationRoleCreate.html.md +1 -0
  59. data/doc_out/EdgeEntityListing.html.md +1 -1
  60. data/doc_out/EdgeGroupEntityListing.html.md +1 -1
  61. data/doc_out/EdgeLineEntityListing.html.md +1 -1
  62. data/doc_out/EmailConversationEntityListing.html.md +1 -1
  63. data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -0
  64. data/doc_out/EmailConversationNotificationParticipants.html.md +1 -0
  65. data/doc_out/EmailMessageListing.html.md +1 -1
  66. data/doc_out/EncryptionKeyEntityListing.html.md +1 -1
  67. data/doc_out/EndpointEntityListing.html.md +1 -1
  68. data/doc_out/EvaluationEntityListing.html.md +1 -1
  69. data/doc_out/EvaluationFormEntityListing.html.md +1 -1
  70. data/doc_out/EvaluatorActivityEntityListing.html.md +1 -1
  71. data/doc_out/ExtensionEntityListing.html.md +1 -1
  72. data/doc_out/ExtensionPoolEntityListing.html.md +1 -1
  73. data/doc_out/FaxDocumentEntityListing.html.md +1 -1
  74. data/doc_out/GroupEntityListing.html.md +1 -1
  75. data/doc_out/GroupSearchCriteria.html.md +7 -7
  76. data/doc_out/GroupSearchRequest.html.md +6 -6
  77. data/doc_out/GroupsApi.html.md +6 -6
  78. data/doc_out/GroupsSearchResponse.html.md +9 -9
  79. data/doc_out/HeartBeatAlertContainer.html.md +1 -1
  80. data/doc_out/HeartBeatRuleContainer.html.md +1 -1
  81. data/doc_out/InboundDomainEntityListing.html.md +1 -1
  82. data/doc_out/InboundRouteEntityListing.html.md +1 -1
  83. data/doc_out/InteractionStatsAlertContainer.html.md +1 -1
  84. data/doc_out/InteractionStatsRuleContainer.html.md +1 -1
  85. data/doc_out/JsonNode.html.md +3 -3
  86. data/doc_out/JsonNodeSearchResponse.html.md +9 -9
  87. data/doc_out/KeywordSetEntityListing.html.md +1 -1
  88. data/doc_out/LanguageEntityListing.html.md +1 -1
  89. data/doc_out/LibraryEntityListing.html.md +1 -1
  90. data/doc_out/LineBaseEntityListing.html.md +1 -1
  91. data/doc_out/LineEntityListing.html.md +1 -1
  92. data/doc_out/LocationSearchCriteria.html.md +7 -7
  93. data/doc_out/LocationSearchRequest.html.md +6 -6
  94. data/doc_out/LocationsApi.html.md +6 -6
  95. data/doc_out/LocationsSearchResponse.html.md +9 -9
  96. data/doc_out/LogicalInterfaceEntityListing.html.md +1 -1
  97. data/doc_out/ManagementUnit.html.md +18 -0
  98. data/doc_out/OAuthClientEntityListing.html.md +1 -1
  99. data/doc_out/OAuthProviderEntityListing.html.md +1 -1
  100. data/doc_out/OrganizationPresenceEntityListing.html.md +1 -1
  101. data/doc_out/OrganizationRoleEntityListing.html.md +1 -1
  102. data/doc_out/OrphanRecordingListing.html.md +1 -1
  103. data/doc_out/OutboundRouteEntityListing.html.md +1 -1
  104. data/doc_out/PermissionCollectionEntityListing.html.md +1 -1
  105. data/doc_out/PhoneBaseEntityListing.html.md +1 -1
  106. data/doc_out/PhoneEntityListing.html.md +1 -1
  107. data/doc_out/PhoneMetaBaseEntityListing.html.md +1 -1
  108. data/doc_out/PhysicalInterfaceEntityListing.html.md +1 -1
  109. data/doc_out/PolicyEntityListing.html.md +1 -1
  110. data/doc_out/Predicate.html.md +14 -0
  111. data/doc_out/QualityAuditPage.html.md +1 -1
  112. data/doc_out/QuestionGroup.html.md +1 -0
  113. data/doc_out/QueueEntityListing.html.md +1 -1
  114. data/doc_out/QueueMemberEntityListing.html.md +1 -1
  115. data/doc_out/ReportMetaDataEntityListing.html.md +1 -1
  116. data/doc_out/ReportRunEntryEntityDomainListing.html.md +1 -1
  117. data/doc_out/ReportScheduleEntityListing.html.md +1 -1
  118. data/doc_out/ResponseEntityList.html.md +1 -1
  119. data/doc_out/ResponseEntityListing.html.md +1 -1
  120. data/doc_out/ResponseSetEntityListing.html.md +1 -1
  121. data/doc_out/RuleSetEntityListing.html.md +1 -1
  122. data/doc_out/SchemaCategoryEntityListing.html.md +1 -1
  123. data/doc_out/SchemaReferenceEntityListing.html.md +1 -1
  124. data/doc_out/ScreenRecordingSessionListing.html.md +1 -1
  125. data/doc_out/ScreenShareConversationNotificationParticipants.html.md +10 -9
  126. data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -0
  127. data/doc_out/Screenshare.html.md +1 -0
  128. data/doc_out/SearchAggregation.html.md +6 -6
  129. data/doc_out/SearchApi.html.md +30 -30
  130. data/doc_out/SearchCriteria.html.md +7 -7
  131. data/doc_out/SearchRequest.html.md +9 -9
  132. data/doc_out/SecurityProfileEntityListing.html.md +1 -1
  133. data/doc_out/ShareEntityListing.html.md +1 -1
  134. data/doc_out/SiteEntityListing.html.md +1 -1
  135. data/doc_out/SkillEntityListing.html.md +1 -1
  136. data/doc_out/SocialConversationNotificationParticipants.html.md +11 -10
  137. data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -0
  138. data/doc_out/SocialExpression.html.md +1 -0
  139. data/doc_out/StationEntityListing.html.md +1 -1
  140. data/doc_out/SuggestApi.html.md +12 -12
  141. data/doc_out/SuggestSearchCriteria.html.md +7 -7
  142. data/doc_out/SuggestSearchRequest.html.md +2 -2
  143. data/doc_out/TagValueEntityListing.html.md +1 -1
  144. data/doc_out/TimeZoneEntityListing.html.md +1 -1
  145. data/doc_out/TrunkEntityListing.html.md +1 -1
  146. data/doc_out/TrunkMetabaseEntityListing.html.md +1 -1
  147. data/doc_out/UserEntityListing.html.md +1 -1
  148. data/doc_out/UserQueueEntityListing.html.md +1 -1
  149. data/doc_out/UserRecordingEntityListing.html.md +1 -1
  150. data/doc_out/UserScheduleAdherence.html.md +26 -0
  151. data/doc_out/UserSearchCriteria.html.md +7 -7
  152. data/doc_out/UserSearchRequest.html.md +6 -6
  153. data/doc_out/UserSkillEntityListing.html.md +1 -1
  154. data/doc_out/UsersApi.html.md +124 -6
  155. data/doc_out/UsersEntityListing.html.md +1 -1
  156. data/doc_out/UsersSearchResponse.html.md +9 -9
  157. data/doc_out/Video.html.md +1 -0
  158. data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
  159. data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
  160. data/doc_out/VisibilityCondition.html.md +14 -0
  161. data/doc_out/WorkforceManagementApi.html.md +69 -0
  162. data/doc_out/WorkspaceEntityListing.html.md +1 -1
  163. data/doc_out/WorkspaceMemberEntityListing.html.md +1 -1
  164. data/doc_out/WrapupCodeEntityListing.html.md +1 -1
  165. data/doc_out/index.html.md +3 -3
  166. data/lib/purecloud.rb +5 -0
  167. data/lib/purecloud/api/groups_api.rb +4 -4
  168. data/lib/purecloud/api/locations_api.rb +4 -4
  169. data/lib/purecloud/api/search_api.rb +20 -20
  170. data/lib/purecloud/api/suggest_api.rb +8 -8
  171. data/lib/purecloud/api/users_api.rb +126 -4
  172. data/lib/purecloud/api/workforce_management_api.rb +88 -0
  173. data/lib/purecloud/api_client.rb +1 -1
  174. data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
  175. data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
  176. data/lib/purecloud/models/attempt_limits_entity_listing.rb +11 -11
  177. data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
  178. data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
  179. data/lib/purecloud/models/call.rb +15 -4
  180. data/lib/purecloud/models/call_conversation_entity_listing.rb +11 -11
  181. data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +11 -1
  182. data/lib/purecloud/models/call_conversation_notification_participants.rb +11 -1
  183. data/lib/purecloud/models/callable_contacts_diagnostic.rb +12 -1
  184. data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
  185. data/lib/purecloud/models/callback.rb +15 -4
  186. data/lib/purecloud/models/callback_conversation_entity_listing.rb +11 -11
  187. data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +11 -1
  188. data/lib/purecloud/models/callback_conversation_notification_participants.rb +11 -1
  189. data/lib/purecloud/models/campaign.rb +12 -1
  190. data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
  191. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
  192. data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
  193. data/lib/purecloud/models/channel_entity_listing.rb +11 -11
  194. data/lib/purecloud/models/chat_conversation_entity_listing.rb +11 -11
  195. data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +11 -1
  196. data/lib/purecloud/models/chat_conversation_notification_participants.rb +11 -1
  197. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +11 -11
  198. data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +11 -1
  199. data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +87 -77
  200. data/lib/purecloud/models/cobrowsesession.rb +15 -4
  201. data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
  202. data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
  203. data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
  204. data/lib/purecloud/models/conversation_notification_call.rb +11 -1
  205. data/lib/purecloud/models/conversation_notification_callback.rb +11 -1
  206. data/lib/purecloud/models/conversation_notification_callbacks.rb +11 -1
  207. data/lib/purecloud/models/conversation_notification_calls.rb +11 -1
  208. data/lib/purecloud/models/conversation_notification_chat.rb +11 -1
  209. data/lib/purecloud/models/conversation_notification_chats.rb +14 -4
  210. data/lib/purecloud/models/conversation_notification_cobrowse.rb +11 -1
  211. data/lib/purecloud/models/conversation_notification_cobrowsesessions.rb +11 -1
  212. data/lib/purecloud/models/conversation_notification_email.rb +11 -1
  213. data/lib/purecloud/models/conversation_notification_emails.rb +11 -1
  214. data/lib/purecloud/models/conversation_notification_screen_share.rb +11 -1
  215. data/lib/purecloud/models/conversation_notification_screen_shares.rb +11 -1
  216. data/lib/purecloud/models/conversation_notification_social_expression.rb +11 -1
  217. data/lib/purecloud/models/conversation_notification_social_expressions.rb +21 -11
  218. data/lib/purecloud/models/conversation_notification_video.rb +0 -9
  219. data/lib/purecloud/models/conversation_notification_videos.rb +0 -9
  220. data/lib/purecloud/models/did_entity_listing.rb +11 -11
  221. data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
  222. data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
  223. data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
  224. data/lib/purecloud/models/document_entity_listing.rb +11 -11
  225. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +11 -11
  226. data/lib/purecloud/models/domain_entity_listing.rb +11 -11
  227. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
  228. data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
  229. data/lib/purecloud/models/domain_organization_role.rb +13 -1
  230. data/lib/purecloud/models/domain_organization_role_create.rb +13 -1
  231. data/lib/purecloud/models/edge_entity_listing.rb +11 -11
  232. data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
  233. data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
  234. data/lib/purecloud/models/email_conversation_entity_listing.rb +11 -11
  235. data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +11 -1
  236. data/lib/purecloud/models/email_conversation_notification_participants.rb +11 -1
  237. data/lib/purecloud/models/email_message_listing.rb +11 -11
  238. data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
  239. data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
  240. data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
  241. data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
  242. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
  243. data/lib/purecloud/models/extension_entity_listing.rb +11 -11
  244. data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
  245. data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
  246. data/lib/purecloud/models/group_entity_listing.rb +11 -11
  247. data/lib/purecloud/models/group_search_criteria.rb +7 -0
  248. data/lib/purecloud/models/group_search_request.rb +6 -0
  249. data/lib/purecloud/models/groups_search_response.rb +9 -0
  250. data/lib/purecloud/models/heart_beat_alert_container.rb +11 -11
  251. data/lib/purecloud/models/heart_beat_rule_container.rb +11 -11
  252. data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
  253. data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
  254. data/lib/purecloud/models/interaction_stats_alert_container.rb +11 -11
  255. data/lib/purecloud/models/interaction_stats_rule_container.rb +11 -11
  256. data/lib/purecloud/models/json_node.rb +40 -40
  257. data/lib/purecloud/models/json_node_search_response.rb +9 -0
  258. data/lib/purecloud/models/keyword_set_entity_listing.rb +11 -11
  259. data/lib/purecloud/models/language_entity_listing.rb +11 -11
  260. data/lib/purecloud/models/library_entity_listing.rb +11 -11
  261. data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
  262. data/lib/purecloud/models/line_entity_listing.rb +11 -11
  263. data/lib/purecloud/models/location_search_criteria.rb +7 -0
  264. data/lib/purecloud/models/location_search_request.rb +6 -0
  265. data/lib/purecloud/models/locations_search_response.rb +9 -0
  266. data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
  267. data/lib/purecloud/models/management_unit.rb +230 -0
  268. data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
  269. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
  270. data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
  271. data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
  272. data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
  273. data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
  274. data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
  275. data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
  276. data/lib/purecloud/models/phone_entity_listing.rb +11 -11
  277. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
  278. data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
  279. data/lib/purecloud/models/policy_entity_listing.rb +11 -11
  280. data/lib/purecloud/models/predicate.rb +175 -0
  281. data/lib/purecloud/models/quality_audit_page.rb +11 -11
  282. data/lib/purecloud/models/question_group.rb +14 -4
  283. data/lib/purecloud/models/queue_entity_listing.rb +11 -11
  284. data/lib/purecloud/models/queue_member_entity_listing.rb +11 -11
  285. data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
  286. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
  287. data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
  288. data/lib/purecloud/models/response_entity_list.rb +11 -11
  289. data/lib/purecloud/models/response_entity_listing.rb +11 -11
  290. data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
  291. data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
  292. data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
  293. data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
  294. data/lib/purecloud/models/screen_recording_session_listing.rb +11 -11
  295. data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +89 -79
  296. data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +11 -1
  297. data/lib/purecloud/models/screenshare.rb +15 -4
  298. data/lib/purecloud/models/search_aggregation.rb +6 -0
  299. data/lib/purecloud/models/search_criteria.rb +7 -0
  300. data/lib/purecloud/models/search_request.rb +9 -1
  301. data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
  302. data/lib/purecloud/models/share_entity_listing.rb +11 -11
  303. data/lib/purecloud/models/site_entity_listing.rb +11 -11
  304. data/lib/purecloud/models/skill_entity_listing.rb +11 -11
  305. data/lib/purecloud/models/social_conversation_notification_participants.rb +103 -93
  306. data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +11 -1
  307. data/lib/purecloud/models/social_expression.rb +15 -4
  308. data/lib/purecloud/models/station_entity_listing.rb +11 -11
  309. data/lib/purecloud/models/suggest_search_criteria.rb +7 -0
  310. data/lib/purecloud/models/suggest_search_request.rb +2 -1
  311. data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
  312. data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
  313. data/lib/purecloud/models/trunk_entity_listing.rb +11 -11
  314. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
  315. data/lib/purecloud/models/user_entity_listing.rb +11 -11
  316. data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
  317. data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
  318. data/lib/purecloud/models/user_schedule_adherence.rb +364 -0
  319. data/lib/purecloud/models/user_search_criteria.rb +7 -0
  320. data/lib/purecloud/models/user_search_request.rb +6 -0
  321. data/lib/purecloud/models/user_skill_entity_listing.rb +11 -11
  322. data/lib/purecloud/models/users_entity_listing.rb +11 -11
  323. data/lib/purecloud/models/users_search_response.rb +9 -0
  324. data/lib/purecloud/models/video.rb +15 -4
  325. data/lib/purecloud/models/video_conversation_notification_participants.rb +13 -22
  326. data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +14 -23
  327. data/lib/purecloud/models/visibility_condition.rb +186 -0
  328. data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
  329. data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
  330. data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
  331. data/lib/purecloud/version.rb +1 -1
  332. data/newVersion.md +1 -1
  333. data/swagger.json +1 -1
  334. data/version.json +1 -1
  335. metadata +12 -2
@@ -0,0 +1,88 @@
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@inin.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: ININ
11
+ http://www.inin.com
12
+
13
+ Terms of Service: https://developer.mypurecloud.com/tos
14
+
15
+ =end
16
+
17
+ require "uri"
18
+
19
+ module PureCloud
20
+ class WorkforceManagementApi
21
+ attr_accessor :api_client
22
+
23
+ def initialize(api_client = ApiClient.default)
24
+ @api_client = api_client
25
+ end
26
+
27
+ # Get a list of UserScheduleAdherence records for the requested users
28
+ #
29
+ # @param user_id User Id(s) for which to fetch current schedule adherence information. Max of 100 userIds per request
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [UserScheduleAdherence]
32
+ def get_adherence(user_id, opts = {})
33
+ data, status_code, headers = get_adherence_with_http_info(user_id, opts)
34
+ return data
35
+ end
36
+
37
+ # Get a list of UserScheduleAdherence records for the requested users
38
+ #
39
+ # @param user_id User Id(s) for which to fetch current schedule adherence information. Max of 100 userIds per request
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(UserScheduleAdherence, Fixnum, Hash)>] UserScheduleAdherence data, response status code and response headers
42
+ def get_adherence_with_http_info(user_id, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: WorkforceManagementApi#get_adherence ..."
45
+ end
46
+
47
+ # verify the required parameter 'user_id' is set
48
+ fail "Missing the required parameter 'user_id' when calling get_adherence" if user_id.nil?
49
+
50
+ # resource path
51
+ local_var_path = "/api/v2/workforcemanagement/adherence".sub('{format}','json')
52
+
53
+ # query parameters
54
+ query_params = {}
55
+ query_params[:'userId'] = @api_client.build_collection_param(user_id, :multi)
56
+
57
+ # header parameters
58
+ header_params = {}
59
+
60
+ # HTTP header 'Accept' (if needed)
61
+ _header_accept = ['application/json']
62
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
63
+
64
+ # HTTP header 'Content-Type'
65
+ _header_content_type = ['application/json']
66
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
67
+
68
+ # form parameters
69
+ form_params = {}
70
+
71
+ # http body (model)
72
+ post_body = nil
73
+
74
+ auth_names = ['PureCloud Auth']
75
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
76
+ :header_params => header_params,
77
+ :query_params => query_params,
78
+ :form_params => form_params,
79
+ :body => post_body,
80
+ :auth_names => auth_names,
81
+ :return_type => 'UserScheduleAdherence')
82
+ if @api_client.config.debugging
83
+ @api_client.config.logger.debug "API called: WorkforceManagementApi#get_adherence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
84
+ end
85
+ return data, status_code, headers
86
+ end
87
+ end
88
+ end
@@ -33,7 +33,7 @@ module PureCloud
33
33
 
34
34
  def initialize(config = Configuration.default)
35
35
  @config = config
36
- @user_agent = "PureCloud SDK/Ruby 0.52.1"
36
+ @user_agent = "PureCloud SDK/Ruby 0.53.1"
37
37
  @default_headers = {
38
38
  'Content-Type' => "application/json",
39
39
  'User-Agent' => @user_agent
@@ -28,12 +28,12 @@ module PureCloud
28
28
 
29
29
  attr_accessor :self_uri
30
30
 
31
- attr_accessor :next_uri
32
-
33
31
  attr_accessor :first_uri
34
32
 
35
33
  attr_accessor :previous_uri
36
34
 
35
+ attr_accessor :next_uri
36
+
37
37
  attr_accessor :last_uri
38
38
 
39
39
  attr_accessor :page_count
@@ -52,12 +52,12 @@ module PureCloud
52
52
 
53
53
  :'self_uri' => :'selfUri',
54
54
 
55
- :'next_uri' => :'nextUri',
56
-
57
55
  :'first_uri' => :'firstUri',
58
56
 
59
57
  :'previous_uri' => :'previousUri',
60
58
 
59
+ :'next_uri' => :'nextUri',
60
+
61
61
  :'last_uri' => :'lastUri',
62
62
 
63
63
  :'page_count' => :'pageCount'
@@ -73,9 +73,9 @@ module PureCloud
73
73
  :'page_number' => :'Integer',
74
74
  :'total' => :'Integer',
75
75
  :'self_uri' => :'String',
76
- :'next_uri' => :'String',
77
76
  :'first_uri' => :'String',
78
77
  :'previous_uri' => :'String',
78
+ :'next_uri' => :'String',
79
79
  :'last_uri' => :'String',
80
80
  :'page_count' => :'Integer'
81
81
 
@@ -111,10 +111,6 @@ module PureCloud
111
111
  self.self_uri = attributes[:'selfUri']
112
112
  end
113
113
 
114
- if attributes[:'nextUri']
115
- self.next_uri = attributes[:'nextUri']
116
- end
117
-
118
114
  if attributes[:'firstUri']
119
115
  self.first_uri = attributes[:'firstUri']
120
116
  end
@@ -123,6 +119,10 @@ module PureCloud
123
119
  self.previous_uri = attributes[:'previousUri']
124
120
  end
125
121
 
122
+ if attributes[:'nextUri']
123
+ self.next_uri = attributes[:'nextUri']
124
+ end
125
+
126
126
  if attributes[:'lastUri']
127
127
  self.last_uri = attributes[:'lastUri']
128
128
  end
@@ -142,9 +142,9 @@ module PureCloud
142
142
  page_number == o.page_number &&
143
143
  total == o.total &&
144
144
  self_uri == o.self_uri &&
145
- next_uri == o.next_uri &&
146
145
  first_uri == o.first_uri &&
147
146
  previous_uri == o.previous_uri &&
147
+ next_uri == o.next_uri &&
148
148
  last_uri == o.last_uri &&
149
149
  page_count == o.page_count
150
150
  end
@@ -156,7 +156,7 @@ module PureCloud
156
156
 
157
157
  # Calculate hash code according to all attributes.
158
158
  def hash
159
- [entities, page_size, page_number, total, self_uri, next_uri, first_uri, previous_uri, last_uri, page_count].hash
159
+ [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
160
160
  end
161
161
 
162
162
  # build the object from hash
@@ -132,7 +132,7 @@ module PureCloud
132
132
 
133
133
  # Custom attribute writer method checking allowed values (enum).
134
134
  def dimension=(dimension)
135
- allowed_values = ["conversationId", "sessionId", "mediaType", "queueId", "userId", "participantId", "participantName", "direction", "wrapUpCode", "wrapUpNote", "interactionType", "requestedRoutingSkillId", "requestedLanguageId", "purpose", "participantType", "segmentType", "disconnectType", "errorCode", "conversationEnd", "stationId", "edgeId", "dnis", "ani", "outboundCampaignId", "outboundContactId", "outboundContactListId", "monitoredParticipantId", "sourceSessionId", "destinationSessionId", "sourceConversationId", "destinationConversationId", "remoteNameDisplayable", "sipResponseCode", "q850ResponseCode", "conference", "groupId", "roomId", "addressFrom", "addressTo", "peerId", "scriptId", "evaluationId", "evaluatorId", "contextId", "formId", "formName", "eventTime"]
135
+ allowed_values = ["conversationId", "sessionId", "mediaType", "queueId", "userId", "participantId", "participantName", "direction", "wrapUpCode", "wrapUpNote", "interactionType", "requestedRoutingSkillId", "requestedLanguageId", "purpose", "participantType", "segmentType", "disconnectType", "errorCode", "conversationEnd", "stationId", "edgeId", "dnis", "ani", "outboundCampaignId", "outboundContactId", "outboundContactListId", "monitoredParticipantId", "sourceSessionId", "destinationSessionId", "sourceConversationId", "destinationConversationId", "remoteNameDisplayable", "sipResponseCode", "q850ResponseCode", "conference", "groupId", "roomId", "addressFrom", "addressTo", "subject", "peerId", "scriptId", "evaluationId", "evaluatorId", "contextId", "formId", "formName", "eventTime"]
136
136
  if dimension && !allowed_values.include?(dimension)
137
137
  fail "invalid value for 'dimension', must be one of #{allowed_values}"
138
138
  end
@@ -28,12 +28,12 @@ module PureCloud
28
28
 
29
29
  attr_accessor :self_uri
30
30
 
31
- attr_accessor :next_uri
32
-
33
31
  attr_accessor :first_uri
34
32
 
35
33
  attr_accessor :previous_uri
36
34
 
35
+ attr_accessor :next_uri
36
+
37
37
  attr_accessor :last_uri
38
38
 
39
39
  attr_accessor :page_count
@@ -52,12 +52,12 @@ module PureCloud
52
52
 
53
53
  :'self_uri' => :'selfUri',
54
54
 
55
- :'next_uri' => :'nextUri',
56
-
57
55
  :'first_uri' => :'firstUri',
58
56
 
59
57
  :'previous_uri' => :'previousUri',
60
58
 
59
+ :'next_uri' => :'nextUri',
60
+
61
61
  :'last_uri' => :'lastUri',
62
62
 
63
63
  :'page_count' => :'pageCount'
@@ -73,9 +73,9 @@ module PureCloud
73
73
  :'page_number' => :'Integer',
74
74
  :'total' => :'Integer',
75
75
  :'self_uri' => :'String',
76
- :'next_uri' => :'String',
77
76
  :'first_uri' => :'String',
78
77
  :'previous_uri' => :'String',
78
+ :'next_uri' => :'String',
79
79
  :'last_uri' => :'String',
80
80
  :'page_count' => :'Integer'
81
81
 
@@ -111,10 +111,6 @@ module PureCloud
111
111
  self.self_uri = attributes[:'selfUri']
112
112
  end
113
113
 
114
- if attributes[:'nextUri']
115
- self.next_uri = attributes[:'nextUri']
116
- end
117
-
118
114
  if attributes[:'firstUri']
119
115
  self.first_uri = attributes[:'firstUri']
120
116
  end
@@ -123,6 +119,10 @@ module PureCloud
123
119
  self.previous_uri = attributes[:'previousUri']
124
120
  end
125
121
 
122
+ if attributes[:'nextUri']
123
+ self.next_uri = attributes[:'nextUri']
124
+ end
125
+
126
126
  if attributes[:'lastUri']
127
127
  self.last_uri = attributes[:'lastUri']
128
128
  end
@@ -142,9 +142,9 @@ module PureCloud
142
142
  page_number == o.page_number &&
143
143
  total == o.total &&
144
144
  self_uri == o.self_uri &&
145
- next_uri == o.next_uri &&
146
145
  first_uri == o.first_uri &&
147
146
  previous_uri == o.previous_uri &&
147
+ next_uri == o.next_uri &&
148
148
  last_uri == o.last_uri &&
149
149
  page_count == o.page_count
150
150
  end
@@ -156,7 +156,7 @@ module PureCloud
156
156
 
157
157
  # Calculate hash code according to all attributes.
158
158
  def hash
159
- [entities, page_size, page_number, total, self_uri, next_uri, first_uri, previous_uri, last_uri, page_count].hash
159
+ [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
160
160
  end
161
161
 
162
162
  # build the object from hash
@@ -28,12 +28,12 @@ module PureCloud
28
28
 
29
29
  attr_accessor :self_uri
30
30
 
31
- attr_accessor :next_uri
32
-
33
31
  attr_accessor :first_uri
34
32
 
35
33
  attr_accessor :previous_uri
36
34
 
35
+ attr_accessor :next_uri
36
+
37
37
  attr_accessor :last_uri
38
38
 
39
39
  attr_accessor :page_count
@@ -52,12 +52,12 @@ module PureCloud
52
52
 
53
53
  :'self_uri' => :'selfUri',
54
54
 
55
- :'next_uri' => :'nextUri',
56
-
57
55
  :'first_uri' => :'firstUri',
58
56
 
59
57
  :'previous_uri' => :'previousUri',
60
58
 
59
+ :'next_uri' => :'nextUri',
60
+
61
61
  :'last_uri' => :'lastUri',
62
62
 
63
63
  :'page_count' => :'pageCount'
@@ -73,9 +73,9 @@ module PureCloud
73
73
  :'page_number' => :'Integer',
74
74
  :'total' => :'Integer',
75
75
  :'self_uri' => :'String',
76
- :'next_uri' => :'String',
77
76
  :'first_uri' => :'String',
78
77
  :'previous_uri' => :'String',
78
+ :'next_uri' => :'String',
79
79
  :'last_uri' => :'String',
80
80
  :'page_count' => :'Integer'
81
81
 
@@ -111,10 +111,6 @@ module PureCloud
111
111
  self.self_uri = attributes[:'selfUri']
112
112
  end
113
113
 
114
- if attributes[:'nextUri']
115
- self.next_uri = attributes[:'nextUri']
116
- end
117
-
118
114
  if attributes[:'firstUri']
119
115
  self.first_uri = attributes[:'firstUri']
120
116
  end
@@ -123,6 +119,10 @@ module PureCloud
123
119
  self.previous_uri = attributes[:'previousUri']
124
120
  end
125
121
 
122
+ if attributes[:'nextUri']
123
+ self.next_uri = attributes[:'nextUri']
124
+ end
125
+
126
126
  if attributes[:'lastUri']
127
127
  self.last_uri = attributes[:'lastUri']
128
128
  end
@@ -142,9 +142,9 @@ module PureCloud
142
142
  page_number == o.page_number &&
143
143
  total == o.total &&
144
144
  self_uri == o.self_uri &&
145
- next_uri == o.next_uri &&
146
145
  first_uri == o.first_uri &&
147
146
  previous_uri == o.previous_uri &&
147
+ next_uri == o.next_uri &&
148
148
  last_uri == o.last_uri &&
149
149
  page_count == o.page_count
150
150
  end
@@ -156,7 +156,7 @@ module PureCloud
156
156
 
157
157
  # Calculate hash code according to all attributes.
158
158
  def hash
159
- [entities, page_size, page_number, total, self_uri, next_uri, first_uri, previous_uri, last_uri, page_count].hash
159
+ [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
160
160
  end
161
161
 
162
162
  # build the object from hash
@@ -28,12 +28,12 @@ module PureCloud
28
28
 
29
29
  attr_accessor :self_uri
30
30
 
31
- attr_accessor :next_uri
32
-
33
31
  attr_accessor :first_uri
34
32
 
35
33
  attr_accessor :previous_uri
36
34
 
35
+ attr_accessor :next_uri
36
+
37
37
  attr_accessor :last_uri
38
38
 
39
39
  attr_accessor :page_count
@@ -52,12 +52,12 @@ module PureCloud
52
52
 
53
53
  :'self_uri' => :'selfUri',
54
54
 
55
- :'next_uri' => :'nextUri',
56
-
57
55
  :'first_uri' => :'firstUri',
58
56
 
59
57
  :'previous_uri' => :'previousUri',
60
58
 
59
+ :'next_uri' => :'nextUri',
60
+
61
61
  :'last_uri' => :'lastUri',
62
62
 
63
63
  :'page_count' => :'pageCount'
@@ -73,9 +73,9 @@ module PureCloud
73
73
  :'page_number' => :'Integer',
74
74
  :'total' => :'Integer',
75
75
  :'self_uri' => :'String',
76
- :'next_uri' => :'String',
77
76
  :'first_uri' => :'String',
78
77
  :'previous_uri' => :'String',
78
+ :'next_uri' => :'String',
79
79
  :'last_uri' => :'String',
80
80
  :'page_count' => :'Integer'
81
81
 
@@ -111,10 +111,6 @@ module PureCloud
111
111
  self.self_uri = attributes[:'selfUri']
112
112
  end
113
113
 
114
- if attributes[:'nextUri']
115
- self.next_uri = attributes[:'nextUri']
116
- end
117
-
118
114
  if attributes[:'firstUri']
119
115
  self.first_uri = attributes[:'firstUri']
120
116
  end
@@ -123,6 +119,10 @@ module PureCloud
123
119
  self.previous_uri = attributes[:'previousUri']
124
120
  end
125
121
 
122
+ if attributes[:'nextUri']
123
+ self.next_uri = attributes[:'nextUri']
124
+ end
125
+
126
126
  if attributes[:'lastUri']
127
127
  self.last_uri = attributes[:'lastUri']
128
128
  end
@@ -142,9 +142,9 @@ module PureCloud
142
142
  page_number == o.page_number &&
143
143
  total == o.total &&
144
144
  self_uri == o.self_uri &&
145
- next_uri == o.next_uri &&
146
145
  first_uri == o.first_uri &&
147
146
  previous_uri == o.previous_uri &&
147
+ next_uri == o.next_uri &&
148
148
  last_uri == o.last_uri &&
149
149
  page_count == o.page_count
150
150
  end
@@ -156,7 +156,7 @@ module PureCloud
156
156
 
157
157
  # Calculate hash code according to all attributes.
158
158
  def hash
159
- [entities, page_size, page_number, total, self_uri, next_uri, first_uri, previous_uri, last_uri, page_count].hash
159
+ [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
160
160
  end
161
161
 
162
162
  # build the object from hash
@@ -71,6 +71,9 @@ module PureCloud
71
71
  # Extra information on fax transmission.
72
72
  attr_accessor :fax_status
73
73
 
74
+ # The source provider for the call.
75
+ attr_accessor :provider
76
+
74
77
  # Attribute mapping from ruby-style variable name to JSON key.
75
78
  def self.attribute_map
76
79
  {
@@ -109,7 +112,9 @@ module PureCloud
109
112
 
110
113
  :'disconnect_reasons' => :'disconnectReasons',
111
114
 
112
- :'fax_status' => :'faxStatus'
115
+ :'fax_status' => :'faxStatus',
116
+
117
+ :'provider' => :'provider'
113
118
 
114
119
  }
115
120
  end
@@ -134,7 +139,8 @@ module PureCloud
134
139
  :'connected_time' => :'DateTime',
135
140
  :'disconnected_time' => :'DateTime',
136
141
  :'disconnect_reasons' => :'Array<DisconnectReason>',
137
- :'fax_status' => :'FaxStatus'
142
+ :'fax_status' => :'FaxStatus',
143
+ :'provider' => :'String'
138
144
 
139
145
  }
140
146
  end
@@ -230,6 +236,10 @@ module PureCloud
230
236
  self.fax_status = attributes[:'faxStatus']
231
237
  end
232
238
 
239
+ if attributes[:'provider']
240
+ self.provider = attributes[:'provider']
241
+ end
242
+
233
243
  end
234
244
 
235
245
  # Custom attribute writer method checking allowed values (enum).
@@ -289,7 +299,8 @@ module PureCloud
289
299
  connected_time == o.connected_time &&
290
300
  disconnected_time == o.disconnected_time &&
291
301
  disconnect_reasons == o.disconnect_reasons &&
292
- fax_status == o.fax_status
302
+ fax_status == o.fax_status &&
303
+ provider == o.provider
293
304
  end
294
305
 
295
306
  # @see the `==` method
@@ -299,7 +310,7 @@ module PureCloud
299
310
 
300
311
  # Calculate hash code according to all attributes.
301
312
  def hash
302
- [state, id, direction, recording, recording_state, muted, confined, held, recording_id, segments, error_info, disconnect_type, start_hold_time, document_id, connected_time, disconnected_time, disconnect_reasons, fax_status].hash
313
+ [state, id, direction, recording, recording_state, muted, confined, held, recording_id, segments, error_info, disconnect_type, start_hold_time, document_id, connected_time, disconnected_time, disconnect_reasons, fax_status, provider].hash
303
314
  end
304
315
 
305
316
  # build the object from hash