docs/WorkforceManagementApi.md in purecloudplatformclientv2-14.1.0 vs docs/WorkforceManagementApi.md in purecloudplatformclientv2-15.0.0

- old
+ new

@@ -16,10 +16,11 @@ [**get_workforcemanagement_managementunit_users**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_users) | Get agents in the management unit [**get_workforcemanagement_managementunits**](WorkforceManagementApi.html#get_workforcemanagement_managementunits) | Get management units [**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user by id [**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user [**patch_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_timeoffrequest) | Mark a time off request for the current user as read or unread +[**post_workforcemanagement_managementunit_historicaladherencequery**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_historicaladherencequery) | Request a historical adherence report [**post_workforcemanagement_managementunit_intraday**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_intraday) | Get intraday data for the given date for the requested queueIds [**post_workforcemanagement_managementunit_schedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_schedules_search) | Get user schedules within the given time range [**post_workforcemanagement_schedules**](WorkforceManagementApi.html#post_workforcemanagement_schedules) | Get a schedule for the current user {: class="table table-striped"} @@ -628,9 +629,72 @@ ### Return type nil (empty response body) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<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 + + +### Example +~~~ruby +# load the gem +require 'purecloudplatformclientv2' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::WorkforceManagementApi.new + +mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user. + +opts = { + body: PureCloud::WfmHistoricalAdherenceQuery.new # WfmHistoricalAdherenceQuery | body +} + +begin + #Request a historical adherence report + result = api_instance.post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_historicaladherencequery: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | | + **body** | [**WfmHistoricalAdherenceQuery**](WfmHistoricalAdherenceQuery.html)| body | [optional] | +{: class="table table-striped"} + + +### Return type + +[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json