UsersApi.md in purecloudplatformclientv2-72.0.0

- old
+ new

@@ -6,17 +6,20 @@
 
 All URIs are relative to *https://api.mypurecloud.com*
 
 Method | Description
 ------------- | ------------- | -------------
+[**delete_analytics_users_details_job**](UsersApi.html#delete_analytics_users_details_job) | Delete/cancel an async request
 [**delete_authorization_subject_division_role**](UsersApi.html#delete_authorization_subject_division_role) | Delete a grant of a role in a division
 [**delete_user**](UsersApi.html#delete_user) | Delete user
 [**delete_user_roles**](UsersApi.html#delete_user_roles) | Removes all the roles from the user.
 [**delete_user_routinglanguage**](UsersApi.html#delete_user_routinglanguage) | Remove routing language from user
 [**delete_user_routingskill**](UsersApi.html#delete_user_routingskill) | Remove routing skill from user
 [**delete_user_station_associatedstation**](UsersApi.html#delete_user_station_associatedstation) | Clear associated station
 [**delete_user_station_defaultstation**](UsersApi.html#delete_user_station_defaultstation) | Clear default station
+[**get_analytics_users_details_job**](UsersApi.html#get_analytics_users_details_job) | Get status for async query for user details
+[**get_analytics_users_details_job_results**](UsersApi.html#get_analytics_users_details_job_results) | Fetch a page of results for an async query
 [**get_authorization_divisionspermitted_me**](UsersApi.html#get_authorization_divisionspermitted_me) | Returns whether or not current user can perform the specified action(s).
 [**get_authorization_divisionspermitted_subject_id**](UsersApi.html#get_authorization_divisionspermitted_subject_id) | Returns whether or not specified user can perform the specified action(s).
 [**get_authorization_subject**](UsersApi.html#get_authorization_subject) | Returns a listing of roles and permissions for a user.
 [**get_authorization_subjects_me**](UsersApi.html#get_authorization_subjects_me) | Returns a listing of roles and permissions for the currently authenticated user.
 [**get_fieldconfig**](UsersApi.html#get_fieldconfig) | Fetch field config for an entity type
@@ -49,10 +52,11 @@
 [**patch_user_routinglanguage**](UsersApi.html#patch_user_routinglanguage) | Update routing language proficiency or state.
 [**patch_user_routinglanguages_bulk**](UsersApi.html#patch_user_routinglanguages_bulk) | Add bulk routing language to user. Max limit 50 languages
 [**patch_user_routingskills_bulk**](UsersApi.html#patch_user_routingskills_bulk) | Bulk add routing skills to user
 [**patch_users_bulk**](UsersApi.html#patch_users_bulk) | Update bulk acd autoanswer on users
 [**post_analytics_users_aggregates_query**](UsersApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
+[**post_analytics_users_details_jobs**](UsersApi.html#post_analytics_users_details_jobs) | Query for user details asynchronously
 [**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details
 [**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations
 [**post_authorization_subject_bulkadd**](UsersApi.html#post_authorization_subject_bulkadd) | Bulk-grant roles and divisions to a subject.
 [**post_authorization_subject_bulkremove**](UsersApi.html#post_authorization_subject_bulkremove) | Bulk-remove grants from a subject.
 [**post_authorization_subject_division_role**](UsersApi.html#post_authorization_subject_division_role) | Make a grant of a role in a division
@@ -72,10 +76,74 @@
 [**put_user_routingstatus**](UsersApi.html#put_user_routingstatus) | Update the routing status of a user
 [**put_user_station_associatedstation_station_id**](UsersApi.html#put_user_station_associatedstation_station_id) | Set associated station
 [**put_user_station_defaultstation_station_id**](UsersApi.html#put_user_station_defaultstation_station_id) | Set default station
 {: class="table table-striped"}
 
+<a name="delete_analytics_users_details_job"></a>
+
+##  delete_analytics_users_details_job(job_id)
+
+
+
+Delete/cancel an async request
+
+
+
+Wraps DELETE /api/v2/analytics/users/details/jobs/{jobId} 
+
+Requires ANY permissions: 
+
+* analytics:userDetail:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# 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
+
+job_id = "job_id_example" # String | jobId
+
+
+begin
+  #Delete/cancel an async request
+  api_instance.delete_analytics_users_details_job(job_id)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->delete_analytics_users_details_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_id** | **String**| jobId |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="delete_authorization_subject_division_role"></a>
 
 ##  delete_authorization_subject_division_role(subject_id, division_id, role_id)
 
 
@@ -534,10 +602,144 @@
  - **Content-Type**: application/json
  - **Accept**: application/json
 
 
 
+<a name="get_analytics_users_details_job"></a>
+
+## [**AsyncQueryStatus**](AsyncQueryStatus.html) get_analytics_users_details_job(job_id)
+
+
+
+Get status for async query for user details
+
+
+
+Wraps GET /api/v2/analytics/users/details/jobs/{jobId} 
+
+Requires ANY permissions: 
+
+* analytics:userDetail:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# 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
+
+job_id = "job_id_example" # String | jobId
+
+
+begin
+  #Get status for async query for user details
+  result = api_instance.get_analytics_users_details_job(job_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_analytics_users_details_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_id** | **String**| jobId |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AsyncQueryStatus**](AsyncQueryStatus.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_analytics_users_details_job_results"></a>
+
+## [**AnalyticsUserDetailsAsyncQueryResponse**](AnalyticsUserDetailsAsyncQueryResponse.html) get_analytics_users_details_job_results(job_id, opts)
+
+
+
+Fetch a page of results for an async query
+
+
+
+Wraps GET /api/v2/analytics/users/details/jobs/{jobId}/results 
+
+Requires ANY permissions: 
+
+* analytics:userDetail:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# 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
+
+job_id = "job_id_example" # String | jobId
+
+opts = { 
+  cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page)
+}
+
+begin
+  #Fetch a page of results for an async query
+  result = api_instance.get_analytics_users_details_job_results(job_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_analytics_users_details_job_results: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_id** | **String**| jobId |  |
+ **cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AnalyticsUserDetailsAsyncQueryResponse**](AnalyticsUserDetailsAsyncQueryResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_authorization_divisionspermitted_me"></a>
 
 ## [**Array&lt;AuthzDivision&gt;**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
 
 
@@ -2985,9 +3187,74 @@
 
 
 ### Return type
 
 [**UserAggregateQueryResponse**](UserAggregateQueryResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_analytics_users_details_jobs"></a>
+
+## [**AsyncQueryResponse**](AsyncQueryResponse.html) post_analytics_users_details_jobs(body)
+
+
+
+Query for user details asynchronously
+
+
+
+Wraps POST /api/v2/analytics/users/details/jobs 
+
+Requires ANY permissions: 
+
+* analytics:userDetail:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# 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
+
+body = PureCloud::AsyncUserDetailsQuery.new # AsyncUserDetailsQuery | query
+
+
+begin
+  #Query for user details asynchronously
+  result = api_instance.post_analytics_users_details_jobs(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->post_analytics_users_details_jobs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AsyncUserDetailsQuery**](AsyncUserDetailsQuery.html)| query |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AsyncQueryResponse**](AsyncQueryResponse.html)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
  - **Accept**: application/json