doc_out/UsersApi.html.md in purecloud-0.58.1 vs doc_out/UsersApi.html.md in purecloud-0.59.1

- old
+ new

@@ -38,10 +38,11 @@ |[**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 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_details_query**](UsersApi.html#post_users_details_query) | **POST** /api/v2/analytics/users/details/query | Query for user details| |[**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| @@ -564,11 +565,11 @@ <a name="get_user_id_adjacents"></a> -## - get_user_id_adjacents(user_id, opts) +## -[**Adjacents**](Adjacents.html) get_user_id_adjacents(user_id, opts) Get adjacents @@ -595,11 +596,12 @@ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand } begin #Get adjacents - api_instance.get_user_id_adjacents(user_id, opts) + result = api_instance.get_user_id_adjacents(user_id, opts) + p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->get_user_id_adjacents: #{e}" end ~~~ @@ -612,11 +614,11 @@ {: class="table table-striped"} ### Return type -nil (empty response body) +[**Adjacents**](Adjacents.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json @@ -679,11 +681,11 @@ <a name="get_user_id_directreports"></a> -## - get_user_id_directreports(user_id, opts) +## -[**Array&lt;User&gt;**](User.html) get_user_id_directreports(user_id, opts) Get direct reports @@ -710,11 +712,12 @@ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand } begin #Get direct reports - api_instance.get_user_id_directreports(user_id, opts) + result = api_instance.get_user_id_directreports(user_id, opts) + p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->get_user_id_directreports: #{e}" end ~~~ @@ -727,22 +730,22 @@ {: class="table table-striped"} ### Return type -nil (empty response body) +[**Array&lt;User&gt;**](User.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="get_user_id_favorites"></a> -## - get_user_id_favorites(user_id, opts) +## -[**UserEntityListing**](UserEntityListing.html) get_user_id_favorites(user_id, opts) Get favorites @@ -772,11 +775,12 @@ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand } begin #Get favorites - api_instance.get_user_id_favorites(user_id, opts) + result = api_instance.get_user_id_favorites(user_id, opts) + p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->get_user_id_favorites: #{e}" end ~~~ @@ -792,11 +796,11 @@ {: class="table table-striped"} ### Return type -nil (empty response body) +[**UserEntityListing**](UserEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json @@ -1270,11 +1274,11 @@ <a name="get_user_id_superiors"></a> -## - get_user_id_superiors(user_id, opts) +## -[**Array&lt;User&gt;**](User.html) get_user_id_superiors(user_id, opts) Get superiors @@ -1301,11 +1305,12 @@ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand } begin #Get superiors - api_instance.get_user_id_superiors(user_id, opts) + result = api_instance.get_user_id_superiors(user_id, opts) + p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->get_user_id_superiors: #{e}" end ~~~ @@ -1318,11 +1323,11 @@ {: class="table table-striped"} ### Return type -nil (empty response body) +[**Array&lt;User&gt;**](User.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json @@ -1912,9 +1917,65 @@ ### Return type [**PresenceQueryResponse**](PresenceQueryResponse.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="post_users_details_query"></a> + +## -[**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_users_details_query(body) + +Query for user details + + + +### 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 + +body = PureCloud::UserDetailsQuery.new # UserDetailsQuery | query + + +begin + #Query for user details + result = api_instance.post_users_details_query(body) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling UsersApi->post_users_details_query: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UserDetailsQuery**](UserDetailsQuery.html)| query | +{: class="table table-striped"} + + +### Return type + +[**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json