doc_out/UsersApi.html.md in purecloud-0.44.1 vs doc_out/UsersApi.html.md in purecloud-0.45.1

- old
+ new

@@ -11,13 +11,13 @@ |[**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_me**](UsersApi.html#get_me) | **GET** /api/v2/users/me | Get user.| +|[**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 using q64| -|[**get_user_id**](UsersApi.html#get_user_id) | **GET** /api/v2/users/{userId} | Get user| +|[**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_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.| @@ -326,14 +326,14 @@ <a name="get_me"></a> ## -[**UserMe**](UserMe.html) get_me(opts) -Get user. +Get current user details. +This request is not valid when using the Client Credentials OAuth grant. - ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -348,15 +348,15 @@ end api_instance = PureCloud::UsersApi.new opts = { - expand: ["expand_example"] # Array<String> | Which fields, if any, to expand + expand: ["expand_example"] # Array<String> | Which fields, if any, to expand. } begin - #Get user. + #Get current user details. result = api_instance.get_me(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->get_me: #{e}" end @@ -364,11 +364,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] {: class="table table-striped"} ### Return type @@ -381,11 +381,11 @@ <a name="get_search"></a> -## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search(opts) +## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search(q64, opts) Search using q64 @@ -404,29 +404,30 @@ config.access_token = @authToken end api_instance = PureCloud::UsersApi.new +q64 = "q64_example" # String | + opts = { - q64: "q64_example", # String | expand: ["expand_example"] # Array<String> | } begin #Search using q64 - result = api_instance.get_search(opts) + result = api_instance.get_search(q64, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->get_search: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **q64** | **String**| | [optional] + **q64** | **String**| | **expand** | [**Array&lt;String&gt;**](String.html)| | [optional] {: class="table table-striped"} ### Return type @@ -442,11 +443,11 @@ <a name="get_user_id"></a> ## -[**User**](User.html) get_user_id(user_id, opts) -Get user +Get user. ### Example ~~~ruby @@ -470,11 +471,11 @@ opts = { expand: ["expand_example"] # Array<String> | Which fields, if any, to expand } begin - #Get user + #Get user. result = api_instance.get_user_id(user_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->get_user_id: #{e}" end @@ -991,11 +992,11 @@ api_instance = PureCloud::UsersApi.new opts = { page_size: 25, # Integer | Page size page_number: 1, # Integer | Page number - id: ["id_example"], # Array<String> | The list of user ids to get. Paging is ignored if ids are specified + id: ["id_example"], # Array<String> | id sort_order: "ASC", # String | Ascending or descending sort order expand: ["expand_example"] # Array<String> | Which fields, if any, to expand } begin @@ -1011,11 +1012,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] - **id** | [**Array&lt;String&gt;**](String.html)| The list of user ids to get. Paging is ignored if ids are specified | [optional] + **id** | [**Array&lt;String&gt;**](String.html)| id | [optional] **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC] **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] {: class="table table-striped"} @@ -1030,11 +1031,11 @@ <a name="patch_user_id"></a> -## -[**User**](User.html) patch_user_id(user_id, opts) +## -[**User**](User.html) patch_user_id(user_id, body) Update user @@ -1055,17 +1056,16 @@ api_instance = PureCloud::UsersApi.new user_id = "user_id_example" # String | User ID -opts = { - body: PureCloud::User.new # User | -} +body = PureCloud::User.new # User | User + begin #Update user - result = api_instance.patch_user_id(user_id, opts) + result = api_instance.patch_user_id(user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->patch_user_id: #{e}" end ~~~ @@ -1073,11 +1073,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | - **body** | [**User**](User.html)| | [optional] + **body** | [**User**](User.html)| User | {: class="table table-striped"} ### Return type @@ -1090,11 +1090,11 @@ <a name="patch_user_id_callforwarding"></a> -## -[**CallForwarding**](CallForwarding.html) patch_user_id_callforwarding(user_id, opts) +## -[**CallForwarding**](CallForwarding.html) patch_user_id_callforwarding(user_id, body) Patch a user's CallForwarding @@ -1115,17 +1115,16 @@ api_instance = PureCloud::UsersApi.new user_id = "user_id_example" # String | User ID -opts = { - body: PureCloud::CallForwarding.new # CallForwarding | -} +body = PureCloud::CallForwarding.new # CallForwarding | Call forwarding + begin #Patch a user's CallForwarding - result = api_instance.patch_user_id_callforwarding(user_id, opts) + result = api_instance.patch_user_id_callforwarding(user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->patch_user_id_callforwarding: #{e}" end ~~~ @@ -1133,11 +1132,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | - **body** | [**CallForwarding**](CallForwarding.html)| | [optional] + **body** | [**CallForwarding**](CallForwarding.html)| Call forwarding | {: class="table table-striped"} ### Return type @@ -1150,11 +1149,11 @@ <a name="patch_user_id_geolocations_client_id"></a> -## -[**Geolocation**](Geolocation.html) patch_user_id_geolocations_client_id(user_id, client_id, opts) +## -[**Geolocation**](Geolocation.html) patch_user_id_geolocations_client_id(user_id, client_id, body) 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. @@ -1177,17 +1176,16 @@ user_id = "user_id_example" # String | user Id client_id = "client_id_example" # String | client Id -opts = { - body: PureCloud::Geolocation.new # Geolocation | -} +body = PureCloud::Geolocation.new # Geolocation | Geolocation + begin #Patch a user's Geolocation - result = api_instance.patch_user_id_geolocations_client_id(user_id, client_id, opts) + result = api_instance.patch_user_id_geolocations_client_id(user_id, client_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->patch_user_id_geolocations_client_id: #{e}" end ~~~ @@ -1196,11 +1194,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| user Id | **client_id** | **String**| client Id | - **body** | [**Geolocation**](Geolocation.html)| | [optional] + **body** | [**Geolocation**](Geolocation.html)| Geolocation | {: class="table table-striped"} ### Return type @@ -1213,11 +1211,11 @@ <a name="patch_user_id_queues"></a> -## -[**UserQueue**](UserQueue.html) patch_user_id_queues(user_id, opts) +## -[**UserQueue**](UserQueue.html) patch_user_id_queues(user_id, body) Join or unjoin a set of queues for a user @@ -1238,17 +1236,16 @@ api_instance = PureCloud::UsersApi.new user_id = "user_id_example" # String | User ID -opts = { - body: [PureCloud::UserQueue.new] # Array<UserQueue> | User Queues -} +body = [PureCloud::UserQueue.new] # Array<UserQueue> | User Queues + begin #Join or unjoin a set of queues for a user - result = api_instance.patch_user_id_queues(user_id, opts) + result = api_instance.patch_user_id_queues(user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->patch_user_id_queues: #{e}" end ~~~ @@ -1256,11 +1253,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | - **body** | [**Array&lt;UserQueue&gt;**](UserQueue.html)| User Queues | [optional] + **body** | [**Array&lt;UserQueue&gt;**](UserQueue.html)| User Queues | {: class="table table-striped"} ### Return type @@ -1273,11 +1270,11 @@ <a name="patch_user_id_queues_queue_id"></a> -## -[**UserQueue**](UserQueue.html) patch_user_id_queues_queue_id(queue_id, user_id, opts) +## -[**UserQueue**](UserQueue.html) patch_user_id_queues_queue_id(queue_id, user_id, body) Join or unjoin a queue for a user @@ -1300,17 +1297,16 @@ queue_id = "queue_id_example" # String | Queue ID user_id = "user_id_example" # String | User ID -opts = { - body: PureCloud::UserQueue.new # UserQueue | Queue Member -} +body = PureCloud::UserQueue.new # UserQueue | Queue Member + begin #Join or unjoin a queue for a user - result = api_instance.patch_user_id_queues_queue_id(queue_id, user_id, opts) + result = api_instance.patch_user_id_queues_queue_id(queue_id, user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->patch_user_id_queues_queue_id: #{e}" end ~~~ @@ -1319,11 +1315,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **queue_id** | **String**| Queue ID | **user_id** | **String**| User ID | - **body** | [**UserQueue**](UserQueue.html)| Queue Member | [optional] + **body** | [**UserQueue**](UserQueue.html)| Queue Member | {: class="table table-striped"} ### Return type @@ -1336,11 +1332,11 @@ <a name="post_search"></a> -## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search(opts) +## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search(body) Search @@ -1359,28 +1355,27 @@ config.access_token = @authToken end api_instance = PureCloud::UsersApi.new -opts = { - body: PureCloud::UserSearchRequest.new # UserSearchRequest | Search request options -} +body = PureCloud::UserSearchRequest.new # UserSearchRequest | Search request options + begin #Search - result = api_instance.post_search(opts) + result = api_instance.post_search(body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->post_search: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**UserSearchRequest**](UserSearchRequest.html)| Search request options | [optional] + **body** | [**UserSearchRequest**](UserSearchRequest.html)| Search request options | {: class="table table-striped"} ### Return type @@ -1393,11 +1388,11 @@ <a name="post_user_id_routingskills"></a> -## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_id_routingskills(user_id, opts) +## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_id_routingskills(user_id, body) Add routing skill to user @@ -1418,17 +1413,16 @@ api_instance = PureCloud::UsersApi.new user_id = "user_id_example" # String | User ID -opts = { - body: PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill -} +body = PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill + begin #Add routing skill to user - result = api_instance.post_user_id_routingskills(user_id, opts) + result = api_instance.post_user_id_routingskills(user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->post_user_id_routingskills: #{e}" end ~~~ @@ -1436,11 +1430,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | - **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | [optional] + **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | {: class="table table-striped"} ### Return type @@ -1453,11 +1447,11 @@ <a name="post_users"></a> -## -[**User**](User.html) post_users(opts) +## -[**User**](User.html) post_users(body) Create user @@ -1476,28 +1470,27 @@ config.access_token = @authToken end api_instance = PureCloud::UsersApi.new -opts = { - body: PureCloud::CreateUser.new # CreateUser | User -} +body = PureCloud::CreateUser.new # CreateUser | User + begin #Create user - result = api_instance.post_users(opts) + result = api_instance.post_users(body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->post_users: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CreateUser**](CreateUser.html)| User | [optional] + **body** | [**CreateUser**](CreateUser.html)| User | {: class="table table-striped"} ### Return type @@ -1510,11 +1503,11 @@ <a name="post_users_aggregates_query"></a> -## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_users_aggregates_query(opts) +## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_users_aggregates_query(body) Query for user aggregates @@ -1533,28 +1526,27 @@ config.access_token = @authToken end api_instance = PureCloud::UsersApi.new -opts = { - body: PureCloud::AggregationQuery.new # AggregationQuery | query -} +body = PureCloud::AggregationQuery.new # AggregationQuery | query + begin #Query for user aggregates - result = api_instance.post_users_aggregates_query(opts) + result = api_instance.post_users_aggregates_query(body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->post_users_aggregates_query: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional] + **body** | [**AggregationQuery**](AggregationQuery.html)| query | {: class="table table-striped"} ### Return type @@ -1567,11 +1559,11 @@ <a name="post_users_observations_query"></a> -## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(opts) +## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(body) Query for user observations @@ -1590,28 +1582,27 @@ config.access_token = @authToken end api_instance = PureCloud::UsersApi.new -opts = { - body: PureCloud::ObservationQuery.new # ObservationQuery | query -} +body = PureCloud::ObservationQuery.new # ObservationQuery | query + begin #Query for user observations - result = api_instance.post_users_observations_query(opts) + result = api_instance.post_users_observations_query(body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->post_users_observations_query: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ObservationQuery**](ObservationQuery.html)| query | [optional] + **body** | [**ObservationQuery**](ObservationQuery.html)| query | {: class="table table-striped"} ### Return type @@ -1624,11 +1615,11 @@ <a name="put_user_id_callforwarding"></a> -## -[**CallForwarding**](CallForwarding.html) put_user_id_callforwarding(user_id, opts) +## -[**CallForwarding**](CallForwarding.html) put_user_id_callforwarding(user_id, body) Update a user's CallForwarding @@ -1649,17 +1640,16 @@ api_instance = PureCloud::UsersApi.new user_id = "user_id_example" # String | User ID -opts = { - body: PureCloud::CallForwarding.new # CallForwarding | -} +body = PureCloud::CallForwarding.new # CallForwarding | Call forwarding + begin #Update a user's CallForwarding - result = api_instance.put_user_id_callforwarding(user_id, opts) + result = api_instance.put_user_id_callforwarding(user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->put_user_id_callforwarding: #{e}" end ~~~ @@ -1667,11 +1657,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | - **body** | [**CallForwarding**](CallForwarding.html)| | [optional] + **body** | [**CallForwarding**](CallForwarding.html)| Call forwarding | {: class="table table-striped"} ### Return type @@ -1743,11 +1733,11 @@ <a name="put_user_id_roles"></a> -## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id, opts) +## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id, body) Sets the user's roles @@ -1768,17 +1758,16 @@ api_instance = PureCloud::UsersApi.new user_id = "user_id_example" # String | User ID -opts = { - body: [PureCloud::Array<String>.new] # Array<String> | -} +body = [PureCloud::Array<String>.new] # Array<String> | List of roles + begin #Sets the user's roles - result = api_instance.put_user_id_roles(user_id, opts) + result = api_instance.put_user_id_roles(user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->put_user_id_roles: #{e}" end ~~~ @@ -1786,11 +1775,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | - **body** | **Array&lt;String&gt;**| | [optional] + **body** | **Array&lt;String&gt;**| List of roles | {: class="table table-striped"} ### Return type @@ -1803,11 +1792,11 @@ <a name="put_user_id_routingskills_skill_id"></a> -## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_id_routingskills_skill_id(user_id, skill_id, opts) +## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_id_routingskills_skill_id(user_id, skill_id, body) Update routing skill proficiency or state. @@ -1830,17 +1819,16 @@ user_id = "user_id_example" # String | User ID skill_id = "skill_id_example" # String | -opts = { - body: PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill -} +body = PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill + begin #Update routing skill proficiency or state. - result = api_instance.put_user_id_routingskills_skill_id(user_id, skill_id, opts) + result = api_instance.put_user_id_routingskills_skill_id(user_id, skill_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->put_user_id_routingskills_skill_id: #{e}" end ~~~ @@ -1849,11 +1837,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | **skill_id** | **String**| | - **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | [optional] + **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | {: class="table table-striped"} ### Return type @@ -1866,11 +1854,11 @@ <a name="put_user_id_routingstatus"></a> -## -[**RoutingStatus**](RoutingStatus.html) put_user_id_routingstatus(user_id, opts) +## -[**RoutingStatus**](RoutingStatus.html) put_user_id_routingstatus(user_id, body) Update the routing status of a user @@ -1891,17 +1879,16 @@ api_instance = PureCloud::UsersApi.new user_id = "user_id_example" # String | User ID -opts = { - body: PureCloud::RoutingStatus.new # RoutingStatus | Routing Status -} +body = PureCloud::RoutingStatus.new # RoutingStatus | Routing Status + begin #Update the routing status of a user - result = api_instance.put_user_id_routingstatus(user_id, opts) + result = api_instance.put_user_id_routingstatus(user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling UsersApi->put_user_id_routingstatus: #{e}" end ~~~ @@ -1909,10 +1896,10 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **String**| User ID | - **body** | [**RoutingStatus**](RoutingStatus.html)| Routing Status | [optional] + **body** | [**RoutingStatus**](RoutingStatus.html)| Routing Status | {: class="table table-striped"} ### Return type