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
@@ -14,11 +14,12 @@ Method | HTTP request | Description
14
14
  |[**delete_user_id_station_associatedstation**](UsersApi.html#delete_user_id_station_associatedstation) | **DELETE** /api/v2/users/{userId}/station/associatedstation | Clear associated station|
15
15
  |[**delete_user_id_station_defaultstation**](UsersApi.html#delete_user_id_station_defaultstation) | **DELETE** /api/v2/users/{userId}/station/defaultstation | Clear default station|
16
16
  |[**get_me**](UsersApi.html#get_me) | **GET** /api/v2/users/me | Get current user details.|
17
- |[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search using q64|
17
+ |[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search users using the q64 value returned from a previous search|
18
18
  |[**get_user_id**](UsersApi.html#get_user_id) | **GET** /api/v2/users/{userId} | Get user.|
19
19
  |[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | **GET** /api/v2/users/{userId}/callforwarding | Get a user's CallForwarding|
20
20
  |[**get_user_id_geolocations_client_id**](UsersApi.html#get_user_id_geolocations_client_id) | **GET** /api/v2/users/{userId}/geolocations/{clientId} | Get a user's Geolocation|
21
21
  |[**get_user_id_outofoffice**](UsersApi.html#get_user_id_outofoffice) | **GET** /api/v2/users/{userId}/outofoffice | Get a OutOfOffice|
22
+ |[**get_user_id_profileskills**](UsersApi.html#get_user_id_profileskills) | **GET** /api/v2/users/{userId}/profileskills | List profile skills for a user|
22
23
  |[**get_user_id_queues**](UsersApi.html#get_user_id_queues) | **GET** /api/v2/users/{userId}/queues | Get queues for user|
23
24
  |[**get_user_id_roles**](UsersApi.html#get_user_id_roles) | **GET** /api/v2/users/{userId}/roles | Returns a listing of roles and permissions for a user.|
24
25
  |[**get_user_id_routingskills**](UsersApi.html#get_user_id_routingskills) | **GET** /api/v2/users/{userId}/routingskills | List routing skills for user|
@@ -30,13 +31,14 @@ Method | HTTP request | Description
30
31
  |[**patch_user_id_geolocations_client_id**](UsersApi.html#patch_user_id_geolocations_client_id) | **PATCH** /api/v2/users/{userId}/geolocations/{clientId} | Patch a user's Geolocation|
31
32
  |[**patch_user_id_queues**](UsersApi.html#patch_user_id_queues) | **PATCH** /api/v2/users/{userId}/queues | Join or unjoin a set of queues for a user|
32
33
  |[**patch_user_id_queues_queue_id**](UsersApi.html#patch_user_id_queues_queue_id) | **PATCH** /api/v2/users/{userId}/queues/{queueId} | Join or unjoin a queue for a user|
33
- |[**post_search**](UsersApi.html#post_search) | **POST** /api/v2/users/search | Search|
34
+ |[**post_search**](UsersApi.html#post_search) | **POST** /api/v2/users/search | Search users|
34
35
  |[**post_user_id_routingskills**](UsersApi.html#post_user_id_routingskills) | **POST** /api/v2/users/{userId}/routingskills | Add routing skill to user|
35
36
  |[**post_users**](UsersApi.html#post_users) | **POST** /api/v2/users | Create user|
36
37
  |[**post_users_aggregates_query**](UsersApi.html#post_users_aggregates_query) | **POST** /api/v2/analytics/users/aggregates/query | Query for user aggregates|
37
38
  |[**post_users_observations_query**](UsersApi.html#post_users_observations_query) | **POST** /api/v2/analytics/users/observations/query | Query for user observations|
38
39
  |[**put_user_id_callforwarding**](UsersApi.html#put_user_id_callforwarding) | **PUT** /api/v2/users/{userId}/callforwarding | Update a user's CallForwarding|
39
40
  |[**put_user_id_outofoffice**](UsersApi.html#put_user_id_outofoffice) | **PUT** /api/v2/users/{userId}/outofoffice | Update an OutOfOffice|
41
+ |[**put_user_id_profileskills**](UsersApi.html#put_user_id_profileskills) | **PUT** /api/v2/users/{userId}/profileskills | Update profile skills for a user|
40
42
  |[**put_user_id_roles**](UsersApi.html#put_user_id_roles) | **PUT** /api/v2/users/{userId}/roles | Sets the user's roles|
41
43
  |[**put_user_id_routingskills_skill_id**](UsersApi.html#put_user_id_routingskills_skill_id) | **PUT** /api/v2/users/{userId}/routingskills/{skillId} | Update routing skill proficiency or state.|
42
44
  |[**put_user_id_routingstatus**](UsersApi.html#put_user_id_routingstatus) | **PUT** /api/v2/users/{userId}/routingstatus | Update the routing status of a user|
@@ -385,7 +387,7 @@ Name | Type | Description | Notes
385
387
 
386
388
  ## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search(q64, opts)
387
389
 
388
- Search using q64
390
+ Search users using the q64 value returned from a previous search
389
391
 
390
392
 
391
393
 
@@ -413,7 +415,7 @@ opts = {
413
415
  }
414
416
 
415
417
  begin
416
- #Search using q64
418
+ #Search users using the q64 value returned from a previous search
417
419
  result = api_instance.get_search(q64, opts)
418
420
  p result
419
421
  rescue PureCloud::ApiError => e
@@ -672,6 +674,62 @@ Name | Type | Description | Notes
672
674
 
673
675
 
674
676
 
677
+ <a name="get_user_id_profileskills"></a>
678
+
679
+ ## -Array&lt;String&gt;** get_user_id_profileskills(user_id)
680
+
681
+ List profile skills for a user
682
+
683
+
684
+
685
+ ### Example
686
+ ~~~ruby
687
+ # load the gem
688
+ require 'purecloud'
689
+ # setup authorization
690
+ @secret = ENV['PURECLOUD_SECRET']
691
+ @id = ENV['PURECLOUD_CLIENT_ID']
692
+ environment = "mypurecloud.com"
693
+
694
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
695
+
696
+ PureCloud.configure do |config|
697
+ config.access_token = @authToken
698
+ end
699
+
700
+ api_instance = PureCloud::UsersApi.new
701
+
702
+ user_id = "user_id_example" # String | User ID
703
+
704
+
705
+ begin
706
+ #List profile skills for a user
707
+ result = api_instance.get_user_id_profileskills(user_id)
708
+ p result
709
+ rescue PureCloud::ApiError => e
710
+ puts "Exception when calling UsersApi->get_user_id_profileskills: #{e}"
711
+ end
712
+ ~~~
713
+
714
+ ### Parameters
715
+
716
+ Name | Type | Description | Notes
717
+ ------------- | ------------- | ------------- | -------------
718
+ **user_id** | **String**| User ID |
719
+ {: class="table table-striped"}
720
+
721
+
722
+ ### Return type
723
+
724
+ **Array&lt;String&gt;**
725
+
726
+ ### HTTP request headers
727
+
728
+ - **Content-Type**: application/json
729
+ - **Accept**: application/json
730
+
731
+
732
+
675
733
  <a name="get_user_id_queues"></a>
676
734
 
677
735
  ## -[**UserQueueEntityListing**](UserQueueEntityListing.html) get_user_id_queues(user_id, opts)
@@ -1338,7 +1396,7 @@ Name | Type | Description | Notes
1338
1396
 
1339
1397
  ## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search(body)
1340
1398
 
1341
- Search
1399
+ Search users
1342
1400
 
1343
1401
 
1344
1402
 
@@ -1363,7 +1421,7 @@ body = PureCloud::UserSearchRequest.new # UserSearchRequest | Search request opt
1363
1421
 
1364
1422
 
1365
1423
  begin
1366
- #Search
1424
+ #Search users
1367
1425
  result = api_instance.post_search(body)
1368
1426
  p result
1369
1427
  rescue PureCloud::ApiError => e
@@ -1735,6 +1793,66 @@ Name | Type | Description | Notes
1735
1793
 
1736
1794
 
1737
1795
 
1796
+ <a name="put_user_id_profileskills"></a>
1797
+
1798
+ ## -Array&lt;String&gt;** put_user_id_profileskills(user_id, opts)
1799
+
1800
+ Update profile skills for a user
1801
+
1802
+
1803
+
1804
+ ### Example
1805
+ ~~~ruby
1806
+ # load the gem
1807
+ require 'purecloud'
1808
+ # setup authorization
1809
+ @secret = ENV['PURECLOUD_SECRET']
1810
+ @id = ENV['PURECLOUD_CLIENT_ID']
1811
+ environment = "mypurecloud.com"
1812
+
1813
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1814
+
1815
+ PureCloud.configure do |config|
1816
+ config.access_token = @authToken
1817
+ end
1818
+
1819
+ api_instance = PureCloud::UsersApi.new
1820
+
1821
+ user_id = "user_id_example" # String | User ID
1822
+
1823
+ opts = {
1824
+ body: [PureCloud::Array<String>.new] # Array<String> | Skills
1825
+ }
1826
+
1827
+ begin
1828
+ #Update profile skills for a user
1829
+ result = api_instance.put_user_id_profileskills(user_id, opts)
1830
+ p result
1831
+ rescue PureCloud::ApiError => e
1832
+ puts "Exception when calling UsersApi->put_user_id_profileskills: #{e}"
1833
+ end
1834
+ ~~~
1835
+
1836
+ ### Parameters
1837
+
1838
+ Name | Type | Description | Notes
1839
+ ------------- | ------------- | ------------- | -------------
1840
+ **user_id** | **String**| User ID |
1841
+ **body** | **Array&lt;String&gt;**| Skills | [optional]
1842
+ {: class="table table-striped"}
1843
+
1844
+
1845
+ ### Return type
1846
+
1847
+ **Array&lt;String&gt;**
1848
+
1849
+ ### HTTP request headers
1850
+
1851
+ - **Content-Type**: application/json
1852
+ - **Accept**: application/json
1853
+
1854
+
1855
+
1738
1856
  <a name="put_user_id_roles"></a>
1739
1857
 
1740
1858
  ## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id, body)
@@ -12,9 +12,9 @@ title: UsersEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **first_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -7,15 +7,15 @@ title: UsersSearchResponse
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **total** | **Integer** | | [optional] |
11
- | **page_count** | **Integer** | | [optional] |
12
- | **page_size** | **Integer** | | [optional] |
13
- | **page_number** | **Integer** | | [optional] |
14
- | **previous_page** | **String** | | [optional] |
15
- | **current_page** | **String** | | [optional] |
16
- | **next_page** | **String** | | [optional] |
17
- | **types** | **Array&lt;String&gt;** | | [optional] |
18
- | **results** | [**Array&lt;User&gt;**](User.html) | | [optional] |
10
+ | **total** | **Integer** | The total number of results found | |
11
+ | **page_count** | **Integer** | The total number of pages | |
12
+ | **page_size** | **Integer** | The current page size | |
13
+ | **page_number** | **Integer** | The current page number | |
14
+ | **previous_page** | **String** | Q64 value for the previous page of results | [optional] |
15
+ | **current_page** | **String** | Q64 value for the current page of results | [optional] |
16
+ | **next_page** | **String** | Q64 value for the next page of results | [optional] |
17
+ | **types** | **Array&lt;String&gt;** | Resource types the search was performed against | |
18
+ | **results** | [**Array&lt;User&gt;**](User.html) | Search results | |
19
19
  {: class="table table-striped"}
20
20
 
21
21
 
@@ -17,6 +17,7 @@ title: Video
17
17
  | **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
18
18
  | **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
19
19
  | **disconnected_time** | **DateTime** | The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
20
+ | **provider** | **String** | The source provider for the video. | [optional] |
20
21
  {: class="table table-striped"}
21
22
 
22
23
 
@@ -32,8 +32,8 @@ title: VideoConversationNotificationParticipants
32
32
  | **context** | **String** | | [optional] |
33
33
  | **start_hold_time** | **DateTime** | | [optional] |
34
34
  | **attributes** | **Hash&lt;String, String&gt;** | | [optional] |
35
- | **user** | [**CallbackConversationNotificationUser**](CallbackConversationNotificationUser.html) | | [optional] |
36
35
  | **sharing_screen** | **BOOLEAN** | | [optional] |
36
+ | **user** | [**CallbackConversationNotificationUser**](CallbackConversationNotificationUser.html) | | [optional] |
37
37
  {: class="table table-striped"}
38
38
 
39
39
 
@@ -28,12 +28,12 @@ title: VideoConversationNotificationVideoMediaParticipant
28
28
  | **script** | [**VideoConversationNotificationUriReference**](VideoConversationNotificationUriReference.html) | | [optional] |
29
29
  | **wrapup_timeout_ms** | **Integer** | | [optional] |
30
30
  | **wrapup_skipped** | **BOOLEAN** | | [optional] |
31
+ | **provider** | **String** | | [optional] |
31
32
  | **audio_muted** | **BOOLEAN** | | [optional] |
32
33
  | **video_muted** | **BOOLEAN** | | [optional] |
33
34
  | **sharing_screen** | **BOOLEAN** | | [optional] |
34
35
  | **peer_count** | **Integer** | | [optional] |
35
36
  | **context** | **String** | | [optional] |
36
- | **provider** | **String** | | [optional] |
37
37
  {: class="table table-striped"}
38
38
 
39
39
 
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: VisibilityCondition
3
+ ---
4
+ ## PureCloud::VisibilityCondition
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **combining_operation** | **String** | | [optional] |
11
+ | **predicates** | [**Array&lt;Predicate&gt;**](Predicate.html) | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,69 @@
1
+ ---
2
+ title: WorkforceManagementApi
3
+ ---
4
+
5
+ ## PureCloud::WorkforceManagementApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | HTTP request | Description
10
+ ------------- | ------------- | -------------
11
+ |[**get_adherence**](WorkforceManagementApi.html#get_adherence) | **GET** /api/v2/workforcemanagement/adherence | Get a list of UserScheduleAdherence records for the requested users|
12
+ {: class="table table-striped"}
13
+
14
+ <a name="get_adherence"></a>
15
+
16
+ ## -[**UserScheduleAdherence**](UserScheduleAdherence.html) get_adherence(user_id)
17
+
18
+ Get a list of UserScheduleAdherence records for the requested users
19
+
20
+
21
+
22
+ ### Example
23
+ ~~~ruby
24
+ # load the gem
25
+ require 'purecloud'
26
+ # setup authorization
27
+ @secret = ENV['PURECLOUD_SECRET']
28
+ @id = ENV['PURECLOUD_CLIENT_ID']
29
+ environment = "mypurecloud.com"
30
+
31
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
32
+
33
+ PureCloud.configure do |config|
34
+ config.access_token = @authToken
35
+ end
36
+
37
+ api_instance = PureCloud::WorkforceManagementApi.new
38
+
39
+ user_id = ["user_id_example"] # Array<String> | User Id(s) for which to fetch current schedule adherence information. Max of 100 userIds per request
40
+
41
+
42
+ begin
43
+ #Get a list of UserScheduleAdherence records for the requested users
44
+ result = api_instance.get_adherence(user_id)
45
+ p result
46
+ rescue PureCloud::ApiError => e
47
+ puts "Exception when calling WorkforceManagementApi->get_adherence: #{e}"
48
+ end
49
+ ~~~
50
+
51
+ ### Parameters
52
+
53
+ Name | Type | Description | Notes
54
+ ------------- | ------------- | ------------- | -------------
55
+ **user_id** | [**Array&lt;String&gt;**](String.html)| User Id(s) for which to fetch current schedule adherence information. Max of 100 userIds per request |
56
+ {: class="table table-striped"}
57
+
58
+
59
+ ### Return type
60
+
61
+ [**UserScheduleAdherence**](UserScheduleAdherence.html)
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: application/json
66
+ - **Accept**: application/json
67
+
68
+
69
+
@@ -12,9 +12,9 @@ title: WorkspaceEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **first_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: WorkspaceMemberEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **first_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: WrapupCodeEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **first_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
9
9
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
10
10
 
11
11
  - API version: v2
12
- - Package version: 0.52.1
13
- - Build date: 2016-10-08T21:55:48.384Z
12
+ - Package version: 0.53.1
13
+ - Build date: 2016-10-11T01:36:00.020Z
14
14
 
15
15
  For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
16
16
 
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
18
18
 
19
19
  ### from rubygems.org
20
20
 
21
- gem 'purecloud', '~> 0.52.1'
21
+ gem 'purecloud', '~> 0.53.1'
22
22
 
23
23
  ### Install from Git
24
24
 
data/lib/purecloud.rb CHANGED
@@ -400,6 +400,7 @@ require 'purecloud/models/location_search_request'
400
400
  require 'purecloud/models/locations_search_response'
401
401
  require 'purecloud/models/lock_info'
402
402
  require 'purecloud/models/logical_interface_entity_listing'
403
+ require 'purecloud/models/management_unit'
403
404
  require 'purecloud/models/max_participants'
404
405
  require 'purecloud/models/media_participant_request'
405
406
  require 'purecloud/models/media_policies'
@@ -462,6 +463,7 @@ require 'purecloud/models/policy_create'
462
463
  require 'purecloud/models/policy_entity_listing'
463
464
  require 'purecloud/models/policy_error_message'
464
465
  require 'purecloud/models/policy_errors'
466
+ require 'purecloud/models/predicate'
465
467
  require 'purecloud/models/prediction_results'
466
468
  require 'purecloud/models/presence_query_response'
467
469
  require 'purecloud/models/property_index_request'
@@ -610,6 +612,7 @@ require 'purecloud/models/user_recording'
610
612
  require 'purecloud/models/user_recording_entity_listing'
611
613
  require 'purecloud/models/user_routing_skill'
612
614
  require 'purecloud/models/user_routing_skill_post'
615
+ require 'purecloud/models/user_schedule_adherence'
613
616
  require 'purecloud/models/user_search_criteria'
614
617
  require 'purecloud/models/user_search_request'
615
618
  require 'purecloud/models/user_skill_entity_listing'
@@ -628,6 +631,7 @@ require 'purecloud/models/video_conversation_notification_error_info'
628
631
  require 'purecloud/models/video_conversation_notification_participants'
629
632
  require 'purecloud/models/video_conversation_notification_uri_reference'
630
633
  require 'purecloud/models/video_conversation_notification_video_media_participant'
634
+ require 'purecloud/models/visibility_condition'
631
635
  require 'purecloud/models/vm_pairing_info'
632
636
  require 'purecloud/models/voicemail_mailbox_info'
633
637
  require 'purecloud/models/voicemail_media_info'
@@ -679,6 +683,7 @@ require 'purecloud/api/user_recordings_api'
679
683
  require 'purecloud/api/users_api'
680
684
  require 'purecloud/api/utilities_api'
681
685
  require 'purecloud/api/voicemail_api'
686
+ require 'purecloud/api/workforce_management_api'
682
687
 
683
688
  module PureCloud
684
689
  class << self