purecloudplatformclientv2 36.1.0 → 37.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (282) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AgentTimeOffRequestPatch.md +15 -0
  4. data/docs/AnalyticsApi.md +2 -2
  5. data/docs/AsgInfoResponse.md +2 -2
  6. data/docs/AsyncWeekScheduleResponse.md +16 -0
  7. data/docs/CallMediaPolicyConditions.md +1 -0
  8. data/docs/CampaignNotification.md +1 -0
  9. data/docs/ChatMediaPolicyConditions.md +1 -0
  10. data/docs/ConversationNotificationMedia.md +3 -0
  11. data/docs/ConversationNotificationMessageDetails.md +1 -0
  12. data/docs/ConversationNotificationMessageMedia.md +3 -0
  13. data/docs/ConversationNotificationMessageSticker.md +14 -0
  14. data/docs/ConversationNotificationMessages.md +1 -0
  15. data/docs/ConversationNotificationStickers.md +14 -0
  16. data/docs/CopyShortTermForecastRequest.md +14 -0
  17. data/docs/CopyWeekScheduleRequest.md +14 -0
  18. data/docs/CopyWorkPlan.md +13 -0
  19. data/docs/CreateAdminTimeOffRequest.md +19 -0
  20. data/docs/CreateAgentTimeOffRequest.md +17 -0
  21. data/docs/CreateAsgRequest.md +1 -1
  22. data/docs/CreateManagementUnitApiRequest.md +17 -0
  23. data/docs/CreateManagementUnitSettings.md +16 -0
  24. data/docs/CreateQueueMediaAssociationRequest.md +14 -0
  25. data/docs/CreateServiceGoalGroupRequest.md +15 -0
  26. data/docs/CreateWorkPlan.md +26 -0
  27. data/docs/CreateWorkPlanActivity.md +23 -0
  28. data/docs/CreateWorkPlanShift.md +29 -0
  29. data/docs/CurrentUserScheduleRequestBody.md +14 -0
  30. data/docs/DateRange.md +14 -0
  31. data/docs/DeletableUserReference.md +15 -0
  32. data/docs/EmailMediaPolicyConditions.md +1 -0
  33. data/docs/ExternalContact.md +3 -1
  34. data/docs/ExternalOrganization.md +1 -1
  35. data/docs/FacebookId.md +14 -0
  36. data/docs/FacebookScopedId.md +13 -0
  37. data/docs/FlowOutcomeNotificationNotification.md +16 -0
  38. data/docs/FlowOutcomeNotificationNotificationArchitectOperation.md +21 -0
  39. data/docs/FlowOutcomeNotificationNotificationErrorDetail.md +16 -0
  40. data/docs/FlowOutcomeNotificationNotificationErrorMessageParams.md +13 -0
  41. data/docs/{SurveyFormUriReference.md → FlowOutcomeNotificationNotificationHomeOrganization.md} +3 -4
  42. data/docs/FlowOutcomeNotificationNotificationUser.md +15 -0
  43. data/docs/ForecastGenerationResult.md +13 -0
  44. data/docs/ForecastGenerationRouteGroupResult.md +14 -0
  45. data/docs/ForecastResultResponse.md +14 -0
  46. data/docs/ForecastSourceDayPointer.md +17 -0
  47. data/docs/ForecastTimeSeriesResult.md +14 -0
  48. data/docs/GenerateShortTermForecastRequest.md +13 -0
  49. data/docs/GenerateShortTermForecastResponse.md +16 -0
  50. data/docs/GenerateWeekScheduleRequest.md +14 -0
  51. data/docs/GenerateWeekScheduleResponse.md +15 -0
  52. data/docs/GroupsApi.md +2 -0
  53. data/docs/HeadcountForecastResponse.md +14 -0
  54. data/docs/HeadcountIntervalResponse.md +14 -0
  55. data/docs/ImportShortTermForecastRequest.md +16 -0
  56. data/docs/ImportWeekScheduleRequest.md +17 -0
  57. data/docs/IntradayDataUpdateNotificationDateTime.md +1 -1
  58. data/docs/IntradayDataUpdateNotificationStartDate.md +1 -1
  59. data/docs/JsonNode.md +1 -1
  60. data/docs/LanguageReference.md +14 -0
  61. data/docs/LineId.md +14 -0
  62. data/docs/LineUserId.md +13 -0
  63. data/docs/ListWrapperForecastSourceDayPointer.md +13 -0
  64. data/docs/ListWrapperShiftStartVariance.md +13 -0
  65. data/docs/ListWrapperWfmForecastModification.md +13 -0
  66. data/docs/MessageConversationNotificationMessageDetails.md +1 -0
  67. data/docs/MessageConversationNotificationMessageMedia.md +3 -0
  68. data/docs/MessageConversationNotificationMessageSticker.md +14 -0
  69. data/docs/MessageConversationNotificationMessages.md +1 -0
  70. data/docs/MessageMediaPolicyConditions.md +1 -0
  71. data/docs/OrgUser.md +1 -0
  72. data/docs/OutboundApi.md +70 -0
  73. data/docs/PartialUploadResponse.md +13 -0
  74. data/docs/PatchUser.md +0 -1
  75. data/docs/PublishedSurveyFormReference.md +16 -0
  76. data/docs/QueryDivision.md +12 -0
  77. data/docs/QueueMediaAssociation.md +16 -0
  78. data/docs/QueueReference.md +14 -0
  79. data/docs/RecordingMessagingMessage.md +1 -0
  80. data/docs/RouteGroup.md +18 -0
  81. data/docs/RouteGroupAttributes.md +16 -0
  82. data/docs/RouteGroupList.md +14 -0
  83. data/docs/RoutingApi.md +8 -8
  84. data/docs/RoutingSkillReference.md +14 -0
  85. data/docs/ScheduleGenerationWarning.md +20 -0
  86. data/docs/SchedulingRunListResponse.md +13 -0
  87. data/docs/SchedulingRunResponse.md +22 -0
  88. data/docs/ServiceGoalGroup.md +18 -0
  89. data/docs/ServiceGoalGroupGoals.md +14 -0
  90. data/docs/ServiceGoalGroupList.md +14 -0
  91. data/docs/SetWrapperDayOfWeek.md +13 -0
  92. data/docs/ShiftStartVariance.md +14 -0
  93. data/docs/ShortTermForecast.md +22 -0
  94. data/docs/ShortTermForecastListItemResponse.md +18 -0
  95. data/docs/ShortTermForecastListResponse.md +13 -0
  96. data/docs/ShortTermForecastReference.md +16 -0
  97. data/docs/ShortTermForecastResponse.md +15 -0
  98. data/docs/SurveyAssignment.md +3 -1
  99. data/docs/SurveyForm.md +1 -0
  100. data/docs/TimeOffRequestEntityList.md +13 -0
  101. data/docs/TimeOffRequestLookup.md +15 -0
  102. data/docs/TimeOffRequestLookupList.md +13 -0
  103. data/docs/TimeOffRequestQueryBody.md +15 -0
  104. data/docs/TrustUser.md +1 -0
  105. data/docs/TrusteeAuthorization.md +13 -0
  106. data/docs/Trustor.md +1 -0
  107. data/docs/UpdateActivityCodeRequest.md +19 -0
  108. data/docs/UpdateWeekScheduleRequest.md +18 -0
  109. data/docs/User.md +1 -0
  110. data/docs/UserMe.md +1 -0
  111. data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +1 -1
  112. data/docs/UserSchedulesPartialUploadRequest.md +13 -0
  113. data/docs/UsersApi.md +5 -6
  114. data/docs/ViewFilter.md +4 -0
  115. data/docs/WeekSchedule.md +23 -0
  116. data/docs/WeekScheduleGenerationResult.md +16 -0
  117. data/docs/WeekScheduleListItemResponse.md +20 -0
  118. data/docs/WeekScheduleListResponse.md +13 -0
  119. data/docs/WeekScheduleResponse.md +14 -0
  120. data/docs/WfmAgent.md +22 -0
  121. data/docs/WfmAverageSpeedOfAnswer.md +14 -0
  122. data/docs/WfmForecastModification.md +20 -0
  123. data/docs/WfmForecastModificationAttributes.md +16 -0
  124. data/docs/WfmForecastModificationIntervalOffsetValue.md +14 -0
  125. data/docs/WfmHistoricalAdherenceQuery.md +1 -1
  126. data/docs/WfmHistoricalAdherenceQueryForUsers.md +17 -0
  127. data/docs/WfmServiceLevel.md +15 -0
  128. data/docs/WfmTimeZone.md +13 -0
  129. data/docs/WorkPlan.md +29 -0
  130. data/docs/WorkPlanActivity.md +25 -0
  131. data/docs/WorkPlanListItemResponse.md +21 -0
  132. data/docs/WorkPlanListResponse.md +13 -0
  133. data/docs/WorkPlanReference.md +13 -0
  134. data/docs/WorkPlanShift.md +31 -0
  135. data/docs/WorkforceManagementApi.md +3557 -187
  136. data/lib/purecloudplatformclientv2.rb +96 -1
  137. data/lib/purecloudplatformclientv2/api/outbound_api.rb +83 -0
  138. data/lib/purecloudplatformclientv2/api/routing_api.rb +8 -8
  139. data/lib/purecloudplatformclientv2/api/users_api.rb +8 -6
  140. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3993 -288
  141. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  142. data/lib/purecloudplatformclientv2/models/agent_time_off_request_patch.rb +268 -0
  143. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
  144. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
  145. data/lib/purecloudplatformclientv2/models/asg_info_response.rb +2 -2
  146. data/lib/purecloudplatformclientv2/models/async_week_schedule_response.rb +294 -0
  147. data/lib/purecloudplatformclientv2/models/call_media_policy_conditions.rb +28 -1
  148. data/lib/purecloudplatformclientv2/models/campaign_notification.rb +26 -1
  149. data/lib/purecloudplatformclientv2/models/chat_media_policy_conditions.rb +28 -1
  150. data/lib/purecloudplatformclientv2/models/conversation_notification_media.rb +79 -4
  151. data/lib/purecloudplatformclientv2/models/conversation_notification_message.rb +2 -2
  152. data/lib/purecloudplatformclientv2/models/conversation_notification_message_details.rb +31 -4
  153. data/lib/purecloudplatformclientv2/models/conversation_notification_message_media.rb +79 -4
  154. data/lib/purecloudplatformclientv2/models/conversation_notification_message_sticker.rb +226 -0
  155. data/lib/purecloudplatformclientv2/models/conversation_notification_messages.rb +31 -4
  156. data/lib/purecloudplatformclientv2/models/conversation_notification_messages_1.rb +2 -2
  157. data/lib/purecloudplatformclientv2/models/conversation_notification_stickers.rb +226 -0
  158. data/lib/purecloudplatformclientv2/models/copy_short_term_forecast_request.rb +239 -0
  159. data/lib/purecloudplatformclientv2/models/copy_week_schedule_request.rb +238 -0
  160. data/lib/purecloudplatformclientv2/models/copy_work_plan.rb +208 -0
  161. data/lib/purecloudplatformclientv2/models/create_admin_time_off_request.rb +398 -0
  162. data/lib/purecloudplatformclientv2/models/create_agent_time_off_request.rb +320 -0
  163. data/lib/purecloudplatformclientv2/models/create_asg_request.rb +1 -1
  164. data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +336 -0
  165. data/lib/purecloudplatformclientv2/models/create_management_unit_settings.rb +281 -0
  166. data/lib/purecloudplatformclientv2/models/create_queue_media_association_request.rb +231 -0
  167. data/lib/purecloudplatformclientv2/models/create_service_goal_group_request.rb +262 -0
  168. data/lib/purecloudplatformclientv2/models/create_work_plan.rb +550 -0
  169. data/lib/purecloudplatformclientv2/models/create_work_plan_activity.rb +463 -0
  170. data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +626 -0
  171. data/lib/purecloudplatformclientv2/models/current_user_schedule_request_body.rb +239 -0
  172. data/lib/purecloudplatformclientv2/models/data_export_notification_notification.rb +2 -2
  173. data/lib/purecloudplatformclientv2/models/date_range.rb +228 -0
  174. data/lib/purecloudplatformclientv2/models/deletable_user_reference.rb +255 -0
  175. data/lib/purecloudplatformclientv2/models/email_media_policy_conditions.rb +28 -1
  176. data/lib/purecloudplatformclientv2/models/external_contact.rb +52 -2
  177. data/lib/purecloudplatformclientv2/models/external_organization.rb +1 -1
  178. data/lib/purecloudplatformclientv2/models/facebook_id.rb +231 -0
  179. data/lib/purecloudplatformclientv2/models/facebook_scoped_id.rb +203 -0
  180. data/lib/purecloudplatformclientv2/models/flow_notification_notification_architect_operation.rb +2 -2
  181. data/lib/purecloudplatformclientv2/models/flow_outcome_notification_notification.rb +276 -0
  182. data/lib/purecloudplatformclientv2/models/flow_outcome_notification_notification_architect_operation.rb +431 -0
  183. data/lib/purecloudplatformclientv2/models/flow_outcome_notification_notification_error_detail.rb +276 -0
  184. data/lib/purecloudplatformclientv2/models/flow_outcome_notification_notification_error_message_params.rb +203 -0
  185. data/lib/purecloudplatformclientv2/models/flow_outcome_notification_notification_home_organization.rb +251 -0
  186. data/lib/purecloudplatformclientv2/models/flow_outcome_notification_notification_user.rb +251 -0
  187. data/lib/purecloudplatformclientv2/models/forecast_generation_result.rb +204 -0
  188. data/lib/purecloudplatformclientv2/models/forecast_generation_route_group_result.rb +230 -0
  189. data/lib/purecloudplatformclientv2/models/forecast_result_response.rb +228 -0
  190. data/lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb +321 -0
  191. data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +256 -0
  192. data/lib/purecloudplatformclientv2/models/generate_short_term_forecast_request.rb +207 -0
  193. data/lib/purecloudplatformclientv2/models/generate_short_term_forecast_response.rb +294 -0
  194. data/lib/purecloudplatformclientv2/models/generate_week_schedule_request.rb +239 -0
  195. data/lib/purecloudplatformclientv2/models/generate_week_schedule_response.rb +268 -0
  196. data/lib/purecloudplatformclientv2/models/headcount_forecast_response.rb +233 -0
  197. data/lib/purecloudplatformclientv2/models/headcount_interval_response.rb +229 -0
  198. data/lib/purecloudplatformclientv2/models/import_short_term_forecast_request.rb +293 -0
  199. data/lib/purecloudplatformclientv2/models/import_week_schedule_request.rb +316 -0
  200. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_date_time.rb +17 -17
  201. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_start_date.rb +17 -17
  202. data/lib/purecloudplatformclientv2/models/json_node.rb +17 -17
  203. data/lib/purecloudplatformclientv2/models/language_reference.rb +228 -0
  204. data/lib/purecloudplatformclientv2/models/line_id.rb +231 -0
  205. data/lib/purecloudplatformclientv2/models/line_user_id.rb +203 -0
  206. data/lib/purecloudplatformclientv2/models/list_wrapper_forecast_source_day_pointer.rb +203 -0
  207. data/lib/purecloudplatformclientv2/models/list_wrapper_shift_start_variance.rb +203 -0
  208. data/lib/purecloudplatformclientv2/models/list_wrapper_wfm_forecast_modification.rb +203 -0
  209. data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_details.rb +31 -4
  210. data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media.rb +79 -4
  211. data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media_participant.rb +2 -2
  212. data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_sticker.rb +226 -0
  213. data/lib/purecloudplatformclientv2/models/message_conversation_notification_messages.rb +31 -4
  214. data/lib/purecloudplatformclientv2/models/message_conversation_notification_participants.rb +2 -2
  215. data/lib/purecloudplatformclientv2/models/message_media_policy_conditions.rb +28 -1
  216. data/lib/purecloudplatformclientv2/models/org_user.rb +27 -1
  217. data/lib/purecloudplatformclientv2/models/partial_upload_response.rb +202 -0
  218. data/lib/purecloudplatformclientv2/models/patch_user.rb +1 -26
  219. data/lib/purecloudplatformclientv2/models/prompt_notification_notification_architect_operation.rb +2 -2
  220. data/lib/purecloudplatformclientv2/models/prompt_notification_notification_current_operation.rb +2 -2
  221. data/lib/purecloudplatformclientv2/models/{survey_form_uri_reference.rb → published_survey_form_reference.rb} +16 -14
  222. data/lib/purecloudplatformclientv2/models/query_division.rb +176 -0
  223. data/lib/purecloudplatformclientv2/models/queue_media_association.rb +283 -0
  224. data/lib/purecloudplatformclientv2/models/queue_reference.rb +228 -0
  225. data/lib/purecloudplatformclientv2/models/recording_messaging_message.rb +26 -1
  226. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +2 -2
  227. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
  228. data/lib/purecloudplatformclientv2/models/route_group.rb +363 -0
  229. data/lib/purecloudplatformclientv2/models/route_group_attributes.rb +307 -0
  230. data/lib/purecloudplatformclientv2/models/route_group_list.rb +235 -0
  231. data/lib/purecloudplatformclientv2/models/routing_skill_reference.rb +228 -0
  232. data/lib/purecloudplatformclientv2/models/schedule_generation_warning.rb +389 -0
  233. data/lib/purecloudplatformclientv2/models/scheduling_run_list_response.rb +203 -0
  234. data/lib/purecloudplatformclientv2/models/scheduling_run_response.rb +451 -0
  235. data/lib/purecloudplatformclientv2/models/service_goal_group.rb +339 -0
  236. data/lib/purecloudplatformclientv2/models/service_goal_group_goals.rb +239 -0
  237. data/lib/purecloudplatformclientv2/models/service_goal_group_list.rb +230 -0
  238. data/lib/purecloudplatformclientv2/models/set_wrapper_day_of_week.rb +203 -0
  239. data/lib/purecloudplatformclientv2/models/shift_start_variance.rb +241 -0
  240. data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +466 -0
  241. data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +362 -0
  242. data/lib/purecloudplatformclientv2/models/short_term_forecast_list_response.rb +203 -0
  243. data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +291 -0
  244. data/lib/purecloudplatformclientv2/models/short_term_forecast_response.rb +268 -0
  245. data/lib/purecloudplatformclientv2/models/survey_assignment.rb +62 -5
  246. data/lib/purecloudplatformclientv2/models/survey_form.rb +32 -1
  247. data/lib/purecloudplatformclientv2/models/time_off_request_entity_list.rb +203 -0
  248. data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +264 -0
  249. data/lib/purecloudplatformclientv2/models/time_off_request_lookup_list.rb +209 -0
  250. data/lib/purecloudplatformclientv2/models/time_off_request_query_body.rb +258 -0
  251. data/lib/purecloudplatformclientv2/models/trust_user.rb +27 -1
  252. data/lib/purecloudplatformclientv2/models/trustee_authorization.rb +204 -0
  253. data/lib/purecloudplatformclientv2/models/trustor.rb +27 -1
  254. data/lib/purecloudplatformclientv2/models/update_activity_code_request.rb +378 -0
  255. data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +346 -0
  256. data/lib/purecloudplatformclientv2/models/user.rb +27 -1
  257. data/lib/purecloudplatformclientv2/models/user_me.rb +27 -1
  258. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification_date_time.rb +17 -17
  259. data/lib/purecloudplatformclientv2/models/user_schedules_partial_upload_request.rb +210 -0
  260. data/lib/purecloudplatformclientv2/models/view_filter.rb +112 -4
  261. data/lib/purecloudplatformclientv2/models/week_schedule.rb +465 -0
  262. data/lib/purecloudplatformclientv2/models/week_schedule_generation_result.rb +282 -0
  263. data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +384 -0
  264. data/lib/purecloudplatformclientv2/models/week_schedule_list_response.rb +204 -0
  265. data/lib/purecloudplatformclientv2/models/week_schedule_response.rb +229 -0
  266. data/lib/purecloudplatformclientv2/models/wfm_agent.rb +443 -0
  267. data/lib/purecloudplatformclientv2/models/wfm_average_speed_of_answer.rb +234 -0
  268. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification.rb +435 -0
  269. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification_attributes.rb +288 -0
  270. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification_interval_offset_value.rb +239 -0
  271. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb +1 -1
  272. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_query_for_users.rb +324 -0
  273. data/lib/purecloudplatformclientv2/models/wfm_service_level.rb +260 -0
  274. data/lib/purecloudplatformclientv2/models/wfm_time_zone.rb +203 -0
  275. data/lib/purecloudplatformclientv2/models/work_plan.rb +627 -0
  276. data/lib/purecloudplatformclientv2/models/work_plan_activity.rb +515 -0
  277. data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +410 -0
  278. data/lib/purecloudplatformclientv2/models/work_plan_list_response.rb +203 -0
  279. data/lib/purecloudplatformclientv2/models/work_plan_reference.rb +207 -0
  280. data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +678 -0
  281. data/lib/purecloudplatformclientv2/version.rb +1 -1
  282. metadata +194 -4
@@ -3251,7 +3251,7 @@ Name | Type | Description | Notes
3251
3251
 
3252
3252
  <a name="put_user_profileskills"></a>
3253
3253
 
3254
- ## -Array&lt;String&gt;** put_user_profileskills(user_id, opts)
3254
+ ## -Array&lt;String&gt;** put_user_profileskills(user_id, body)
3255
3255
 
3256
3256
 
3257
3257
 
@@ -3288,13 +3288,12 @@ api_instance = PureCloud::UsersApi.new
3288
3288
 
3289
3289
  user_id = "user_id_example" # String | User ID
3290
3290
 
3291
- opts = {
3292
- body: [PureCloud::Array<String>.new] # Array<String> | Skills
3293
- }
3291
+ body = [PureCloud::Array<String>.new] # Array<String> | Skills
3292
+
3294
3293
 
3295
3294
  begin
3296
3295
  #Update profile skills for a user
3297
- result = api_instance.put_user_profileskills(user_id, opts)
3296
+ result = api_instance.put_user_profileskills(user_id, body)
3298
3297
  p result
3299
3298
  rescue PureCloud::ApiError => e
3300
3299
  puts "Exception when calling UsersApi->put_user_profileskills: #{e}"
@@ -3306,7 +3305,7 @@ end
3306
3305
  Name | Type | Description | Notes
3307
3306
  ------------- | ------------- | ------------- | -------------
3308
3307
  **user_id** | **String**| User ID | |
3309
- **body** | **Array&lt;String&gt;**| Skills | [optional] |
3308
+ **body** | **Array&lt;String&gt;**| Skills | |
3310
3309
  {: class="table table-striped"}
3311
3310
 
3312
3311
 
@@ -32,6 +32,10 @@ title: ViewFilter
32
32
  | **transferred** | **BOOLEAN** | Indicates filtering for transfers | [optional] |
33
33
  | **abandoned** | **BOOLEAN** | Indicates filtering for abandons | [optional] |
34
34
  | **message_types** | **Array&lt;String&gt;** | The message media types used to filter the view | [optional] |
35
+ | **division_ids** | **Array&lt;String&gt;** | The divison Ids used to filter the view | [optional] |
36
+ | **survey_form_ids** | **Array&lt;String&gt;** | The survey form ids used to filter the view | [optional] |
37
+ | **survey_total_score** | [**NumericRange**](NumericRange.html) | The survey total score used to filter the view | [optional] |
38
+ | **survey_nps_score** | [**NumericRange**](NumericRange.html) | The survey NPS score used to filter the view | [optional] |
35
39
  {: class="table table-striped"}
36
40
 
37
41
 
@@ -0,0 +1,23 @@
1
+ ---
2
+ title: WeekSchedule
3
+ ---
4
+ ## PureCloud::WeekSchedule
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **week_date** | **String** | First day of this week schedule in week in yyyy-MM-dd format | [optional] |
12
+ | **description** | **String** | Description of the week schedule | [optional] |
13
+ | **published** | **BOOLEAN** | Whether the week schedule is published | [optional] |
14
+ | **generation_results** | [**WeekScheduleGenerationResult**](WeekScheduleGenerationResult.html) | Summary of the results from the schedule run | [optional] |
15
+ | **short_term_forecast** | [**ShortTermForecastReference**](ShortTermForecastReference.html) | Short term forecast associated with this schedule | [optional] |
16
+ | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this work plan | [optional] |
17
+ | **user_schedules** | [**Hash&lt;String, UserSchedule&gt;**](UserSchedule.html) | User schedules in the week | [optional] |
18
+ | **headcount_forecast** | [**HeadcountForecastResponse**](HeadcountForecastResponse.html) | Headcount information for the week schedule | [optional] |
19
+ | **agent_schedules_version** | **Integer** | Version of agent schedules in the week schedule | [optional] |
20
+ | **self_uri** | **String** | The URI for this object | [optional] |
21
+ {: class="table table-striped"}
22
+
23
+
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: WeekScheduleGenerationResult
3
+ ---
4
+ ## PureCloud::WeekScheduleGenerationResult
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **failed** | **BOOLEAN** | Whether the schedule generation failed | [optional] |
11
+ | **run_id** | **String** | ID of the schedule run | [optional] |
12
+ | **agent_warnings** | [**Array&lt;ScheduleGenerationWarning&gt;**](ScheduleGenerationWarning.html) | Warning messages from the schedule run. This will be available only when requesting information for a single week schedule | [optional] |
13
+ | **agent_warning_count** | **Integer** | Count of warning messages from the schedule run. This will be available only when requesting multiple week schedules | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: WeekScheduleListItemResponse
3
+ ---
4
+ ## PureCloud::WeekScheduleListItemResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **week_date** | **String** | First day of this week schedule in week in yyyy-MM-dd format | [optional] |
12
+ | **description** | **String** | Description of the week schedule | [optional] |
13
+ | **published** | **BOOLEAN** | Whether the week schedule is published | [optional] |
14
+ | **generation_results** | [**WeekScheduleGenerationResult**](WeekScheduleGenerationResult.html) | Summary of the results from the schedule run | [optional] |
15
+ | **short_term_forecast** | [**ShortTermForecastReference**](ShortTermForecastReference.html) | Short term forecast associated with this schedule | [optional] |
16
+ | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this work plan | [optional] |
17
+ | **self_uri** | **String** | The URI for this object | [optional] |
18
+ {: class="table table-striped"}
19
+
20
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WeekScheduleListResponse
3
+ ---
4
+ ## PureCloud::WeekScheduleListResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array&lt;WeekScheduleListItemResponse&gt;**](WeekScheduleListItemResponse.html) | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: WeekScheduleResponse
3
+ ---
4
+ ## PureCloud::WeekScheduleResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **result** | [**WeekSchedule**](WeekSchedule.html) | The result of the request. The value will be null if response is large | [optional] |
11
+ | **download_url** | **String** | The url to fetch the result for large responses. The value is null if result contains the data | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: WfmAgent
3
+ ---
4
+ ## PureCloud::WfmAgent
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **user** | [**UserReference**](UserReference.html) | The user associated with this data | [optional] |
12
+ | **queues** | [**Array&lt;QueueReference&gt;**](QueueReference.html) | List of queues to which the agent belongs and which are defined in the service goal groups in this management unit | [optional] |
13
+ | **languages** | [**Array&lt;LanguageReference&gt;**](LanguageReference.html) | The list of languages | [optional] |
14
+ | **skills** | [**Array&lt;RoutingSkillReference&gt;**](RoutingSkillReference.html) | The list of skills | [optional] |
15
+ | **work_plan** | [**WorkPlanReference**](WorkPlanReference.html) | The work plan associated with this agent | [optional] |
16
+ | **schedulable** | **BOOLEAN** | Whether the agent has the permission to be included in schedule generation | [optional] |
17
+ | **time_zone** | [**WfmTimeZone**](WfmTimeZone.html) | The time zone for this agent. Defaults to the time zone of the management unit to which the agent belongs | [optional] |
18
+ | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Metadata for this agent | [optional] |
19
+ | **self_uri** | **String** | The URI for this object | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: WfmAverageSpeedOfAnswer
3
+ ---
4
+ ## PureCloud::WfmAverageSpeedOfAnswer
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **include** | **BOOLEAN** | Whether to include average speed of answer (ASA) in this service goal group&#39;s configuration | |
11
+ | **seconds** | **Integer** | The target average speed of answer (ASA) in seconds. Required if include == true | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: WfmForecastModification
3
+ ---
4
+ ## PureCloud::WfmForecastModification
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **type** | **String** | The type of the modification | |
11
+ | **start_interval_index** | **Integer** | The number of 15 minute intervals past referenceStartDate representing the first interval to which to apply this modification. Must be null if values is populated | [optional] |
12
+ | **end_interval_index** | **Integer** | The number of 15 minute intervals past referenceStartDate representing the last interval to which to apply this modification. Must be null if values is populated | [optional] |
13
+ | **metric** | **String** | The metric to which this modification applies | |
14
+ | **value** | **Float** | The value of the modification. Must be null if \&quot;values\&quot; is populated | [optional] |
15
+ | **values** | [**Array&lt;WfmForecastModificationIntervalOffsetValue&gt;**](WfmForecastModificationIntervalOffsetValue.html) | The list of values to update. Only applicable for grid-type modifications. Must be null if \&quot;value\&quot; is populated | [optional] |
16
+ | **enabled** | **BOOLEAN** | Whether the modification is enabled for the forecast | |
17
+ | **attributes** | [**WfmForecastModificationAttributes**](WfmForecastModificationAttributes.html) | The attributes defining how this modification applies to the forecast | |
18
+ {: class="table table-striped"}
19
+
20
+
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: WfmForecastModificationAttributes
3
+ ---
4
+ ## PureCloud::WfmForecastModificationAttributes
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **queues** | [**Array&lt;QueueReference&gt;**](QueueReference.html) | The queues to which to apply a modification | [optional] |
11
+ | **media_types** | **Array&lt;String&gt;** | The media types to which to apply a modification | [optional] |
12
+ | **languages** | [**Array&lt;LanguageReference&gt;**](LanguageReference.html) | The languages to which to apply a modification | [optional] |
13
+ | **skill_sets** | **Array&lt;Array&lt;RoutingSkillReference&gt;&gt;** | The skill sets to which to apply a modification | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: WfmForecastModificationIntervalOffsetValue
3
+ ---
4
+ ## PureCloud::WfmForecastModificationIntervalOffsetValue
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **interval_index** | **Integer** | The number of 15 minute intervals past referenceStartDate to which to apply this modification | |
11
+ | **value** | **Integer** | The value to set for the given interval | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -10,7 +10,7 @@ title: WfmHistoricalAdherenceQuery
10
10
  | **start_date** | **DateTime** | Beginning of the date range to query in ISO-8601 format | |
11
11
  | **end_date** | **DateTime** | End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time | [optional] |
12
12
  | **time_zone** | **String** | The time zone to use for returned results in olson format. If it is not set, the management unit time zone will be used to compute adherence | [optional] |
13
- | **user_ids** | **Array&lt;String&gt;** | The userIds to report on. If it is not set, adherence will be computed for all the users in management unit | [optional] |
13
+ | **user_ids** | **Array&lt;String&gt;** | The userIds to report on. If null or not set, adherence will be computed for all the users in management unit | [optional] |
14
14
  | **include_exceptions** | **BOOLEAN** | Whether user exceptions should be returned as part of the results | [optional] |
15
15
  {: class="table table-striped"}
16
16
 
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: WfmHistoricalAdherenceQueryForUsers
3
+ ---
4
+ ## PureCloud::WfmHistoricalAdherenceQueryForUsers
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **start_date** | **DateTime** | Beginning of the date range to query in ISO-8601 format | |
11
+ | **end_date** | **DateTime** | End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time | [optional] |
12
+ | **time_zone** | **String** | The time zone to use for returned results in olson format | |
13
+ | **user_ids** | **Array&lt;String&gt;** | The userIds to report on | |
14
+ | **include_exceptions** | **BOOLEAN** | Whether user exceptions should be returned as part of the results | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: WfmServiceLevel
3
+ ---
4
+ ## PureCloud::WfmServiceLevel
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **include** | **BOOLEAN** | Whether to include service level targets in the associated service goal group&#39;s configuration | |
11
+ | **percent** | **Integer** | Service level target percent answered for the associated service goal group. Required if include == true | [optional] |
12
+ | **seconds** | **Integer** | Service level target answer time for the associated service goal group. Required if include == true | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WfmTimeZone
3
+ ---
4
+ ## PureCloud::WfmTimeZone
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The Olson format time zone ID (see https://en.wikipedia.org/wiki/Tz_database) | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,29 @@
1
+ ---
2
+ title: WorkPlan
3
+ ---
4
+ ## PureCloud::WorkPlan
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
+ | **enabled** | **BOOLEAN** | Whether the work plan is enabled for scheduling | [optional] |
13
+ | **constrain_weekly_paid_time** | **BOOLEAN** | Whether the weekly paid time constraint is enabled for this work plan | [optional] |
14
+ | **flexible_weekly_paid_time** | **BOOLEAN** | Whether the weekly paid time constraint is flexible for this work plan | [optional] |
15
+ | **weekly_exact_paid_minutes** | **Integer** | Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false | [optional] |
16
+ | **weekly_minimum_paid_minutes** | **Integer** | Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
17
+ | **weekly_maximum_paid_minutes** | **Integer** | Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
18
+ | **constrain_minimum_time_between_shifts** | **BOOLEAN** | Whether the minimum time between shifts constraint is enabled for this work plan | [optional] |
19
+ | **minimum_time_between_shifts_minutes** | **Integer** | Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true | [optional] |
20
+ | **maximum_days** | **Integer** | Maximum number days in a week allowed to be scheduled for this work plan | [optional] |
21
+ | **optional_days** | [**SetWrapperDayOfWeek**](SetWrapperDayOfWeek.html) | Optional days to schedule for this work plan | [optional] |
22
+ | **shift_start_variances** | [**ListWrapperShiftStartVariance**](ListWrapperShiftStartVariance.html) | Variance in minutes among start times of shifts in this work plan | [optional] |
23
+ | **shifts** | [**Array&lt;WorkPlanShift&gt;**](WorkPlanShift.html) | Shifts in this work plan | [optional] |
24
+ | **agents** | [**Array&lt;DeletableUserReference&gt;**](DeletableUserReference.html) | Agents in this work plan | [optional] |
25
+ | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this work plan | |
26
+ | **self_uri** | **String** | The URI for this object | [optional] |
27
+ {: class="table table-striped"}
28
+
29
+
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: WorkPlanActivity
3
+ ---
4
+ ## PureCloud::WorkPlanActivity
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **activity_code_id** | **String** | ID of the activity code associated with this activity | [optional] |
11
+ | **description** | **String** | Description of the activity | [optional] |
12
+ | **length_minutes** | **Integer** | Length of the activity in minutes | [optional] |
13
+ | **start_time_is_relative_to_shift_start** | **BOOLEAN** | Whether the start time of the activity is relative to the start time of the shift it belongs to | [optional] |
14
+ | **flexible_start_time** | **BOOLEAN** | Whether the start time of the activity is flexible | [optional] |
15
+ | **earliest_start_time_minutes** | **Integer** | Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true | [optional] |
16
+ | **latest_start_time_minutes** | **Integer** | Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true | [optional] |
17
+ | **exact_start_time_minutes** | **Integer** | Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false | [optional] |
18
+ | **start_time_increment_minutes** | **Integer** | Increment in offset minutes that would contribute to different possible start times for the activity | [optional] |
19
+ | **counts_as_paid_time** | **BOOLEAN** | Whether the activity is paid | [optional] |
20
+ | **counts_as_contiguous_work_time** | **BOOLEAN** | Whether the activity duration is counted towards contiguous work time | [optional] |
21
+ | **id** | **String** | ID of the activity. This is required only for the case of updating an existing activity | [optional] |
22
+ | **delete** | **BOOLEAN** | If marked true for updating an existing activity, the activity will be permanently deleted | [optional] |
23
+ {: class="table table-striped"}
24
+
25
+
@@ -0,0 +1,21 @@
1
+ ---
2
+ title: WorkPlanListItemResponse
3
+ ---
4
+ ## PureCloud::WorkPlanListItemResponse
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
+ | **agent_count** | **Integer** | Number of agents in this work plan | [optional] |
13
+ | **weekly_minimum_paid_minutes** | **Integer** | Minimum weekly paid time in minutes defined in this work plan | [optional] |
14
+ | **weekly_maximum_paid_minutes** | **Integer** | Maximum weekly paid time in minutes defined in this work plan | [optional] |
15
+ | **maximum_days** | **Integer** | Maximum number of days in a week that can be scheduled using this work plan | [optional] |
16
+ | **enabled** | **BOOLEAN** | Whether the work plan is enabled for scheduling | [optional] |
17
+ | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this work plan | [optional] |
18
+ | **self_uri** | **String** | The URI for this object | [optional] |
19
+ {: class="table table-striped"}
20
+
21
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WorkPlanListResponse
3
+ ---
4
+ ## PureCloud::WorkPlanListResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array&lt;WorkPlanListItemResponse&gt;**](WorkPlanListItemResponse.html) | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WorkPlanReference
3
+ ---
4
+ ## PureCloud::WorkPlanReference
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The ID of the work plan | |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: WorkPlanShift
3
+ ---
4
+ ## PureCloud::WorkPlanShift
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **name** | **String** | Name of the shift | |
11
+ | **days** | [**SetWrapperDayOfWeek**](SetWrapperDayOfWeek.html) | Days of the week applicable for this shift | [optional] |
12
+ | **flexible_start_time** | **BOOLEAN** | Whether the start time of the shift is flexible | [optional] |
13
+ | **exact_start_time_minutes_from_midnight** | **Integer** | Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false | [optional] |
14
+ | **earliest_start_time_minutes_from_midnight** | **Integer** | Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true | [optional] |
15
+ | **latest_start_time_minutes_from_midnight** | **Integer** | Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true | [optional] |
16
+ | **constrain_stop_time** | **BOOLEAN** | Whether the latest stop time constraint for the shift is enabled | [optional] |
17
+ | **latest_stop_time_minutes_from_midnight** | **Integer** | Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true | [optional] |
18
+ | **start_increment_minutes** | **Integer** | Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true | [optional] |
19
+ | **flexible_paid_time** | **BOOLEAN** | Whether the paid time setting for the shift is flexible | [optional] |
20
+ | **exact_paid_time_minutes** | **Integer** | Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false | [optional] |
21
+ | **minimum_paid_time_minutes** | **Integer** | Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true | [optional] |
22
+ | **maximum_paid_time_minutes** | **Integer** | Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true | [optional] |
23
+ | **constrain_contiguous_work_time** | **BOOLEAN** | Whether the contiguous time constraint for the shift is enabled | [optional] |
24
+ | **minimum_contiguous_work_time_minutes** | **Integer** | Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true | [optional] |
25
+ | **maximum_contiguous_work_time_minutes** | **Integer** | Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true | [optional] |
26
+ | **activities** | [**Array&lt;WorkPlanActivity&gt;**](WorkPlanActivity.html) | Activities configured for this shift | [optional] |
27
+ | **id** | **String** | ID of the shift. This is required only for the case of updating an existing shift | [optional] |
28
+ | **delete** | **BOOLEAN** | If marked true for updating an existing shift, the shift will be permanently deleted | [optional] |
29
+ {: class="table table-striped"}
30
+
31
+
@@ -8,35 +8,3392 @@ All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
9
  Method | Description
10
10
  ------------- | ------------- | -------------
11
+ [**delete_workforcemanagement_managementunit**](WorkforceManagementApi.html#delete_workforcemanagement_managementunit) | Delete management unit
12
+ [**delete_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#delete_workforcemanagement_managementunit_activitycode) | Deletes an activity code
13
+ [**delete_workforcemanagement_managementunit_scheduling_run**](WorkforceManagementApi.html#delete_workforcemanagement_managementunit_scheduling_run) | Cancel a schedule run
14
+ [**delete_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#delete_workforcemanagement_managementunit_servicegoalgroup) | Delete a service goal group
15
+ [**delete_workforcemanagement_managementunit_week_schedule**](WorkforceManagementApi.html#delete_workforcemanagement_managementunit_week_schedule) | Delete a schedule
16
+ [**delete_workforcemanagement_managementunit_week_shorttermforecast**](WorkforceManagementApi.html#delete_workforcemanagement_managementunit_week_shorttermforecast) | Delete a short term forecast
17
+ [**delete_workforcemanagement_managementunit_workplan**](WorkforceManagementApi.html#delete_workforcemanagement_managementunit_workplan) | Delete a work plan
11
18
  [**get_workforcemanagement_adherence**](WorkforceManagementApi.html#get_workforcemanagement_adherence) | Get a list of UserScheduleAdherence records for the requested users
19
+ [**get_workforcemanagement_managementunit**](WorkforceManagementApi.html#get_workforcemanagement_managementunit) | Get management unit
20
+ [**get_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycode) | Get an activity code
12
21
  [**get_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycodes) | Get activity codes
22
+ [**get_workforcemanagement_managementunit_agent**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_agent) | Get data for agent in the management unit
13
23
  [**get_workforcemanagement_managementunit_intraday_queues**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_intraday_queues) | Get intraday queues for the given date
24
+ [**get_workforcemanagement_managementunit_scheduling_runs**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_runs) | Get the status of all the ongoing schedule runs
25
+ [**get_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_servicegoalgroup) | Get a service goal group
26
+ [**get_workforcemanagement_managementunit_servicegoalgroups**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_servicegoalgroups) | Get service goal groups
27
+ [**get_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_settings) | Get the settings for the requested management unit
14
28
  [**get_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequest) | Get a time off request
15
29
  [**get_workforcemanagement_managementunit_user_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequests) | Get a list of time off requests for a given user
16
- [**get_workforcemanagement_managementunit_users**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_users) | Get agents in the management unit
30
+ [**get_workforcemanagement_managementunit_users**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_users) | Get users in the management unit
31
+ [**get_workforcemanagement_managementunit_week_schedule**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedule) | Get a week schedule
32
+ [**get_workforcemanagement_managementunit_week_schedule_generationresults**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedule_generationresults) | Get week schedule generation results
33
+ [**get_workforcemanagement_managementunit_week_schedules**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedules) | Get the list of schedules in a week in management unit
34
+ [**get_workforcemanagement_managementunit_week_shorttermforecast_final**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shorttermforecast_final) | Get the final result of a short term forecast calculation with modifications applied
35
+ [**get_workforcemanagement_managementunit_week_shorttermforecasts**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shorttermforecasts) | Get short term forecasts
36
+ [**get_workforcemanagement_managementunit_workplan**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_workplan) | Get a work plan
37
+ [**get_workforcemanagement_managementunit_workplans**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_workplans) | Get work plans
17
38
  [**get_workforcemanagement_managementunits**](WorkforceManagementApi.html#get_workforcemanagement_managementunits) | Get management units
39
+ [**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user
40
+ [**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user
41
+ [**patch_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_activitycode) | Update an activity code
42
+ [**patch_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_servicegoalgroup) | Update a service goal group
43
+ [**patch_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_settings) | Patch the settings for the requested management unit
18
44
  [**patch_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_user_timeoffrequest) | Update a time off request
45
+ [**patch_workforcemanagement_managementunit_week_schedule**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_week_schedule) | Update a week schedule
46
+ [**patch_workforcemanagement_managementunit_workplan**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_workplan) | Update a work plan
47
+ [**patch_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_timeoffrequest) | Update a time off request for the current user
48
+ [**post_workforcemanagement_adherence_historical**](WorkforceManagementApi.html#post_workforcemanagement_adherence_historical) | Request a historical adherence report for users across management units
19
49
  [**post_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_activitycodes) | Create a new activity code
20
50
  [**post_workforcemanagement_managementunit_historicaladherencequery**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_historicaladherencequery) | Request a historical adherence report
21
51
  [**post_workforcemanagement_managementunit_intraday**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_intraday) | Get intraday data for the given date for the requested queueIds
22
52
  [**post_workforcemanagement_managementunit_schedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_schedules_search) | Query published schedules for given given time range for set of users
53
+ [**post_workforcemanagement_managementunit_servicegoalgroups**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_servicegoalgroups) | Create a new service goal group
54
+ [**post_workforcemanagement_managementunit_timeoffrequests**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_timeoffrequests) | Create a new time off request
55
+ [**post_workforcemanagement_managementunit_timeoffrequests_fetchdetails**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_timeoffrequests_fetchdetails) | Gets a list of time off requests from lookup ids
56
+ [**post_workforcemanagement_managementunit_timeoffrequests_query**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_timeoffrequests_query) | Gets the lookup ids to fetch the specified set of requests
57
+ [**post_workforcemanagement_managementunit_week_schedule_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedule_copy) | Copy a week schedule
58
+ [**post_workforcemanagement_managementunit_week_schedules**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules) | Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500
59
+ [**post_workforcemanagement_managementunit_week_schedules_generate**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules_generate) | Generate a week schedule
60
+ [**post_workforcemanagement_managementunit_week_schedules_partialupload**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules_partialupload) | Partial upload of user schedules where activity count is greater than 17500
61
+ [**post_workforcemanagement_managementunit_week_shorttermforecast_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecast_copy) | Copy a short term forecast
62
+ [**post_workforcemanagement_managementunit_week_shorttermforecasts**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts) | Import a short term forecast
63
+ [**post_workforcemanagement_managementunit_week_shorttermforecasts_generate**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts_generate) | Generate a short term forecast
64
+ [**post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload) | Import a short term forecast
65
+ [**post_workforcemanagement_managementunit_workplan_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_workplan_copy) | Create a copy of work plan
66
+ [**post_workforcemanagement_managementunit_workplans**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_workplans) | Create a new work plan
67
+ [**post_workforcemanagement_managementunits**](WorkforceManagementApi.html#post_workforcemanagement_managementunits) | Add a management unit
68
+ [**post_workforcemanagement_schedules**](WorkforceManagementApi.html#post_workforcemanagement_schedules) | Get published schedule for the current user
69
+ [**post_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#post_workforcemanagement_timeoffrequests) | Create a time off request for the current user
23
70
  {: class="table table-striped"}
24
71
 
72
+ <a name="delete_workforcemanagement_managementunit"></a>
73
+
74
+ ## - delete_workforcemanagement_managementunit(mu_id)
75
+
76
+
77
+
78
+ Delete management unit
79
+
80
+
81
+
82
+ Wraps DELETE /api/v2/workforcemanagement/managementunits/{muId}
83
+
84
+ Requires ANY permissions:
85
+
86
+ * wfm:managementUnit:administer
87
+
88
+
89
+ ### Example
90
+ ~~~ruby
91
+ # load the gem
92
+ require 'purecloudplatformclientv2'
93
+ # setup authorization
94
+ @secret = ENV['PURECLOUD_SECRET']
95
+ @id = ENV['PURECLOUD_CLIENT_ID']
96
+ environment = "mypurecloud.com"
97
+
98
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
99
+
100
+ PureCloud.configure do |config|
101
+ config.access_token = @authToken
102
+ end
103
+
104
+ api_instance = PureCloud::WorkforceManagementApi.new
105
+
106
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
107
+
108
+
109
+ begin
110
+ #Delete management unit
111
+ api_instance.delete_workforcemanagement_managementunit(mu_id)
112
+ rescue PureCloud::ApiError => e
113
+ puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit: #{e}"
114
+ end
115
+ ~~~
116
+
117
+ ### Parameters
118
+
119
+ Name | Type | Description | Notes
120
+ ------------- | ------------- | ------------- | -------------
121
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
122
+ {: class="table table-striped"}
123
+
124
+
125
+ ### Return type
126
+
127
+ nil (empty response body)
128
+
129
+ ### HTTP request headers
130
+
131
+ - **Content-Type**: application/json
132
+ - **Accept**: application/json
133
+
134
+
135
+
136
+ <a name="delete_workforcemanagement_managementunit_activitycode"></a>
137
+
138
+ ## - delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
139
+
140
+
141
+
142
+ Deletes an activity code
143
+
144
+
145
+
146
+ Wraps DELETE /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}
147
+
148
+ Requires ANY permissions:
149
+
150
+ * wfm:activityCode:administer
151
+
152
+
153
+ ### Example
154
+ ~~~ruby
155
+ # load the gem
156
+ require 'purecloudplatformclientv2'
157
+ # setup authorization
158
+ @secret = ENV['PURECLOUD_SECRET']
159
+ @id = ENV['PURECLOUD_CLIENT_ID']
160
+ environment = "mypurecloud.com"
161
+
162
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
163
+
164
+ PureCloud.configure do |config|
165
+ config.access_token = @authToken
166
+ end
167
+
168
+ api_instance = PureCloud::WorkforceManagementApi.new
169
+
170
+ mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
171
+
172
+ ac_id = "ac_id_example" # String | The ID of the activity code to delete
173
+
174
+
175
+ begin
176
+ #Deletes an activity code
177
+ api_instance.delete_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
178
+ rescue PureCloud::ApiError => e
179
+ puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_activitycode: #{e}"
180
+ end
181
+ ~~~
182
+
183
+ ### Parameters
184
+
185
+ Name | Type | Description | Notes
186
+ ------------- | ------------- | ------------- | -------------
187
+ **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
188
+ **ac_id** | **String**| The ID of the activity code to delete | |
189
+ {: class="table table-striped"}
190
+
191
+
192
+ ### Return type
193
+
194
+ nil (empty response body)
195
+
196
+ ### HTTP request headers
197
+
198
+ - **Content-Type**: application/json
199
+ - **Accept**: application/json
200
+
201
+
202
+
203
+ <a name="delete_workforcemanagement_managementunit_scheduling_run"></a>
204
+
205
+ ## - delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
206
+
207
+
208
+
209
+ Cancel a schedule run
210
+
211
+
212
+
213
+ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}
214
+
215
+ Requires ANY permissions:
216
+
217
+ * wfm:schedule:generate
218
+
219
+
220
+ ### Example
221
+ ~~~ruby
222
+ # load the gem
223
+ require 'purecloudplatformclientv2'
224
+ # setup authorization
225
+ @secret = ENV['PURECLOUD_SECRET']
226
+ @id = ENV['PURECLOUD_CLIENT_ID']
227
+ environment = "mypurecloud.com"
228
+
229
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
230
+
231
+ PureCloud.configure do |config|
232
+ config.access_token = @authToken
233
+ end
234
+
235
+ api_instance = PureCloud::WorkforceManagementApi.new
236
+
237
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit.
238
+
239
+ run_id = "run_id_example" # String | The ID of the schedule run
240
+
241
+
242
+ begin
243
+ #Cancel a schedule run
244
+ api_instance.delete_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id)
245
+ rescue PureCloud::ApiError => e
246
+ puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_scheduling_run: #{e}"
247
+ end
248
+ ~~~
249
+
250
+ ### Parameters
251
+
252
+ Name | Type | Description | Notes
253
+ ------------- | ------------- | ------------- | -------------
254
+ **management_unit_id** | **String**| The ID of the management unit. | |
255
+ **run_id** | **String**| The ID of the schedule run | |
256
+ {: class="table table-striped"}
257
+
258
+
259
+ ### Return type
260
+
261
+ nil (empty response body)
262
+
263
+ ### HTTP request headers
264
+
265
+ - **Content-Type**: application/json
266
+ - **Accept**: application/json
267
+
268
+
269
+
270
+ <a name="delete_workforcemanagement_managementunit_servicegoalgroup"></a>
271
+
272
+ ## - delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
273
+
274
+
275
+
276
+ Delete a service goal group
277
+
278
+
279
+
280
+ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}
281
+
282
+ Requires ANY permissions:
283
+
284
+ * wfm:serviceGoalGroup:administer
285
+
286
+
287
+ ### Example
288
+ ~~~ruby
289
+ # load the gem
290
+ require 'purecloudplatformclientv2'
291
+ # setup authorization
292
+ @secret = ENV['PURECLOUD_SECRET']
293
+ @id = ENV['PURECLOUD_CLIENT_ID']
294
+ environment = "mypurecloud.com"
295
+
296
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
297
+
298
+ PureCloud.configure do |config|
299
+ config.access_token = @authToken
300
+ end
301
+
302
+ api_instance = PureCloud::WorkforceManagementApi.new
303
+
304
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
305
+
306
+ service_goal_group_id = "service_goal_group_id_example" # String | The ID of the service goal group to delete
307
+
308
+
309
+ begin
310
+ #Delete a service goal group
311
+ api_instance.delete_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
312
+ rescue PureCloud::ApiError => e
313
+ puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_servicegoalgroup: #{e}"
314
+ end
315
+ ~~~
316
+
317
+ ### Parameters
318
+
319
+ Name | Type | Description | Notes
320
+ ------------- | ------------- | ------------- | -------------
321
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
322
+ **service_goal_group_id** | **String**| The ID of the service goal group to delete | |
323
+ {: class="table table-striped"}
324
+
325
+
326
+ ### Return type
327
+
328
+ nil (empty response body)
329
+
330
+ ### HTTP request headers
331
+
332
+ - **Content-Type**: application/json
333
+ - **Accept**: application/json
334
+
335
+
336
+
337
+ <a name="delete_workforcemanagement_managementunit_week_schedule"></a>
338
+
339
+ ## - delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id)
340
+
341
+
342
+
343
+ Delete a schedule
344
+
345
+
346
+
347
+ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}
348
+
349
+ Requires ANY permissions:
350
+
351
+ * wfm:schedule:administer
352
+
353
+
354
+ ### Example
355
+ ~~~ruby
356
+ # load the gem
357
+ require 'purecloudplatformclientv2'
358
+ # setup authorization
359
+ @secret = ENV['PURECLOUD_SECRET']
360
+ @id = ENV['PURECLOUD_CLIENT_ID']
361
+ environment = "mypurecloud.com"
362
+
363
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
364
+
365
+ PureCloud.configure do |config|
366
+ config.access_token = @authToken
367
+ end
368
+
369
+ api_instance = PureCloud::WorkforceManagementApi.new
370
+
371
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
372
+
373
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
374
+
375
+ schedule_id = "schedule_id_example" # String | The ID of theschedule to delete
376
+
377
+
378
+ begin
379
+ #Delete a schedule
380
+ api_instance.delete_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id)
381
+ rescue PureCloud::ApiError => e
382
+ puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_week_schedule: #{e}"
383
+ end
384
+ ~~~
385
+
386
+ ### Parameters
387
+
388
+ Name | Type | Description | Notes
389
+ ------------- | ------------- | ------------- | -------------
390
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
391
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
392
+ **schedule_id** | **String**| The ID of theschedule to delete | |
393
+ {: class="table table-striped"}
394
+
395
+
396
+ ### Return type
397
+
398
+ nil (empty response body)
399
+
400
+ ### HTTP request headers
401
+
402
+ - **Content-Type**: application/json
403
+ - **Accept**: application/json
404
+
405
+
406
+
407
+ <a name="delete_workforcemanagement_managementunit_week_shorttermforecast"></a>
408
+
409
+ ## - delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id)
410
+
411
+
412
+
413
+ Delete a short term forecast
414
+
415
+ Must not be tied to any schedules
416
+
417
+ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}
418
+
419
+ Requires ANY permissions:
420
+
421
+ * wfm:shortTermForecast:administer
422
+
423
+
424
+ ### Example
425
+ ~~~ruby
426
+ # load the gem
427
+ require 'purecloudplatformclientv2'
428
+ # setup authorization
429
+ @secret = ENV['PURECLOUD_SECRET']
430
+ @id = ENV['PURECLOUD_CLIENT_ID']
431
+ environment = "mypurecloud.com"
432
+
433
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
434
+
435
+ PureCloud.configure do |config|
436
+ config.access_token = @authToken
437
+ end
438
+
439
+ api_instance = PureCloud::WorkforceManagementApi.new
440
+
441
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit to which the forecast belongs
442
+
443
+ week_date_id = "week_date_id_example" # String | The week start date of the forecast in yyyy-MM-dd format
444
+
445
+ forecast_id = "forecast_id_example" # String | The ID of the forecast
446
+
447
+
448
+ begin
449
+ #Delete a short term forecast
450
+ api_instance.delete_workforcemanagement_managementunit_week_shorttermforecast(management_unit_id, week_date_id, forecast_id)
451
+ rescue PureCloud::ApiError => e
452
+ puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_week_shorttermforecast: #{e}"
453
+ end
454
+ ~~~
455
+
456
+ ### Parameters
457
+
458
+ Name | Type | Description | Notes
459
+ ------------- | ------------- | ------------- | -------------
460
+ **management_unit_id** | **String**| The management unit ID of the management unit to which the forecast belongs | |
461
+ **week_date_id** | **String**| The week start date of the forecast in yyyy-MM-dd format | |
462
+ **forecast_id** | **String**| The ID of the forecast | |
463
+ {: class="table table-striped"}
464
+
465
+
466
+ ### Return type
467
+
468
+ nil (empty response body)
469
+
470
+ ### HTTP request headers
471
+
472
+ - **Content-Type**: application/json
473
+ - **Accept**: application/json
474
+
475
+
476
+
477
+ <a name="delete_workforcemanagement_managementunit_workplan"></a>
478
+
479
+ ## - delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
480
+
481
+
482
+
483
+ Delete a work plan
484
+
485
+
486
+
487
+ Wraps DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
488
+
489
+ Requires ANY permissions:
490
+
491
+ * wfm:workPlan:administer
492
+
493
+
494
+ ### Example
495
+ ~~~ruby
496
+ # load the gem
497
+ require 'purecloudplatformclientv2'
498
+ # setup authorization
499
+ @secret = ENV['PURECLOUD_SECRET']
500
+ @id = ENV['PURECLOUD_CLIENT_ID']
501
+ environment = "mypurecloud.com"
502
+
503
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
504
+
505
+ PureCloud.configure do |config|
506
+ config.access_token = @authToken
507
+ end
508
+
509
+ api_instance = PureCloud::WorkforceManagementApi.new
510
+
511
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
512
+
513
+ work_plan_id = "work_plan_id_example" # String | The ID of the work plan to delete
514
+
515
+
516
+ begin
517
+ #Delete a work plan
518
+ api_instance.delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
519
+ rescue PureCloud::ApiError => e
520
+ puts "Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_workplan: #{e}"
521
+ end
522
+ ~~~
523
+
524
+ ### Parameters
525
+
526
+ Name | Type | Description | Notes
527
+ ------------- | ------------- | ------------- | -------------
528
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
529
+ **work_plan_id** | **String**| The ID of the work plan to delete | |
530
+ {: class="table table-striped"}
531
+
532
+
533
+ ### Return type
534
+
535
+ nil (empty response body)
536
+
537
+ ### HTTP request headers
538
+
539
+ - **Content-Type**: application/json
540
+ - **Accept**: application/json
541
+
542
+
543
+
25
544
  <a name="get_workforcemanagement_adherence"></a>
26
545
 
27
- ## -[**Array&lt;UserScheduleAdherence&gt;**](UserScheduleAdherence.html) get_workforcemanagement_adherence(user_id)
546
+ ## -[**Array&lt;UserScheduleAdherence&gt;**](UserScheduleAdherence.html) get_workforcemanagement_adherence(user_id)
547
+
548
+
549
+
550
+ Get a list of UserScheduleAdherence records for the requested users
551
+
552
+
553
+
554
+ Wraps GET /api/v2/workforcemanagement/adherence
555
+
556
+ Requires ANY permissions:
557
+
558
+ * wfm:realtimeAdherence:view
559
+
560
+
561
+ ### Example
562
+ ~~~ruby
563
+ # load the gem
564
+ require 'purecloudplatformclientv2'
565
+ # setup authorization
566
+ @secret = ENV['PURECLOUD_SECRET']
567
+ @id = ENV['PURECLOUD_CLIENT_ID']
568
+ environment = "mypurecloud.com"
569
+
570
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
571
+
572
+ PureCloud.configure do |config|
573
+ config.access_token = @authToken
574
+ end
575
+
576
+ api_instance = PureCloud::WorkforceManagementApi.new
577
+
578
+ user_id = ["user_id_example"] # Array<String> | User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request
579
+
580
+
581
+ begin
582
+ #Get a list of UserScheduleAdherence records for the requested users
583
+ result = api_instance.get_workforcemanagement_adherence(user_id)
584
+ p result
585
+ rescue PureCloud::ApiError => e
586
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_adherence: #{e}"
587
+ end
588
+ ~~~
589
+
590
+ ### Parameters
591
+
592
+ Name | Type | Description | Notes
593
+ ------------- | ------------- | ------------- | -------------
594
+ **user_id** | [**Array&lt;String&gt;**](String.html)| User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request | |
595
+ {: class="table table-striped"}
596
+
597
+
598
+ ### Return type
599
+
600
+ [**Array&lt;UserScheduleAdherence&gt;**](UserScheduleAdherence.html)
601
+
602
+ ### HTTP request headers
603
+
604
+ - **Content-Type**: application/json
605
+ - **Accept**: application/json
606
+
607
+
608
+
609
+ <a name="get_workforcemanagement_managementunit"></a>
610
+
611
+ ## -[**ManagementUnit**](ManagementUnit.html) get_workforcemanagement_managementunit(mu_id, opts)
612
+
613
+
614
+
615
+ Get management unit
616
+
617
+
618
+
619
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}
620
+
621
+ Requires ANY permissions:
622
+
623
+ * wfm:activityCode:administer
624
+ * wfm:agent:administer
625
+ * wfm:agentSchedule:view
626
+ * wfm:historicalAdherence:view
627
+ * wfm:intraday:view
628
+ * wfm:managementUnit:administer
629
+ * wfm:publishedSchedule:view
630
+ * wfm:realtimeAdherence:view
631
+ * wfm:schedule:administer
632
+ * wfm:schedule:generate
633
+ * wfm:serviceGoalGroup:administer
634
+ * wfm:shortTermForecast:administer
635
+ * wfm:agentTimeOffRequest:submit
636
+ * wfm:timeOffRequest:administer
637
+ * wfm:workPlan:administer
638
+
639
+
640
+ ### Example
641
+ ~~~ruby
642
+ # load the gem
643
+ require 'purecloudplatformclientv2'
644
+ # setup authorization
645
+ @secret = ENV['PURECLOUD_SECRET']
646
+ @id = ENV['PURECLOUD_CLIENT_ID']
647
+ environment = "mypurecloud.com"
648
+
649
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
650
+
651
+ PureCloud.configure do |config|
652
+ config.access_token = @authToken
653
+ end
654
+
655
+ api_instance = PureCloud::WorkforceManagementApi.new
656
+
657
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
658
+
659
+ opts = {
660
+ expand: "expand_example" # String |
661
+ }
662
+
663
+ begin
664
+ #Get management unit
665
+ result = api_instance.get_workforcemanagement_managementunit(mu_id, opts)
666
+ p result
667
+ rescue PureCloud::ApiError => e
668
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit: #{e}"
669
+ end
670
+ ~~~
671
+
672
+ ### Parameters
673
+
674
+ Name | Type | Description | Notes
675
+ ------------- | ------------- | ------------- | -------------
676
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
677
+ **expand** | **String**| | [optional] <br />**Values**: settings |
678
+ {: class="table table-striped"}
679
+
680
+
681
+ ### Return type
682
+
683
+ [**ManagementUnit**](ManagementUnit.html)
684
+
685
+ ### HTTP request headers
686
+
687
+ - **Content-Type**: application/json
688
+ - **Accept**: application/json
689
+
690
+
691
+
692
+ <a name="get_workforcemanagement_managementunit_activitycode"></a>
693
+
694
+ ## -[**ActivityCode**](ActivityCode.html) get_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
695
+
696
+
697
+
698
+ Get an activity code
699
+
700
+
701
+
702
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}
703
+
704
+ Requires ANY permissions:
705
+
706
+ * wfm:activityCode:administer
707
+ * wfm:agent:administer
708
+ * wfm:agentSchedule:view
709
+ * wfm:historicalAdherence:view
710
+ * wfm:intraday:view
711
+ * wfm:managementUnit:administer
712
+ * wfm:publishedSchedule:view
713
+ * wfm:realtimeAdherence:view
714
+ * wfm:schedule:administer
715
+ * wfm:schedule:generate
716
+ * wfm:serviceGoalGroup:administer
717
+ * wfm:shortTermForecast:administer
718
+ * wfm:agentTimeOffRequest:submit
719
+ * wfm:timeOffRequest:administer
720
+ * wfm:workPlan:administer
721
+
722
+
723
+ ### Example
724
+ ~~~ruby
725
+ # load the gem
726
+ require 'purecloudplatformclientv2'
727
+ # setup authorization
728
+ @secret = ENV['PURECLOUD_SECRET']
729
+ @id = ENV['PURECLOUD_CLIENT_ID']
730
+ environment = "mypurecloud.com"
731
+
732
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
733
+
734
+ PureCloud.configure do |config|
735
+ config.access_token = @authToken
736
+ end
737
+
738
+ api_instance = PureCloud::WorkforceManagementApi.new
739
+
740
+ mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
741
+
742
+ ac_id = "ac_id_example" # String | The ID of the activity code to fetch
743
+
744
+
745
+ begin
746
+ #Get an activity code
747
+ result = api_instance.get_workforcemanagement_managementunit_activitycode(mu_id, ac_id)
748
+ p result
749
+ rescue PureCloud::ApiError => e
750
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_activitycode: #{e}"
751
+ end
752
+ ~~~
753
+
754
+ ### Parameters
755
+
756
+ Name | Type | Description | Notes
757
+ ------------- | ------------- | ------------- | -------------
758
+ **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
759
+ **ac_id** | **String**| The ID of the activity code to fetch | |
760
+ {: class="table table-striped"}
761
+
762
+
763
+ ### Return type
764
+
765
+ [**ActivityCode**](ActivityCode.html)
766
+
767
+ ### HTTP request headers
768
+
769
+ - **Content-Type**: application/json
770
+ - **Accept**: application/json
771
+
772
+
773
+
774
+ <a name="get_workforcemanagement_managementunit_activitycodes"></a>
775
+
776
+ ## -[**ActivityCodeContainer**](ActivityCodeContainer.html) get_workforcemanagement_managementunit_activitycodes(mu_id)
777
+
778
+
779
+
780
+ Get activity codes
781
+
782
+
783
+
784
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
785
+
786
+ Requires ANY permissions:
787
+
788
+ * wfm:activityCode:administer
789
+ * wfm:agent:administer
790
+ * wfm:agentSchedule:view
791
+ * wfm:historicalAdherence:view
792
+ * wfm:intraday:view
793
+ * wfm:managementUnit:administer
794
+ * wfm:publishedSchedule:view
795
+ * wfm:realtimeAdherence:view
796
+ * wfm:schedule:administer
797
+ * wfm:schedule:generate
798
+ * wfm:serviceGoalGroup:administer
799
+ * wfm:shortTermForecast:administer
800
+ * wfm:agentTimeOffRequest:submit
801
+ * wfm:timeOffRequest:administer
802
+ * wfm:workPlan:administer
803
+
804
+
805
+ ### Example
806
+ ~~~ruby
807
+ # load the gem
808
+ require 'purecloudplatformclientv2'
809
+ # setup authorization
810
+ @secret = ENV['PURECLOUD_SECRET']
811
+ @id = ENV['PURECLOUD_CLIENT_ID']
812
+ environment = "mypurecloud.com"
813
+
814
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
815
+
816
+ PureCloud.configure do |config|
817
+ config.access_token = @authToken
818
+ end
819
+
820
+ api_instance = PureCloud::WorkforceManagementApi.new
821
+
822
+ mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
823
+
824
+
825
+ begin
826
+ #Get activity codes
827
+ result = api_instance.get_workforcemanagement_managementunit_activitycodes(mu_id)
828
+ p result
829
+ rescue PureCloud::ApiError => e
830
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_activitycodes: #{e}"
831
+ end
832
+ ~~~
833
+
834
+ ### Parameters
835
+
836
+ Name | Type | Description | Notes
837
+ ------------- | ------------- | ------------- | -------------
838
+ **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
839
+ {: class="table table-striped"}
840
+
841
+
842
+ ### Return type
843
+
844
+ [**ActivityCodeContainer**](ActivityCodeContainer.html)
845
+
846
+ ### HTTP request headers
847
+
848
+ - **Content-Type**: application/json
849
+ - **Accept**: application/json
850
+
851
+
852
+
853
+ <a name="get_workforcemanagement_managementunit_agent"></a>
854
+
855
+ ## -[**WfmAgent**](WfmAgent.html) get_workforcemanagement_managementunit_agent(management_unit_id, agent_id)
856
+
857
+
858
+
859
+ Get data for agent in the management unit
860
+
861
+
862
+
863
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}
864
+
865
+ Requires ANY permissions:
866
+
867
+ * wfm:agent:administer
868
+
869
+
870
+ ### Example
871
+ ~~~ruby
872
+ # load the gem
873
+ require 'purecloudplatformclientv2'
874
+ # setup authorization
875
+ @secret = ENV['PURECLOUD_SECRET']
876
+ @id = ENV['PURECLOUD_CLIENT_ID']
877
+ environment = "mypurecloud.com"
878
+
879
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
880
+
881
+ PureCloud.configure do |config|
882
+ config.access_token = @authToken
883
+ end
884
+
885
+ api_instance = PureCloud::WorkforceManagementApi.new
886
+
887
+ management_unit_id = "management_unit_id_example" # String | The id of the management unit, or 'mine' for the management unit of the logged-in user.
888
+
889
+ agent_id = "agent_id_example" # String | The agent id
890
+
891
+
892
+ begin
893
+ #Get data for agent in the management unit
894
+ result = api_instance.get_workforcemanagement_managementunit_agent(management_unit_id, agent_id)
895
+ p result
896
+ rescue PureCloud::ApiError => e
897
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_agent: #{e}"
898
+ end
899
+ ~~~
900
+
901
+ ### Parameters
902
+
903
+ Name | Type | Description | Notes
904
+ ------------- | ------------- | ------------- | -------------
905
+ **management_unit_id** | **String**| The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
906
+ **agent_id** | **String**| The agent id | |
907
+ {: class="table table-striped"}
908
+
909
+
910
+ ### Return type
911
+
912
+ [**WfmAgent**](WfmAgent.html)
913
+
914
+ ### HTTP request headers
915
+
916
+ - **Content-Type**: application/json
917
+ - **Accept**: application/json
918
+
919
+
920
+
921
+ <a name="get_workforcemanagement_managementunit_intraday_queues"></a>
922
+
923
+ ## -[**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
924
+
925
+
926
+
927
+ Get intraday queues for the given date
928
+
929
+
930
+
931
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/intraday/queues
932
+
933
+ Requires ANY permissions:
934
+
935
+ * wfm:intraday:view
936
+
937
+
938
+ ### Example
939
+ ~~~ruby
940
+ # load the gem
941
+ require 'purecloudplatformclientv2'
942
+ # setup authorization
943
+ @secret = ENV['PURECLOUD_SECRET']
944
+ @id = ENV['PURECLOUD_CLIENT_ID']
945
+ environment = "mypurecloud.com"
946
+
947
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
948
+
949
+ PureCloud.configure do |config|
950
+ config.access_token = @authToken
951
+ end
952
+
953
+ api_instance = PureCloud::WorkforceManagementApi.new
954
+
955
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit
956
+
957
+ date = "date_example" # String | yyyy-MM-dd date string interpreted in the configured management unit time zone
958
+
959
+
960
+ begin
961
+ #Get intraday queues for the given date
962
+ result = api_instance.get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
963
+ p result
964
+ rescue PureCloud::ApiError => e
965
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_intraday_queues: #{e}"
966
+ end
967
+ ~~~
968
+
969
+ ### Parameters
970
+
971
+ Name | Type | Description | Notes
972
+ ------------- | ------------- | ------------- | -------------
973
+ **mu_id** | **String**| The management unit ID of the management unit | |
974
+ **date** | **String**| yyyy-MM-dd date string interpreted in the configured management unit time zone | |
975
+ {: class="table table-striped"}
976
+
977
+
978
+ ### Return type
979
+
980
+ [**WfmIntradayQueueListing**](WfmIntradayQueueListing.html)
981
+
982
+ ### HTTP request headers
983
+
984
+ - **Content-Type**: application/json
985
+ - **Accept**: application/json
986
+
987
+
988
+
989
+ <a name="get_workforcemanagement_managementunit_scheduling_runs"></a>
990
+
991
+ ## -[**SchedulingRunListResponse**](SchedulingRunListResponse.html) get_workforcemanagement_managementunit_scheduling_runs(management_unit_id)
992
+
993
+
994
+
995
+ Get the status of all the ongoing schedule runs
996
+
997
+
998
+
999
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs
1000
+
1001
+ Requires ANY permissions:
1002
+
1003
+ * wfm:schedule:generate
1004
+
1005
+
1006
+ ### Example
1007
+ ~~~ruby
1008
+ # load the gem
1009
+ require 'purecloudplatformclientv2'
1010
+ # setup authorization
1011
+ @secret = ENV['PURECLOUD_SECRET']
1012
+ @id = ENV['PURECLOUD_CLIENT_ID']
1013
+ environment = "mypurecloud.com"
1014
+
1015
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1016
+
1017
+ PureCloud.configure do |config|
1018
+ config.access_token = @authToken
1019
+ end
1020
+
1021
+ api_instance = PureCloud::WorkforceManagementApi.new
1022
+
1023
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit.
1024
+
1025
+
1026
+ begin
1027
+ #Get the status of all the ongoing schedule runs
1028
+ result = api_instance.get_workforcemanagement_managementunit_scheduling_runs(management_unit_id)
1029
+ p result
1030
+ rescue PureCloud::ApiError => e
1031
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_scheduling_runs: #{e}"
1032
+ end
1033
+ ~~~
1034
+
1035
+ ### Parameters
1036
+
1037
+ Name | Type | Description | Notes
1038
+ ------------- | ------------- | ------------- | -------------
1039
+ **management_unit_id** | **String**| The ID of the management unit. | |
1040
+ {: class="table table-striped"}
1041
+
1042
+
1043
+ ### Return type
1044
+
1045
+ [**SchedulingRunListResponse**](SchedulingRunListResponse.html)
1046
+
1047
+ ### HTTP request headers
1048
+
1049
+ - **Content-Type**: application/json
1050
+ - **Accept**: application/json
1051
+
1052
+
1053
+
1054
+ <a name="get_workforcemanagement_managementunit_servicegoalgroup"></a>
1055
+
1056
+ ## -[**ServiceGoalGroup**](ServiceGoalGroup.html) get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
1057
+
1058
+
1059
+
1060
+ Get a service goal group
1061
+
1062
+
1063
+
1064
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}
1065
+
1066
+ Requires ANY permissions:
1067
+
1068
+ * wfm:serviceGoalGroup:administer
1069
+
1070
+
1071
+ ### Example
1072
+ ~~~ruby
1073
+ # load the gem
1074
+ require 'purecloudplatformclientv2'
1075
+ # setup authorization
1076
+ @secret = ENV['PURECLOUD_SECRET']
1077
+ @id = ENV['PURECLOUD_CLIENT_ID']
1078
+ environment = "mypurecloud.com"
1079
+
1080
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1081
+
1082
+ PureCloud.configure do |config|
1083
+ config.access_token = @authToken
1084
+ end
1085
+
1086
+ api_instance = PureCloud::WorkforceManagementApi.new
1087
+
1088
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1089
+
1090
+ service_goal_group_id = "service_goal_group_id_example" # String | The ID of the service goal group to fetch
1091
+
1092
+
1093
+ begin
1094
+ #Get a service goal group
1095
+ result = api_instance.get_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id)
1096
+ p result
1097
+ rescue PureCloud::ApiError => e
1098
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_servicegoalgroup: #{e}"
1099
+ end
1100
+ ~~~
1101
+
1102
+ ### Parameters
1103
+
1104
+ Name | Type | Description | Notes
1105
+ ------------- | ------------- | ------------- | -------------
1106
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1107
+ **service_goal_group_id** | **String**| The ID of the service goal group to fetch | |
1108
+ {: class="table table-striped"}
1109
+
1110
+
1111
+ ### Return type
1112
+
1113
+ [**ServiceGoalGroup**](ServiceGoalGroup.html)
1114
+
1115
+ ### HTTP request headers
1116
+
1117
+ - **Content-Type**: application/json
1118
+ - **Accept**: application/json
1119
+
1120
+
1121
+
1122
+ <a name="get_workforcemanagement_managementunit_servicegoalgroups"></a>
1123
+
1124
+ ## -[**ServiceGoalGroupList**](ServiceGoalGroupList.html) get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id)
1125
+
1126
+
1127
+
1128
+ Get service goal groups
1129
+
1130
+
1131
+
1132
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups
1133
+
1134
+ Requires ANY permissions:
1135
+
1136
+ * wfm:serviceGoalGroup:administer
1137
+ * wfm:shortTermForecast:administer
1138
+
1139
+
1140
+ ### Example
1141
+ ~~~ruby
1142
+ # load the gem
1143
+ require 'purecloudplatformclientv2'
1144
+ # setup authorization
1145
+ @secret = ENV['PURECLOUD_SECRET']
1146
+ @id = ENV['PURECLOUD_CLIENT_ID']
1147
+ environment = "mypurecloud.com"
1148
+
1149
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1150
+
1151
+ PureCloud.configure do |config|
1152
+ config.access_token = @authToken
1153
+ end
1154
+
1155
+ api_instance = PureCloud::WorkforceManagementApi.new
1156
+
1157
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1158
+
1159
+
1160
+ begin
1161
+ #Get service goal groups
1162
+ result = api_instance.get_workforcemanagement_managementunit_servicegoalgroups(management_unit_id)
1163
+ p result
1164
+ rescue PureCloud::ApiError => e
1165
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_servicegoalgroups: #{e}"
1166
+ end
1167
+ ~~~
1168
+
1169
+ ### Parameters
1170
+
1171
+ Name | Type | Description | Notes
1172
+ ------------- | ------------- | ------------- | -------------
1173
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1174
+ {: class="table table-striped"}
1175
+
1176
+
1177
+ ### Return type
1178
+
1179
+ [**ServiceGoalGroupList**](ServiceGoalGroupList.html)
1180
+
1181
+ ### HTTP request headers
1182
+
1183
+ - **Content-Type**: application/json
1184
+ - **Accept**: application/json
1185
+
1186
+
1187
+
1188
+ <a name="get_workforcemanagement_managementunit_settings"></a>
1189
+
1190
+ ## -[**ManagementUnitSettings**](ManagementUnitSettings.html) get_workforcemanagement_managementunit_settings(mu_id)
1191
+
1192
+
1193
+
1194
+ Get the settings for the requested management unit
1195
+
1196
+
1197
+
1198
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/settings
1199
+
1200
+ Requires ANY permissions:
1201
+
1202
+ * wfm:managementUnit:administer
1203
+
1204
+
1205
+ ### Example
1206
+ ~~~ruby
1207
+ # load the gem
1208
+ require 'purecloudplatformclientv2'
1209
+ # setup authorization
1210
+ @secret = ENV['PURECLOUD_SECRET']
1211
+ @id = ENV['PURECLOUD_CLIENT_ID']
1212
+ environment = "mypurecloud.com"
1213
+
1214
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1215
+
1216
+ PureCloud.configure do |config|
1217
+ config.access_token = @authToken
1218
+ end
1219
+
1220
+ api_instance = PureCloud::WorkforceManagementApi.new
1221
+
1222
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
1223
+
1224
+
1225
+ begin
1226
+ #Get the settings for the requested management unit
1227
+ result = api_instance.get_workforcemanagement_managementunit_settings(mu_id)
1228
+ p result
1229
+ rescue PureCloud::ApiError => e
1230
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_settings: #{e}"
1231
+ end
1232
+ ~~~
1233
+
1234
+ ### Parameters
1235
+
1236
+ Name | Type | Description | Notes
1237
+ ------------- | ------------- | ------------- | -------------
1238
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1239
+ {: class="table table-striped"}
1240
+
1241
+
1242
+ ### Return type
1243
+
1244
+ [**ManagementUnitSettings**](ManagementUnitSettings.html)
1245
+
1246
+ ### HTTP request headers
1247
+
1248
+ - **Content-Type**: application/json
1249
+ - **Accept**: application/json
1250
+
1251
+
1252
+
1253
+ <a name="get_workforcemanagement_managementunit_user_timeoffrequest"></a>
1254
+
1255
+ ## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
1256
+
1257
+
1258
+
1259
+ Get a time off request
1260
+
1261
+
1262
+
1263
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
1264
+
1265
+ Requires ANY permissions:
1266
+
1267
+ * wfm:timeOffRequest:administer
1268
+
1269
+
1270
+ ### Example
1271
+ ~~~ruby
1272
+ # load the gem
1273
+ require 'purecloudplatformclientv2'
1274
+ # setup authorization
1275
+ @secret = ENV['PURECLOUD_SECRET']
1276
+ @id = ENV['PURECLOUD_CLIENT_ID']
1277
+ environment = "mypurecloud.com"
1278
+
1279
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1280
+
1281
+ PureCloud.configure do |config|
1282
+ config.access_token = @authToken
1283
+ end
1284
+
1285
+ api_instance = PureCloud::WorkforceManagementApi.new
1286
+
1287
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
1288
+
1289
+ user_id = "user_id_example" # String | The userId to whom the Time Off Request applies.
1290
+
1291
+ time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
1292
+
1293
+
1294
+ begin
1295
+ #Get a time off request
1296
+ result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
1297
+ p result
1298
+ rescue PureCloud::ApiError => e
1299
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
1300
+ end
1301
+ ~~~
1302
+
1303
+ ### Parameters
1304
+
1305
+ Name | Type | Description | Notes
1306
+ ------------- | ------------- | ------------- | -------------
1307
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1308
+ **user_id** | **String**| The userId to whom the Time Off Request applies. | |
1309
+ **time_off_request_id** | **String**| Time Off Request Id | |
1310
+ {: class="table table-striped"}
1311
+
1312
+
1313
+ ### Return type
1314
+
1315
+ [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
1316
+
1317
+ ### HTTP request headers
1318
+
1319
+ - **Content-Type**: application/json
1320
+ - **Accept**: application/json
1321
+
1322
+
1323
+
1324
+ <a name="get_workforcemanagement_managementunit_user_timeoffrequests"></a>
1325
+
1326
+ ## -[**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
1327
+
1328
+
1329
+
1330
+ Get a list of time off requests for a given user
1331
+
1332
+
1333
+
1334
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests
1335
+
1336
+ Requires ANY permissions:
1337
+
1338
+ * wfm:timeOffRequest:administer
1339
+
1340
+
1341
+ ### Example
1342
+ ~~~ruby
1343
+ # load the gem
1344
+ require 'purecloudplatformclientv2'
1345
+ # setup authorization
1346
+ @secret = ENV['PURECLOUD_SECRET']
1347
+ @id = ENV['PURECLOUD_CLIENT_ID']
1348
+ environment = "mypurecloud.com"
1349
+
1350
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1351
+
1352
+ PureCloud.configure do |config|
1353
+ config.access_token = @authToken
1354
+ end
1355
+
1356
+ api_instance = PureCloud::WorkforceManagementApi.new
1357
+
1358
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
1359
+
1360
+ user_id = "user_id_example" # String | The userId to whom the Time Off Request applies.
1361
+
1362
+ opts = {
1363
+ recently_reviewed: false # BOOLEAN | Limit results to requests that have been reviewed within the preceding 30 days
1364
+ }
1365
+
1366
+ begin
1367
+ #Get a list of time off requests for a given user
1368
+ result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
1369
+ p result
1370
+ rescue PureCloud::ApiError => e
1371
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequests: #{e}"
1372
+ end
1373
+ ~~~
1374
+
1375
+ ### Parameters
1376
+
1377
+ Name | Type | Description | Notes
1378
+ ------------- | ------------- | ------------- | -------------
1379
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1380
+ **user_id** | **String**| The userId to whom the Time Off Request applies. | |
1381
+ **recently_reviewed** | **BOOLEAN**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] [default to false] |
1382
+ {: class="table table-striped"}
1383
+
1384
+
1385
+ ### Return type
1386
+
1387
+ [**TimeOffRequestList**](TimeOffRequestList.html)
1388
+
1389
+ ### HTTP request headers
1390
+
1391
+ - **Content-Type**: application/json
1392
+ - **Accept**: application/json
1393
+
1394
+
1395
+
1396
+ <a name="get_workforcemanagement_managementunit_users"></a>
1397
+
1398
+ ## -[**WfmUserEntityListing**](WfmUserEntityListing.html) get_workforcemanagement_managementunit_users(mu_id)
1399
+
1400
+
1401
+
1402
+ Get users in the management unit
1403
+
1404
+
1405
+
1406
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users
1407
+
1408
+ Requires ANY permissions:
1409
+
1410
+ * wfm:agent:administer
1411
+ * wfm:historicalAdherence:view
1412
+ * wfm:publishedSchedule:view
1413
+ * wfm:realtimeAdherence:view
1414
+ * wfm:schedule:administer
1415
+ * wfm:timeOffRequest:administer
1416
+ * wfm:workPlan:administer
1417
+
1418
+
1419
+ ### Example
1420
+ ~~~ruby
1421
+ # load the gem
1422
+ require 'purecloudplatformclientv2'
1423
+ # setup authorization
1424
+ @secret = ENV['PURECLOUD_SECRET']
1425
+ @id = ENV['PURECLOUD_CLIENT_ID']
1426
+ environment = "mypurecloud.com"
1427
+
1428
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1429
+
1430
+ PureCloud.configure do |config|
1431
+ config.access_token = @authToken
1432
+ end
1433
+
1434
+ api_instance = PureCloud::WorkforceManagementApi.new
1435
+
1436
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
1437
+
1438
+
1439
+ begin
1440
+ #Get users in the management unit
1441
+ result = api_instance.get_workforcemanagement_managementunit_users(mu_id)
1442
+ p result
1443
+ rescue PureCloud::ApiError => e
1444
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_users: #{e}"
1445
+ end
1446
+ ~~~
1447
+
1448
+ ### Parameters
1449
+
1450
+ Name | Type | Description | Notes
1451
+ ------------- | ------------- | ------------- | -------------
1452
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1453
+ {: class="table table-striped"}
1454
+
1455
+
1456
+ ### Return type
1457
+
1458
+ [**WfmUserEntityListing**](WfmUserEntityListing.html)
1459
+
1460
+ ### HTTP request headers
1461
+
1462
+ - **Content-Type**: application/json
1463
+ - **Accept**: application/json
1464
+
1465
+
1466
+
1467
+ <a name="get_workforcemanagement_managementunit_week_schedule"></a>
1468
+
1469
+ ## -[**WeekScheduleResponse**](WeekScheduleResponse.html) get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
1470
+
1471
+
1472
+
1473
+ Get a week schedule
1474
+
1475
+
1476
+
1477
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}
1478
+
1479
+ Requires ANY permissions:
1480
+
1481
+ * wfm:schedule:administer
1482
+ * wfm:publishedSchedule:view
1483
+
1484
+
1485
+ ### Example
1486
+ ~~~ruby
1487
+ # load the gem
1488
+ require 'purecloudplatformclientv2'
1489
+ # setup authorization
1490
+ @secret = ENV['PURECLOUD_SECRET']
1491
+ @id = ENV['PURECLOUD_CLIENT_ID']
1492
+ environment = "mypurecloud.com"
1493
+
1494
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1495
+
1496
+ PureCloud.configure do |config|
1497
+ config.access_token = @authToken
1498
+ end
1499
+
1500
+ api_instance = PureCloud::WorkforceManagementApi.new
1501
+
1502
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1503
+
1504
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
1505
+
1506
+ schedule_id = "schedule_id_example" # String | The ID of the schedule to fetch
1507
+
1508
+ opts = {
1509
+ expand: "expand_example", # String | Which fields, if any, to expand
1510
+ force_download_service: true # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
1511
+ }
1512
+
1513
+ begin
1514
+ #Get a week schedule
1515
+ result = api_instance.get_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
1516
+ p result
1517
+ rescue PureCloud::ApiError => e
1518
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_schedule: #{e}"
1519
+ end
1520
+ ~~~
1521
+
1522
+ ### Parameters
1523
+
1524
+ Name | Type | Description | Notes
1525
+ ------------- | ------------- | ------------- | -------------
1526
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1527
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
1528
+ **schedule_id** | **String**| The ID of the schedule to fetch | |
1529
+ **expand** | **String**| Which fields, if any, to expand | [optional] <br />**Values**: generationResults, headcountForecast |
1530
+ **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
1531
+ {: class="table table-striped"}
1532
+
1533
+
1534
+ ### Return type
1535
+
1536
+ [**WeekScheduleResponse**](WeekScheduleResponse.html)
1537
+
1538
+ ### HTTP request headers
1539
+
1540
+ - **Content-Type**: application/json
1541
+ - **Accept**: application/json
1542
+
1543
+
1544
+
1545
+ <a name="get_workforcemanagement_managementunit_week_schedule_generationresults"></a>
1546
+
1547
+ ## -[**WeekScheduleGenerationResult**](WeekScheduleGenerationResult.html) get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id)
1548
+
1549
+
1550
+
1551
+ Get week schedule generation results
1552
+
1553
+
1554
+
1555
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults
1556
+
1557
+ Requires ANY permissions:
1558
+
1559
+ * wfm:schedule:administer
1560
+ * wfm:publishedSchedule:view
1561
+
1562
+
1563
+ ### Example
1564
+ ~~~ruby
1565
+ # load the gem
1566
+ require 'purecloudplatformclientv2'
1567
+ # setup authorization
1568
+ @secret = ENV['PURECLOUD_SECRET']
1569
+ @id = ENV['PURECLOUD_CLIENT_ID']
1570
+ environment = "mypurecloud.com"
1571
+
1572
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1573
+
1574
+ PureCloud.configure do |config|
1575
+ config.access_token = @authToken
1576
+ end
1577
+
1578
+ api_instance = PureCloud::WorkforceManagementApi.new
1579
+
1580
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1581
+
1582
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
1583
+
1584
+ schedule_id = "schedule_id_example" # String | The ID of the schedule to fetch generation results
1585
+
1586
+
1587
+ begin
1588
+ #Get week schedule generation results
1589
+ result = api_instance.get_workforcemanagement_managementunit_week_schedule_generationresults(management_unit_id, week_id, schedule_id)
1590
+ p result
1591
+ rescue PureCloud::ApiError => e
1592
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_schedule_generationresults: #{e}"
1593
+ end
1594
+ ~~~
1595
+
1596
+ ### Parameters
1597
+
1598
+ Name | Type | Description | Notes
1599
+ ------------- | ------------- | ------------- | -------------
1600
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1601
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
1602
+ **schedule_id** | **String**| The ID of the schedule to fetch generation results | |
1603
+ {: class="table table-striped"}
1604
+
1605
+
1606
+ ### Return type
1607
+
1608
+ [**WeekScheduleGenerationResult**](WeekScheduleGenerationResult.html)
1609
+
1610
+ ### HTTP request headers
1611
+
1612
+ - **Content-Type**: application/json
1613
+ - **Accept**: application/json
1614
+
1615
+
1616
+
1617
+ <a name="get_workforcemanagement_managementunit_week_schedules"></a>
1618
+
1619
+ ## -[**WeekScheduleListResponse**](WeekScheduleListResponse.html) get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id)
1620
+
1621
+
1622
+
1623
+ Get the list of schedules in a week in management unit
1624
+
1625
+
1626
+
1627
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules
1628
+
1629
+ Requires ANY permissions:
1630
+
1631
+ * wfm:schedule:administer
1632
+ * wfm:publishedSchedule:view
1633
+
1634
+
1635
+ ### Example
1636
+ ~~~ruby
1637
+ # load the gem
1638
+ require 'purecloudplatformclientv2'
1639
+ # setup authorization
1640
+ @secret = ENV['PURECLOUD_SECRET']
1641
+ @id = ENV['PURECLOUD_CLIENT_ID']
1642
+ environment = "mypurecloud.com"
1643
+
1644
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1645
+
1646
+ PureCloud.configure do |config|
1647
+ config.access_token = @authToken
1648
+ end
1649
+
1650
+ api_instance = PureCloud::WorkforceManagementApi.new
1651
+
1652
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1653
+
1654
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
1655
+
1656
+
1657
+ begin
1658
+ #Get the list of schedules in a week in management unit
1659
+ result = api_instance.get_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id)
1660
+ p result
1661
+ rescue PureCloud::ApiError => e
1662
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_schedules: #{e}"
1663
+ end
1664
+ ~~~
1665
+
1666
+ ### Parameters
1667
+
1668
+ Name | Type | Description | Notes
1669
+ ------------- | ------------- | ------------- | -------------
1670
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1671
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
1672
+ {: class="table table-striped"}
1673
+
1674
+
1675
+ ### Return type
1676
+
1677
+ [**WeekScheduleListResponse**](WeekScheduleListResponse.html)
1678
+
1679
+ ### HTTP request headers
1680
+
1681
+ - **Content-Type**: application/json
1682
+ - **Accept**: application/json
1683
+
1684
+
1685
+
1686
+ <a name="get_workforcemanagement_managementunit_week_shorttermforecast_final"></a>
1687
+
1688
+ ## -[**ForecastResultResponse**](ForecastResultResponse.html) get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
1689
+
1690
+
1691
+
1692
+ Get the final result of a short term forecast calculation with modifications applied
1693
+
1694
+
1695
+
1696
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final
1697
+
1698
+ Requires ANY permissions:
1699
+
1700
+ * wfm:shortTermForecast:administer
1701
+
1702
+
1703
+ ### Example
1704
+ ~~~ruby
1705
+ # load the gem
1706
+ require 'purecloudplatformclientv2'
1707
+ # setup authorization
1708
+ @secret = ENV['PURECLOUD_SECRET']
1709
+ @id = ENV['PURECLOUD_CLIENT_ID']
1710
+ environment = "mypurecloud.com"
1711
+
1712
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1713
+
1714
+ PureCloud.configure do |config|
1715
+ config.access_token = @authToken
1716
+ end
1717
+
1718
+ api_instance = PureCloud::WorkforceManagementApi.new
1719
+
1720
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit to which the forecast belongs
1721
+
1722
+ week_date_id = "week_date_id_example" # String | The week start date of the forecast in yyyy-MM-dd format
1723
+
1724
+ forecast_id = "forecast_id_example" # String | The ID of the forecast
1725
+
1726
+ opts = {
1727
+ force_download_service: true # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
1728
+ }
1729
+
1730
+ begin
1731
+ #Get the final result of a short term forecast calculation with modifications applied
1732
+ result = api_instance.get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
1733
+ p result
1734
+ rescue PureCloud::ApiError => e
1735
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shorttermforecast_final: #{e}"
1736
+ end
1737
+ ~~~
1738
+
1739
+ ### Parameters
1740
+
1741
+ Name | Type | Description | Notes
1742
+ ------------- | ------------- | ------------- | -------------
1743
+ **management_unit_id** | **String**| The management unit ID of the management unit to which the forecast belongs | |
1744
+ **week_date_id** | **String**| The week start date of the forecast in yyyy-MM-dd format | |
1745
+ **forecast_id** | **String**| The ID of the forecast | |
1746
+ **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
1747
+ {: class="table table-striped"}
1748
+
1749
+
1750
+ ### Return type
1751
+
1752
+ [**ForecastResultResponse**](ForecastResultResponse.html)
1753
+
1754
+ ### HTTP request headers
1755
+
1756
+ - **Content-Type**: application/json
1757
+ - **Accept**: application/json
1758
+
1759
+
1760
+
1761
+ <a name="get_workforcemanagement_managementunit_week_shorttermforecasts"></a>
1762
+
1763
+ ## -[**ShortTermForecastListResponse**](ShortTermForecastListResponse.html) get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id)
1764
+
1765
+
1766
+
1767
+ Get short term forecasts
1768
+
1769
+ Use \"recent\" for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date
1770
+
1771
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts
1772
+
1773
+ Requires ANY permissions:
1774
+
1775
+ * wfm:shortTermForecast:administer
1776
+
1777
+
1778
+ ### Example
1779
+ ~~~ruby
1780
+ # load the gem
1781
+ require 'purecloudplatformclientv2'
1782
+ # setup authorization
1783
+ @secret = ENV['PURECLOUD_SECRET']
1784
+ @id = ENV['PURECLOUD_CLIENT_ID']
1785
+ environment = "mypurecloud.com"
1786
+
1787
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1788
+
1789
+ PureCloud.configure do |config|
1790
+ config.access_token = @authToken
1791
+ end
1792
+
1793
+ api_instance = PureCloud::WorkforceManagementApi.new
1794
+
1795
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit to which the forecast belongs
1796
+
1797
+ week_date_id = "week_date_id_example" # String | The week start date of the forecast in yyyy-MM-dd format
1798
+
1799
+
1800
+ begin
1801
+ #Get short term forecasts
1802
+ result = api_instance.get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id)
1803
+ p result
1804
+ rescue PureCloud::ApiError => e
1805
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shorttermforecasts: #{e}"
1806
+ end
1807
+ ~~~
1808
+
1809
+ ### Parameters
1810
+
1811
+ Name | Type | Description | Notes
1812
+ ------------- | ------------- | ------------- | -------------
1813
+ **management_unit_id** | **String**| The management unit ID of the management unit to which the forecast belongs | |
1814
+ **week_date_id** | **String**| The week start date of the forecast in yyyy-MM-dd format | |
1815
+ {: class="table table-striped"}
1816
+
1817
+
1818
+ ### Return type
1819
+
1820
+ [**ShortTermForecastListResponse**](ShortTermForecastListResponse.html)
1821
+
1822
+ ### HTTP request headers
1823
+
1824
+ - **Content-Type**: application/json
1825
+ - **Accept**: application/json
1826
+
1827
+
1828
+
1829
+ <a name="get_workforcemanagement_managementunit_workplan"></a>
1830
+
1831
+ ## -[**WorkPlan**](WorkPlan.html) get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
1832
+
1833
+
1834
+
1835
+ Get a work plan
1836
+
1837
+
1838
+
1839
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
1840
+
1841
+ Requires ANY permissions:
1842
+
1843
+ * wfm:workPlan:administer
1844
+
1845
+
1846
+ ### Example
1847
+ ~~~ruby
1848
+ # load the gem
1849
+ require 'purecloudplatformclientv2'
1850
+ # setup authorization
1851
+ @secret = ENV['PURECLOUD_SECRET']
1852
+ @id = ENV['PURECLOUD_CLIENT_ID']
1853
+ environment = "mypurecloud.com"
1854
+
1855
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1856
+
1857
+ PureCloud.configure do |config|
1858
+ config.access_token = @authToken
1859
+ end
1860
+
1861
+ api_instance = PureCloud::WorkforceManagementApi.new
1862
+
1863
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1864
+
1865
+ work_plan_id = "work_plan_id_example" # String | The ID of the work plan to fetch
1866
+
1867
+
1868
+ begin
1869
+ #Get a work plan
1870
+ result = api_instance.get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id)
1871
+ p result
1872
+ rescue PureCloud::ApiError => e
1873
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplan: #{e}"
1874
+ end
1875
+ ~~~
1876
+
1877
+ ### Parameters
1878
+
1879
+ Name | Type | Description | Notes
1880
+ ------------- | ------------- | ------------- | -------------
1881
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1882
+ **work_plan_id** | **String**| The ID of the work plan to fetch | |
1883
+ {: class="table table-striped"}
1884
+
1885
+
1886
+ ### Return type
1887
+
1888
+ [**WorkPlan**](WorkPlan.html)
1889
+
1890
+ ### HTTP request headers
1891
+
1892
+ - **Content-Type**: application/json
1893
+ - **Accept**: application/json
1894
+
1895
+
1896
+
1897
+ <a name="get_workforcemanagement_managementunit_workplans"></a>
1898
+
1899
+ ## -[**WorkPlanListResponse**](WorkPlanListResponse.html) get_workforcemanagement_managementunit_workplans(management_unit_id, opts)
1900
+
1901
+
1902
+
1903
+ Get work plans
1904
+
1905
+
1906
+
1907
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans
1908
+
1909
+ Requires ANY permissions:
1910
+
1911
+ * wfm:workPlan:administer
1912
+ * wfm:agent:administer
1913
+ * wfm:schedule:administer
1914
+ * wfm:publishedSchedule:view
1915
+
1916
+
1917
+ ### Example
1918
+ ~~~ruby
1919
+ # load the gem
1920
+ require 'purecloudplatformclientv2'
1921
+ # setup authorization
1922
+ @secret = ENV['PURECLOUD_SECRET']
1923
+ @id = ENV['PURECLOUD_CLIENT_ID']
1924
+ environment = "mypurecloud.com"
1925
+
1926
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1927
+
1928
+ PureCloud.configure do |config|
1929
+ config.access_token = @authToken
1930
+ end
1931
+
1932
+ api_instance = PureCloud::WorkforceManagementApi.new
1933
+
1934
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1935
+
1936
+ opts = {
1937
+ expand: "expand_example" # String |
1938
+ }
1939
+
1940
+ begin
1941
+ #Get work plans
1942
+ result = api_instance.get_workforcemanagement_managementunit_workplans(management_unit_id, opts)
1943
+ p result
1944
+ rescue PureCloud::ApiError => e
1945
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplans: #{e}"
1946
+ end
1947
+ ~~~
1948
+
1949
+ ### Parameters
1950
+
1951
+ Name | Type | Description | Notes
1952
+ ------------- | ------------- | ------------- | -------------
1953
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1954
+ **expand** | **String**| | [optional] <br />**Values**: agentCount |
1955
+ {: class="table table-striped"}
1956
+
1957
+
1958
+ ### Return type
1959
+
1960
+ [**WorkPlanListResponse**](WorkPlanListResponse.html)
1961
+
1962
+ ### HTTP request headers
1963
+
1964
+ - **Content-Type**: application/json
1965
+ - **Accept**: application/json
1966
+
1967
+
1968
+
1969
+ <a name="get_workforcemanagement_managementunits"></a>
1970
+
1971
+ ## -[**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits(opts)
1972
+
1973
+
1974
+
1975
+ Get management units
1976
+
1977
+
1978
+
1979
+ Wraps GET /api/v2/workforcemanagement/managementunits
1980
+
1981
+ Requires NO permissions:
1982
+
1983
+
1984
+
1985
+ ### Example
1986
+ ~~~ruby
1987
+ # load the gem
1988
+ require 'purecloudplatformclientv2'
1989
+ # setup authorization
1990
+ @secret = ENV['PURECLOUD_SECRET']
1991
+ @id = ENV['PURECLOUD_CLIENT_ID']
1992
+ environment = "mypurecloud.com"
1993
+
1994
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1995
+
1996
+ PureCloud.configure do |config|
1997
+ config.access_token = @authToken
1998
+ end
1999
+
2000
+ api_instance = PureCloud::WorkforceManagementApi.new
2001
+
2002
+ opts = {
2003
+ page_size: 56, # Integer |
2004
+ page_number: 56, # Integer |
2005
+ expand: "expand_example", # String |
2006
+ feature: "feature_example", # String |
2007
+ division_id: "division_id_example" # String |
2008
+ }
2009
+
2010
+ begin
2011
+ #Get management units
2012
+ result = api_instance.get_workforcemanagement_managementunits(opts)
2013
+ p result
2014
+ rescue PureCloud::ApiError => e
2015
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunits: #{e}"
2016
+ end
2017
+ ~~~
2018
+
2019
+ ### Parameters
2020
+
2021
+ Name | Type | Description | Notes
2022
+ ------------- | ------------- | ------------- | -------------
2023
+ **page_size** | **Integer**| | [optional] |
2024
+ **page_number** | **Integer**| | [optional] |
2025
+ **expand** | **String**| | [optional] <br />**Values**: details |
2026
+ **feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ShortTermForecasts, TimeOffRequests, WorkPlans |
2027
+ **division_id** | **String**| | [optional] |
2028
+ {: class="table table-striped"}
2029
+
2030
+
2031
+ ### Return type
2032
+
2033
+ [**ManagementUnitListing**](ManagementUnitListing.html)
2034
+
2035
+ ### HTTP request headers
2036
+
2037
+ - **Content-Type**: application/json
2038
+ - **Accept**: application/json
2039
+
2040
+
2041
+
2042
+ <a name="get_workforcemanagement_timeoffrequest"></a>
2043
+
2044
+ ## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_timeoffrequest(time_off_request_id)
2045
+
2046
+
2047
+
2048
+ Get a time off request for the current user
2049
+
2050
+
2051
+
2052
+ Wraps GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
2053
+
2054
+ Requires ANY permissions:
2055
+
2056
+ * wfm:agentSchedule:view
2057
+ * wfm:agentTimeOffRequest:submit
2058
+
2059
+
2060
+ ### Example
2061
+ ~~~ruby
2062
+ # load the gem
2063
+ require 'purecloudplatformclientv2'
2064
+ # setup authorization
2065
+ @secret = ENV['PURECLOUD_SECRET']
2066
+ @id = ENV['PURECLOUD_CLIENT_ID']
2067
+ environment = "mypurecloud.com"
2068
+
2069
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2070
+
2071
+ PureCloud.configure do |config|
2072
+ config.access_token = @authToken
2073
+ end
2074
+
2075
+ api_instance = PureCloud::WorkforceManagementApi.new
2076
+
2077
+ time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
2078
+
2079
+
2080
+ begin
2081
+ #Get a time off request for the current user
2082
+ result = api_instance.get_workforcemanagement_timeoffrequest(time_off_request_id)
2083
+ p result
2084
+ rescue PureCloud::ApiError => e
2085
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequest: #{e}"
2086
+ end
2087
+ ~~~
2088
+
2089
+ ### Parameters
2090
+
2091
+ Name | Type | Description | Notes
2092
+ ------------- | ------------- | ------------- | -------------
2093
+ **time_off_request_id** | **String**| Time Off Request Id | |
2094
+ {: class="table table-striped"}
2095
+
2096
+
2097
+ ### Return type
2098
+
2099
+ [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
2100
+
2101
+ ### HTTP request headers
2102
+
2103
+ - **Content-Type**: application/json
2104
+ - **Accept**: application/json
2105
+
2106
+
2107
+
2108
+ <a name="get_workforcemanagement_timeoffrequests"></a>
2109
+
2110
+ ## -[**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_timeoffrequests(opts)
2111
+
2112
+
2113
+
2114
+ Get a list of time off requests for the current user
2115
+
2116
+
2117
+
2118
+ Wraps GET /api/v2/workforcemanagement/timeoffrequests
2119
+
2120
+ Requires ANY permissions:
2121
+
2122
+ * wfm:agentSchedule:view
2123
+ * wfm:agentTimeOffRequest:submit
2124
+
2125
+
2126
+ ### Example
2127
+ ~~~ruby
2128
+ # load the gem
2129
+ require 'purecloudplatformclientv2'
2130
+ # setup authorization
2131
+ @secret = ENV['PURECLOUD_SECRET']
2132
+ @id = ENV['PURECLOUD_CLIENT_ID']
2133
+ environment = "mypurecloud.com"
2134
+
2135
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2136
+
2137
+ PureCloud.configure do |config|
2138
+ config.access_token = @authToken
2139
+ end
2140
+
2141
+ api_instance = PureCloud::WorkforceManagementApi.new
2142
+
2143
+ opts = {
2144
+ recently_reviewed: false # BOOLEAN | Limit results to requests that have been reviewed within the preceding 30 days
2145
+ }
2146
+
2147
+ begin
2148
+ #Get a list of time off requests for the current user
2149
+ result = api_instance.get_workforcemanagement_timeoffrequests(opts)
2150
+ p result
2151
+ rescue PureCloud::ApiError => e
2152
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequests: #{e}"
2153
+ end
2154
+ ~~~
2155
+
2156
+ ### Parameters
2157
+
2158
+ Name | Type | Description | Notes
2159
+ ------------- | ------------- | ------------- | -------------
2160
+ **recently_reviewed** | **BOOLEAN**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] [default to false] |
2161
+ {: class="table table-striped"}
2162
+
2163
+
2164
+ ### Return type
2165
+
2166
+ [**TimeOffRequestList**](TimeOffRequestList.html)
2167
+
2168
+ ### HTTP request headers
2169
+
2170
+ - **Content-Type**: application/json
2171
+ - **Accept**: application/json
2172
+
2173
+
2174
+
2175
+ <a name="patch_workforcemanagement_managementunit_activitycode"></a>
2176
+
2177
+ ## -[**ActivityCode**](ActivityCode.html) patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
2178
+
2179
+
2180
+
2181
+ Update an activity code
2182
+
2183
+
2184
+
2185
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}
2186
+
2187
+ Requires ANY permissions:
2188
+
2189
+ * wfm:activityCode:administer
2190
+
2191
+
2192
+ ### Example
2193
+ ~~~ruby
2194
+ # load the gem
2195
+ require 'purecloudplatformclientv2'
2196
+ # setup authorization
2197
+ @secret = ENV['PURECLOUD_SECRET']
2198
+ @id = ENV['PURECLOUD_CLIENT_ID']
2199
+ environment = "mypurecloud.com"
2200
+
2201
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2202
+
2203
+ PureCloud.configure do |config|
2204
+ config.access_token = @authToken
2205
+ end
2206
+
2207
+ api_instance = PureCloud::WorkforceManagementApi.new
2208
+
2209
+ mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2210
+
2211
+ ac_id = "ac_id_example" # String | The ID of the activity code to update
2212
+
2213
+ opts = {
2214
+ body: PureCloud::UpdateActivityCodeRequest.new # UpdateActivityCodeRequest | body
2215
+ }
2216
+
2217
+ begin
2218
+ #Update an activity code
2219
+ result = api_instance.patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
2220
+ p result
2221
+ rescue PureCloud::ApiError => e
2222
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_activitycode: #{e}"
2223
+ end
2224
+ ~~~
2225
+
2226
+ ### Parameters
2227
+
2228
+ Name | Type | Description | Notes
2229
+ ------------- | ------------- | ------------- | -------------
2230
+ **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2231
+ **ac_id** | **String**| The ID of the activity code to update | |
2232
+ **body** | [**UpdateActivityCodeRequest**](UpdateActivityCodeRequest.html)| body | [optional] |
2233
+ {: class="table table-striped"}
2234
+
2235
+
2236
+ ### Return type
2237
+
2238
+ [**ActivityCode**](ActivityCode.html)
2239
+
2240
+ ### HTTP request headers
2241
+
2242
+ - **Content-Type**: application/json
2243
+ - **Accept**: application/json
2244
+
2245
+
2246
+
2247
+ <a name="patch_workforcemanagement_managementunit_servicegoalgroup"></a>
2248
+
2249
+ ## -[**ServiceGoalGroup**](ServiceGoalGroup.html) patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
2250
+
2251
+
2252
+
2253
+ Update a service goal group
2254
+
2255
+
2256
+
2257
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}
2258
+
2259
+ Requires ANY permissions:
2260
+
2261
+ * wfm:serviceGoalGroup:administer
2262
+
2263
+
2264
+ ### Example
2265
+ ~~~ruby
2266
+ # load the gem
2267
+ require 'purecloudplatformclientv2'
2268
+ # setup authorization
2269
+ @secret = ENV['PURECLOUD_SECRET']
2270
+ @id = ENV['PURECLOUD_CLIENT_ID']
2271
+ environment = "mypurecloud.com"
2272
+
2273
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2274
+
2275
+ PureCloud.configure do |config|
2276
+ config.access_token = @authToken
2277
+ end
2278
+
2279
+ api_instance = PureCloud::WorkforceManagementApi.new
2280
+
2281
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2282
+
2283
+ service_goal_group_id = "service_goal_group_id_example" # String | The ID of the service goal group to update
2284
+
2285
+ opts = {
2286
+ body: PureCloud::ServiceGoalGroup.new # ServiceGoalGroup | body
2287
+ }
2288
+
2289
+ begin
2290
+ #Update a service goal group
2291
+ result = api_instance.patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
2292
+ p result
2293
+ rescue PureCloud::ApiError => e
2294
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_servicegoalgroup: #{e}"
2295
+ end
2296
+ ~~~
2297
+
2298
+ ### Parameters
2299
+
2300
+ Name | Type | Description | Notes
2301
+ ------------- | ------------- | ------------- | -------------
2302
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2303
+ **service_goal_group_id** | **String**| The ID of the service goal group to update | |
2304
+ **body** | [**ServiceGoalGroup**](ServiceGoalGroup.html)| body | [optional] |
2305
+ {: class="table table-striped"}
2306
+
2307
+
2308
+ ### Return type
2309
+
2310
+ [**ServiceGoalGroup**](ServiceGoalGroup.html)
2311
+
2312
+ ### HTTP request headers
2313
+
2314
+ - **Content-Type**: application/json
2315
+ - **Accept**: application/json
2316
+
2317
+
2318
+
2319
+ <a name="patch_workforcemanagement_managementunit_settings"></a>
2320
+
2321
+ ## -[**ManagementUnitSettings**](ManagementUnitSettings.html) patch_workforcemanagement_managementunit_settings(mu_id, opts)
2322
+
2323
+
2324
+
2325
+ Patch the settings for the requested management unit
2326
+
2327
+
2328
+
2329
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/settings
2330
+
2331
+ Requires ANY permissions:
2332
+
2333
+ * wfm:managementUnit:administer
2334
+
2335
+
2336
+ ### Example
2337
+ ~~~ruby
2338
+ # load the gem
2339
+ require 'purecloudplatformclientv2'
2340
+ # setup authorization
2341
+ @secret = ENV['PURECLOUD_SECRET']
2342
+ @id = ENV['PURECLOUD_CLIENT_ID']
2343
+ environment = "mypurecloud.com"
2344
+
2345
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2346
+
2347
+ PureCloud.configure do |config|
2348
+ config.access_token = @authToken
2349
+ end
2350
+
2351
+ api_instance = PureCloud::WorkforceManagementApi.new
2352
+
2353
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
2354
+
2355
+ opts = {
2356
+ body: PureCloud::ManagementUnitSettings.new # ManagementUnitSettings | config
2357
+ }
2358
+
2359
+ begin
2360
+ #Patch the settings for the requested management unit
2361
+ result = api_instance.patch_workforcemanagement_managementunit_settings(mu_id, opts)
2362
+ p result
2363
+ rescue PureCloud::ApiError => e
2364
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_settings: #{e}"
2365
+ end
2366
+ ~~~
2367
+
2368
+ ### Parameters
2369
+
2370
+ Name | Type | Description | Notes
2371
+ ------------- | ------------- | ------------- | -------------
2372
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2373
+ **body** | [**ManagementUnitSettings**](ManagementUnitSettings.html)| config | [optional] |
2374
+ {: class="table table-striped"}
2375
+
2376
+
2377
+ ### Return type
2378
+
2379
+ [**ManagementUnitSettings**](ManagementUnitSettings.html)
2380
+
2381
+ ### HTTP request headers
2382
+
2383
+ - **Content-Type**: application/json
2384
+ - **Accept**: application/json
2385
+
2386
+
2387
+
2388
+ <a name="patch_workforcemanagement_managementunit_user_timeoffrequest"></a>
2389
+
2390
+ ## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
2391
+
2392
+
2393
+
2394
+ Update a time off request
2395
+
2396
+
2397
+
2398
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
2399
+
2400
+ Requires ANY permissions:
2401
+
2402
+ * wfm:timeOffRequest:administer
2403
+
2404
+
2405
+ ### Example
2406
+ ~~~ruby
2407
+ # load the gem
2408
+ require 'purecloudplatformclientv2'
2409
+ # setup authorization
2410
+ @secret = ENV['PURECLOUD_SECRET']
2411
+ @id = ENV['PURECLOUD_CLIENT_ID']
2412
+ environment = "mypurecloud.com"
2413
+
2414
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2415
+
2416
+ PureCloud.configure do |config|
2417
+ config.access_token = @authToken
2418
+ end
2419
+
2420
+ api_instance = PureCloud::WorkforceManagementApi.new
2421
+
2422
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
2423
+
2424
+ user_id = "user_id_example" # String | The id of the user the requested time off request belongs to
2425
+
2426
+ time_off_request_id = "time_off_request_id_example" # String | The id of the time off request to update
2427
+
2428
+ opts = {
2429
+ body: PureCloud::AdminTimeOffRequestPatch.new # AdminTimeOffRequestPatch | body
2430
+ }
2431
+
2432
+ begin
2433
+ #Update a time off request
2434
+ result = api_instance.patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
2435
+ p result
2436
+ rescue PureCloud::ApiError => e
2437
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
2438
+ end
2439
+ ~~~
2440
+
2441
+ ### Parameters
2442
+
2443
+ Name | Type | Description | Notes
2444
+ ------------- | ------------- | ------------- | -------------
2445
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2446
+ **user_id** | **String**| The id of the user the requested time off request belongs to | |
2447
+ **time_off_request_id** | **String**| The id of the time off request to update | |
2448
+ **body** | [**AdminTimeOffRequestPatch**](AdminTimeOffRequestPatch.html)| body | [optional] |
2449
+ {: class="table table-striped"}
2450
+
2451
+
2452
+ ### Return type
2453
+
2454
+ [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
2455
+
2456
+ ### HTTP request headers
2457
+
2458
+ - **Content-Type**: application/json
2459
+ - **Accept**: application/json
2460
+
2461
+
2462
+
2463
+ <a name="patch_workforcemanagement_managementunit_week_schedule"></a>
2464
+
2465
+ ## -[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
2466
+
2467
+
2468
+
2469
+ Update a week schedule
2470
+
2471
+
2472
+
2473
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}
2474
+
2475
+ Requires ANY permissions:
2476
+
2477
+ * wfm:schedule:administer
2478
+
2479
+
2480
+ ### Example
2481
+ ~~~ruby
2482
+ # load the gem
2483
+ require 'purecloudplatformclientv2'
2484
+ # setup authorization
2485
+ @secret = ENV['PURECLOUD_SECRET']
2486
+ @id = ENV['PURECLOUD_CLIENT_ID']
2487
+ environment = "mypurecloud.com"
2488
+
2489
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2490
+
2491
+ PureCloud.configure do |config|
2492
+ config.access_token = @authToken
2493
+ end
2494
+
2495
+ api_instance = PureCloud::WorkforceManagementApi.new
2496
+
2497
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2498
+
2499
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
2500
+
2501
+ schedule_id = "schedule_id_example" # String | The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500
2502
+
2503
+ opts = {
2504
+ force_async: true, # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
2505
+ force_download_service: true, # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
2506
+ body: PureCloud::UpdateWeekScheduleRequest.new # UpdateWeekScheduleRequest | body
2507
+ }
2508
+
2509
+ begin
2510
+ #Update a week schedule
2511
+ result = api_instance.patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
2512
+ p result
2513
+ rescue PureCloud::ApiError => e
2514
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_week_schedule: #{e}"
2515
+ end
2516
+ ~~~
2517
+
2518
+ ### Parameters
2519
+
2520
+ Name | Type | Description | Notes
2521
+ ------------- | ------------- | ------------- | -------------
2522
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2523
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
2524
+ **schedule_id** | **String**| The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500 | |
2525
+ **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
2526
+ **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
2527
+ **body** | [**UpdateWeekScheduleRequest**](UpdateWeekScheduleRequest.html)| body | [optional] |
2528
+ {: class="table table-striped"}
2529
+
2530
+
2531
+ ### Return type
2532
+
2533
+ [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
2534
+
2535
+ ### HTTP request headers
2536
+
2537
+ - **Content-Type**: application/json
2538
+ - **Accept**: application/json
2539
+
2540
+
2541
+
2542
+ <a name="patch_workforcemanagement_managementunit_workplan"></a>
2543
+
2544
+ ## -[**WorkPlan**](WorkPlan.html) patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
2545
+
2546
+
2547
+
2548
+ Update a work plan
2549
+
2550
+
2551
+
2552
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
2553
+
2554
+ Requires ANY permissions:
2555
+
2556
+ * wfm:workPlan:administer
2557
+
2558
+
2559
+ ### Example
2560
+ ~~~ruby
2561
+ # load the gem
2562
+ require 'purecloudplatformclientv2'
2563
+ # setup authorization
2564
+ @secret = ENV['PURECLOUD_SECRET']
2565
+ @id = ENV['PURECLOUD_CLIENT_ID']
2566
+ environment = "mypurecloud.com"
2567
+
2568
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2569
+
2570
+ PureCloud.configure do |config|
2571
+ config.access_token = @authToken
2572
+ end
2573
+
2574
+ api_instance = PureCloud::WorkforceManagementApi.new
2575
+
2576
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2577
+
2578
+ work_plan_id = "work_plan_id_example" # String | The ID of the work plan to update
2579
+
2580
+ opts = {
2581
+ body: PureCloud::WorkPlan.new # WorkPlan | body
2582
+ }
2583
+
2584
+ begin
2585
+ #Update a work plan
2586
+ result = api_instance.patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
2587
+ p result
2588
+ rescue PureCloud::ApiError => e
2589
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_workplan: #{e}"
2590
+ end
2591
+ ~~~
2592
+
2593
+ ### Parameters
2594
+
2595
+ Name | Type | Description | Notes
2596
+ ------------- | ------------- | ------------- | -------------
2597
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2598
+ **work_plan_id** | **String**| The ID of the work plan to update | |
2599
+ **body** | [**WorkPlan**](WorkPlan.html)| body | [optional] |
2600
+ {: class="table table-striped"}
2601
+
2602
+
2603
+ ### Return type
2604
+
2605
+ [**WorkPlan**](WorkPlan.html)
2606
+
2607
+ ### HTTP request headers
2608
+
2609
+ - **Content-Type**: application/json
2610
+ - **Accept**: application/json
2611
+
2612
+
2613
+
2614
+ <a name="patch_workforcemanagement_timeoffrequest"></a>
2615
+
2616
+ ## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
2617
+
2618
+
2619
+
2620
+ Update a time off request for the current user
2621
+
2622
+
2623
+
2624
+ Wraps PATCH /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
2625
+
2626
+ Requires ANY permissions:
2627
+
2628
+ * wfm:agentSchedule:view
2629
+ * wfm:agentTimeOffRequest:submit
2630
+
2631
+
2632
+ ### Example
2633
+ ~~~ruby
2634
+ # load the gem
2635
+ require 'purecloudplatformclientv2'
2636
+ # setup authorization
2637
+ @secret = ENV['PURECLOUD_SECRET']
2638
+ @id = ENV['PURECLOUD_CLIENT_ID']
2639
+ environment = "mypurecloud.com"
2640
+
2641
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2642
+
2643
+ PureCloud.configure do |config|
2644
+ config.access_token = @authToken
2645
+ end
2646
+
2647
+ api_instance = PureCloud::WorkforceManagementApi.new
2648
+
2649
+ time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
2650
+
2651
+ opts = {
2652
+ body: PureCloud::AgentTimeOffRequestPatch.new # AgentTimeOffRequestPatch | body
2653
+ }
2654
+
2655
+ begin
2656
+ #Update a time off request for the current user
2657
+ result = api_instance.patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
2658
+ p result
2659
+ rescue PureCloud::ApiError => e
2660
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_timeoffrequest: #{e}"
2661
+ end
2662
+ ~~~
2663
+
2664
+ ### Parameters
2665
+
2666
+ Name | Type | Description | Notes
2667
+ ------------- | ------------- | ------------- | -------------
2668
+ **time_off_request_id** | **String**| Time Off Request Id | |
2669
+ **body** | [**AgentTimeOffRequestPatch**](AgentTimeOffRequestPatch.html)| body | [optional] |
2670
+ {: class="table table-striped"}
2671
+
2672
+
2673
+ ### Return type
2674
+
2675
+ [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
2676
+
2677
+ ### HTTP request headers
2678
+
2679
+ - **Content-Type**: application/json
2680
+ - **Accept**: application/json
2681
+
2682
+
2683
+
2684
+ <a name="post_workforcemanagement_adherence_historical"></a>
2685
+
2686
+ ## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_adherence_historical(opts)
2687
+
2688
+
2689
+
2690
+ Request a historical adherence report for users across management units
2691
+
2692
+
2693
+
2694
+ Wraps POST /api/v2/workforcemanagement/adherence/historical
2695
+
2696
+ Requires ANY permissions:
2697
+
2698
+ * wfm:historicalAdherence:view
2699
+
2700
+
2701
+ ### Example
2702
+ ~~~ruby
2703
+ # load the gem
2704
+ require 'purecloudplatformclientv2'
2705
+ # setup authorization
2706
+ @secret = ENV['PURECLOUD_SECRET']
2707
+ @id = ENV['PURECLOUD_CLIENT_ID']
2708
+ environment = "mypurecloud.com"
2709
+
2710
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2711
+
2712
+ PureCloud.configure do |config|
2713
+ config.access_token = @authToken
2714
+ end
2715
+
2716
+ api_instance = PureCloud::WorkforceManagementApi.new
2717
+
2718
+ opts = {
2719
+ body: PureCloud::WfmHistoricalAdherenceQueryForUsers.new # WfmHistoricalAdherenceQueryForUsers | body
2720
+ }
2721
+
2722
+ begin
2723
+ #Request a historical adherence report for users across management units
2724
+ result = api_instance.post_workforcemanagement_adherence_historical(opts)
2725
+ p result
2726
+ rescue PureCloud::ApiError => e
2727
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_adherence_historical: #{e}"
2728
+ end
2729
+ ~~~
2730
+
2731
+ ### Parameters
2732
+
2733
+ Name | Type | Description | Notes
2734
+ ------------- | ------------- | ------------- | -------------
2735
+ **body** | [**WfmHistoricalAdherenceQueryForUsers**](WfmHistoricalAdherenceQueryForUsers.html)| body | [optional] |
2736
+ {: class="table table-striped"}
2737
+
2738
+
2739
+ ### Return type
2740
+
2741
+ [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html)
2742
+
2743
+ ### HTTP request headers
2744
+
2745
+ - **Content-Type**: application/json
2746
+ - **Accept**: application/json
2747
+
2748
+
2749
+
2750
+ <a name="post_workforcemanagement_managementunit_activitycodes"></a>
2751
+
2752
+ ## -[**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
2753
+
2754
+
2755
+
2756
+ Create a new activity code
2757
+
2758
+
2759
+
2760
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
2761
+
2762
+ Requires ANY permissions:
2763
+
2764
+ * wfm:activityCode:administer
2765
+
2766
+
2767
+ ### Example
2768
+ ~~~ruby
2769
+ # load the gem
2770
+ require 'purecloudplatformclientv2'
2771
+ # setup authorization
2772
+ @secret = ENV['PURECLOUD_SECRET']
2773
+ @id = ENV['PURECLOUD_CLIENT_ID']
2774
+ environment = "mypurecloud.com"
2775
+
2776
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2777
+
2778
+ PureCloud.configure do |config|
2779
+ config.access_token = @authToken
2780
+ end
2781
+
2782
+ api_instance = PureCloud::WorkforceManagementApi.new
2783
+
2784
+ mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2785
+
2786
+ opts = {
2787
+ body: PureCloud::CreateActivityCodeRequest.new # CreateActivityCodeRequest | body
2788
+ }
2789
+
2790
+ begin
2791
+ #Create a new activity code
2792
+ result = api_instance.post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
2793
+ p result
2794
+ rescue PureCloud::ApiError => e
2795
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_activitycodes: #{e}"
2796
+ end
2797
+ ~~~
2798
+
2799
+ ### Parameters
2800
+
2801
+ Name | Type | Description | Notes
2802
+ ------------- | ------------- | ------------- | -------------
2803
+ **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2804
+ **body** | [**CreateActivityCodeRequest**](CreateActivityCodeRequest.html)| body | [optional] |
2805
+ {: class="table table-striped"}
2806
+
2807
+
2808
+ ### Return type
2809
+
2810
+ [**ActivityCode**](ActivityCode.html)
2811
+
2812
+ ### HTTP request headers
2813
+
2814
+ - **Content-Type**: application/json
2815
+ - **Accept**: application/json
2816
+
2817
+
2818
+
2819
+ <a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
2820
+
2821
+ ## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
2822
+
2823
+
2824
+
2825
+ Request a historical adherence report
2826
+
2827
+ The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
2828
+
2829
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery
2830
+
2831
+ Requires ANY permissions:
2832
+
2833
+ * wfm:historicalAdherence:view
2834
+
2835
+
2836
+ ### Example
2837
+ ~~~ruby
2838
+ # load the gem
2839
+ require 'purecloudplatformclientv2'
2840
+ # setup authorization
2841
+ @secret = ENV['PURECLOUD_SECRET']
2842
+ @id = ENV['PURECLOUD_CLIENT_ID']
2843
+ environment = "mypurecloud.com"
2844
+
2845
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2846
+
2847
+ PureCloud.configure do |config|
2848
+ config.access_token = @authToken
2849
+ end
2850
+
2851
+ api_instance = PureCloud::WorkforceManagementApi.new
2852
+
2853
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit
2854
+
2855
+ opts = {
2856
+ body: PureCloud::WfmHistoricalAdherenceQuery.new # WfmHistoricalAdherenceQuery | body
2857
+ }
2858
+
2859
+ begin
2860
+ #Request a historical adherence report
2861
+ result = api_instance.post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
2862
+ p result
2863
+ rescue PureCloud::ApiError => e
2864
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_historicaladherencequery: #{e}"
2865
+ end
2866
+ ~~~
2867
+
2868
+ ### Parameters
2869
+
2870
+ Name | Type | Description | Notes
2871
+ ------------- | ------------- | ------------- | -------------
2872
+ **mu_id** | **String**| The management unit ID of the management unit | |
2873
+ **body** | [**WfmHistoricalAdherenceQuery**](WfmHistoricalAdherenceQuery.html)| body | [optional] |
2874
+ {: class="table table-striped"}
2875
+
2876
+
2877
+ ### Return type
2878
+
2879
+ [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html)
2880
+
2881
+ ### HTTP request headers
2882
+
2883
+ - **Content-Type**: application/json
2884
+ - **Accept**: application/json
2885
+
2886
+
2887
+
2888
+ <a name="post_workforcemanagement_managementunit_intraday"></a>
2889
+
2890
+ ## -[**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)
2891
+
2892
+
2893
+
2894
+ Get intraday data for the given date for the requested queueIds
2895
+
2896
+
2897
+
2898
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/intraday
2899
+
2900
+ Requires ANY permissions:
2901
+
2902
+ * wfm:intraday:view
2903
+
2904
+
2905
+ ### Example
2906
+ ~~~ruby
2907
+ # load the gem
2908
+ require 'purecloudplatformclientv2'
2909
+ # setup authorization
2910
+ @secret = ENV['PURECLOUD_SECRET']
2911
+ @id = ENV['PURECLOUD_CLIENT_ID']
2912
+ environment = "mypurecloud.com"
2913
+
2914
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2915
+
2916
+ PureCloud.configure do |config|
2917
+ config.access_token = @authToken
2918
+ end
2919
+
2920
+ api_instance = PureCloud::WorkforceManagementApi.new
2921
+
2922
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit
2923
+
2924
+ opts = {
2925
+ body: PureCloud::IntradayQueryDataCommand.new # IntradayQueryDataCommand | body
2926
+ }
2927
+
2928
+ begin
2929
+ #Get intraday data for the given date for the requested queueIds
2930
+ result = api_instance.post_workforcemanagement_managementunit_intraday(mu_id, opts)
2931
+ p result
2932
+ rescue PureCloud::ApiError => e
2933
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_intraday: #{e}"
2934
+ end
2935
+ ~~~
2936
+
2937
+ ### Parameters
2938
+
2939
+ Name | Type | Description | Notes
2940
+ ------------- | ------------- | ------------- | -------------
2941
+ **mu_id** | **String**| The management unit ID of the management unit | |
2942
+ **body** | [**IntradayQueryDataCommand**](IntradayQueryDataCommand.html)| body | [optional] |
2943
+ {: class="table table-striped"}
2944
+
2945
+
2946
+ ### Return type
2947
+
2948
+ [**IntradayResponse**](IntradayResponse.html)
2949
+
2950
+ ### HTTP request headers
2951
+
2952
+ - **Content-Type**: application/json
2953
+ - **Accept**: application/json
2954
+
2955
+
2956
+
2957
+ <a name="post_workforcemanagement_managementunit_schedules_search"></a>
2958
+
2959
+ ## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
2960
+
2961
+
2962
+
2963
+ Query published schedules for given given time range for set of users
2964
+
2965
+
2966
+
2967
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search
2968
+
2969
+ Requires ANY permissions:
2970
+
2971
+ * wfm:schedule:administer
2972
+ * wfm:publishedSchedule:view
2973
+
2974
+
2975
+ ### Example
2976
+ ~~~ruby
2977
+ # load the gem
2978
+ require 'purecloudplatformclientv2'
2979
+ # setup authorization
2980
+ @secret = ENV['PURECLOUD_SECRET']
2981
+ @id = ENV['PURECLOUD_CLIENT_ID']
2982
+ environment = "mypurecloud.com"
2983
+
2984
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2985
+
2986
+ PureCloud.configure do |config|
2987
+ config.access_token = @authToken
2988
+ end
2989
+
2990
+ api_instance = PureCloud::WorkforceManagementApi.new
2991
+
2992
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
2993
+
2994
+ opts = {
2995
+ body: PureCloud::UserListScheduleRequestBody.new # UserListScheduleRequestBody | body
2996
+ }
2997
+
2998
+ begin
2999
+ #Query published schedules for given given time range for set of users
3000
+ result = api_instance.post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
3001
+ p result
3002
+ rescue PureCloud::ApiError => e
3003
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_schedules_search: #{e}"
3004
+ end
3005
+ ~~~
3006
+
3007
+ ### Parameters
3008
+
3009
+ Name | Type | Description | Notes
3010
+ ------------- | ------------- | ------------- | -------------
3011
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3012
+ **body** | [**UserListScheduleRequestBody**](UserListScheduleRequestBody.html)| body | [optional] |
3013
+ {: class="table table-striped"}
3014
+
3015
+
3016
+ ### Return type
3017
+
3018
+ [**UserScheduleContainer**](UserScheduleContainer.html)
3019
+
3020
+ ### HTTP request headers
3021
+
3022
+ - **Content-Type**: application/json
3023
+ - **Accept**: application/json
3024
+
3025
+
3026
+
3027
+ <a name="post_workforcemanagement_managementunit_servicegoalgroups"></a>
3028
+
3029
+ ## -[**ServiceGoalGroup**](ServiceGoalGroup.html) post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
3030
+
3031
+
3032
+
3033
+ Create a new service goal group
3034
+
3035
+
3036
+
3037
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups
3038
+
3039
+ Requires ANY permissions:
3040
+
3041
+ * wfm:serviceGoalGroup:administer
3042
+
3043
+
3044
+ ### Example
3045
+ ~~~ruby
3046
+ # load the gem
3047
+ require 'purecloudplatformclientv2'
3048
+ # setup authorization
3049
+ @secret = ENV['PURECLOUD_SECRET']
3050
+ @id = ENV['PURECLOUD_CLIENT_ID']
3051
+ environment = "mypurecloud.com"
3052
+
3053
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3054
+
3055
+ PureCloud.configure do |config|
3056
+ config.access_token = @authToken
3057
+ end
3058
+
3059
+ api_instance = PureCloud::WorkforceManagementApi.new
3060
+
3061
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3062
+
3063
+ opts = {
3064
+ body: PureCloud::CreateServiceGoalGroupRequest.new # CreateServiceGoalGroupRequest | body
3065
+ }
3066
+
3067
+ begin
3068
+ #Create a new service goal group
3069
+ result = api_instance.post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
3070
+ p result
3071
+ rescue PureCloud::ApiError => e
3072
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_servicegoalgroups: #{e}"
3073
+ end
3074
+ ~~~
3075
+
3076
+ ### Parameters
3077
+
3078
+ Name | Type | Description | Notes
3079
+ ------------- | ------------- | ------------- | -------------
3080
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3081
+ **body** | [**CreateServiceGoalGroupRequest**](CreateServiceGoalGroupRequest.html)| body | [optional] |
3082
+ {: class="table table-striped"}
3083
+
3084
+
3085
+ ### Return type
3086
+
3087
+ [**ServiceGoalGroup**](ServiceGoalGroup.html)
3088
+
3089
+ ### HTTP request headers
3090
+
3091
+ - **Content-Type**: application/json
3092
+ - **Accept**: application/json
3093
+
3094
+
3095
+
3096
+ <a name="post_workforcemanagement_managementunit_timeoffrequests"></a>
3097
+
3098
+ ## -[**TimeOffRequestList**](TimeOffRequestList.html) post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
3099
+
3100
+
3101
+
3102
+ Create a new time off request
3103
+
3104
+
3105
+
3106
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests
3107
+
3108
+ Requires ANY permissions:
3109
+
3110
+ * wfm:timeOffRequest:administer
3111
+
3112
+
3113
+ ### Example
3114
+ ~~~ruby
3115
+ # load the gem
3116
+ require 'purecloudplatformclientv2'
3117
+ # setup authorization
3118
+ @secret = ENV['PURECLOUD_SECRET']
3119
+ @id = ENV['PURECLOUD_CLIENT_ID']
3120
+ environment = "mypurecloud.com"
3121
+
3122
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3123
+
3124
+ PureCloud.configure do |config|
3125
+ config.access_token = @authToken
3126
+ end
3127
+
3128
+ api_instance = PureCloud::WorkforceManagementApi.new
3129
+
3130
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3131
+
3132
+ opts = {
3133
+ body: PureCloud::CreateAdminTimeOffRequest.new # CreateAdminTimeOffRequest | body
3134
+ }
3135
+
3136
+ begin
3137
+ #Create a new time off request
3138
+ result = api_instance.post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
3139
+ p result
3140
+ rescue PureCloud::ApiError => e
3141
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests: #{e}"
3142
+ end
3143
+ ~~~
3144
+
3145
+ ### Parameters
3146
+
3147
+ Name | Type | Description | Notes
3148
+ ------------- | ------------- | ------------- | -------------
3149
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3150
+ **body** | [**CreateAdminTimeOffRequest**](CreateAdminTimeOffRequest.html)| body | [optional] |
3151
+ {: class="table table-striped"}
3152
+
3153
+
3154
+ ### Return type
3155
+
3156
+ [**TimeOffRequestList**](TimeOffRequestList.html)
3157
+
3158
+ ### HTTP request headers
3159
+
3160
+ - **Content-Type**: application/json
3161
+ - **Accept**: application/json
3162
+
3163
+
3164
+
3165
+ <a name="post_workforcemanagement_managementunit_timeoffrequests_fetchdetails"></a>
3166
+
3167
+ ## -[**TimeOffRequestEntityList**](TimeOffRequestEntityList.html) post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
3168
+
3169
+
3170
+
3171
+ Gets a list of time off requests from lookup ids
3172
+
3173
+
3174
+
3175
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails
3176
+
3177
+ Requires ANY permissions:
3178
+
3179
+ * wfm:timeOffRequest:administer
3180
+
3181
+
3182
+ ### Example
3183
+ ~~~ruby
3184
+ # load the gem
3185
+ require 'purecloudplatformclientv2'
3186
+ # setup authorization
3187
+ @secret = ENV['PURECLOUD_SECRET']
3188
+ @id = ENV['PURECLOUD_CLIENT_ID']
3189
+ environment = "mypurecloud.com"
3190
+
3191
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3192
+
3193
+ PureCloud.configure do |config|
3194
+ config.access_token = @authToken
3195
+ end
3196
+
3197
+ api_instance = PureCloud::WorkforceManagementApi.new
3198
+
3199
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3200
+
3201
+ opts = {
3202
+ body: PureCloud::TimeOffRequestLookupList.new # TimeOffRequestLookupList | body
3203
+ }
3204
+
3205
+ begin
3206
+ #Gets a list of time off requests from lookup ids
3207
+ result = api_instance.post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
3208
+ p result
3209
+ rescue PureCloud::ApiError => e
3210
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_fetchdetails: #{e}"
3211
+ end
3212
+ ~~~
3213
+
3214
+ ### Parameters
3215
+
3216
+ Name | Type | Description | Notes
3217
+ ------------- | ------------- | ------------- | -------------
3218
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3219
+ **body** | [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html)| body | [optional] |
3220
+ {: class="table table-striped"}
3221
+
3222
+
3223
+ ### Return type
3224
+
3225
+ [**TimeOffRequestEntityList**](TimeOffRequestEntityList.html)
3226
+
3227
+ ### HTTP request headers
3228
+
3229
+ - **Content-Type**: application/json
3230
+ - **Accept**: application/json
3231
+
3232
+
3233
+
3234
+ <a name="post_workforcemanagement_managementunit_timeoffrequests_query"></a>
3235
+
3236
+ ## -[**TimeOffRequestLookupList**](TimeOffRequestLookupList.html) post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
3237
+
3238
+
3239
+
3240
+ Gets the lookup ids to fetch the specified set of requests
3241
+
3242
+
3243
+
3244
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/query
3245
+
3246
+ Requires ANY permissions:
3247
+
3248
+ * wfm:timeOffRequest:administer
3249
+
3250
+
3251
+ ### Example
3252
+ ~~~ruby
3253
+ # load the gem
3254
+ require 'purecloudplatformclientv2'
3255
+ # setup authorization
3256
+ @secret = ENV['PURECLOUD_SECRET']
3257
+ @id = ENV['PURECLOUD_CLIENT_ID']
3258
+ environment = "mypurecloud.com"
3259
+
3260
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3261
+
3262
+ PureCloud.configure do |config|
3263
+ config.access_token = @authToken
3264
+ end
3265
+
3266
+ api_instance = PureCloud::WorkforceManagementApi.new
3267
+
3268
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3269
+
3270
+ opts = {
3271
+ body: PureCloud::TimeOffRequestQueryBody.new # TimeOffRequestQueryBody | body
3272
+ }
3273
+
3274
+ begin
3275
+ #Gets the lookup ids to fetch the specified set of requests
3276
+ result = api_instance.post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
3277
+ p result
3278
+ rescue PureCloud::ApiError => e
3279
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_query: #{e}"
3280
+ end
3281
+ ~~~
3282
+
3283
+ ### Parameters
3284
+
3285
+ Name | Type | Description | Notes
3286
+ ------------- | ------------- | ------------- | -------------
3287
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3288
+ **body** | [**TimeOffRequestQueryBody**](TimeOffRequestQueryBody.html)| body | [optional] |
3289
+ {: class="table table-striped"}
3290
+
3291
+
3292
+ ### Return type
3293
+
3294
+ [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html)
3295
+
3296
+ ### HTTP request headers
3297
+
3298
+ - **Content-Type**: application/json
3299
+ - **Accept**: application/json
3300
+
3301
+
3302
+
3303
+ <a name="post_workforcemanagement_managementunit_week_schedule_copy"></a>
3304
+
3305
+ ## -[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
3306
+
3307
+
3308
+
3309
+ Copy a week schedule
3310
+
3311
+
3312
+
3313
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy
3314
+
3315
+ Requires ANY permissions:
3316
+
3317
+ * wfm:schedule:administer
3318
+
3319
+
3320
+ ### Example
3321
+ ~~~ruby
3322
+ # load the gem
3323
+ require 'purecloudplatformclientv2'
3324
+ # setup authorization
3325
+ @secret = ENV['PURECLOUD_SECRET']
3326
+ @id = ENV['PURECLOUD_CLIENT_ID']
3327
+ environment = "mypurecloud.com"
3328
+
3329
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
28
3330
 
3331
+ PureCloud.configure do |config|
3332
+ config.access_token = @authToken
3333
+ end
29
3334
 
3335
+ api_instance = PureCloud::WorkforceManagementApi.new
30
3336
 
31
- Get a list of UserScheduleAdherence records for the requested users
3337
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
32
3338
 
3339
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
33
3340
 
3341
+ schedule_id = "schedule_id_example" # String | The ID of the schedule to copy from
34
3342
 
35
- Wraps GET /api/v2/workforcemanagement/adherence
3343
+ opts = {
3344
+ force_async: true, # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
3345
+ force_download_service: true, # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
3346
+ body: PureCloud::CopyWeekScheduleRequest.new # CopyWeekScheduleRequest | body
3347
+ }
3348
+
3349
+ begin
3350
+ #Copy a week schedule
3351
+ result = api_instance.post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
3352
+ p result
3353
+ rescue PureCloud::ApiError => e
3354
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_copy: #{e}"
3355
+ end
3356
+ ~~~
3357
+
3358
+ ### Parameters
3359
+
3360
+ Name | Type | Description | Notes
3361
+ ------------- | ------------- | ------------- | -------------
3362
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3363
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
3364
+ **schedule_id** | **String**| The ID of the schedule to copy from | |
3365
+ **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
3366
+ **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
3367
+ **body** | [**CopyWeekScheduleRequest**](CopyWeekScheduleRequest.html)| body | [optional] |
3368
+ {: class="table table-striped"}
3369
+
3370
+
3371
+ ### Return type
3372
+
3373
+ [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
3374
+
3375
+ ### HTTP request headers
3376
+
3377
+ - **Content-Type**: application/json
3378
+ - **Accept**: application/json
3379
+
3380
+
3381
+
3382
+ <a name="post_workforcemanagement_managementunit_week_schedules"></a>
3383
+
3384
+ ## -[**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
3385
+
3386
+
3387
+
3388
+ Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500
3389
+
3390
+
3391
+
3392
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules
36
3393
 
37
3394
  Requires ANY permissions:
38
3395
 
39
- * wfm:realtimeAdherence:view
3396
+ * wfm:schedule:administer
40
3397
 
41
3398
 
42
3399
  ### Example
@@ -56,15 +3413,22 @@ end
56
3413
 
57
3414
  api_instance = PureCloud::WorkforceManagementApi.new
58
3415
 
59
- user_id = ["user_id_example"] # Array<String> | User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request
3416
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3417
+
3418
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
60
3419
 
3420
+ opts = {
3421
+ force_async: true, # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
3422
+ force_download_service: true, # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
3423
+ body: PureCloud::ImportWeekScheduleRequest.new # ImportWeekScheduleRequest | body
3424
+ }
61
3425
 
62
3426
  begin
63
- #Get a list of UserScheduleAdherence records for the requested users
64
- result = api_instance.get_workforcemanagement_adherence(user_id)
3427
+ #Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500
3428
+ result = api_instance.post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
65
3429
  p result
66
3430
  rescue PureCloud::ApiError => e
67
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_adherence: #{e}"
3431
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules: #{e}"
68
3432
  end
69
3433
  ~~~
70
3434
 
@@ -72,13 +3436,17 @@ end
72
3436
 
73
3437
  Name | Type | Description | Notes
74
3438
  ------------- | ------------- | ------------- | -------------
75
- **user_id** | [**Array&lt;String&gt;**](String.html)| User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request | |
3439
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3440
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
3441
+ **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
3442
+ **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
3443
+ **body** | [**ImportWeekScheduleRequest**](ImportWeekScheduleRequest.html)| body | [optional] |
76
3444
  {: class="table table-striped"}
77
3445
 
78
3446
 
79
3447
  ### Return type
80
3448
 
81
- [**Array&lt;UserScheduleAdherence&gt;**](UserScheduleAdherence.html)
3449
+ [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
82
3450
 
83
3451
  ### HTTP request headers
84
3452
 
@@ -87,35 +3455,21 @@ Name | Type | Description | Notes
87
3455
 
88
3456
 
89
3457
 
90
- <a name="get_workforcemanagement_managementunit_activitycodes"></a>
3458
+ <a name="post_workforcemanagement_managementunit_week_schedules_generate"></a>
91
3459
 
92
- ## -[**ActivityCodeContainer**](ActivityCodeContainer.html) get_workforcemanagement_managementunit_activitycodes(mu_id)
3460
+ ## -[**GenerateWeekScheduleResponse**](GenerateWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
93
3461
 
94
3462
 
95
3463
 
96
- Get activity codes
3464
+ Generate a week schedule
97
3465
 
98
3466
 
99
3467
 
100
- Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
3468
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate
101
3469
 
102
3470
  Requires ANY permissions:
103
3471
 
104
- * wfm:activityCode:administer
105
- * wfm:agent:administer
106
- * wfm:agentSchedule:view
107
- * wfm:historicalAdherence:view
108
- * wfm:intraday:view
109
- * wfm:managementUnit:administer
110
- * wfm:publishedSchedule:view
111
- * wfm:realtimeAdherence:view
112
- * wfm:schedule:administer
113
3472
  * wfm:schedule:generate
114
- * wfm:serviceGoalGroup:administer
115
- * wfm:shortTermForecast:administer
116
- * wfm:agentTimeOffRequest:submit
117
- * wfm:timeOffRequest:administer
118
- * wfm:workPlan:administer
119
3473
 
120
3474
 
121
3475
  ### Example
@@ -135,15 +3489,20 @@ end
135
3489
 
136
3490
  api_instance = PureCloud::WorkforceManagementApi.new
137
3491
 
138
- mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3492
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
139
3493
 
3494
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
3495
+
3496
+ opts = {
3497
+ body: PureCloud::GenerateWeekScheduleRequest.new # GenerateWeekScheduleRequest | body
3498
+ }
140
3499
 
141
3500
  begin
142
- #Get activity codes
143
- result = api_instance.get_workforcemanagement_managementunit_activitycodes(mu_id)
3501
+ #Generate a week schedule
3502
+ result = api_instance.post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
144
3503
  p result
145
3504
  rescue PureCloud::ApiError => e
146
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_activitycodes: #{e}"
3505
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_generate: #{e}"
147
3506
  end
148
3507
  ~~~
149
3508
 
@@ -151,13 +3510,15 @@ end
151
3510
 
152
3511
  Name | Type | Description | Notes
153
3512
  ------------- | ------------- | ------------- | -------------
154
- **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3513
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3514
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
3515
+ **body** | [**GenerateWeekScheduleRequest**](GenerateWeekScheduleRequest.html)| body | [optional] |
155
3516
  {: class="table table-striped"}
156
3517
 
157
3518
 
158
3519
  ### Return type
159
3520
 
160
- [**ActivityCodeContainer**](ActivityCodeContainer.html)
3521
+ [**GenerateWeekScheduleResponse**](GenerateWeekScheduleResponse.html)
161
3522
 
162
3523
  ### HTTP request headers
163
3524
 
@@ -166,21 +3527,21 @@ Name | Type | Description | Notes
166
3527
 
167
3528
 
168
3529
 
169
- <a name="get_workforcemanagement_managementunit_intraday_queues"></a>
3530
+ <a name="post_workforcemanagement_managementunit_week_schedules_partialupload"></a>
170
3531
 
171
- ## -[**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
3532
+ ## -[**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
172
3533
 
173
3534
 
174
3535
 
175
- Get intraday queues for the given date
3536
+ Partial upload of user schedules where activity count is greater than 17500
176
3537
 
177
3538
 
178
3539
 
179
- Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/intraday/queues
3540
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload
180
3541
 
181
3542
  Requires ANY permissions:
182
3543
 
183
- * wfm:intraday:view
3544
+ * wfm:schedule:administer
184
3545
 
185
3546
 
186
3547
  ### Example
@@ -200,17 +3561,20 @@ end
200
3561
 
201
3562
  api_instance = PureCloud::WorkforceManagementApi.new
202
3563
 
203
- mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3564
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
204
3565
 
205
- date = "date_example" # String | ISO-8601 date string with no time or timezone component, interpreted in the configured management unit time zone, e.g. 2017-01-23
3566
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
206
3567
 
3568
+ opts = {
3569
+ body: PureCloud::UserSchedulesPartialUploadRequest.new # UserSchedulesPartialUploadRequest | body
3570
+ }
207
3571
 
208
3572
  begin
209
- #Get intraday queues for the given date
210
- result = api_instance.get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
3573
+ #Partial upload of user schedules where activity count is greater than 17500
3574
+ result = api_instance.post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
211
3575
  p result
212
3576
  rescue PureCloud::ApiError => e
213
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_intraday_queues: #{e}"
3577
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_partialupload: #{e}"
214
3578
  end
215
3579
  ~~~
216
3580
 
@@ -218,14 +3582,15 @@ end
218
3582
 
219
3583
  Name | Type | Description | Notes
220
3584
  ------------- | ------------- | ------------- | -------------
221
- **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
222
- **date** | **String**| ISO-8601 date string with no time or timezone component, interpreted in the configured management unit time zone, e.g. 2017-01-23 | |
3585
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3586
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
3587
+ **body** | [**UserSchedulesPartialUploadRequest**](UserSchedulesPartialUploadRequest.html)| body | [optional] |
223
3588
  {: class="table table-striped"}
224
3589
 
225
3590
 
226
3591
  ### Return type
227
3592
 
228
- [**WfmIntradayQueueListing**](WfmIntradayQueueListing.html)
3593
+ [**PartialUploadResponse**](PartialUploadResponse.html)
229
3594
 
230
3595
  ### HTTP request headers
231
3596
 
@@ -234,21 +3599,21 @@ Name | Type | Description | Notes
234
3599
 
235
3600
 
236
3601
 
237
- <a name="get_workforcemanagement_managementunit_user_timeoffrequest"></a>
3602
+ <a name="post_workforcemanagement_managementunit_week_shorttermforecast_copy"></a>
238
3603
 
239
- ## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
3604
+ ## -[**ShortTermForecastResponse**](ShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, body, opts)
240
3605
 
241
3606
 
242
3607
 
243
- Get a time off request
3608
+ Copy a short term forecast
244
3609
 
245
3610
 
246
3611
 
247
- Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
3612
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy
248
3613
 
249
3614
  Requires ANY permissions:
250
3615
 
251
- * wfm:timeOffRequest:administer
3616
+ * wfm:shortTermForecast:administer
252
3617
 
253
3618
 
254
3619
  ### Example
@@ -268,19 +3633,24 @@ end
268
3633
 
269
3634
  api_instance = PureCloud::WorkforceManagementApi.new
270
3635
 
271
- mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3636
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit to which the forecast belongs
272
3637
 
273
- user_id = "user_id_example" # String | The userId to whom the Time Off Request applies.
3638
+ week_date_id = "week_date_id_example" # String | The week start date of the forecast in yyyy-MM-dd format
274
3639
 
275
- time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
3640
+ forecast_id = "forecast_id_example" # String | The ID of the forecast to copy
3641
+
3642
+ body = PureCloud::CopyShortTermForecastRequest.new # CopyShortTermForecastRequest | body
276
3643
 
3644
+ opts = {
3645
+ force_async: true # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
3646
+ }
277
3647
 
278
3648
  begin
279
- #Get a time off request
280
- result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
3649
+ #Copy a short term forecast
3650
+ result = api_instance.post_workforcemanagement_managementunit_week_shorttermforecast_copy(management_unit_id, week_date_id, forecast_id, body, opts)
281
3651
  p result
282
3652
  rescue PureCloud::ApiError => e
283
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
3653
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecast_copy: #{e}"
284
3654
  end
285
3655
  ~~~
286
3656
 
@@ -288,15 +3658,17 @@ end
288
3658
 
289
3659
  Name | Type | Description | Notes
290
3660
  ------------- | ------------- | ------------- | -------------
291
- **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
292
- **user_id** | **String**| The userId to whom the Time Off Request applies. | |
293
- **time_off_request_id** | **String**| Time Off Request Id | |
3661
+ **management_unit_id** | **String**| The management unit ID of the management unit to which the forecast belongs | |
3662
+ **week_date_id** | **String**| The week start date of the forecast in yyyy-MM-dd format | |
3663
+ **forecast_id** | **String**| The ID of the forecast to copy | |
3664
+ **body** | [**CopyShortTermForecastRequest**](CopyShortTermForecastRequest.html)| body | |
3665
+ **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
294
3666
  {: class="table table-striped"}
295
3667
 
296
3668
 
297
3669
  ### Return type
298
3670
 
299
- [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
3671
+ [**ShortTermForecastResponse**](ShortTermForecastResponse.html)
300
3672
 
301
3673
  ### HTTP request headers
302
3674
 
@@ -305,21 +3677,21 @@ Name | Type | Description | Notes
305
3677
 
306
3678
 
307
3679
 
308
- <a name="get_workforcemanagement_managementunit_user_timeoffrequests"></a>
3680
+ <a name="post_workforcemanagement_managementunit_week_shorttermforecasts"></a>
309
3681
 
310
- ## -[**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
3682
+ ## -[**ShortTermForecastResponse**](ShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, body, opts)
311
3683
 
312
3684
 
313
3685
 
314
- Get a list of time off requests for a given user
3686
+ Import a short term forecast
315
3687
 
316
3688
 
317
3689
 
318
- Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests
3690
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts
319
3691
 
320
3692
  Requires ANY permissions:
321
3693
 
322
- * wfm:timeOffRequest:administer
3694
+ * wfm:shortTermForecast:administer
323
3695
 
324
3696
 
325
3697
  ### Example
@@ -339,20 +3711,22 @@ end
339
3711
 
340
3712
  api_instance = PureCloud::WorkforceManagementApi.new
341
3713
 
342
- mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3714
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit to which the forecast belongs
343
3715
 
344
- user_id = "user_id_example" # String | The userId to whom the Time Off Request applies.
3716
+ week_date_id = "week_date_id_example" # String | The week start date of the forecast in yyyy-MM-dd format
3717
+
3718
+ body = PureCloud::ImportShortTermForecastRequest.new # ImportShortTermForecastRequest | body
345
3719
 
346
3720
  opts = {
347
- recently_reviewed: false # BOOLEAN | Limit results to requests that have been reviewed within the preceding 30 days
3721
+ force_async: true # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
348
3722
  }
349
3723
 
350
3724
  begin
351
- #Get a list of time off requests for a given user
352
- result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
3725
+ #Import a short term forecast
3726
+ result = api_instance.post_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id, body, opts)
353
3727
  p result
354
3728
  rescue PureCloud::ApiError => e
355
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequests: #{e}"
3729
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecasts: #{e}"
356
3730
  end
357
3731
  ~~~
358
3732
 
@@ -360,15 +3734,16 @@ end
360
3734
 
361
3735
  Name | Type | Description | Notes
362
3736
  ------------- | ------------- | ------------- | -------------
363
- **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
364
- **user_id** | **String**| The userId to whom the Time Off Request applies. | |
365
- **recently_reviewed** | **BOOLEAN**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] [default to false] |
3737
+ **management_unit_id** | **String**| The management unit ID of the management unit to which the forecast belongs | |
3738
+ **week_date_id** | **String**| The week start date of the forecast in yyyy-MM-dd format | |
3739
+ **body** | [**ImportShortTermForecastRequest**](ImportShortTermForecastRequest.html)| body | |
3740
+ **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
366
3741
  {: class="table table-striped"}
367
3742
 
368
3743
 
369
3744
  ### Return type
370
3745
 
371
- [**TimeOffRequestList**](TimeOffRequestList.html)
3746
+ [**ShortTermForecastResponse**](ShortTermForecastResponse.html)
372
3747
 
373
3748
  ### HTTP request headers
374
3749
 
@@ -377,24 +3752,21 @@ Name | Type | Description | Notes
377
3752
 
378
3753
 
379
3754
 
380
- <a name="get_workforcemanagement_managementunit_users"></a>
3755
+ <a name="post_workforcemanagement_managementunit_week_shorttermforecasts_generate"></a>
381
3756
 
382
- ## -[**WfmUserEntityListing**](WfmUserEntityListing.html) get_workforcemanagement_managementunit_users(mu_id)
3757
+ ## -[**GenerateShortTermForecastResponse**](GenerateShortTermForecastResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, body, opts)
383
3758
 
384
3759
 
385
3760
 
386
- Get agents in the management unit
3761
+ Generate a short term forecast
387
3762
 
388
3763
 
389
3764
 
390
- Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users
3765
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/generate
391
3766
 
392
3767
  Requires ANY permissions:
393
3768
 
394
- * wfm:agent:administer
395
- * wfm:timeOffRequest:administer
396
- * wfm:realtimeAdherence:view
397
- * wfm:historicalAdherence:view
3769
+ * wfm:shortTermForecast:administer
398
3770
 
399
3771
 
400
3772
  ### Example
@@ -414,15 +3786,22 @@ end
414
3786
 
415
3787
  api_instance = PureCloud::WorkforceManagementApi.new
416
3788
 
417
- mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3789
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit to which the forecast belongs
3790
+
3791
+ week_date_id = "week_date_id_example" # String | The week start date of the forecast in yyyy-MM-dd format
418
3792
 
3793
+ body = PureCloud::GenerateShortTermForecastRequest.new # GenerateShortTermForecastRequest |
3794
+
3795
+ opts = {
3796
+ force_async: true # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
3797
+ }
419
3798
 
420
3799
  begin
421
- #Get agents in the management unit
422
- result = api_instance.get_workforcemanagement_managementunit_users(mu_id)
3800
+ #Generate a short term forecast
3801
+ result = api_instance.post_workforcemanagement_managementunit_week_shorttermforecasts_generate(management_unit_id, week_date_id, body, opts)
423
3802
  p result
424
3803
  rescue PureCloud::ApiError => e
425
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_users: #{e}"
3804
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecasts_generate: #{e}"
426
3805
  end
427
3806
  ~~~
428
3807
 
@@ -430,13 +3809,16 @@ end
430
3809
 
431
3810
  Name | Type | Description | Notes
432
3811
  ------------- | ------------- | ------------- | -------------
433
- **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3812
+ **management_unit_id** | **String**| The management unit ID of the management unit to which the forecast belongs | |
3813
+ **week_date_id** | **String**| The week start date of the forecast in yyyy-MM-dd format | |
3814
+ **body** | [**GenerateShortTermForecastRequest**](GenerateShortTermForecastRequest.html)| | |
3815
+ **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
434
3816
  {: class="table table-striped"}
435
3817
 
436
3818
 
437
3819
  ### Return type
438
3820
 
439
- [**WfmUserEntityListing**](WfmUserEntityListing.html)
3821
+ [**GenerateShortTermForecastResponse**](GenerateShortTermForecastResponse.html)
440
3822
 
441
3823
  ### HTTP request headers
442
3824
 
@@ -445,20 +3827,21 @@ Name | Type | Description | Notes
445
3827
 
446
3828
 
447
3829
 
448
- <a name="get_workforcemanagement_managementunits"></a>
3830
+ <a name="post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload"></a>
449
3831
 
450
- ## -[**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits(opts)
3832
+ ## -[**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, body)
451
3833
 
452
3834
 
453
3835
 
454
- Get management units
3836
+ Import a short term forecast
455
3837
 
456
3838
 
457
3839
 
458
- Wraps GET /api/v2/workforcemanagement/managementunits
3840
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/partialupload
459
3841
 
460
- Requires NO permissions:
3842
+ Requires ANY permissions:
461
3843
 
3844
+ * wfm:shortTermForecast:administer
462
3845
 
463
3846
 
464
3847
  ### Example
@@ -478,20 +3861,19 @@ end
478
3861
 
479
3862
  api_instance = PureCloud::WorkforceManagementApi.new
480
3863
 
481
- opts = {
482
- page_size: 56, # Integer |
483
- page_number: 56, # Integer |
484
- expand: "expand_example", # String |
485
- feature: "feature_example", # String |
486
- division_id: "division_id_example" # String |
487
- }
3864
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit to which the forecast belongs
3865
+
3866
+ week_date_id = "week_date_id_example" # String | The week start date of the forecast in yyyy-MM-dd format
3867
+
3868
+ body = PureCloud::RouteGroupList.new # RouteGroupList | body
3869
+
488
3870
 
489
3871
  begin
490
- #Get management units
491
- result = api_instance.get_workforcemanagement_managementunits(opts)
3872
+ #Import a short term forecast
3873
+ result = api_instance.post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload(management_unit_id, week_date_id, body)
492
3874
  p result
493
3875
  rescue PureCloud::ApiError => e
494
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunits: #{e}"
3876
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shorttermforecasts_partialupload: #{e}"
495
3877
  end
496
3878
  ~~~
497
3879
 
@@ -499,17 +3881,15 @@ end
499
3881
 
500
3882
  Name | Type | Description | Notes
501
3883
  ------------- | ------------- | ------------- | -------------
502
- **page_size** | **Integer**| | [optional] |
503
- **page_number** | **Integer**| | [optional] |
504
- **expand** | **String**| | [optional] <br />**Values**: details |
505
- **feature** | **String**| | [optional] <br />**Values**: Agents, ActivityCodes, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ShortTermForecasts, TimeOffRequests, WorkPlans |
506
- **division_id** | **String**| | [optional] |
3884
+ **management_unit_id** | **String**| The management unit ID of the management unit to which the forecast belongs | |
3885
+ **week_date_id** | **String**| The week start date of the forecast in yyyy-MM-dd format | |
3886
+ **body** | [**RouteGroupList**](RouteGroupList.html)| body | |
507
3887
  {: class="table table-striped"}
508
3888
 
509
3889
 
510
3890
  ### Return type
511
3891
 
512
- [**ManagementUnitListing**](ManagementUnitListing.html)
3892
+ [**PartialUploadResponse**](PartialUploadResponse.html)
513
3893
 
514
3894
  ### HTTP request headers
515
3895
 
@@ -518,21 +3898,21 @@ Name | Type | Description | Notes
518
3898
 
519
3899
 
520
3900
 
521
- <a name="patch_workforcemanagement_managementunit_user_timeoffrequest"></a>
3901
+ <a name="post_workforcemanagement_managementunit_workplan_copy"></a>
522
3902
 
523
- ## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
3903
+ ## -[**WorkPlan**](WorkPlan.html) post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts)
524
3904
 
525
3905
 
526
3906
 
527
- Update a time off request
3907
+ Create a copy of work plan
528
3908
 
529
3909
 
530
3910
 
531
- Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
3911
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy
532
3912
 
533
3913
  Requires ANY permissions:
534
3914
 
535
- * wfm:timeOffRequest:administer
3915
+ * wfm:workPlan:administer
536
3916
 
537
3917
 
538
3918
  ### Example
@@ -552,22 +3932,20 @@ end
552
3932
 
553
3933
  api_instance = PureCloud::WorkforceManagementApi.new
554
3934
 
555
- mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
556
-
557
- user_id = "user_id_example" # String | The id of the user the requested time off request belongs to
3935
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
558
3936
 
559
- time_off_request_id = "time_off_request_id_example" # String | The id of the time off request to update
3937
+ work_plan_id = "work_plan_id_example" # String | The ID of the work plan to create a copy
560
3938
 
561
3939
  opts = {
562
- body: PureCloud::AdminTimeOffRequestPatch.new # AdminTimeOffRequestPatch | body
3940
+ body: PureCloud::CopyWorkPlan.new # CopyWorkPlan | body
563
3941
  }
564
3942
 
565
3943
  begin
566
- #Update a time off request
567
- result = api_instance.patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
3944
+ #Create a copy of work plan
3945
+ result = api_instance.post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, opts)
568
3946
  p result
569
3947
  rescue PureCloud::ApiError => e
570
- puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
3948
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplan_copy: #{e}"
571
3949
  end
572
3950
  ~~~
573
3951
 
@@ -575,16 +3953,15 @@ end
575
3953
 
576
3954
  Name | Type | Description | Notes
577
3955
  ------------- | ------------- | ------------- | -------------
578
- **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
579
- **user_id** | **String**| The id of the user the requested time off request belongs to | |
580
- **time_off_request_id** | **String**| The id of the time off request to update | |
581
- **body** | [**AdminTimeOffRequestPatch**](AdminTimeOffRequestPatch.html)| body | [optional] |
3956
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3957
+ **work_plan_id** | **String**| The ID of the work plan to create a copy | |
3958
+ **body** | [**CopyWorkPlan**](CopyWorkPlan.html)| body | [optional] |
582
3959
  {: class="table table-striped"}
583
3960
 
584
3961
 
585
3962
  ### Return type
586
3963
 
587
- [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
3964
+ [**WorkPlan**](WorkPlan.html)
588
3965
 
589
3966
  ### HTTP request headers
590
3967
 
@@ -593,21 +3970,21 @@ Name | Type | Description | Notes
593
3970
 
594
3971
 
595
3972
 
596
- <a name="post_workforcemanagement_managementunit_activitycodes"></a>
3973
+ <a name="post_workforcemanagement_managementunit_workplans"></a>
597
3974
 
598
- ## -[**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
3975
+ ## -[**WorkPlan**](WorkPlan.html) post_workforcemanagement_managementunit_workplans(management_unit_id, opts)
599
3976
 
600
3977
 
601
3978
 
602
- Create a new activity code
3979
+ Create a new work plan
603
3980
 
604
3981
 
605
3982
 
606
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
3983
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans
607
3984
 
608
3985
  Requires ANY permissions:
609
3986
 
610
- * wfm:activityCode:administer
3987
+ * wfm:workPlan:administer
611
3988
 
612
3989
 
613
3990
  ### Example
@@ -627,18 +4004,18 @@ end
627
4004
 
628
4005
  api_instance = PureCloud::WorkforceManagementApi.new
629
4006
 
630
- mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
4007
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
631
4008
 
632
4009
  opts = {
633
- body: PureCloud::CreateActivityCodeRequest.new # CreateActivityCodeRequest | body
4010
+ body: PureCloud::CreateWorkPlan.new # CreateWorkPlan | body
634
4011
  }
635
4012
 
636
4013
  begin
637
- #Create a new activity code
638
- result = api_instance.post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
4014
+ #Create a new work plan
4015
+ result = api_instance.post_workforcemanagement_managementunit_workplans(management_unit_id, opts)
639
4016
  p result
640
4017
  rescue PureCloud::ApiError => e
641
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_activitycodes: #{e}"
4018
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplans: #{e}"
642
4019
  end
643
4020
  ~~~
644
4021
 
@@ -646,14 +4023,14 @@ end
646
4023
 
647
4024
  Name | Type | Description | Notes
648
4025
  ------------- | ------------- | ------------- | -------------
649
- **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
650
- **body** | [**CreateActivityCodeRequest**](CreateActivityCodeRequest.html)| body | [optional] |
4026
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4027
+ **body** | [**CreateWorkPlan**](CreateWorkPlan.html)| body | [optional] |
651
4028
  {: class="table table-striped"}
652
4029
 
653
4030
 
654
4031
  ### Return type
655
4032
 
656
- [**ActivityCode**](ActivityCode.html)
4033
+ [**WorkPlan**](WorkPlan.html)
657
4034
 
658
4035
  ### HTTP request headers
659
4036
 
@@ -662,21 +4039,21 @@ Name | Type | Description | Notes
662
4039
 
663
4040
 
664
4041
 
665
- <a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
4042
+ <a name="post_workforcemanagement_managementunits"></a>
666
4043
 
667
- ## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
4044
+ ## -[**ManagementUnit**](ManagementUnit.html) post_workforcemanagement_managementunits(opts)
668
4045
 
669
4046
 
670
4047
 
671
- Request a historical adherence report
4048
+ Add a management unit
672
4049
 
673
4050
 
674
4051
 
675
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery
4052
+ Wraps POST /api/v2/workforcemanagement/managementunits
676
4053
 
677
4054
  Requires ANY permissions:
678
4055
 
679
- * wfm:historicalAdherence:view
4056
+ * wfm:managementUnit:administer
680
4057
 
681
4058
 
682
4059
  ### Example
@@ -696,18 +4073,16 @@ end
696
4073
 
697
4074
  api_instance = PureCloud::WorkforceManagementApi.new
698
4075
 
699
- mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
700
-
701
4076
  opts = {
702
- body: PureCloud::WfmHistoricalAdherenceQuery.new # WfmHistoricalAdherenceQuery | body
4077
+ body: PureCloud::CreateManagementUnitApiRequest.new # CreateManagementUnitApiRequest | body
703
4078
  }
704
4079
 
705
4080
  begin
706
- #Request a historical adherence report
707
- result = api_instance.post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
4081
+ #Add a management unit
4082
+ result = api_instance.post_workforcemanagement_managementunits(opts)
708
4083
  p result
709
4084
  rescue PureCloud::ApiError => e
710
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_historicaladherencequery: #{e}"
4085
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunits: #{e}"
711
4086
  end
712
4087
  ~~~
713
4088
 
@@ -715,14 +4090,13 @@ end
715
4090
 
716
4091
  Name | Type | Description | Notes
717
4092
  ------------- | ------------- | ------------- | -------------
718
- **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
719
- **body** | [**WfmHistoricalAdherenceQuery**](WfmHistoricalAdherenceQuery.html)| body | [optional] |
4093
+ **body** | [**CreateManagementUnitApiRequest**](CreateManagementUnitApiRequest.html)| body | [optional] |
720
4094
  {: class="table table-striped"}
721
4095
 
722
4096
 
723
4097
  ### Return type
724
4098
 
725
- [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html)
4099
+ [**ManagementUnit**](ManagementUnit.html)
726
4100
 
727
4101
  ### HTTP request headers
728
4102
 
@@ -731,21 +4105,23 @@ Name | Type | Description | Notes
731
4105
 
732
4106
 
733
4107
 
734
- <a name="post_workforcemanagement_managementunit_intraday"></a>
4108
+ <a name="post_workforcemanagement_schedules"></a>
735
4109
 
736
- ## -[**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)
4110
+ ## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_schedules(opts)
737
4111
 
738
4112
 
739
4113
 
740
- Get intraday data for the given date for the requested queueIds
4114
+ Get published schedule for the current user
741
4115
 
742
4116
 
743
4117
 
744
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/intraday
4118
+ Wraps POST /api/v2/workforcemanagement/schedules
745
4119
 
746
4120
  Requires ANY permissions:
747
4121
 
748
- * wfm:intraday:view
4122
+ * wfm:agentSchedule:view
4123
+ * wfm:schedule:administer
4124
+ * wfm:publishedSchedule:view
749
4125
 
750
4126
 
751
4127
  ### Example
@@ -765,18 +4141,16 @@ end
765
4141
 
766
4142
  api_instance = PureCloud::WorkforceManagementApi.new
767
4143
 
768
- mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
769
-
770
4144
  opts = {
771
- body: PureCloud::IntradayQueryDataCommand.new # IntradayQueryDataCommand | body
4145
+ body: PureCloud::CurrentUserScheduleRequestBody.new # CurrentUserScheduleRequestBody | body
772
4146
  }
773
4147
 
774
4148
  begin
775
- #Get intraday data for the given date for the requested queueIds
776
- result = api_instance.post_workforcemanagement_managementunit_intraday(mu_id, opts)
4149
+ #Get published schedule for the current user
4150
+ result = api_instance.post_workforcemanagement_schedules(opts)
777
4151
  p result
778
4152
  rescue PureCloud::ApiError => e
779
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_intraday: #{e}"
4153
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_schedules: #{e}"
780
4154
  end
781
4155
  ~~~
782
4156
 
@@ -784,14 +4158,13 @@ end
784
4158
 
785
4159
  Name | Type | Description | Notes
786
4160
  ------------- | ------------- | ------------- | -------------
787
- **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
788
- **body** | [**IntradayQueryDataCommand**](IntradayQueryDataCommand.html)| body | [optional] |
4161
+ **body** | [**CurrentUserScheduleRequestBody**](CurrentUserScheduleRequestBody.html)| body | [optional] |
789
4162
  {: class="table table-striped"}
790
4163
 
791
4164
 
792
4165
  ### Return type
793
4166
 
794
- [**IntradayResponse**](IntradayResponse.html)
4167
+ [**UserScheduleContainer**](UserScheduleContainer.html)
795
4168
 
796
4169
  ### HTTP request headers
797
4170
 
@@ -800,22 +4173,22 @@ Name | Type | Description | Notes
800
4173
 
801
4174
 
802
4175
 
803
- <a name="post_workforcemanagement_managementunit_schedules_search"></a>
4176
+ <a name="post_workforcemanagement_timeoffrequests"></a>
804
4177
 
805
- ## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
4178
+ ## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) post_workforcemanagement_timeoffrequests(opts)
806
4179
 
807
4180
 
808
4181
 
809
- Query published schedules for given given time range for set of users
4182
+ Create a time off request for the current user
810
4183
 
811
4184
 
812
4185
 
813
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search
4186
+ Wraps POST /api/v2/workforcemanagement/timeoffrequests
814
4187
 
815
4188
  Requires ANY permissions:
816
4189
 
817
- * wfm:schedule:administer
818
- * wfm:publishedSchedule:view
4190
+ * wfm:agentSchedule:view
4191
+ * wfm:agentTimeOffRequest:submit
819
4192
 
820
4193
 
821
4194
  ### Example
@@ -835,18 +4208,16 @@ end
835
4208
 
836
4209
  api_instance = PureCloud::WorkforceManagementApi.new
837
4210
 
838
- mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
839
-
840
4211
  opts = {
841
- body: PureCloud::UserListScheduleRequestBody.new # UserListScheduleRequestBody | body
4212
+ body: PureCloud::CreateAgentTimeOffRequest.new # CreateAgentTimeOffRequest | body
842
4213
  }
843
4214
 
844
4215
  begin
845
- #Query published schedules for given given time range for set of users
846
- result = api_instance.post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
4216
+ #Create a time off request for the current user
4217
+ result = api_instance.post_workforcemanagement_timeoffrequests(opts)
847
4218
  p result
848
4219
  rescue PureCloud::ApiError => e
849
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_schedules_search: #{e}"
4220
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_timeoffrequests: #{e}"
850
4221
  end
851
4222
  ~~~
852
4223
 
@@ -854,14 +4225,13 @@ end
854
4225
 
855
4226
  Name | Type | Description | Notes
856
4227
  ------------- | ------------- | ------------- | -------------
857
- **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
858
- **body** | [**UserListScheduleRequestBody**](UserListScheduleRequestBody.html)| body | [optional] |
4228
+ **body** | [**CreateAgentTimeOffRequest**](CreateAgentTimeOffRequest.html)| body | [optional] |
859
4229
  {: class="table table-striped"}
860
4230
 
861
4231
 
862
4232
  ### Return type
863
4233
 
864
- [**UserScheduleContainer**](UserScheduleContainer.html)
4234
+ [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
865
4235
 
866
4236
  ### HTTP request headers
867
4237