doc_out/UsersApi.html.md in purecloud-0.36.1 vs doc_out/UsersApi.html.md in purecloud-0.37.1

- old
+ new

@@ -17,21 +17,19 @@ |[**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_presences_source**](UsersApi.html#get_user_id_presences_source) | **GET** /api/v2/users/{userId}/presences/{source} | Get a user&#39;s Presence| |[**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_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&#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_presences_source**](UsersApi.html#patch_user_id_presences_source) | **PATCH** /api/v2/users/{userId}/presences/{source} | Patch a user&#39;s Presence| |[**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_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| @@ -670,69 +668,10 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="get_user_id_presences_source"></a> - -## -[**UserPresence**](UserPresence.html) get_user_id_presences_source(user_id, source) - -Get a user's Presence - - - -### 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 - -source = "source_example" # String | source - - -begin - #Get a user's Presence - result = api_instance.get_user_id_presences_source(user_id, source) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling UsersApi->get_user_id_presences_source: #{e}" -end -~~~ - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **String**| user Id | - **source** | **String**| source | -{: class="table table-striped"} - - -### Return type - -[**UserPresence**](UserPresence.html) - -### 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 @@ -1263,72 +1202,9 @@ ### Return type [**Geolocation**](Geolocation.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - -<a name="patch_user_id_presences_source"></a> - -## -[**UserPresence**](UserPresence.html) patch_user_id_presences_source(user_id, source, opts) - -Patch a user's Presence - -The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. Option 3: Provide the message value. Option 1 can be combined with Option2 and/or Option 3. - -### 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 - -source = "source_example" # String | source - -opts = { - body: PureCloud::UserPresence.new # UserPresence | -} - -begin - #Patch a user's Presence - result = api_instance.patch_user_id_presences_source(user_id, source, opts) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling UsersApi->patch_user_id_presences_source: #{e}" -end -~~~ - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **String**| user Id | - **source** | **String**| source | - **body** | [**UserPresence**](UserPresence.html)| | [optional] -{: class="table table-striped"} - - -### Return type - -[**UserPresence**](UserPresence.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json