doc_out/UsersApi.html.md in purecloud-0.53.1 vs doc_out/UsersApi.html.md in purecloud-0.54.1
- old
+ new
@@ -14,19 +14,23 @@
|[**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 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_adjacents**](UsersApi.html#get_user_id_adjacents) | **GET** /api/v2/users/{userId}/adjacents | Get adjacents|
|[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | **GET** /api/v2/users/{userId}/callforwarding | Get a user's CallForwarding|
+|[**get_user_id_directreports**](UsersApi.html#get_user_id_directreports) | **GET** /api/v2/users/{userId}/directreports | Get direct reports|
+|[**get_user_id_favorites**](UsersApi.html#get_user_id_favorites) | **GET** /api/v2/users/{userId}/favorites | Get favorites|
|[**get_user_id_geolocations_client_id**](UsersApi.html#get_user_id_geolocations_client_id) | **GET** /api/v2/users/{userId}/geolocations/{clientId} | Get a user'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|
+|[**get_user_id_superiors**](UsersApi.html#get_user_id_superiors) | **GET** /api/v2/users/{userId}/superiors | Get superiors|
|[**get_users**](UsersApi.html#get_users) | **GET** /api/v2/users | Get the list of available users.|
|[**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'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'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|
@@ -501,10 +505,69 @@
- **Content-Type**: application/json
- **Accept**: application/json
+<a name="get_user_id_adjacents"></a>
+
+## - get_user_id_adjacents(user_id, opts)
+
+Get adjacents
+
+
+
+### 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 = {
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+}
+
+begin
+ #Get adjacents
+ api_instance.get_user_id_adjacents(user_id, opts)
+rescue PureCloud::ApiError => e
+ puts "Exception when calling UsersApi->get_user_id_adjacents: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |
+ **expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
<a name="get_user_id_callforwarding"></a>
## -[**CallForwarding**](CallForwarding.html) get_user_id_callforwarding(user_id)
Get a user's CallForwarding
@@ -557,10 +620,134 @@
- **Content-Type**: application/json
- **Accept**: application/json
+<a name="get_user_id_directreports"></a>
+
+## - get_user_id_directreports(user_id, opts)
+
+Get direct reports
+
+
+
+### 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 = {
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+}
+
+begin
+ #Get direct reports
+ api_instance.get_user_id_directreports(user_id, opts)
+rescue PureCloud::ApiError => e
+ puts "Exception when calling UsersApi->get_user_id_directreports: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |
+ **expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_user_id_favorites"></a>
+
+## - get_user_id_favorites(user_id, opts)
+
+Get favorites
+
+
+
+### 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 = {
+ page_size: 25, # Integer | Page size
+ page_number: 1, # Integer | Page number
+ sort_order: "ASC", # String | Sort order
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+}
+
+begin
+ #Get favorites
+ api_instance.get_user_id_favorites(user_id, opts)
+rescue PureCloud::ApiError => e
+ puts "Exception when calling UsersApi->get_user_id_favorites: #{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**| Sort order | [optional] [default to ASC]
+ **expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
<a name="get_user_id_geolocations_client_id"></a>
## -[**Geolocation**](Geolocation.html) get_user_id_geolocations_client_id(user_id, client_id)
Get a user's Geolocation
@@ -1016,9 +1203,68 @@
### Return type
[**UserStations**](UserStations.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_user_id_superiors"></a>
+
+## - get_user_id_superiors(user_id, opts)
+
+Get superiors
+
+
+
+### 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 = {
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+}
+
+begin
+ #Get superiors
+ api_instance.get_user_id_superiors(user_id, opts)
+rescue PureCloud::ApiError => e
+ puts "Exception when calling UsersApi->get_user_id_superiors: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |
+ **expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json