doc_out/UsersApi.html.md in purecloud-0.40.1 vs doc_out/UsersApi.html.md in purecloud-0.41.1

- old
+ new

@@ -17,11 +17,10 @@ |[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search using q64| |[**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| @@ -36,11 +35,10 @@ |[**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| @@ -671,66 +669,10 @@ - **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 @@ -1418,11 +1360,11 @@ end api_instance = PureCloud::UsersApi.new opts = { - body: PureCloud::SearchRequest.new # SearchRequest | Search request options + body: PureCloud::UserSearchRequest.new # UserSearchRequest | Search request options } begin #Search result = api_instance.post_search(opts) @@ -1434,11 +1376,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**SearchRequest**](SearchRequest.html)| Search request options | [optional] + **body** | [**UserSearchRequest**](UserSearchRequest.html)| Search request options | [optional] {: class="table table-striped"} ### Return type @@ -1791,69 +1733,9 @@ ### 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