purecloud 0.58.1 → 0.59.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (349) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/bin/notificationMappings.json +16 -0
  4. data/config-ruby.json +1 -1
  5. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  6. data/doc_out/AnalyticsApi.html.md +57 -0
  7. data/doc_out/AnalyticsConversationSegment.html.md +2 -0
  8. data/doc_out/AnalyticsRoutingStatusRecord.html.md +16 -0
  9. data/doc_out/AnalyticsSession.html.md +8 -0
  10. data/doc_out/AnalyticsUserDetail.html.md +15 -0
  11. data/doc_out/AnalyticsUserDetailsQueryResponse.html.md +14 -0
  12. data/doc_out/AnalyticsUserPresenceRecord.html.md +17 -0
  13. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  14. data/doc_out/AttributeEntityListing.html.md +2 -2
  15. data/doc_out/CalibrationEntityListing.html.md +2 -2
  16. data/doc_out/CallConversationEntityListing.html.md +2 -2
  17. data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
  18. data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
  19. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  20. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  21. data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
  22. data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
  23. data/doc_out/CampaignEntityListing.html.md +2 -2
  24. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  25. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  26. data/doc_out/ChannelEntityListing.html.md +2 -2
  27. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  28. data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
  29. data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
  30. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  31. data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
  32. data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
  33. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  34. data/doc_out/ContactListEntityListing.html.md +2 -2
  35. data/doc_out/ContentManagementApi.html.md +69 -0
  36. data/doc_out/ConversationEntityListing.html.md +2 -2
  37. data/doc_out/ConversationNotificationParticipant.html.md +1 -1
  38. data/doc_out/ConversationNotificationParticipants.html.md +13 -13
  39. data/doc_out/{ConversationNotificationScreenShare.html.md → ConversationNotificationScreenshare.html.md} +2 -2
  40. data/doc_out/{ConversationNotificationScreenShares.html.md → ConversationNotificationScreenshares.html.md} +2 -2
  41. data/doc_out/DIDEntityListing.html.md +2 -2
  42. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  43. data/doc_out/DncListEntityListing.html.md +2 -2
  44. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  45. data/doc_out/DocumentDataNotification.html.md +28 -0
  46. data/doc_out/{CallbackConversationNotificationUser.html.md → DocumentDataNotificationCreatedBy.html.md} +2 -2
  47. data/doc_out/DocumentDataNotificationLockData.html.md +15 -0
  48. data/doc_out/DocumentDataNotificationLockInfo.html.md +15 -0
  49. data/doc_out/DocumentDataNotificationUserData.html.md +14 -0
  50. data/doc_out/DocumentDataNotificationWorkspace.html.md +13 -0
  51. data/doc_out/DocumentDataNotificationWorkspaceData.html.md +13 -0
  52. data/doc_out/DocumentEntityListing.html.md +2 -2
  53. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  54. data/doc_out/DomainEntityListing.html.md +2 -2
  55. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  56. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  57. data/doc_out/EdgeEntityListing.html.md +2 -2
  58. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  59. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  60. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  61. data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
  62. data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
  63. data/doc_out/EmailMessageListing.html.md +2 -2
  64. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  65. data/doc_out/EndpointEntityListing.html.md +2 -2
  66. data/doc_out/EvaluationEntityListing.html.md +2 -2
  67. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  68. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  69. data/doc_out/ExtensionEntityListing.html.md +2 -2
  70. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  71. data/doc_out/FaxDataNotification.html.md +31 -0
  72. data/doc_out/FaxDataNotificationLockData.html.md +15 -0
  73. data/doc_out/FaxDataNotificationLockInfo.html.md +15 -0
  74. data/doc_out/FaxDataNotificationUserData.html.md +14 -0
  75. data/doc_out/FaxDataNotificationWorkspaceData.html.md +13 -0
  76. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  77. data/doc_out/GroupEntityListing.html.md +2 -2
  78. data/doc_out/GroupsApi.html.md +3 -1
  79. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  80. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  81. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  82. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  83. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  84. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  85. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  86. data/doc_out/LanguageEntityListing.html.md +2 -2
  87. data/doc_out/LibraryEntityListing.html.md +2 -2
  88. data/doc_out/LineBaseEntityListing.html.md +2 -2
  89. data/doc_out/LineEntityListing.html.md +2 -2
  90. data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
  91. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  92. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  93. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  94. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  95. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  96. data/doc_out/OrphanRecordingListing.html.md +2 -2
  97. data/doc_out/OutOfOfficeNotification.html.md +1 -1
  98. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  99. data/doc_out/Page.html.md +20 -0
  100. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  101. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  102. data/doc_out/PhoneEntityListing.html.md +2 -2
  103. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  104. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  105. data/doc_out/PolicyEntityListing.html.md +2 -2
  106. data/doc_out/PresenceApi.html.md +3 -4
  107. data/doc_out/QualityAuditPage.html.md +2 -2
  108. data/doc_out/QueueEmailAddress.html.md +1 -1
  109. data/doc_out/QueueEntityListing.html.md +2 -2
  110. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  111. data/doc_out/RecordingApi.html.md +2 -2
  112. data/doc_out/RecordingDataNotification.html.md +31 -0
  113. data/doc_out/RecordingDataNotificationConversationData.html.md +13 -0
  114. data/doc_out/RecordingDataNotificationLockData.html.md +15 -0
  115. data/doc_out/RecordingDataNotificationLockInfo.html.md +15 -0
  116. data/doc_out/RecordingDataNotificationUserData.html.md +14 -0
  117. data/doc_out/RecordingDataNotificationWorkspaceData.html.md +13 -0
  118. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  119. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  120. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  121. data/doc_out/ResponseEntityList.html.md +2 -2
  122. data/doc_out/ResponseEntityListing.html.md +2 -2
  123. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  124. data/doc_out/RuleSetEntityListing.html.md +2 -2
  125. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  126. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  127. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  128. data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
  129. data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
  130. data/doc_out/Script.html.md +26 -0
  131. data/doc_out/ScriptEntityListing.html.md +22 -0
  132. data/doc_out/ScriptsApi.html.md +557 -0
  133. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  134. data/doc_out/ShareEntityListing.html.md +2 -2
  135. data/doc_out/SiteEntityListing.html.md +2 -2
  136. data/doc_out/SkillEntityListing.html.md +2 -2
  137. data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
  138. data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
  139. data/doc_out/StationEntityListing.html.md +2 -2
  140. data/doc_out/TagValueEntityListing.html.md +2 -2
  141. data/doc_out/TelephonyProvidersEdgeApi.html.md +5 -3
  142. data/doc_out/TimeOffRequest.html.md +30 -0
  143. data/doc_out/TimeOffRequestList.html.md +16 -0
  144. data/doc_out/TimeOffRequestPatch.html.md +13 -0
  145. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  146. data/doc_out/TrunkBaseEntityListing.html.md +2 -2
  147. data/doc_out/TrunkEntityListing.html.md +2 -2
  148. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  149. data/doc_out/UserDetailsQuery.html.md +20 -0
  150. data/doc_out/UserEntityListing.html.md +2 -2
  151. data/doc_out/UserQueueEntityListing.html.md +2 -2
  152. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  153. data/doc_out/UserSkillEntityListing.html.md +2 -2
  154. data/doc_out/UsersApi.html.md +73 -12
  155. data/doc_out/UsersEntityListing.html.md +2 -2
  156. data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
  157. data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
  158. data/doc_out/WorkforceManagementApi.html.md +302 -0
  159. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  160. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  161. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  162. data/doc_out/index.html.md +3 -3
  163. data/lib/purecloud.rb +32 -3
  164. data/lib/purecloud/api/analytics_api.rb +60 -0
  165. data/lib/purecloud/api/content_management_api.rb +75 -0
  166. data/lib/purecloud/api/groups_api.rb +3 -0
  167. data/lib/purecloud/api/outbound_api.rb +16 -16
  168. data/lib/purecloud/api/presence_api.rb +5 -6
  169. data/lib/purecloud/api/recording_api.rb +2 -2
  170. data/lib/purecloud/api/scripts_api.rb +617 -0
  171. data/lib/purecloud/api/telephony_providers_edge_api.rb +7 -4
  172. data/lib/purecloud/api/users_api.rb +84 -20
  173. data/lib/purecloud/api/workforce_management_api.rb +317 -0
  174. data/lib/purecloud/api_client.rb +1 -1
  175. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  176. data/lib/purecloud/models/analytics_conversation_segment.rb +28 -4
  177. data/lib/purecloud/models/analytics_routing_status_record.rb +208 -0
  178. data/lib/purecloud/models/analytics_session.rb +83 -1
  179. data/lib/purecloud/models/analytics_user_detail.rb +192 -0
  180. data/lib/purecloud/models/analytics_user_details_query_response.rb +179 -0
  181. data/lib/purecloud/models/analytics_user_presence_record.rb +219 -0
  182. data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
  183. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  184. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  185. data/lib/purecloud/models/call.rb +4 -4
  186. data/lib/purecloud/models/call_conversation.rb +1 -1
  187. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  188. data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
  189. data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
  190. data/lib/purecloud/models/call_media_participant.rb +4 -4
  191. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  192. data/lib/purecloud/models/callback.rb +3 -3
  193. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  194. data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
  195. data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
  196. data/lib/purecloud/models/callback_media_participant.rb +3 -3
  197. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  198. data/lib/purecloud/models/campaign_sequence.rb +1 -1
  199. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  200. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  201. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  202. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  203. data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
  204. data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
  205. data/lib/purecloud/models/chat_media_participant.rb +3 -3
  206. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
  207. data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
  208. data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
  209. data/lib/purecloud/models/cobrowse_media_participant.rb +3 -3
  210. data/lib/purecloud/models/cobrowsesession.rb +2 -2
  211. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  212. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  213. data/lib/purecloud/models/conversation.rb +1 -1
  214. data/lib/purecloud/models/conversation_chat.rb +3 -3
  215. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  216. data/lib/purecloud/models/conversation_notification_participant.rb +8 -8
  217. data/lib/purecloud/models/conversation_notification_participants.rb +128 -128
  218. data/lib/purecloud/models/{conversation_notification_screen_share.rb → conversation_notification_screenshare.rb} +1 -1
  219. data/lib/purecloud/models/{conversation_notification_screen_shares.rb → conversation_notification_screenshares.rb} +1 -1
  220. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  221. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  222. data/lib/purecloud/models/disconnect_reason.rb +1 -1
  223. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  224. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  225. data/lib/purecloud/models/document_data_notification.rb +315 -0
  226. data/lib/purecloud/models/{callback_conversation_notification_user.rb → document_data_notification_created_by.rb} +1 -1
  227. data/lib/purecloud/models/document_data_notification_lock_data.rb +185 -0
  228. data/lib/purecloud/models/document_data_notification_lock_info.rb +185 -0
  229. data/lib/purecloud/models/document_data_notification_user_data.rb +175 -0
  230. data/lib/purecloud/models/document_data_notification_workspace.rb +165 -0
  231. data/lib/purecloud/models/document_data_notification_workspace_data.rb +165 -0
  232. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  233. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
  234. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  235. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  236. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  237. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  238. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  239. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  240. data/lib/purecloud/models/email.rb +3 -3
  241. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  242. data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
  243. data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
  244. data/lib/purecloud/models/email_media_participant.rb +3 -3
  245. data/lib/purecloud/models/email_message_listing.rb +17 -17
  246. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  247. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  248. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  249. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  250. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  251. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  252. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  253. data/lib/purecloud/models/fax_data_notification.rb +345 -0
  254. data/lib/purecloud/models/fax_data_notification_lock_data.rb +185 -0
  255. data/lib/purecloud/models/fax_data_notification_lock_info.rb +185 -0
  256. data/lib/purecloud/models/fax_data_notification_user_data.rb +175 -0
  257. data/lib/purecloud/models/fax_data_notification_workspace_data.rb +165 -0
  258. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  259. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  260. data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
  261. data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
  262. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  263. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  264. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  265. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  266. data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
  267. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  268. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  269. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  270. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  271. data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
  272. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  273. data/lib/purecloud/models/media_participant_request.rb +1 -1
  274. data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
  275. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  276. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  277. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  278. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  279. data/lib/purecloud/models/out_of_office_notification.rb +1 -1
  280. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  281. data/lib/purecloud/models/page.rb +243 -0
  282. data/lib/purecloud/models/participant.rb +1 -1
  283. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  284. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  285. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  286. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  287. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  288. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  289. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  290. data/lib/purecloud/models/queue_email_address.rb +1 -1
  291. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  292. data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
  293. data/lib/purecloud/models/recording_data_notification.rb +345 -0
  294. data/lib/purecloud/models/recording_data_notification_conversation_data.rb +165 -0
  295. data/lib/purecloud/models/recording_data_notification_lock_data.rb +185 -0
  296. data/lib/purecloud/models/recording_data_notification_lock_info.rb +185 -0
  297. data/lib/purecloud/models/recording_data_notification_user_data.rb +175 -0
  298. data/lib/purecloud/models/recording_data_notification_workspace_data.rb +165 -0
  299. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  300. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  301. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  302. data/lib/purecloud/models/response_entity_list.rb +17 -17
  303. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  304. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  305. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  306. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  307. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  308. data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
  309. data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
  310. data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
  311. data/lib/purecloud/models/screenshare.rb +2 -2
  312. data/lib/purecloud/models/script.rb +303 -0
  313. data/lib/purecloud/models/script_entity_listing.rb +257 -0
  314. data/lib/purecloud/models/search_aggregation.rb +1 -1
  315. data/lib/purecloud/models/search_criteria.rb +1 -1
  316. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  317. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  318. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  319. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  320. data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
  321. data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
  322. data/lib/purecloud/models/social_expression.rb +2 -2
  323. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  324. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  325. data/lib/purecloud/models/time_off_request.rb +369 -0
  326. data/lib/purecloud/models/time_off_request_list.rb +199 -0
  327. data/lib/purecloud/models/time_off_request_patch.rb +167 -0
  328. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  329. data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
  330. data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
  331. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  332. data/lib/purecloud/models/user_details_query.rb +262 -0
  333. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  334. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  335. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  336. data/lib/purecloud/models/user_schedule_adherence.rb +3 -3
  337. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  338. data/lib/purecloud/models/users_entity_listing.rb +17 -17
  339. data/lib/purecloud/models/video.rb +2 -2
  340. data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
  341. data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
  342. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  343. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  344. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  345. data/lib/purecloud/version.rb +1 -1
  346. data/newVersion.md +1 -1
  347. data/swagger.json +1 -1
  348. data/version.json +1 -1
  349. metadata +66 -8
data/doc_out/SecurityProfileEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: SecurityProfileEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/ShareEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: ShareEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/SiteEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: SiteEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/SkillEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: SkillEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/SocialConversationNotificationParticipants.html.md CHANGED
@@ -34,7 +34,7 @@ title: SocialConversationNotificationParticipants
34
34
  | **address** | **String** | | [optional] |
35
35
  | **start_hold_time** | **DateTime** | | [optional] |
36
36
  | **attributes** | **Hash<String, String>** | | [optional] |
37
- | **user** | [**CallbackConversationNotificationUser**](CallbackConversationNotificationUser.html) | | [optional] |
37
+ | **user** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
38
38
  {: class="table table-striped"}
39
39
 
40
40
 
data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md CHANGED
@@ -21,7 +21,7 @@ title: SocialConversationNotificationSocialMediaParticipant
21
21
  | **held** | **BOOLEAN** | | [optional] |
22
22
  | **wrapup_required** | **BOOLEAN** | | [optional] |
23
23
  | **wrapup_prompt** | **String** | | [optional] |
24
- | **user** | [**CallbackConversationNotificationUser**](CallbackConversationNotificationUser.html) | | [optional] |
24
+ | **user** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
25
25
  | **queue** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
26
26
  | **attributes** | **Hash<String, String>** | | [optional] |
27
27
  | **error_info** | [**SocialConversationNotificationErrorInfo**](SocialConversationNotificationErrorInfo.html) | | [optional] |
data/doc_out/StationEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: StationEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/TagValueEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: TagValueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/TelephonyProvidersEdgeApi.html.md CHANGED
@@ -3695,7 +3695,7 @@ Name | Type | Description | Notes
3695
3695
 
3696
3696
  Get Trunk Base Settings listing
3697
3697
 
3698
-
3698
+ Managed properties will not be returned unless the user is assigned the managed:all:all permission.
3699
3699
 
3700
3700
  ### Example
3701
3701
  ~~~ruby
@@ -3719,7 +3719,8 @@ opts = {
3719
3719
  page_size: 25, # Integer | Page size
3720
3720
  sort_by: "name", # String | Value by which to sort
3721
3721
  sort_order: "ASC", # String | Sort order
3722
- recording_enabled: true # BOOLEAN | Filter trunks by recording enabled
3722
+ recording_enabled: true, # BOOLEAN | Filter trunks by recording enabled
3723
+ expand: ["expand_example"] # Array<String> | Fields to expand in the response, comma-separated
3723
3724
  }
3724
3725
 
3725
3726
  begin
@@ -3740,6 +3741,7 @@ Name | Type | Description | Notes
3740
3741
  **sort_by** | **String**| Value by which to sort | [optional] [default to name]
3741
3742
  **sort_order** | **String**| Sort order | [optional] [default to ASC]
3742
3743
  **recording_enabled** | **BOOLEAN**| Filter trunks by recording enabled | [optional]
3744
+ **expand** | [**Array&lt;String&gt;**](String.html)| Fields to expand in the response, comma-separated | [optional]
3743
3745
  {: class="table table-striped"}
3744
3746
 
3745
3747
 
@@ -3877,7 +3879,7 @@ Name | Type | Description | Notes
3877
3879
 
3878
3880
  Get a Trunk Base Settings object by ID
3879
3881
 
3880
-
3882
+ Managed properties will not be returned unless the user is assigned the managed:all:all permission.
3881
3883
 
3882
3884
  ### Example
3883
3885
  ~~~ruby
data/doc_out/TimeOffRequest.html.md ADDED
@@ -0,0 +1,30 @@
1
+ ---
2
+ title: TimeOffRequest
3
+ ---
4
+ ## PureCloud::TimeOffRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **user** | [**User**](User.html) | The user associated with this TimeOffRequest | |
13
+ | **is_full_day_request** | **BOOLEAN** | Whether this is a full day request (false means partial day) | [default to false]|
14
+ | **marked_as_read** | **BOOLEAN** | Whether this request has been marked as read by the agent | [default to false]|
15
+ | **activity_code_id** | **String** | The ID of the activity code associated with this TimeOffRequest | |
16
+ | **status** | **String** | The administrative status of this TimeOffRequest | |
17
+ | **partial_day_start_date_times** | **Array&lt;DateTime&gt;** | The start date-times for partial day requests. Required if isFullDayRequest == false | [optional] |
18
+ | **daily_duration_minutes** | **Integer** | The daily duration of this TimeOffRequest in minutes | |
19
+ | **notes** | **String** | The notes as input by the one who entered the TimeOffRequest | [optional] |
20
+ | **submitted_by** | [**User**](User.html) | The user who submitted this TimeOffRequest | [optional] |
21
+ | **submitted_date** | **DateTime** | The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
22
+ | **reviewed_by** | [**User**](User.html) | The user who reviewed this TimeOffRequest | [optional] |
23
+ | **reviewed_date** | **DateTime** | The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
24
+ | **modified_by** | [**User**](User.html) | The user who last modified this TimeOffRequest | [optional] |
25
+ | **modified_date** | **DateTime** | The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
26
+ | **self_uri** | **String** | The URI for this object | [optional] |
27
+ | **full_day_management_unit_dates** | **Array&lt;String&gt;** | ISO-8601 date only with no timezones. Should be interpreted in the Management Unit&#39;s configured time zone. Required if isFullDayRequest == true | [optional] |
28
+ {: class="table table-striped"}
29
+
30
+
data/doc_out/TimeOffRequestList.html.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: TimeOffRequestList
3
+ ---
4
+ ## PureCloud::TimeOffRequestList
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **time_off_requests** | [**Array&lt;TimeOffRequest&gt;**](TimeOffRequest.html) | | [optional] |
13
+ | **self_uri** | **String** | The URI for this object | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
data/doc_out/TimeOffRequestPatch.html.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: TimeOffRequestPatch
3
+ ---
4
+ ## PureCloud::TimeOffRequestPatch
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **marked_as_read** | **BOOLEAN** | | [optional] [default to false]|
11
+ {: class="table table-striped"}
12
+
13
+
data/doc_out/TimeZoneEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: TimeZoneEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/TrunkBaseEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: TrunkBaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/TrunkEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: TrunkEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/TrunkMetabaseEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: TrunkMetabaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/UserDetailsQuery.html.md ADDED
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: UserDetailsQuery
3
+ ---
4
+ ## PureCloud::UserDetailsQuery
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **interval** | **String** | Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
11
+ | **user_filters** | [**Array&lt;AnalyticsQueryFilter&gt;**](AnalyticsQueryFilter.html) | Filters that target the users to retrieve data for | [optional] |
12
+ | **presence_filters** | [**Array&lt;AnalyticsQueryFilter&gt;**](AnalyticsQueryFilter.html) | Filters that target system and organization presence-level data | [optional] |
13
+ | **routing_status_filters** | [**Array&lt;AnalyticsQueryFilter&gt;**](AnalyticsQueryFilter.html) | Filters that target agent routing status-level data | [optional] |
14
+ | **presence_aggregations** | [**Array&lt;AnalyticsQueryAggregation&gt;**](AnalyticsQueryAggregation.html) | Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters | [optional] |
15
+ | **routing_status_aggregations** | [**Array&lt;AnalyticsQueryAggregation&gt;**](AnalyticsQueryAggregation.html) | Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters | [optional] |
16
+ | **paging** | [**PagingSpec**](PagingSpec.html) | Page size and number to control iterating through large result sets. Default page size is 25 | [optional] |
17
+ | **order** | **String** | Sort the result set in ascending/descending order. Default is ascending | [optional] |
18
+ {: class="table table-striped"}
19
+
20
+
data/doc_out/UserEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: UserEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/UserQueueEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: UserQueueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/UserRecordingEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: UserRecordingEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/UserSkillEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: UserSkillEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/UsersApi.html.md CHANGED
@@ -40,6 +40,7 @@ Method | HTTP request | Description
40
40
  |[**post_user_id_routingskills**](UsersApi.html#post_user_id_routingskills) | **POST** /api/v2/users/{userId}/routingskills | Add routing skill to user|
41
41
  |[**post_users**](UsersApi.html#post_users) | **POST** /api/v2/users | Create user|
42
42
  |[**post_users_aggregates_query**](UsersApi.html#post_users_aggregates_query) | **POST** /api/v2/analytics/users/aggregates/query | Query for user aggregates|
43
+ |[**post_users_details_query**](UsersApi.html#post_users_details_query) | **POST** /api/v2/analytics/users/details/query | Query for user details|
43
44
  |[**post_users_observations_query**](UsersApi.html#post_users_observations_query) | **POST** /api/v2/analytics/users/observations/query | Query for user observations|
44
45
  |[**put_user_id_callforwarding**](UsersApi.html#put_user_id_callforwarding) | **PUT** /api/v2/users/{userId}/callforwarding | Update a user&#39;s CallForwarding|
45
46
  |[**put_user_id_outofoffice**](UsersApi.html#put_user_id_outofoffice) | **PUT** /api/v2/users/{userId}/outofoffice | Update an OutOfOffice|
@@ -566,7 +567,7 @@ Name | Type | Description | Notes
566
567
 
567
568
  <a name="get_user_id_adjacents"></a>
568
569
 
569
- ## - get_user_id_adjacents(user_id, opts)
570
+ ## -[**Adjacents**](Adjacents.html) get_user_id_adjacents(user_id, opts)
570
571
 
571
572
  Get adjacents
572
573
 
@@ -597,7 +598,8 @@ opts = {
597
598
 
598
599
  begin
599
600
  #Get adjacents
600
- api_instance.get_user_id_adjacents(user_id, opts)
601
+ result = api_instance.get_user_id_adjacents(user_id, opts)
602
+ p result
601
603
  rescue PureCloud::ApiError => e
602
604
  puts "Exception when calling UsersApi->get_user_id_adjacents: #{e}"
603
605
  end
@@ -614,7 +616,7 @@ Name | Type | Description | Notes
614
616
 
615
617
  ### Return type
616
618
 
617
- nil (empty response body)
619
+ [**Adjacents**](Adjacents.html)
618
620
 
619
621
  ### HTTP request headers
620
622
 
@@ -681,7 +683,7 @@ Name | Type | Description | Notes
681
683
 
682
684
  <a name="get_user_id_directreports"></a>
683
685
 
684
- ## - get_user_id_directreports(user_id, opts)
686
+ ## -[**Array&lt;User&gt;**](User.html) get_user_id_directreports(user_id, opts)
685
687
 
686
688
  Get direct reports
687
689
 
@@ -712,7 +714,8 @@ opts = {
712
714
 
713
715
  begin
714
716
  #Get direct reports
715
- api_instance.get_user_id_directreports(user_id, opts)
717
+ result = api_instance.get_user_id_directreports(user_id, opts)
718
+ p result
716
719
  rescue PureCloud::ApiError => e
717
720
  puts "Exception when calling UsersApi->get_user_id_directreports: #{e}"
718
721
  end
@@ -729,7 +732,7 @@ Name | Type | Description | Notes
729
732
 
730
733
  ### Return type
731
734
 
732
- nil (empty response body)
735
+ [**Array&lt;User&gt;**](User.html)
733
736
 
734
737
  ### HTTP request headers
735
738
 
@@ -740,7 +743,7 @@ nil (empty response body)
740
743
 
741
744
  <a name="get_user_id_favorites"></a>
742
745
 
743
- ## - get_user_id_favorites(user_id, opts)
746
+ ## -[**UserEntityListing**](UserEntityListing.html) get_user_id_favorites(user_id, opts)
744
747
 
745
748
  Get favorites
746
749
 
@@ -774,7 +777,8 @@ opts = {
774
777
 
775
778
  begin
776
779
  #Get favorites
777
- api_instance.get_user_id_favorites(user_id, opts)
780
+ result = api_instance.get_user_id_favorites(user_id, opts)
781
+ p result
778
782
  rescue PureCloud::ApiError => e
779
783
  puts "Exception when calling UsersApi->get_user_id_favorites: #{e}"
780
784
  end
@@ -794,7 +798,7 @@ Name | Type | Description | Notes
794
798
 
795
799
  ### Return type
796
800
 
797
- nil (empty response body)
801
+ [**UserEntityListing**](UserEntityListing.html)
798
802
 
799
803
  ### HTTP request headers
800
804
 
@@ -1272,7 +1276,7 @@ Name | Type | Description | Notes
1272
1276
 
1273
1277
  <a name="get_user_id_superiors"></a>
1274
1278
 
1275
- ## - get_user_id_superiors(user_id, opts)
1279
+ ## -[**Array&lt;User&gt;**](User.html) get_user_id_superiors(user_id, opts)
1276
1280
 
1277
1281
  Get superiors
1278
1282
 
@@ -1303,7 +1307,8 @@ opts = {
1303
1307
 
1304
1308
  begin
1305
1309
  #Get superiors
1306
- api_instance.get_user_id_superiors(user_id, opts)
1310
+ result = api_instance.get_user_id_superiors(user_id, opts)
1311
+ p result
1307
1312
  rescue PureCloud::ApiError => e
1308
1313
  puts "Exception when calling UsersApi->get_user_id_superiors: #{e}"
1309
1314
  end
@@ -1320,7 +1325,7 @@ Name | Type | Description | Notes
1320
1325
 
1321
1326
  ### Return type
1322
1327
 
1323
- nil (empty response body)
1328
+ [**Array&lt;User&gt;**](User.html)
1324
1329
 
1325
1330
  ### HTTP request headers
1326
1331
 
@@ -1922,6 +1927,62 @@ Name | Type | Description | Notes
1922
1927
 
1923
1928
 
1924
1929
 
1930
+ <a name="post_users_details_query"></a>
1931
+
1932
+ ## -[**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_users_details_query(body)
1933
+
1934
+ Query for user details
1935
+
1936
+
1937
+
1938
+ ### Example
1939
+ ~~~ruby
1940
+ # load the gem
1941
+ require 'purecloud'
1942
+ # setup authorization
1943
+ @secret = ENV['PURECLOUD_SECRET']
1944
+ @id = ENV['PURECLOUD_CLIENT_ID']
1945
+ environment = "mypurecloud.com"
1946
+
1947
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1948
+
1949
+ PureCloud.configure do |config|
1950
+ config.access_token = @authToken
1951
+ end
1952
+
1953
+ api_instance = PureCloud::UsersApi.new
1954
+
1955
+ body = PureCloud::UserDetailsQuery.new # UserDetailsQuery | query
1956
+
1957
+
1958
+ begin
1959
+ #Query for user details
1960
+ result = api_instance.post_users_details_query(body)
1961
+ p result
1962
+ rescue PureCloud::ApiError => e
1963
+ puts "Exception when calling UsersApi->post_users_details_query: #{e}"
1964
+ end
1965
+ ~~~
1966
+
1967
+ ### Parameters
1968
+
1969
+ Name | Type | Description | Notes
1970
+ ------------- | ------------- | ------------- | -------------
1971
+ **body** | [**UserDetailsQuery**](UserDetailsQuery.html)| query |
1972
+ {: class="table table-striped"}
1973
+
1974
+
1975
+ ### Return type
1976
+
1977
+ [**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html)
1978
+
1979
+ ### HTTP request headers
1980
+
1981
+ - **Content-Type**: application/json
1982
+ - **Accept**: application/json
1983
+
1984
+
1985
+
1925
1986
  <a name="post_users_observations_query"></a>
1926
1987
 
1927
1988
  ## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(body)