docs/UsersApi.md in purecloudplatformclientv2-8.0.0 vs docs/UsersApi.md in purecloudplatformclientv2-9.0.0

- old
+ new

@@ -94,11 +94,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -152,11 +152,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -212,12 +212,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **skill_id** | **String**| skillId | + **user_id** | **String**| User ID | | + **skill_id** | **String**| skillId | | {: class="table table-striped"} ### Return type @@ -271,11 +271,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -329,11 +329,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -388,11 +388,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **type** | **String**| Field type | + **type** | **String**| Field type | <br />**Values**: person, group, org, externalContact | {: class="table table-striped"} ### Return type @@ -434,11 +434,12 @@ 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 + expand: ["expand_example"], # Array<String> | Which fields, if any, to expand + state: "active" # String | Search for a user with this state } begin #Get user. result = api_instance.get_user(user_id, opts) @@ -450,12 +451,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] + **user_id** | **String**| User ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups | + **state** | **String**| Search for a user with this state | [optional] [default to active]<br />**Values**: active, deleted | {: class="table table-striped"} ### Return type @@ -513,12 +515,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] + **user_id** | **String**| User ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups | {: class="table table-striped"} ### Return type @@ -573,11 +575,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -635,12 +637,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] + **user_id** | **String**| User ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups | {: class="table table-striped"} ### Return type @@ -701,15 +703,15 @@ ### 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&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] + **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&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups | {: class="table table-striped"} ### Return type @@ -766,12 +768,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| user Id | - **client_id** | **String**| client Id | + **user_id** | **String**| user Id | | + **client_id** | **String**| client Id | | {: class="table table-striped"} ### Return type @@ -826,11 +828,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -885,11 +887,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -949,14 +951,14 @@ ### 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] - **joined** | **BOOLEAN**| Is joined to the queue | [optional] [default to true] + **user_id** | **String**| User ID | | + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | + **joined** | **BOOLEAN**| Is joined to the queue | [optional] [default to true] | {: class="table table-striped"} ### Return type @@ -1011,11 +1013,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -1075,14 +1077,14 @@ ### 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**| Ascending or descending sort order | [optional] [default to ASC] + **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**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending | {: class="table table-striped"} ### Return type @@ -1137,11 +1139,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -1196,11 +1198,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | + **user_id** | **String**| User ID | | {: class="table table-striped"} ### Return type @@ -1258,12 +1260,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] + **user_id** | **String**| User ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups | {: class="table table-striped"} ### Return type @@ -1324,16 +1326,16 @@ ### Parameters 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)| 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] - **state** | **String**| Only list users of this state | [optional] [default to active] + **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)| id | [optional] | + **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups | + **state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, deleted | {: class="table table-striped"} ### Return type @@ -1389,11 +1391,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] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, date, geolocationsettings, organization, presencedefinitions, locationdefinitions, orgauthorization, favorites, superiors, directreports, adjacents, routingskills, routinglanguages, fieldconfigs, token | {: class="table table-striped"} ### Return type @@ -1451,12 +1453,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **q64** | **String**| q64 | - **expand** | [**Array&lt;String&gt;**](String.html)| expand | [optional] + **q64** | **String**| q64 | | + **expand** | [**Array&lt;String&gt;**](String.html)| expand | [optional] | {: class="table table-striped"} ### Return type @@ -1513,12 +1515,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **body** | [**UpdateUser**](UpdateUser.html)| User | + **user_id** | **String**| User ID | | + **body** | [**UpdateUser**](UpdateUser.html)| User | | {: class="table table-striped"} ### Return type @@ -1575,12 +1577,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **body** | [**CallForwarding**](CallForwarding.html)| Call forwarding | + **user_id** | **String**| User ID | | + **body** | [**CallForwarding**](CallForwarding.html)| Call forwarding | | {: class="table table-striped"} ### Return type @@ -1639,13 +1641,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| user Id | - **client_id** | **String**| client Id | - **body** | [**Geolocation**](Geolocation.html)| Geolocation | + **user_id** | **String**| user Id | | + **client_id** | **String**| client Id | | + **body** | [**Geolocation**](Geolocation.html)| Geolocation | | {: class="table table-striped"} ### Return type @@ -1704,13 +1706,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **queue_id** | **String**| Queue ID | - **user_id** | **String**| User ID | - **body** | [**UserQueue**](UserQueue.html)| Queue Member | + **queue_id** | **String**| Queue ID | | + **user_id** | **String**| User ID | | + **body** | [**UserQueue**](UserQueue.html)| Queue Member | | {: class="table table-striped"} ### Return type @@ -1767,12 +1769,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **body** | [**Array&lt;UserQueue&gt;**](UserQueue.html)| User Queues | + **user_id** | **String**| User ID | | + **body** | [**Array&lt;UserQueue&gt;**](UserQueue.html)| User Queues | | {: class="table table-striped"} ### Return type @@ -1827,11 +1829,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**AggregationQuery**](AggregationQuery.html)| query | + **body** | [**AggregationQuery**](AggregationQuery.html)| query | | {: class="table table-striped"} ### Return type @@ -1886,11 +1888,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**UserDetailsQuery**](UserDetailsQuery.html)| query | + **body** | [**UserDetailsQuery**](UserDetailsQuery.html)| query | | {: class="table table-striped"} ### Return type @@ -1945,11 +1947,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ObservationQuery**](ObservationQuery.html)| query | + **body** | [**ObservationQuery**](ObservationQuery.html)| query | | {: class="table table-striped"} ### Return type @@ -2006,12 +2008,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **body** | [**UserRoutingSkillPost**](UserRoutingSkillPost.html)| Skill | + **user_id** | **String**| User ID | | + **body** | [**UserRoutingSkillPost**](UserRoutingSkillPost.html)| Skill | | {: class="table table-striped"} ### Return type @@ -2066,11 +2068,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CreateUser**](CreateUser.html)| User | + **body** | [**CreateUser**](CreateUser.html)| User | | {: class="table table-striped"} ### Return type @@ -2125,11 +2127,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**UserSearchRequest**](UserSearchRequest.html)| Search request options | + **body** | [**UserSearchRequest**](UserSearchRequest.html)| Search request options | | {: class="table table-striped"} ### Return type @@ -2186,12 +2188,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **body** | [**CallForwarding**](CallForwarding.html)| Call forwarding | + **user_id** | **String**| User ID | | + **body** | [**CallForwarding**](CallForwarding.html)| Call forwarding | | {: class="table table-striped"} ### Return type @@ -2248,12 +2250,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **body** | [**OutOfOffice**](OutOfOffice.html)| The updated UserPresence | + **user_id** | **String**| User ID | | + **body** | [**OutOfOffice**](OutOfOffice.html)| The updated UserPresence | | {: class="table table-striped"} ### Return type @@ -2311,12 +2313,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **body** | **Array&lt;String&gt;**| Skills | [optional] + **user_id** | **String**| User ID | | + **body** | **Array&lt;String&gt;**| Skills | [optional] | {: class="table table-striped"} ### Return type @@ -2373,12 +2375,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **body** | **Array&lt;String&gt;**| List of roles | + **user_id** | **String**| User ID | | + **body** | **Array&lt;String&gt;**| List of roles | | {: class="table table-striped"} ### Return type @@ -2437,13 +2439,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **skill_id** | **String**| skillId | - **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | + **user_id** | **String**| User ID | | + **skill_id** | **String**| skillId | | + **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | | {: class="table table-striped"} ### Return type @@ -2500,12 +2502,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **body** | [**RoutingStatus**](RoutingStatus.html)| Routing Status | + **user_id** | **String**| User ID | | + **body** | [**RoutingStatus**](RoutingStatus.html)| Routing Status | | {: class="table table-striped"} ### Return type @@ -2561,12 +2563,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **station_id** | **String**| stationId | + **user_id** | **String**| User ID | | + **station_id** | **String**| stationId | | {: class="table table-striped"} ### Return type @@ -2622,11 +2624,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **String**| User ID | - **station_id** | **String**| stationId | + **user_id** | **String**| User ID | | + **station_id** | **String**| stationId | | {: class="table table-striped"} ### Return type