doc_out/UsersApi.html.md in purecloud-0.52.1 vs doc_out/UsersApi.html.md in purecloud-0.53.1

- old
+ new

@@ -12,15 +12,16 @@ |[**delete_user_id_roles**](UsersApi.html#delete_user_id_roles) | **DELETE** /api/v2/users/{userId}/roles | Removes all the roles from the user.| |[**delete_user_id_routingskills_skill_id**](UsersApi.html#delete_user_id_routingskills_skill_id) | **DELETE** /api/v2/users/{userId}/routingskills/{skillId} | Remove routing skill from user| |[**delete_user_id_station_associatedstation**](UsersApi.html#delete_user_id_station_associatedstation) | **DELETE** /api/v2/users/{userId}/station/associatedstation | Clear associated station| |[**delete_user_id_station_defaultstation**](UsersApi.html#delete_user_id_station_defaultstation) | **DELETE** /api/v2/users/{userId}/station/defaultstation | Clear default station| |[**get_me**](UsersApi.html#get_me) | **GET** /api/v2/users/me | Get current user details.| -|[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search using q64| +|[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search users using the q64 value returned from a previous search| |[**get_user_id**](UsersApi.html#get_user_id) | **GET** /api/v2/users/{userId} | Get user.| |[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | **GET** /api/v2/users/{userId}/callforwarding | Get a user&#39;s CallForwarding| |[**get_user_id_geolocations_client_id**](UsersApi.html#get_user_id_geolocations_client_id) | **GET** /api/v2/users/{userId}/geolocations/{clientId} | Get a user&#39;s Geolocation| |[**get_user_id_outofoffice**](UsersApi.html#get_user_id_outofoffice) | **GET** /api/v2/users/{userId}/outofoffice | Get a OutOfOffice| +|[**get_user_id_profileskills**](UsersApi.html#get_user_id_profileskills) | **GET** /api/v2/users/{userId}/profileskills | List profile skills for a user| |[**get_user_id_queues**](UsersApi.html#get_user_id_queues) | **GET** /api/v2/users/{userId}/queues | Get queues for user| |[**get_user_id_roles**](UsersApi.html#get_user_id_roles) | **GET** /api/v2/users/{userId}/roles | Returns a listing of roles and permissions for a user.| |[**get_user_id_routingskills**](UsersApi.html#get_user_id_routingskills) | **GET** /api/v2/users/{userId}/routingskills | List routing skills for user| |[**get_user_id_routingstatus**](UsersApi.html#get_user_id_routingstatus) | **GET** /api/v2/users/{userId}/routingstatus | Fetch the routing status of a user| |[**get_user_id_station**](UsersApi.html#get_user_id_station) | **GET** /api/v2/users/{userId}/station | Get station information for user| @@ -28,17 +29,18 @@ |[**patch_user_id**](UsersApi.html#patch_user_id) | **PATCH** /api/v2/users/{userId} | Update user| |[**patch_user_id_callforwarding**](UsersApi.html#patch_user_id_callforwarding) | **PATCH** /api/v2/users/{userId}/callforwarding | Patch a user&#39;s CallForwarding| |[**patch_user_id_geolocations_client_id**](UsersApi.html#patch_user_id_geolocations_client_id) | **PATCH** /api/v2/users/{userId}/geolocations/{clientId} | Patch a user&#39;s Geolocation| |[**patch_user_id_queues**](UsersApi.html#patch_user_id_queues) | **PATCH** /api/v2/users/{userId}/queues | Join or unjoin a set of queues for a user| |[**patch_user_id_queues_queue_id**](UsersApi.html#patch_user_id_queues_queue_id) | **PATCH** /api/v2/users/{userId}/queues/{queueId} | Join or unjoin a queue for a user| -|[**post_search**](UsersApi.html#post_search) | **POST** /api/v2/users/search | Search| +|[**post_search**](UsersApi.html#post_search) | **POST** /api/v2/users/search | Search users| |[**post_user_id_routingskills**](UsersApi.html#post_user_id_routingskills) | **POST** /api/v2/users/{userId}/routingskills | Add routing skill to user| |[**post_users**](UsersApi.html#post_users) | **POST** /api/v2/users | Create user| |[**post_users_aggregates_query**](UsersApi.html#post_users_aggregates_query) | **POST** /api/v2/analytics/users/aggregates/query | Query for user aggregates| |[**post_users_observations_query**](UsersApi.html#post_users_observations_query) | **POST** /api/v2/analytics/users/observations/query | Query for user observations| |[**put_user_id_callforwarding**](UsersApi.html#put_user_id_callforwarding) | **PUT** /api/v2/users/{userId}/callforwarding | Update a user&#39;s CallForwarding| |[**put_user_id_outofoffice**](UsersApi.html#put_user_id_outofoffice) | **PUT** /api/v2/users/{userId}/outofoffice | Update an OutOfOffice| +|[**put_user_id_profileskills**](UsersApi.html#put_user_id_profileskills) | **PUT** /api/v2/users/{userId}/profileskills | Update profile skills for a user| |[**put_user_id_roles**](UsersApi.html#put_user_id_roles) | **PUT** /api/v2/users/{userId}/roles | Sets the user&#39;s roles| |[**put_user_id_routingskills_skill_id**](UsersApi.html#put_user_id_routingskills_skill_id) | **PUT** /api/v2/users/{userId}/routingskills/{skillId} | Update routing skill proficiency or state.| |[**put_user_id_routingstatus**](UsersApi.html#put_user_id_routingstatus) | **PUT** /api/v2/users/{userId}/routingstatus | Update the routing status of a user| |[**put_user_id_station_associatedstation_station_id**](UsersApi.html#put_user_id_station_associatedstation_station_id) | **PUT** /api/v2/users/{userId}/station/associatedstation/{stationId} | Set associated station| |[**put_user_id_station_defaultstation_station_id**](UsersApi.html#put_user_id_station_defaultstation_station_id) | **PUT** /api/v2/users/{userId}/station/defaultstation/{stationId} | Set default station| @@ -383,11 +385,11 @@ <a name="get_search"></a> ## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search(q64, opts) -Search using q64 +Search users using the q64 value returned from a previous search ### Example ~~~ruby @@ -411,11 +413,11 @@ opts = { expand: ["expand_example"] # Array<String> | expand } begin - #Search using q64 + #Search users using the q64 value returned from a previous search result = api_instance.get_search(q64, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->get_search: #{e}" end @@ -670,10 +672,66 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_user_id_profileskills"></a> + +## -Array&lt;String&gt;** get_user_id_profileskills(user_id) + +List profile skills for a user + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# 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 + + +begin + #List profile skills for a user + result = api_instance.get_user_id_profileskills(user_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling UsersApi->get_user_id_profileskills: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **String**| User ID | +{: class="table table-striped"} + + +### Return type + +**Array&lt;String&gt;** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_user_id_queues"></a> ## -[**UserQueueEntityListing**](UserQueueEntityListing.html) get_user_id_queues(user_id, opts) Get queues for user @@ -1336,11 +1394,11 @@ <a name="post_search"></a> ## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search(body) -Search +Search users ### Example ~~~ruby @@ -1361,11 +1419,11 @@ body = PureCloud::UserSearchRequest.new # UserSearchRequest | Search request options begin - #Search + #Search users result = api_instance.post_search(body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->post_search: #{e}" end @@ -1725,9 +1783,69 @@ ### Return type [**OutOfOffice**](OutOfOffice.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="put_user_id_profileskills"></a> + +## -Array&lt;String&gt;** put_user_id_profileskills(user_id, opts) + +Update profile skills for a user + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# 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 = { + body: [PureCloud::Array<String>.new] # Array<String> | Skills +} + +begin + #Update profile skills for a user + result = api_instance.put_user_id_profileskills(user_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling UsersApi->put_user_id_profileskills: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **String**| User ID | + **body** | **Array&lt;String&gt;**| Skills | [optional] +{: class="table table-striped"} + + +### Return type + +**Array&lt;String&gt;** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json