WorkforceManagementApi.md in purecloudplatformclientv2-33.0.0

- old
+ new

@@ -9,18 +9,19 @@
 Method | Description
 ------------- | ------------- | -------------
 [**get_workforcemanagement_adherence**](WorkforceManagementApi.html#get_workforcemanagement_adherence) | Get a list of UserScheduleAdherence records for the requested users
 [**get_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycodes) | Get activity codes
 [**get_workforcemanagement_managementunit_intraday_queues**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_intraday_queues) | Get intraday queues for the given date
-[**get_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequest) | Get a time off request by id
-[**get_workforcemanagement_managementunit_user_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequests) | Get a list of time off requests for any user
+[**get_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequest) | Get a time off request
+[**get_workforcemanagement_managementunit_user_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequests) | Get a list of time off requests for a given user
 [**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
+[**patch_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_user_timeoffrequest) | Update a time off request
 [**post_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_activitycodes) | Create a new activity code
 [**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_managementunit_schedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_schedules_search) | Query published schedules for given given time range for set of users
 {: class="table table-striped"}
 
 <a name="get_workforcemanagement_adherence"></a>
 
 ## -[**Array&lt;UserScheduleAdherence&gt;**](UserScheduleAdherence.html) get_workforcemanagement_adherence(user_id)
@@ -106,11 +107,11 @@
   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.
+mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
 
 
 begin
   #Get activity codes
   result = api_instance.get_workforcemanagement_managementunit_activitycodes(mu_id)
@@ -122,11 +123,11 @@
 
 ### 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. |  |
+ **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. |  |
 {: class="table table-striped"}
 
 
 ### Return type
 
@@ -201,13 +202,13 @@
 
 
 
 <a name="get_workforcemanagement_managementunit_user_timeoffrequest"></a>
 
-## -[**TimeOffRequest**](TimeOffRequest.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
+## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
 
-Get a time off request by id
+Get a time off request
 
 
 
 Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId} 
 
@@ -227,19 +228,19 @@
   config.access_token = @authToken
 end
 
 api_instance = PureCloud::WorkforceManagementApi.new
 
-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.
+mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
 
 user_id = "user_id_example" # String | The userId to whom the Time Off Request applies.
 
 time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
 
 
 begin
-  #Get a time off request by id
+  #Get a time off request
   result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
   p result
 rescue PureCloud::ApiError => e
   puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
 end
@@ -247,19 +248,19 @@
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. |  |
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. |  |
  **user_id** | **String**| The userId to whom the Time Off Request applies. |  |
  **time_off_request_id** | **String**| Time Off Request Id |  |
 {: class="table table-striped"}
 
 
 ### Return type
 
-[**TimeOffRequest**](TimeOffRequest.html)
+[**TimeOffRequestResponse**](TimeOffRequestResponse.html)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
  - **Accept**: application/json
@@ -268,11 +269,11 @@
 
 <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 any user
+Get a list of time off requests for a given user
 
 
 
 Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests 
 
@@ -292,20 +293,20 @@
   config.access_token = @authToken
 end
 
 api_instance = PureCloud::WorkforceManagementApi.new
 
-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.
+mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
 
 user_id = "user_id_example" # String | The userId to whom the Time Off Request applies.
 
 opts = { 
   recently_reviewed: false # BOOLEAN | Limit results to requests that have been reviewed within the preceding 30 days
 }
 
 begin
-  #Get a list of time off requests for any user
+  #Get a list of time off requests for a given user
   result = api_instance.get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
   p result
 rescue PureCloud::ApiError => e
   puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequests: #{e}"
 end
@@ -313,11 +314,11 @@
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. |  |
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. |  |
  **user_id** | **String**| The userId to whom the Time Off Request applies. |  |
  **recently_reviewed** | **BOOLEAN**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] [default to false] |
 {: class="table table-striped"}
 
 
@@ -453,10 +454,79 @@
  - **Content-Type**: application/json
  - **Accept**: application/json
 
 
 
+<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} 
+
+
+### 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.
+
+user_id = "user_id_example" # String | The id of the user the requested time off request belongs to
+
+time_off_request_id = "time_off_request_id_example" # String | The id of the time off request to update
+
+opts = { 
+  body: PureCloud::AdminTimeOffRequestPatch.new # AdminTimeOffRequestPatch | body
+}
+
+begin
+  #Update a time off request
+  result = api_instance.patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_user_timeoffrequest: #{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. |  |
+ **user_id** | **String**| The id of the user the requested time off request belongs to |  |
+ **time_off_request_id** | **String**| The id of the time off request to update |  |
+ **body** | [**AdminTimeOffRequestPatch**](AdminTimeOffRequestPatch.html)| body | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**TimeOffRequestResponse**](TimeOffRequestResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_workforcemanagement_managementunit_activitycodes"></a>
 
 ## -[**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
 
 Create a new activity code
@@ -481,11 +551,11 @@
   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.
+mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
 
 opts = { 
   body: PureCloud::CreateActivityCodeRequest.new # CreateActivityCodeRequest | body
 }
 
@@ -500,11 +570,11 @@
 
 ### 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. |  |
+ **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. |  |
  **body** | [**CreateActivityCodeRequest**](CreateActivityCodeRequest.html)| body | [optional]  |
 {: class="table table-striped"}
 
 
 ### Return type
@@ -646,11 +716,11 @@
 
 <a name="post_workforcemanagement_managementunit_schedules_search"></a>
 
 ## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
 
-Get user schedules within the given time range
+Query published schedules for given given time range for set of users
 
 
 
 Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search 
 
@@ -677,10 +747,10 @@
 opts = { 
   body: PureCloud::UserListScheduleRequestBody.new # UserListScheduleRequestBody | body
 }
 
 begin
-  #Get user schedules within the given time range
+  #Query published schedules for given given time range for set of users
   result = api_instance.post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
   p result
 rescue PureCloud::ApiError => e
   puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_schedules_search: #{e}"
 end