RubyGems - purecloudplatformclientv2 - Versions diffs - 26.0.1 → 27.0.0 - Mend

purecloudplatformclientv2 26.0.1 → 27.0.0

Files changed (300) hide show

data/docs/UserProfileEntityListing.md CHANGED

@@ -13,9 +13,9 @@ title: UserProfileEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/UserQueueEntityListing.md CHANGED

@@ -13,9 +13,9 @@ title: UserQueueEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/UserRecordingEntityListing.md CHANGED

@@ -13,9 +13,9 @@ title: UserRecordingEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/UserSkillEntityListing.md CHANGED

@@ -13,9 +13,9 @@ title: UserSkillEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/VoicemailMessageEntityListing.md CHANGED

@@ -13,9 +13,9 @@ title: VoicemailMessageEntityListing
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/docs/WfmMoveAgentsCompleteNotification.md CHANGED

@@ -9,7 +9,7 @@ title: WfmMoveAgentsCompleteNotification
 |------------ | ------------- | ------------- | -------------|
 | **requesting_user** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) |  | [optional] |
 | **destination_management_unit** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) |  | [optional] |
-| **move_agent_results** | [**Array&lt;WfmMoveAgentsCompleteNotificationMoveAgentResults&gt;**](WfmMoveAgentsCompleteNotificationMoveAgentResults.html) |  | [optional] |
+| **results** | [**Array&lt;WfmMoveAgentsCompleteNotificationResults&gt;**](WfmMoveAgentsCompleteNotificationResults.html) |  | [optional] |
 {: class="table table-striped"}

data/docs/{WfmMoveAgentsCompleteNotificationMoveAgentResults.md → WfmMoveAgentsCompleteNotificationResults.md} RENAMED

@@ -1,14 +1,14 @@
 ---
-title: WfmMoveAgentsCompleteNotificationMoveAgentResults
+title: WfmMoveAgentsCompleteNotificationResults
 ---
-## PureCloud::WfmMoveAgentsCompleteNotificationMoveAgentResults
+## PureCloud::WfmMoveAgentsCompleteNotificationResults
 ## Properties
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **user** | [**WfmMoveAgentsCompleteNotificationUser**](WfmMoveAgentsCompleteNotificationUser.html) |  | [optional] |
-| **move_agent_result** | **String** |  | [optional] |
+| **result** | **String** |  | [optional] |
 {: class="table table-striped"}

data/docs/WfmMoveAgentsCompleteNotificationWfmMoveAgentData.md CHANGED

@@ -8,7 +8,7 @@ title: WfmMoveAgentsCompleteNotificationWfmMoveAgentData
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **user** | [**WfmMoveAgentsCompleteNotificationUser**](WfmMoveAgentsCompleteNotificationUser.html) |  | [optional] |
-| **move_agent_result** | **String** |  | [optional] |
+| **result** | **String** |  | [optional] |
 {: class="table table-striped"}

data/docs/WorkforceManagementApi.md CHANGED

@@ -15,16 +15,10 @@ Method | Description
 [**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_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_agents**](WorkforceManagementApi.html#post_workforcemanagement_agents) | Move agents in and out of management unit
-[**post_workforcemanagement_agents_managementunits**](WorkforceManagementApi.html#post_workforcemanagement_agents_managementunits) | Get the management units to which the agents belong
 [**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_schedules**](WorkforceManagementApi.html#post_workforcemanagement_schedules) | Get a schedule for the current user
 {: class="table table-striped"}
 <a name="get_workforcemanagement_adherence"></a>
@@ -461,307 +455,6 @@ Name | Type | Description  | Notes
-<a name="get_workforcemanagement_timeoffrequest"></a>
-## -[**TimeOffRequest**](TimeOffRequest.html) get_workforcemanagement_timeoffrequest(time_off_request_id)
-Get a time off request for the current user by id
-Wraps GET /api/v2/workforcemanagement/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
-time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
-begin
-  #Get a time off request for the current user by id
-  result = api_instance.get_workforcemanagement_timeoffrequest(time_off_request_id)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequest: #{e}"
-end
-~~~
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **time_off_request_id** | **String**| Time Off Request Id |  |
-{: class="table table-striped"}
-### Return type
-[**TimeOffRequest**](TimeOffRequest.html)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="get_workforcemanagement_timeoffrequests"></a>
-## -[**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_timeoffrequests(opts)
-Get a list of time off requests for the current user
-Wraps GET /api/v2/workforcemanagement/timeoffrequests
-### 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
-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 the current user
-  result = api_instance.get_workforcemanagement_timeoffrequests(opts)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequests: #{e}"
-end
-~~~
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **recently_reviewed** | **BOOLEAN**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] [default to false] |
-{: class="table table-striped"}
-### Return type
-[**TimeOffRequestList**](TimeOffRequestList.html)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="patch_workforcemanagement_timeoffrequest"></a>
-## - patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
-Mark a time off request for the current user as read or unread
-Wraps PATCH /api/v2/workforcemanagement/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
-time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
-opts = {
-  body: PureCloud::TimeOffRequestPatch.new # TimeOffRequestPatch |
-}
-begin
-  #Mark a time off request for the current user as read or unread
-  api_instance.patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
-rescue PureCloud::ApiError => e
-  puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_timeoffrequest: #{e}"
-end
-~~~
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **time_off_request_id** | **String**| Time Off Request Id |  |
- **body** | [**TimeOffRequestPatch**](TimeOffRequestPatch.html)|  | [optional]  |
-{: class="table table-striped"}
-### Return type
-nil (empty response body)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="post_workforcemanagement_agents"></a>
-## -[**MoveAgentsResponse**](MoveAgentsResponse.html) post_workforcemanagement_agents(opts)
-Move agents in and out of management unit
-Wraps POST /api/v2/workforcemanagement/agents
-### 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
-opts = {
-  body: PureCloud::MoveAgentsRequest.new # MoveAgentsRequest | body
-}
-begin
-  #Move agents in and out of management unit
-  result = api_instance.post_workforcemanagement_agents(opts)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_agents: #{e}"
-end
-~~~
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**MoveAgentsRequest**](MoveAgentsRequest.html)| body | [optional]  |
-{: class="table table-striped"}
-### Return type
-[**MoveAgentsResponse**](MoveAgentsResponse.html)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="post_workforcemanagement_agents_managementunits"></a>
-## -[**Array&lt;AgentManagementUnitReference&gt;**](AgentManagementUnitReference.html) post_workforcemanagement_agents_managementunits(opts)
-Get the management units to which the agents belong
-Wraps POST /api/v2/workforcemanagement/agents/managementunits
-### 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
-opts = {
-  body: [PureCloud::Array<String>.new] # Array<String> | body
-}
-begin
-  #Get the management units to which the agents belong
-  result = api_instance.post_workforcemanagement_agents_managementunits(opts)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_agents_managementunits: #{e}"
-end
-~~~
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | **Array&lt;String&gt;**| body | [optional]  |
-{: class="table table-striped"}
-### Return type
-[**Array&lt;AgentManagementUnitReference&gt;**](AgentManagementUnitReference.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)
@@ -1014,63 +707,3 @@ Name | Type | Description  | Notes
-<a name="post_workforcemanagement_schedules"></a>
-## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_schedules(opts)
-Get a schedule for the current user
-Wraps POST /api/v2/workforcemanagement/schedules
-### 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
-opts = {
-  body: PureCloud::CurrentUserScheduleRequestBody.new # CurrentUserScheduleRequestBody | body
-}
-begin
-  #Get a schedule for the current user
-  result = api_instance.post_workforcemanagement_schedules(opts)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_schedules: #{e}"
-end
-~~~
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**CurrentUserScheduleRequestBody**](CurrentUserScheduleRequestBody.html)| body | [optional]  |
-{: class="table table-striped"}
-### Return type
-[**UserScheduleContainer**](UserScheduleContainer.html)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json