purecloudplatformclientv2 30.0.0 → 30.1.0

data/docs/UserRoutingLanguage.md

@@ -0,0 +1,18 @@
+---
+title: UserRoutingLanguage
+---
+## PureCloud::UserRoutingLanguage
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **proficiency** | **Float** | Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings. | [optional] |
+| **state** | **String** | Activate or deactivate this routing langauge. | [optional] |
+| **language_uri** | **String** | URI to the organization language used by this user langauge. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserRoutingLanguagePost.md

@@ -0,0 +1,16 @@
+---
+title: UserRoutingLanguagePost
+---
+## PureCloud::UserRoutingLanguagePost
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The id of the existing routing language to add to the user | |
+| **proficiency** | **Float** | Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings. | |
+| **language_uri** | **String** | URI to the organization language used by this user langauge. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UsersApi.md

@@ -10,6 +10,7 @@ Method | Description
 ------------- | ------------- | -------------
 [**delete_user**](UsersApi.html#delete_user) | Delete user
 [**delete_user_roles**](UsersApi.html#delete_user_roles) | Removes all the roles from the user.
+[**delete_user_routinglanguage**](UsersApi.html#delete_user_routinglanguage) | Remove routing language from user
 [**delete_user_routingskill**](UsersApi.html#delete_user_routingskill) | Remove routing skill from user
 [**delete_user_station_associatedstation**](UsersApi.html#delete_user_station_associatedstation) | Clear associated station
 [**delete_user_station_defaultstation**](UsersApi.html#delete_user_station_defaultstation) | Clear default station
@@ -26,6 +27,7 @@ Method | Description
 [**get_user_profileskills**](UsersApi.html#get_user_profileskills) | List profile skills for a user
 [**get_user_queues**](UsersApi.html#get_user_queues) | Get queues for user
 [**get_user_roles**](UsersApi.html#get_user_roles) | Returns a listing of roles and permissions for a user.
+[**get_user_routinglanguages**](UsersApi.html#get_user_routinglanguages) | List routing language for user
 [**get_user_routingskills**](UsersApi.html#get_user_routingskills) | List routing skills for user
 [**get_user_routingstatus**](UsersApi.html#get_user_routingstatus) | Fetch the routing status of a user
 [**get_user_station**](UsersApi.html#get_user_station) | Get station information for user
@@ -39,11 +41,13 @@ Method | Description
 [**patch_user_geolocation**](UsersApi.html#patch_user_geolocation) | Patch a user's Geolocation
 [**patch_user_queue**](UsersApi.html#patch_user_queue) | Join or unjoin a queue for a user
 [**patch_user_queues**](UsersApi.html#patch_user_queues) | Join or unjoin a set of queues for a user
+[**patch_user_routinglanguage**](UsersApi.html#patch_user_routinglanguage) | Update routing language proficiency or state.
 [**post_analytics_users_aggregates_query**](UsersApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
 [**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details
 [**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations
 [**post_user_invite**](UsersApi.html#post_user_invite) | Send an activation email to the user
 [**post_user_password**](UsersApi.html#post_user_password) | Change a users password
+[**post_user_routinglanguages**](UsersApi.html#post_user_routinglanguages) | Add routing language to user
 [**post_user_routingskills**](UsersApi.html#post_user_routingskills) | Add routing skill to user
 [**post_users**](UsersApi.html#post_users) | Create user
 [**post_users_me_password**](UsersApi.html#post_users_me_password) | Change your password
@@ -175,6 +179,67 @@ nil (empty response body)
 
 
 
+<a name="delete_user_routinglanguage"></a>
+
+## - delete_user_routinglanguage(user_id, language_id)
+
+Remove routing language from user
+
+
+
+Wraps DELETE /api/v2/users/{userId}/routinglanguages/{languageId} 
+
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User ID
+
+language_id = "language_id_example" # String | languageId
+
+
+begin
+  #Remove routing language from user
+  api_instance.delete_user_routinglanguage(user_id, language_id)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->delete_user_routinglanguage: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **language_id** | **String**| languageId |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="delete_user_routingskill"></a>
 
 ## - delete_user_routingskill(user_id, skill_id)
@@ -1171,6 +1236,73 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_user_routinglanguages"></a>
+
+## -[**UserLanguageEntityListing**](UserLanguageEntityListing.html) get_user_routinglanguages(user_id, opts)
+
+List routing language for user
+
+
+
+Wraps GET /api/v2/users/{userId}/routinglanguages 
+
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User ID
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1, # Integer | Page number
+  sort_order: "ASC" # String | Ascending or descending sort order
+}
+
+begin
+  #List routing language for user
+  result = api_instance.get_user_routinglanguages(user_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_user_routinglanguages: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
+ **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserLanguageEntityListing**](UserLanguageEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_user_routingskills"></a>
 
 ## -[**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_routingskills(user_id, opts)
@@ -1993,6 +2125,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="patch_user_routinglanguage"></a>
+
+## -[**UserRoutingLanguage**](UserRoutingLanguage.html) patch_user_routinglanguage(user_id, language_id, body)
+
+Update routing language proficiency or state.
+
+
+
+Wraps PATCH /api/v2/users/{userId}/routinglanguages/{languageId} 
+
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User ID
+
+language_id = "language_id_example" # String | languageId
+
+body = PureCloud::UserRoutingLanguage.new # UserRoutingLanguage | Language
+
+
+begin
+  #Update routing language proficiency or state.
+  result = api_instance.patch_user_routinglanguage(user_id, language_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->patch_user_routinglanguage: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **language_id** | **String**| languageId |  |
+ **body** | [**UserRoutingLanguage**](UserRoutingLanguage.html)| Language |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserRoutingLanguage**](UserRoutingLanguage.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_analytics_users_aggregates_query"></a>
 
 ## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
@@ -2293,6 +2490,68 @@ nil (empty response body)
 
 
 
+<a name="post_user_routinglanguages"></a>
+
+## -[**UserRoutingLanguage**](UserRoutingLanguage.html) post_user_routinglanguages(user_id, body)
+
+Add routing language to user
+
+
+
+Wraps POST /api/v2/users/{userId}/routinglanguages 
+
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User ID
+
+body = PureCloud::UserRoutingLanguagePost.new # UserRoutingLanguagePost | Language
+
+
+begin
+  #Add routing language to user
+  result = api_instance.post_user_routinglanguages(user_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->post_user_routinglanguages: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **body** | [**UserRoutingLanguagePost**](UserRoutingLanguagePost.html)| Language |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserRoutingLanguage**](UserRoutingLanguage.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_user_routingskills"></a>
 
 ## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_routingskills(user_id, body)

data/docs/ViewFilter.md

@@ -7,17 +7,28 @@ title: ViewFilter
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **media_types** | **Array<String>** | The media types used to filter the data export request | [optional] |
-| **queue_ids** | **Array<String>** | The queue ids used to filter the data export request | [optional] |
-| **skill_ids** | **Array<String>** | The skill ids used to filter the data export request | [optional] |
-| **language_ids** | **Array<String>** | The language ids used to filter the data export request | [optional] |
-| **directions** | **Array<String>** | The directions used to filter the data export request | [optional] |
-| **wrap_up_codes** | **Array<String>** | The wrap up codes used to filter the data export request | [optional] |
-| **dnis_list** | **Array<String>** | The dnis list used to filter the data export request | [optional] |
-| **user_ids** | **Array<String>** | The user ids used to filter the data export request | [optional] |
-| **address_tos** | **Array<String>** | The address To values used to filter the data export request | [optional] |
-| **outbound_campaign_ids** | **Array<String>** | The outbound campaign ids used to filter the data export request | [optional] |
-| **outbound_contact_list_ids** | **Array<String>** | The outbound contact list ids used to filter the data export request | [optional] |
+| **media_types** | **Array<String>** | The media types are used to filter the view | [optional] |
+| **queue_ids** | **Array<String>** | The queue ids are used to filter the view | [optional] |
+| **skill_ids** | **Array<String>** | The skill ids are used to filter the view | [optional] |
+| **language_ids** | **Array<String>** | The language ids are used to filter the view | [optional] |
+| **directions** | **Array<String>** | The directions are used to filter the view | [optional] |
+| **wrap_up_codes** | **Array<String>** | The wrap up codes are used to filter the view | [optional] |
+| **dnis_list** | **Array<String>** | The dnis list is used to filter the view | [optional] |
+| **user_ids** | **Array<String>** | The user ids are used to filter the view | [optional] |
+| **address_tos** | **Array<String>** | The address To values are used to filter the view | [optional] |
+| **address_froms** | **Array<String>** | The address from values are used to filter the view | [optional] |
+| **outbound_campaign_ids** | **Array<String>** | The outbound campaign ids are used to filter the view | [optional] |
+| **outbound_contact_list_ids** | **Array<String>** | The outbound contact list ids are used to filter the view | [optional] |
+| **contact_ids** | **Array<String>** | The contact ids are used to filter the view | [optional] |
+| **ani_list** | **Array<String>** | The ani list ids are used to filter the view | [optional] |
+| **duration_milliseconds** | [**NumericRange**](NumericRange.html) | The duration is used to filter the view | [optional] |
+| **evaluation_score** | [**NumericRange**](NumericRange.html) | The evaluationScore is used to filter the view | [optional] |
+| **evaluation_critical_score** | [**NumericRange**](NumericRange.html) | The evaluationCriticalScore is used to filter the view | [optional] |
+| **evaluation_form_ids** | **Array<String>** | The evaluation form ids are used to filter the view | [optional] |
+| **evaluated_agent_ids** | **Array<String>** | The evaluated agent ids are used to filter the view | [optional] |
+| **evaluator_ids** | **Array<String>** | The evaluator ids are used to filter the view | [optional] |
+| **transferred** | **BOOLEAN** | Indicates filtering for transfers | [optional] |
+| **abandoned** | **BOOLEAN** | Indicates filtering for abandons | [optional] |
 {: class="table table-striped"}
 
 

data/docs/WorkforceManagementApi.md

@@ -167,7 +167,7 @@ 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 management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
 
 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
 
@@ -185,7 +185,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. |  |
+ **mu_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. |  |
  **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 |  |
 {: class="table table-striped"}
 
@@ -229,7 +229,7 @@ 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 management unit ID 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.
 
@@ -249,7 +249,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. |  |
+ **mu_id** | **String**| The management unit ID of the management unit, or 'mine' 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"}
@@ -294,7 +294,7 @@ 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 management unit ID 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.
 
@@ -315,7 +315,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. |  |
+ **mu_id** | **String**| The management unit ID of the management unit, or 'mine' 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"}
@@ -360,7 +360,7 @@ 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 management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
 
 
 begin
@@ -376,7 +376,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. |  |
+ **mu_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. |  |
 {: class="table table-striped"}
 
 
@@ -546,7 +546,7 @@ 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 management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
 
 opts = { 
   body: PureCloud::WfmHistoricalAdherenceQuery.new # WfmHistoricalAdherenceQuery | body
@@ -565,7 +565,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. |  |
+ **mu_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. |  |
  **body** | [**WfmHistoricalAdherenceQuery**](WfmHistoricalAdherenceQuery.html)| body | [optional]  |
 {: class="table table-striped"}
 
@@ -609,7 +609,7 @@ 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 management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
 
 opts = { 
   body: PureCloud::IntradayQueryDataCommand.new # IntradayQueryDataCommand | body
@@ -628,7 +628,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. |  |
+ **mu_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. |  |
  **body** | [**IntradayQueryDataCommand**](IntradayQueryDataCommand.html)| body | [optional]  |
 {: class="table table-striped"}
 
@@ -672,7 +672,7 @@ 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 management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
 
 opts = { 
   body: PureCloud::UserListScheduleRequestBody.new # UserListScheduleRequestBody | body
@@ -691,7 +691,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **mu_id** | **String**| The muId of the management unit, or 'mine' for the management unit of the logged-in user. |  |
+ **mu_id** | **String**| The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user. |  |
  **body** | [**UserListScheduleRequestBody**](UserListScheduleRequestBody.html)| body | [optional]  |
 {: class="table table-striped"}