purecloud 0.58.1 → 0.59.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 (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
@@ -3864,13 +3864,14 @@ module PureCloud
3864
3864
  end
3865
3865
 
3866
3866
  # Get Trunk Base Settings listing
3867
- #
3867
+ # Managed properties will not be returned unless the user is assigned the managed:all:all permission.
3868
3868
  # @param [Hash] opts the optional parameters
3869
3869
  # @option opts [Integer] :page_number Page number (default to 1)
3870
3870
  # @option opts [Integer] :page_size Page size (default to 25)
3871
3871
  # @option opts [String] :sort_by Value by which to sort (default to name)
3872
3872
  # @option opts [String] :sort_order Sort order (default to ASC)
3873
3873
  # @option opts [BOOLEAN] :recording_enabled Filter trunks by recording enabled
3874
+ # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
3874
3875
  # @return [TrunkBaseEntityListing]
3875
3876
  def get_providers_edges_trunkbasesettings(opts = {})
3876
3877
  data, status_code, headers = get_providers_edges_trunkbasesettings_with_http_info(opts)
@@ -3878,13 +3879,14 @@ module PureCloud
3878
3879
  end
3879
3880
 
3880
3881
  # Get Trunk Base Settings listing
3881
- #
3882
+ # Managed properties will not be returned unless the user is assigned the managed:all:all permission.
3882
3883
  # @param [Hash] opts the optional parameters
3883
3884
  # @option opts [Integer] :page_number Page number
3884
3885
  # @option opts [Integer] :page_size Page size
3885
3886
  # @option opts [String] :sort_by Value by which to sort
3886
3887
  # @option opts [String] :sort_order Sort order
3887
3888
  # @option opts [BOOLEAN] :recording_enabled Filter trunks by recording enabled
3889
+ # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
3888
3890
  # @return [Array<(TrunkBaseEntityListing, Fixnum, Hash)>] TrunkBaseEntityListing data, response status code and response headers
3889
3891
  def get_providers_edges_trunkbasesettings_with_http_info(opts = {})
3890
3892
  if @api_client.config.debugging
@@ -3901,6 +3903,7 @@ module PureCloud
3901
3903
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
3902
3904
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
3903
3905
  query_params[:'recordingEnabled'] = opts[:'recording_enabled'] if opts[:'recording_enabled']
3906
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
3904
3907
 
3905
3908
  # header parameters
3906
3909
  header_params = {}
@@ -4063,7 +4066,7 @@ module PureCloud
4063
4066
  end
4064
4067
 
4065
4068
  # Get a Trunk Base Settings object by ID
4066
- #
4069
+ # Managed properties will not be returned unless the user is assigned the managed:all:all permission.
4067
4070
  # @param trunk_base_settings_id Trunk Base ID
4068
4071
  # @param [Hash] opts the optional parameters
4069
4072
  # @return [TrunkBase]
@@ -4073,7 +4076,7 @@ module PureCloud
4073
4076
  end
4074
4077
 
4075
4078
  # Get a Trunk Base Settings object by ID
4076
- #
4079
+ # Managed properties will not be returned unless the user is assigned the managed:all:all permission.
4077
4080
  # @param trunk_base_settings_id Trunk Base ID
4078
4081
  # @param [Hash] opts the optional parameters
4079
4082
  # @return [Array<(TrunkBase, Fixnum, Hash)>] TrunkBase data, response status code and response headers
@@ -580,10 +580,10 @@ module PureCloud
580
580
  # @param user_id User ID
581
581
  # @param [Hash] opts the optional parameters
582
582
  # @option opts [Array<String>] :expand Which fields, if any, to expand
583
- # @return [nil]
583
+ # @return [Adjacents]
584
584
  def get_user_id_adjacents(user_id, opts = {})
585
- get_user_id_adjacents_with_http_info(user_id, opts)
586
- return nil
585
+ data, status_code, headers = get_user_id_adjacents_with_http_info(user_id, opts)
586
+ return data
587
587
  end
588
588
 
589
589
  # Get adjacents
@@ -591,7 +591,7 @@ module PureCloud
591
591
  # @param user_id User ID
592
592
  # @param [Hash] opts the optional parameters
593
593
  # @option opts [Array<String>] :expand Which fields, if any, to expand
594
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
594
+ # @return [Array<(Adjacents, Fixnum, Hash)>] Adjacents data, response status code and response headers
595
595
  def get_user_id_adjacents_with_http_info(user_id, opts = {})
596
596
  if @api_client.config.debugging
597
597
  @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_adjacents ..."
@@ -630,7 +630,8 @@ module PureCloud
630
630
  :query_params => query_params,
631
631
  :form_params => form_params,
632
632
  :body => post_body,
633
- :auth_names => auth_names)
633
+ :auth_names => auth_names,
634
+ :return_type => 'Adjacents')
634
635
  if @api_client.config.debugging
635
636
  @api_client.config.logger.debug "API called: UsersApi#get_user_id_adjacents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
636
637
  end
@@ -702,10 +703,10 @@ module PureCloud
702
703
  # @param user_id User ID
703
704
  # @param [Hash] opts the optional parameters
704
705
  # @option opts [Array<String>] :expand Which fields, if any, to expand
705
- # @return [nil]
706
+ # @return [Array<User>]
706
707
  def get_user_id_directreports(user_id, opts = {})
707
- get_user_id_directreports_with_http_info(user_id, opts)
708
- return nil
708
+ data, status_code, headers = get_user_id_directreports_with_http_info(user_id, opts)
709
+ return data
709
710
  end
710
711
 
711
712
  # Get direct reports
@@ -713,7 +714,7 @@ module PureCloud
713
714
  # @param user_id User ID
714
715
  # @param [Hash] opts the optional parameters
715
716
  # @option opts [Array<String>] :expand Which fields, if any, to expand
716
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
717
+ # @return [Array<(Array<User>, Fixnum, Hash)>] Array<User> data, response status code and response headers
717
718
  def get_user_id_directreports_with_http_info(user_id, opts = {})
718
719
  if @api_client.config.debugging
719
720
  @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_directreports ..."
@@ -752,7 +753,8 @@ module PureCloud
752
753
  :query_params => query_params,
753
754
  :form_params => form_params,
754
755
  :body => post_body,
755
- :auth_names => auth_names)
756
+ :auth_names => auth_names,
757
+ :return_type => 'Array<User>')
756
758
  if @api_client.config.debugging
757
759
  @api_client.config.logger.debug "API called: UsersApi#get_user_id_directreports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
758
760
  end
@@ -767,10 +769,10 @@ module PureCloud
767
769
  # @option opts [Integer] :page_number Page number (default to 1)
768
770
  # @option opts [String] :sort_order Sort order (default to ASC)
769
771
  # @option opts [Array<String>] :expand Which fields, if any, to expand
770
- # @return [nil]
772
+ # @return [UserEntityListing]
771
773
  def get_user_id_favorites(user_id, opts = {})
772
- get_user_id_favorites_with_http_info(user_id, opts)
773
- return nil
774
+ data, status_code, headers = get_user_id_favorites_with_http_info(user_id, opts)
775
+ return data
774
776
  end
775
777
 
776
778
  # Get favorites
@@ -781,7 +783,7 @@ module PureCloud
781
783
  # @option opts [Integer] :page_number Page number
782
784
  # @option opts [String] :sort_order Sort order
783
785
  # @option opts [Array<String>] :expand Which fields, if any, to expand
784
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
786
+ # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
785
787
  def get_user_id_favorites_with_http_info(user_id, opts = {})
786
788
  if @api_client.config.debugging
787
789
  @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_favorites ..."
@@ -823,7 +825,8 @@ module PureCloud
823
825
  :query_params => query_params,
824
826
  :form_params => form_params,
825
827
  :body => post_body,
826
- :auth_names => auth_names)
828
+ :auth_names => auth_names,
829
+ :return_type => 'UserEntityListing')
827
830
  if @api_client.config.debugging
828
831
  @api_client.config.logger.debug "API called: UsersApi#get_user_id_favorites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
829
832
  end
@@ -1342,10 +1345,10 @@ module PureCloud
1342
1345
  # @param user_id User ID
1343
1346
  # @param [Hash] opts the optional parameters
1344
1347
  # @option opts [Array<String>] :expand Which fields, if any, to expand
1345
- # @return [nil]
1348
+ # @return [Array<User>]
1346
1349
  def get_user_id_superiors(user_id, opts = {})
1347
- get_user_id_superiors_with_http_info(user_id, opts)
1348
- return nil
1350
+ data, status_code, headers = get_user_id_superiors_with_http_info(user_id, opts)
1351
+ return data
1349
1352
  end
1350
1353
 
1351
1354
  # Get superiors
@@ -1353,7 +1356,7 @@ module PureCloud
1353
1356
  # @param user_id User ID
1354
1357
  # @param [Hash] opts the optional parameters
1355
1358
  # @option opts [Array<String>] :expand Which fields, if any, to expand
1356
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1359
+ # @return [Array<(Array<User>, Fixnum, Hash)>] Array<User> data, response status code and response headers
1357
1360
  def get_user_id_superiors_with_http_info(user_id, opts = {})
1358
1361
  if @api_client.config.debugging
1359
1362
  @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_superiors ..."
@@ -1392,7 +1395,8 @@ module PureCloud
1392
1395
  :query_params => query_params,
1393
1396
  :form_params => form_params,
1394
1397
  :body => post_body,
1395
- :auth_names => auth_names)
1398
+ :auth_names => auth_names,
1399
+ :return_type => 'Array<User>')
1396
1400
  if @api_client.config.debugging
1397
1401
  @api_client.config.logger.debug "API called: UsersApi#get_user_id_superiors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1398
1402
  end
@@ -2053,6 +2057,66 @@ module PureCloud
2053
2057
  return data, status_code, headers
2054
2058
  end
2055
2059
 
2060
+ # Query for user details
2061
+ #
2062
+ # @param body query
2063
+ # @param [Hash] opts the optional parameters
2064
+ # @return [AnalyticsUserDetailsQueryResponse]
2065
+ def post_users_details_query(body, opts = {})
2066
+ data, status_code, headers = post_users_details_query_with_http_info(body, opts)
2067
+ return data
2068
+ end
2069
+
2070
+ # Query for user details
2071
+ #
2072
+ # @param body query
2073
+ # @param [Hash] opts the optional parameters
2074
+ # @return [Array<(AnalyticsUserDetailsQueryResponse, Fixnum, Hash)>] AnalyticsUserDetailsQueryResponse data, response status code and response headers
2075
+ def post_users_details_query_with_http_info(body, opts = {})
2076
+ if @api_client.config.debugging
2077
+ @api_client.config.logger.debug "Calling API: UsersApi#post_users_details_query ..."
2078
+ end
2079
+
2080
+ # verify the required parameter 'body' is set
2081
+ fail "Missing the required parameter 'body' when calling post_users_details_query" if body.nil?
2082
+
2083
+ # resource path
2084
+ local_var_path = "/api/v2/analytics/users/details/query".sub('{format}','json')
2085
+
2086
+ # query parameters
2087
+ query_params = {}
2088
+
2089
+ # header parameters
2090
+ header_params = {}
2091
+
2092
+ # HTTP header 'Accept' (if needed)
2093
+ _header_accept = ['application/json']
2094
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2095
+
2096
+ # HTTP header 'Content-Type'
2097
+ _header_content_type = ['application/json']
2098
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2099
+
2100
+ # form parameters
2101
+ form_params = {}
2102
+
2103
+ # http body (model)
2104
+ post_body = @api_client.object_to_http_body(body)
2105
+
2106
+ auth_names = ['PureCloud Auth']
2107
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2108
+ :header_params => header_params,
2109
+ :query_params => query_params,
2110
+ :form_params => form_params,
2111
+ :body => post_body,
2112
+ :auth_names => auth_names,
2113
+ :return_type => 'AnalyticsUserDetailsQueryResponse')
2114
+ if @api_client.config.debugging
2115
+ @api_client.config.logger.debug "API called: UsersApi#post_users_details_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2116
+ end
2117
+ return data, status_code, headers
2118
+ end
2119
+
2056
2120
  # Query for user observations
2057
2121
  #
2058
2122
  # @param body query
@@ -85,6 +85,323 @@ module PureCloud
85
85
  return data, status_code, headers
86
86
  end
87
87
 
88
+ # Get a list of time off requests for any user
89
+ #
90
+ # @param mu_id The muId of the management unit.
91
+ # @param user_id The userId to whom the Time Off Request applies.
92
+ # @param [Hash] opts the optional parameters
93
+ # @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
94
+ # @return [TimeOffRequestList]
95
+ def get_managementunits_mu_id_users_user_id_timeoffrequests(mu_id, user_id, opts = {})
96
+ data, status_code, headers = get_managementunits_mu_id_users_user_id_timeoffrequests_with_http_info(mu_id, user_id, opts)
97
+ return data
98
+ end
99
+
100
+ # Get a list of time off requests for any user
101
+ #
102
+ # @param mu_id The muId of the management unit.
103
+ # @param user_id The userId to whom the Time Off Request applies.
104
+ # @param [Hash] opts the optional parameters
105
+ # @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days
106
+ # @return [Array<(TimeOffRequestList, Fixnum, Hash)>] TimeOffRequestList data, response status code and response headers
107
+ def get_managementunits_mu_id_users_user_id_timeoffrequests_with_http_info(mu_id, user_id, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug "Calling API: WorkforceManagementApi#get_managementunits_mu_id_users_user_id_timeoffrequests ..."
110
+ end
111
+
112
+ # verify the required parameter 'mu_id' is set
113
+ fail "Missing the required parameter 'mu_id' when calling get_managementunits_mu_id_users_user_id_timeoffrequests" if mu_id.nil?
114
+
115
+ # verify the required parameter 'user_id' is set
116
+ fail "Missing the required parameter 'user_id' when calling get_managementunits_mu_id_users_user_id_timeoffrequests" if user_id.nil?
117
+
118
+ # resource path
119
+ local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
120
+
121
+ # query parameters
122
+ query_params = {}
123
+ query_params[:'recentlyReviewed'] = opts[:'recently_reviewed'] if opts[:'recently_reviewed']
124
+
125
+ # header parameters
126
+ header_params = {}
127
+
128
+ # HTTP header 'Accept' (if needed)
129
+ _header_accept = ['application/json']
130
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
131
+
132
+ # HTTP header 'Content-Type'
133
+ _header_content_type = ['application/json']
134
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
135
+
136
+ # form parameters
137
+ form_params = {}
138
+
139
+ # http body (model)
140
+ post_body = nil
141
+
142
+ auth_names = ['PureCloud Auth']
143
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
144
+ :header_params => header_params,
145
+ :query_params => query_params,
146
+ :form_params => form_params,
147
+ :body => post_body,
148
+ :auth_names => auth_names,
149
+ :return_type => 'TimeOffRequestList')
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: WorkforceManagementApi#get_managementunits_mu_id_users_user_id_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # Get a time off request by id
157
+ #
158
+ # @param mu_id The muId of the management unit.
159
+ # @param user_id The userId to whom the Time Off Request applies.
160
+ # @param time_off_request_id Time Off Request Id
161
+ # @param [Hash] opts the optional parameters
162
+ # @return [TimeOffRequest]
163
+ def get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id(mu_id, user_id, time_off_request_id, opts = {})
164
+ data, status_code, headers = get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id_with_http_info(mu_id, user_id, time_off_request_id, opts)
165
+ return data
166
+ end
167
+
168
+ # Get a time off request by id
169
+ #
170
+ # @param mu_id The muId of the management unit.
171
+ # @param user_id The userId to whom the Time Off Request applies.
172
+ # @param time_off_request_id Time Off Request Id
173
+ # @param [Hash] opts the optional parameters
174
+ # @return [Array<(TimeOffRequest, Fixnum, Hash)>] TimeOffRequest data, response status code and response headers
175
+ def get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id_with_http_info(mu_id, user_id, time_off_request_id, opts = {})
176
+ if @api_client.config.debugging
177
+ @api_client.config.logger.debug "Calling API: WorkforceManagementApi#get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id ..."
178
+ end
179
+
180
+ # verify the required parameter 'mu_id' is set
181
+ fail "Missing the required parameter 'mu_id' when calling get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id" if mu_id.nil?
182
+
183
+ # verify the required parameter 'user_id' is set
184
+ fail "Missing the required parameter 'user_id' when calling get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id" if user_id.nil?
185
+
186
+ # verify the required parameter 'time_off_request_id' is set
187
+ fail "Missing the required parameter 'time_off_request_id' when calling get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id" if time_off_request_id.nil?
188
+
189
+ # resource path
190
+ local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)
191
+
192
+ # query parameters
193
+ query_params = {}
194
+
195
+ # header parameters
196
+ header_params = {}
197
+
198
+ # HTTP header 'Accept' (if needed)
199
+ _header_accept = ['application/json']
200
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
201
+
202
+ # HTTP header 'Content-Type'
203
+ _header_content_type = ['application/json']
204
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
205
+
206
+ # form parameters
207
+ form_params = {}
208
+
209
+ # http body (model)
210
+ post_body = nil
211
+
212
+ auth_names = ['PureCloud Auth']
213
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
214
+ :header_params => header_params,
215
+ :query_params => query_params,
216
+ :form_params => form_params,
217
+ :body => post_body,
218
+ :auth_names => auth_names,
219
+ :return_type => 'TimeOffRequest')
220
+ if @api_client.config.debugging
221
+ @api_client.config.logger.debug "API called: WorkforceManagementApi#get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
222
+ end
223
+ return data, status_code, headers
224
+ end
225
+
226
+ # Get a list of time off requests for the current user
227
+ #
228
+ # @param [Hash] opts the optional parameters
229
+ # @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
230
+ # @return [TimeOffRequestList]
231
+ def get_timeoffrequests(opts = {})
232
+ data, status_code, headers = get_timeoffrequests_with_http_info(opts)
233
+ return data
234
+ end
235
+
236
+ # Get a list of time off requests for the current user
237
+ #
238
+ # @param [Hash] opts the optional parameters
239
+ # @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days
240
+ # @return [Array<(TimeOffRequestList, Fixnum, Hash)>] TimeOffRequestList data, response status code and response headers
241
+ def get_timeoffrequests_with_http_info(opts = {})
242
+ if @api_client.config.debugging
243
+ @api_client.config.logger.debug "Calling API: WorkforceManagementApi#get_timeoffrequests ..."
244
+ end
245
+
246
+ # resource path
247
+ local_var_path = "/api/v2/workforcemanagement/timeoffrequests".sub('{format}','json')
248
+
249
+ # query parameters
250
+ query_params = {}
251
+ query_params[:'recentlyReviewed'] = opts[:'recently_reviewed'] if opts[:'recently_reviewed']
252
+
253
+ # header parameters
254
+ header_params = {}
255
+
256
+ # HTTP header 'Accept' (if needed)
257
+ _header_accept = ['application/json']
258
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
259
+
260
+ # HTTP header 'Content-Type'
261
+ _header_content_type = ['application/json']
262
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
263
+
264
+ # form parameters
265
+ form_params = {}
266
+
267
+ # http body (model)
268
+ post_body = nil
269
+
270
+ auth_names = ['PureCloud Auth']
271
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
272
+ :header_params => header_params,
273
+ :query_params => query_params,
274
+ :form_params => form_params,
275
+ :body => post_body,
276
+ :auth_names => auth_names,
277
+ :return_type => 'TimeOffRequestList')
278
+ if @api_client.config.debugging
279
+ @api_client.config.logger.debug "API called: WorkforceManagementApi#get_timeoffrequests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
280
+ end
281
+ return data, status_code, headers
282
+ end
283
+
284
+ # Get a time off request for the current user by id
285
+ #
286
+ # @param time_off_request_id Time Off Request Id
287
+ # @param [Hash] opts the optional parameters
288
+ # @return [TimeOffRequest]
289
+ def get_timeoffrequests_timeoffrequest_id(time_off_request_id, opts = {})
290
+ data, status_code, headers = get_timeoffrequests_timeoffrequest_id_with_http_info(time_off_request_id, opts)
291
+ return data
292
+ end
293
+
294
+ # Get a time off request for the current user by id
295
+ #
296
+ # @param time_off_request_id Time Off Request Id
297
+ # @param [Hash] opts the optional parameters
298
+ # @return [Array<(TimeOffRequest, Fixnum, Hash)>] TimeOffRequest data, response status code and response headers
299
+ def get_timeoffrequests_timeoffrequest_id_with_http_info(time_off_request_id, opts = {})
300
+ if @api_client.config.debugging
301
+ @api_client.config.logger.debug "Calling API: WorkforceManagementApi#get_timeoffrequests_timeoffrequest_id ..."
302
+ end
303
+
304
+ # verify the required parameter 'time_off_request_id' is set
305
+ fail "Missing the required parameter 'time_off_request_id' when calling get_timeoffrequests_timeoffrequest_id" if time_off_request_id.nil?
306
+
307
+ # resource path
308
+ local_var_path = "/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)
309
+
310
+ # query parameters
311
+ query_params = {}
312
+
313
+ # header parameters
314
+ header_params = {}
315
+
316
+ # HTTP header 'Accept' (if needed)
317
+ _header_accept = ['application/json']
318
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
319
+
320
+ # HTTP header 'Content-Type'
321
+ _header_content_type = ['application/json']
322
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
323
+
324
+ # form parameters
325
+ form_params = {}
326
+
327
+ # http body (model)
328
+ post_body = nil
329
+
330
+ auth_names = ['PureCloud Auth']
331
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
332
+ :header_params => header_params,
333
+ :query_params => query_params,
334
+ :form_params => form_params,
335
+ :body => post_body,
336
+ :auth_names => auth_names,
337
+ :return_type => 'TimeOffRequest')
338
+ if @api_client.config.debugging
339
+ @api_client.config.logger.debug "API called: WorkforceManagementApi#get_timeoffrequests_timeoffrequest_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
340
+ end
341
+ return data, status_code, headers
342
+ end
343
+
344
+ # Mark a time off request for the current user as read or unread
345
+ #
346
+ # @param time_off_request_id Time Off Request Id
347
+ # @param [Hash] opts the optional parameters
348
+ # @option opts [TimeOffRequestPatch] :body
349
+ # @return [nil]
350
+ def patch_timeoffrequests_timeoffrequest_id(time_off_request_id, opts = {})
351
+ patch_timeoffrequests_timeoffrequest_id_with_http_info(time_off_request_id, opts)
352
+ return nil
353
+ end
354
+
355
+ # Mark a time off request for the current user as read or unread
356
+ #
357
+ # @param time_off_request_id Time Off Request Id
358
+ # @param [Hash] opts the optional parameters
359
+ # @option opts [TimeOffRequestPatch] :body
360
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
361
+ def patch_timeoffrequests_timeoffrequest_id_with_http_info(time_off_request_id, opts = {})
362
+ if @api_client.config.debugging
363
+ @api_client.config.logger.debug "Calling API: WorkforceManagementApi#patch_timeoffrequests_timeoffrequest_id ..."
364
+ end
365
+
366
+ # verify the required parameter 'time_off_request_id' is set
367
+ fail "Missing the required parameter 'time_off_request_id' when calling patch_timeoffrequests_timeoffrequest_id" if time_off_request_id.nil?
368
+
369
+ # resource path
370
+ local_var_path = "/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'timeOffRequestId' + '}', time_off_request_id.to_s)
371
+
372
+ # query parameters
373
+ query_params = {}
374
+
375
+ # header parameters
376
+ header_params = {}
377
+
378
+ # HTTP header 'Accept' (if needed)
379
+ _header_accept = ['application/json']
380
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
381
+
382
+ # HTTP header 'Content-Type'
383
+ _header_content_type = ['application/json']
384
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
385
+
386
+ # form parameters
387
+ form_params = {}
388
+
389
+ # http body (model)
390
+ post_body = @api_client.object_to_http_body(opts[:'body'])
391
+
392
+ auth_names = ['PureCloud Auth']
393
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
394
+ :header_params => header_params,
395
+ :query_params => query_params,
396
+ :form_params => form_params,
397
+ :body => post_body,
398
+ :auth_names => auth_names)
399
+ if @api_client.config.debugging
400
+ @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_timeoffrequests_timeoffrequest_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
401
+ end
402
+ return data, status_code, headers
403
+ end
404
+
88
405
  # Create a forecast
89
406
  #
90
407
  # @param body The request body