docs/UsersApi.md in purecloudplatformclientv2-93.0.0 vs docs/UsersApi.md in purecloudplatformclientv2-94.0.0
- old
+ new
@@ -1178,11 +1178,12 @@
page_size: 25, # Integer | Page size
page_number: 1, # Integer | Page number
id: ["id_example"], # Array<String> | id
jid: ["jid_example"], # Array<String> | jid
sort_order: "ASC", # String | Ascending or descending sort order
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+ expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
+ integration_presence_source: "integration_presence_source_example" # String | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\".
}
begin
#Get a user profile listing
result = api_instance.get_profiles_users(opts)
@@ -1200,10 +1201,11 @@
**page_number** | **Integer**| Page number | [optional] [default to 1] |
**id** | [**Array<String>**](String.html)| id | [optional] |
**jid** | [**Array<String>**](String.html)| jid | [optional] |
**sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization |
+ **integration_presence_source** | **String**| Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
{: class="table table-striped"}
### Return type
@@ -1317,10 +1319,11 @@
user_id = "user_id_example" # String | User ID
opts = {
expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
+ integration_presence_source: "integration_presence_source_example", # String | Gets an integration presence for a user instead of their default.
state: "active" # String | Search for a user with this state
}
begin
#Get user.
@@ -1335,10 +1338,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user_id** | **String**| User ID | |
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography |
+ **integration_presence_source** | **String**| Gets an integration presence for a user instead of their default. | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
**state** | **String**| Search for a user with this state | [optional] [default to active]<br />**Values**: active, deleted |
{: class="table table-striped"}
### Return type
@@ -1791,11 +1795,12 @@
api_instance = PureCloud::UsersApi.new
user_id = "user_id_example" # String | userId
opts = {
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+ expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
+ integration_presence_source: "integration_presence_source_example" # String | Gets an integration presence for a user instead of their default.
}
begin
#Get user profile
result = api_instance.get_user_profile(user_id, opts)
@@ -1809,10 +1814,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user_id** | **String**| userId | |
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team |
+ **integration_presence_source** | **String**| Gets an integration presence for a user instead of their default. | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
{: class="table table-striped"}
### Return type
@@ -2480,10 +2486,11 @@
page_number: 1, # Integer | Page number
id: ["id_example"], # Array<String> | A list of user IDs to fetch by bulk
jabber_id: ["jabber_id_example"], # Array<String> | A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)
sort_order: "ASC", # String | Ascending or descending sort order
expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
+ integration_presence_source: "integration_presence_source_example", # String | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.
state: "active" # String | Only list users of this state
}
begin
#Get the list of available users.
@@ -2502,10 +2509,11 @@
**page_number** | **Integer**| Page number | [optional] [default to 1] |
**id** | [**Array<String>**](String.html)| A list of user IDs to fetch by bulk | [optional] |
**jabber_id** | [**Array<String>**](String.html)| A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) | [optional] |
**sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography |
+ **integration_presence_source** | **String**| Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10. | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
**state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, inactive, deleted, any |
{: class="table table-striped"}
### Return type
@@ -2551,11 +2559,12 @@
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.
+ integration_presence_source: "integration_presence_source_example" # String | Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".
}
begin
#Get current user details.
result = api_instance.get_users_me(opts)
@@ -2568,10 +2577,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, date, geolocationsettings, organization, presencedefinitions, locationdefinitions, orgauthorization, orgproducts, favorites, superiors, directreports, adjacents, routingskills, routinglanguages, fieldconfigs, token, trustors |
+ **integration_presence_source** | **String**| Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\". | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
{: class="table table-striped"}
### Return type
@@ -2618,11 +2628,12 @@
api_instance = PureCloud::UsersApi.new
q64 = "q64_example" # String | q64
opts = {
- expand: ["expand_example"] # Array<String> | expand
+ expand: ["expand_example"], # Array<String> | expand
+ integration_presence_source: "integration_presence_source_example" # String | integrationPresenceSource
}
begin
#Search users using the q64 value returned from a previous search
result = api_instance.get_users_search(q64, opts)
@@ -2636,9 +2647,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**q64** | **String**| q64 | |
**expand** | [**Array<String>**](String.html)| expand | [optional] |
+ **integration_presence_source** | **String**| integrationPresenceSource | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
{: class="table table-striped"}
### Return type