docs/WorkforceManagementApi.md in purecloudplatformclientv2-34.0.0 vs docs/WorkforceManagementApi.md in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -24,17 +24,23 @@
<a name="get_workforcemanagement_adherence"></a>
## -[**Array<UserScheduleAdherence>**](UserScheduleAdherence.html) get_workforcemanagement_adherence(user_id)
+
+
Get a list of UserScheduleAdherence records for the requested users
Wraps GET /api/v2/workforcemanagement/adherence
+Requires ANY permissions:
+* wfm:realtimeAdherence:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -83,17 +89,23 @@
<a name="get_workforcemanagement_managementunit_activitycodes"></a>
## -[**ActivityCodeContainer**](ActivityCodeContainer.html) get_workforcemanagement_managementunit_activitycodes(mu_id)
+
+
Get activity codes
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
+Requires ANY permissions:
+* wfm:activityCode:administer* wfm:agent:administer* wfm:agentSchedule:view* wfm:historicalAdherence:view* wfm:intraday:view* wfm:managementUnit:administer* wfm:publishedSchedule:view* wfm:realtimeAdherence:view* wfm:schedule:administer* wfm:schedule:generate* wfm:serviceGoalGroup:administer* wfm:shortTermForecast:administer* wfm:agentTimeOffRequest:submit* wfm:timeOffRequest:administer* wfm:workPlan:administer
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -142,17 +154,23 @@
<a name="get_workforcemanagement_managementunit_intraday_queues"></a>
## -[**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
+
+
Get intraday queues for the given date
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/intraday/queues
+Requires ANY permissions:
+* wfm:intraday:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -204,17 +222,23 @@
<a name="get_workforcemanagement_managementunit_user_timeoffrequest"></a>
## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
+
+
Get a time off request
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
+Requires ANY permissions:
+* wfm:timeOffRequest:administer
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -269,17 +293,23 @@
<a name="get_workforcemanagement_managementunit_user_timeoffrequests"></a>
## -[**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
+
+
Get a list of time off requests for a given user
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests
+Requires ANY permissions:
+* wfm:timeOffRequest:administer
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -335,17 +365,23 @@
<a name="get_workforcemanagement_managementunit_users"></a>
## -[**WfmUserEntityListing**](WfmUserEntityListing.html) get_workforcemanagement_managementunit_users(mu_id)
+
+
Get agents in the management unit
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users
+Requires ANY permissions:
+* wfm:agent:administer
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -394,17 +430,23 @@
<a name="get_workforcemanagement_managementunits"></a>
## -[**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits(opts)
+
+
Get management units
Wraps GET /api/v2/workforcemanagement/managementunits
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -420,11 +462,11 @@
api_instance = PureCloud::WorkforceManagementApi.new
opts = {
page_size: 56, # Integer |
- page_number: 1, # Integer |
+ page_number: 56, # Integer |
expand: "expand_example" # String |
}
begin
#Get management units
@@ -438,11 +480,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page_size** | **Integer**| | [optional] |
- **page_number** | **Integer**| | [optional] [default to 1] |
+ **page_number** | **Integer**| | [optional] |
**expand** | **String**| | [optional] <br />**Values**: details |
{: class="table table-striped"}
### Return type
@@ -458,17 +500,23 @@
<a name="patch_workforcemanagement_managementunit_user_timeoffrequest"></a>
## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
+
+
Update a time off request
Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
+Requires ANY permissions:
+* wfm:timeOffRequest:administer
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -527,17 +575,23 @@
<a name="post_workforcemanagement_managementunit_activitycodes"></a>
## -[**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
+
+
Create a new activity code
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
+Requires ANY permissions:
+* wfm:activityCode:administer
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -590,17 +644,23 @@
<a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
+
+
Request a historical adherence report
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery
+Requires ANY permissions:
+* wfm:historicalAdherence:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -653,17 +713,23 @@
<a name="post_workforcemanagement_managementunit_intraday"></a>
## -[**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)
+
+
Get intraday data for the given date for the requested queueIds
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/intraday
+Requires ANY permissions:
+* wfm:intraday:view
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -716,14 +782,20 @@
<a name="post_workforcemanagement_managementunit_schedules_search"></a>
## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
+
+
Query published schedules for given given time range for set of users
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search
+
+Requires ANY permissions:
+
+* wfm:schedule:administer* wfm:publishedSchedule:view
### Example
~~~ruby
# load the gem