doc_out/UsersApi.html.md in purecloud-0.67.1 vs doc_out/UsersApi.html.md in purecloud-0.68.1
- old
+ new
@@ -4,64 +4,67 @@
## PureCloud::UsersApi
All URIs are relative to *https://api.mypurecloud.com*
-Method | HTTP request | Description
+Method | Description
------------- | ------------- | -------------
-|[**delete_user_id**](UsersApi.html#delete_user_id) | **DELETE** /api/v2/users/{userId} | Delete user|
-|[**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_fieldconfig**](UsersApi.html#get_fieldconfig) | **GET** /api/v2/fieldconfig | Fetch field config for an entity type|
-|[**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|
-|[**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'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'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|
+[**delete_user_id**](UsersApi.html#delete_user_id) | Delete user
+[**delete_user_id_roles**](UsersApi.html#delete_user_id_roles) | Removes all the roles from the user.
+[**delete_user_id_routingskills_skill_id**](UsersApi.html#delete_user_id_routingskills_skill_id) | Remove routing skill from user
+[**delete_user_id_station_associatedstation**](UsersApi.html#delete_user_id_station_associatedstation) | Clear associated station
+[**delete_user_id_station_defaultstation**](UsersApi.html#delete_user_id_station_defaultstation) | Clear default station
+[**get_fieldconfig**](UsersApi.html#get_fieldconfig) | Fetch field config for an entity type
+[**get_me**](UsersApi.html#get_me) | Get current user details.
+[**get_search**](UsersApi.html#get_search) | Search users using the q64 value returned from a previous search
+[**get_user_id**](UsersApi.html#get_user_id) | Get user.
+[**get_user_id_adjacents**](UsersApi.html#get_user_id_adjacents) | Get adjacents
+[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | Get a user's CallForwarding
+[**get_user_id_directreports**](UsersApi.html#get_user_id_directreports) | Get direct reports
+[**get_user_id_favorites**](UsersApi.html#get_user_id_favorites) | Get favorites
+[**get_user_id_geolocations_client_id**](UsersApi.html#get_user_id_geolocations_client_id) | Get a user's Geolocation
+[**get_user_id_outofoffice**](UsersApi.html#get_user_id_outofoffice) | Get a OutOfOffice
+[**get_user_id_profileskills**](UsersApi.html#get_user_id_profileskills) | List profile skills for a user
+[**get_user_id_queues**](UsersApi.html#get_user_id_queues) | Get queues for user
+[**get_user_id_roles**](UsersApi.html#get_user_id_roles) | Returns a listing of roles and permissions for a user.
+[**get_user_id_routingskills**](UsersApi.html#get_user_id_routingskills) | List routing skills for user
+[**get_user_id_routingstatus**](UsersApi.html#get_user_id_routingstatus) | Fetch the routing status of a user
+[**get_user_id_station**](UsersApi.html#get_user_id_station) | Get station information for user
+[**get_user_id_superiors**](UsersApi.html#get_user_id_superiors) | Get superiors
+[**get_users**](UsersApi.html#get_users) | Get the list of available users.
+[**patch_user_id**](UsersApi.html#patch_user_id) | Update user
+[**patch_user_id_callforwarding**](UsersApi.html#patch_user_id_callforwarding) | Patch a user's CallForwarding
+[**patch_user_id_geolocations_client_id**](UsersApi.html#patch_user_id_geolocations_client_id) | Patch a user's Geolocation
+[**patch_user_id_queues**](UsersApi.html#patch_user_id_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) | Join or unjoin a queue for a user
+[**post_search**](UsersApi.html#post_search) | Search users
+[**post_user_id_routingskills**](UsersApi.html#post_user_id_routingskills) | Add routing skill to user
+[**post_users**](UsersApi.html#post_users) | Create user
+[**post_users_aggregates_query**](UsersApi.html#post_users_aggregates_query) | Query for user aggregates
+[**post_users_details_query**](UsersApi.html#post_users_details_query) | Query for user details
+[**post_users_observations_query**](UsersApi.html#post_users_observations_query) | Query for user observations
+[**put_user_id_callforwarding**](UsersApi.html#put_user_id_callforwarding) | Update a user's CallForwarding
+[**put_user_id_outofoffice**](UsersApi.html#put_user_id_outofoffice) | Update an OutOfOffice
+[**put_user_id_profileskills**](UsersApi.html#put_user_id_profileskills) | Update profile skills for a user
+[**put_user_id_roles**](UsersApi.html#put_user_id_roles) | Sets the user's roles
+[**put_user_id_routingskills_skill_id**](UsersApi.html#put_user_id_routingskills_skill_id) | Update routing skill proficiency or state.
+[**put_user_id_routingstatus**](UsersApi.html#put_user_id_routingstatus) | Update the routing status of a user
+[**put_user_id_station_associatedstation_station_id**](UsersApi.html#put_user_id_station_associatedstation_station_id) | Set associated station
+[**put_user_id_station_defaultstation_station_id**](UsersApi.html#put_user_id_station_defaultstation_station_id) | Set default station
{: class="table table-striped"}
<a name="delete_user_id"></a>
## -String** delete_user_id(user_id)
Delete user
+Wraps DELETE /api/v2/users/{userId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -114,10 +117,13 @@
Removes all the roles from the user.
+Wraps DELETE /api/v2/users/{userId}/roles
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -169,10 +175,13 @@
Remove routing skill from user
+Wraps DELETE /api/v2/users/{userId}/routingskills/{skillId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -228,10 +237,13 @@
Clear associated station
+Wraps DELETE /api/v2/users/{userId}/station/associatedstation
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -283,10 +295,13 @@
Clear default station
+Wraps DELETE /api/v2/users/{userId}/station/defaultstation
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -338,10 +353,13 @@
Fetch field config for an entity type
+Wraps GET /api/v2/fieldconfig
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -394,10 +412,13 @@
Get current user details.
This request is not valid when using the Client Credentials OAuth grant.
+Wraps GET /api/v2/users/me
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -451,10 +472,13 @@
Search users using the q64 value returned from a previous search
+Wraps GET /api/v2/users/search
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -511,10 +535,13 @@
Get user.
+Wraps GET /api/v2/users/{userId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -571,10 +598,13 @@
Get adjacents
+Wraps GET /api/v2/users/{userId}/adjacents
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -631,10 +661,13 @@
Get a user's CallForwarding
+Wraps GET /api/v2/users/{userId}/callforwarding
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -687,10 +720,13 @@
Get direct reports
+Wraps GET /api/v2/users/{userId}/directreports
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -747,10 +783,13 @@
Get favorites
+Wraps GET /api/v2/users/{userId}/favorites
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -813,10 +852,13 @@
Get a user's Geolocation
+Wraps GET /api/v2/users/{userId}/geolocations/{clientId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -872,10 +914,13 @@
Get a OutOfOffice
+Wraps GET /api/v2/users/{userId}/outofoffice
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -928,10 +973,13 @@
List profile skills for a user
+Wraps GET /api/v2/users/{userId}/profileskills
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -984,10 +1032,13 @@
Get queues for user
+Wraps GET /api/v2/users/{userId}/queues
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1048,10 +1099,13 @@
Returns a listing of roles and permissions for a user.
+Wraps GET /api/v2/users/{userId}/roles
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1104,10 +1158,13 @@
List routing skills for user
+Wraps GET /api/v2/users/{userId}/routingskills
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1168,10 +1225,13 @@
Fetch the routing status of a user
+Wraps GET /api/v2/users/{userId}/routingstatus
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1224,10 +1284,13 @@
Get station information for user
+Wraps GET /api/v2/users/{userId}/station
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1280,10 +1343,13 @@
Get superiors
+Wraps GET /api/v2/users/{userId}/superiors
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1340,10 +1406,13 @@
Get the list of available users.
+Wraps GET /api/v2/users
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1405,10 +1474,13 @@
Update user
+Wraps PATCH /api/v2/users/{userId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1464,10 +1536,13 @@
Patch a user's CallForwarding
+Wraps PATCH /api/v2/users/{userId}/callforwarding
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1523,10 +1598,13 @@
Patch a user's Geolocation
The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
+Wraps PATCH /api/v2/users/{userId}/geolocations/{clientId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1585,10 +1663,13 @@
Join or unjoin a set of queues for a user
+Wraps PATCH /api/v2/users/{userId}/queues
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1644,10 +1725,13 @@
Join or unjoin a queue for a user
+Wraps PATCH /api/v2/users/{userId}/queues/{queueId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1706,10 +1790,13 @@
Search users
+Wraps POST /api/v2/users/search
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1762,10 +1849,13 @@
Add routing skill to user
+Wraps POST /api/v2/users/{userId}/routingskills
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1821,10 +1911,13 @@
Create user
+Wraps POST /api/v2/users
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1877,10 +1970,13 @@
Query for user aggregates
+Wraps POST /api/v2/analytics/users/aggregates/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1933,10 +2029,13 @@
Query for user details
+Wraps POST /api/v2/analytics/users/details/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1989,10 +2088,13 @@
Query for user observations
+Wraps POST /api/v2/analytics/users/observations/query
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -2045,10 +2147,13 @@
Update a user's CallForwarding
+Wraps PUT /api/v2/users/{userId}/callforwarding
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -2104,10 +2209,13 @@
Update an OutOfOffice
+Wraps PUT /api/v2/users/{userId}/outofoffice
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -2163,10 +2271,13 @@
Update profile skills for a user
+Wraps PUT /api/v2/users/{userId}/profileskills
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -2223,10 +2334,13 @@
Sets the user's roles
+Wraps PUT /api/v2/users/{userId}/roles
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -2282,10 +2396,13 @@
Update routing skill proficiency or state.
+Wraps PUT /api/v2/users/{userId}/routingskills/{skillId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -2344,10 +2461,13 @@
Update the routing status of a user
+Wraps PUT /api/v2/users/{userId}/routingstatus
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -2403,10 +2523,13 @@
Set associated station
+Wraps PUT /api/v2/users/{userId}/station/associatedstation/{stationId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -2459,9 +2582,12 @@
## - put_user_id_station_defaultstation_station_id(user_id, station_id)
Set default station
+
+
+Wraps PUT /api/v2/users/{userId}/station/defaultstation/{stationId}
### Example
~~~ruby
# load the gem