purecloudplatformclientv2 71.0.0 → 72.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1862707a3f45de0a91a07d11e3a7f90539d204ec
-  data.tar.gz: 263189a8fc54b59e9c0944e11d33ae718ace917e
+  metadata.gz: 5f85a76319d416b5a693e8859cd29b46f5f38b2f
+  data.tar.gz: '03369d8306000726d397c2c83aba1205661602c6'
 SHA512:
-  metadata.gz: 4eb3307c7247082de5d2d1a66d4c817ba525b6276dbec07739fc3d44e108353f5143c3241fb6274065f74ee4393ec78d6f2eacc4d2062a66c610498bd39f7793
-  data.tar.gz: 9364e57a2200b6918a1eaa5904f8356c368fba9f1276d0fe02ed61f113dd2ae91a6d15787e41f10907f3aedbe93ff146e9547d653d895304c155a919398dd596
+  metadata.gz: 543a1b902492222b7d9d69884e69a85c8bff8159ccbd626bffc1a27c17c2c842a383412838481e810e647c72dbdf96f74b6ee3d792f7bd75d74e21af1b79fee9
+  data.tar.gz: 97cc05306051a292398ea4e0dc26c2c4dea89257ad22968b1a5b53ed14fa2e32831fea01406bfe15ee8e07cb8e97d98fb9f9d8d3a89164c288a7676abb910363

data/README.md

@@ -1,7 +1,7 @@
 ---
 title: PureCloud Ruby Gem
 ---
-![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=71.0.0)
+![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=72.0.0)
 
 Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
 ### from rubygems.org
 
 ```{"language":"ruby"}
-gem install 'purecloudplatformclientv2', '~> 71.0.0'
+gem install 'purecloudplatformclientv2', '~> 72.0.0'
 ```
 
 ### Install from Git

data/docs/ActionEntityListing.md

@@ -12,10 +12,10 @@ title: ActionEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/AgentActivityEntityListing.md

@@ -12,10 +12,10 @@ title: AgentActivityEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/AnalyticsApi.md

@@ -10,6 +10,7 @@ Method | Description
 ------------- | ------------- | -------------
 [**delete_analytics_conversations_details_job**](AnalyticsApi.html#delete_analytics_conversations_details_job) | Delete/cancel an async request
 [**delete_analytics_reporting_schedule**](AnalyticsApi.html#delete_analytics_reporting_schedule) | Delete a scheduled report job.
+[**delete_analytics_users_details_job**](AnalyticsApi.html#delete_analytics_users_details_job) | Delete/cancel an async request
 [**get_analytics_conversation_details**](AnalyticsApi.html#get_analytics_conversation_details) | Get a conversation by id
 [**get_analytics_conversations_details**](AnalyticsApi.html#get_analytics_conversations_details) | Gets multiple conversations by id
 [**get_analytics_conversations_details_job**](AnalyticsApi.html#get_analytics_conversations_details_job) | Get status for async query for conversation details
@@ -24,6 +25,8 @@ Method | Description
 [**get_analytics_reporting_schedule_history_run_id**](AnalyticsApi.html#get_analytics_reporting_schedule_history_run_id) | A completed scheduled report job
 [**get_analytics_reporting_schedules**](AnalyticsApi.html#get_analytics_reporting_schedules) | Get a list of scheduled report jobs
 [**get_analytics_reporting_timeperiods**](AnalyticsApi.html#get_analytics_reporting_timeperiods) | Get a list of report time periods.
+[**get_analytics_users_details_job**](AnalyticsApi.html#get_analytics_users_details_job) | Get status for async query for user details
+[**get_analytics_users_details_job_results**](AnalyticsApi.html#get_analytics_users_details_job_results) | Fetch a page of results for an async query
 [**post_analytics_conversation_details_properties**](AnalyticsApi.html#post_analytics_conversation_details_properties) | Index conversation properties
 [**post_analytics_conversations_aggregates_query**](AnalyticsApi.html#post_analytics_conversations_aggregates_query) | Query for conversation aggregates
 [**post_analytics_conversations_details_jobs**](AnalyticsApi.html#post_analytics_conversations_details_jobs) | Query for conversation details asynchronously
@@ -37,6 +40,7 @@ Method | Description
 [**post_analytics_reporting_schedules**](AnalyticsApi.html#post_analytics_reporting_schedules) | Create a scheduled report job
 [**post_analytics_surveys_aggregates_query**](AnalyticsApi.html#post_analytics_surveys_aggregates_query) | Query for survey aggregates
 [**post_analytics_users_aggregates_query**](AnalyticsApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
+[**post_analytics_users_details_jobs**](AnalyticsApi.html#post_analytics_users_details_jobs) | Query for user details asynchronously
 [**post_analytics_users_details_query**](AnalyticsApi.html#post_analytics_users_details_query) | Query for user details
 [**post_analytics_users_observations_query**](AnalyticsApi.html#post_analytics_users_observations_query) | Query for user observations
 [**put_analytics_reporting_schedule**](AnalyticsApi.html#put_analytics_reporting_schedule) | Update a scheduled report job.
@@ -169,6 +173,70 @@ nil (empty response body)
 
 
 
+<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::AnalyticsApi.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 AnalyticsApi->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="get_analytics_conversation_details"></a>
 
 ## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
@@ -1078,6 +1146,140 @@ This endpoint does not need any parameter.
 
 
 
+<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::AnalyticsApi.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 AnalyticsApi->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::AnalyticsApi.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 AnalyticsApi->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="post_analytics_conversation_details_properties"></a>
 
 ## [**PropertyIndexRequest**](PropertyIndexRequest.html) post_analytics_conversation_details_properties(conversation_id, body)
@@ -1924,6 +2126,71 @@ Name | Type | Description  | Notes
 
 
 
+<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::AnalyticsApi.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 AnalyticsApi->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
+
+
+
 <a name="post_analytics_users_details_query"></a>
 
 ## [**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)

data/docs/AnalyticsUserDetailsAsyncQueryResponse.md

@@ -0,0 +1,14 @@
+---
+title: AnalyticsUserDetailsAsyncQueryResponse
+---
+## PureCloud::AnalyticsUserDetailsAsyncQueryResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **user_details** | [**Array<AnalyticsUserDetail>**](AnalyticsUserDetail.html) |  | [optional] |
+| **cursor** | **String** | Optional cursor to indicate where to resume the results | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AsyncConversationQuery.md

@@ -7,7 +7,7 @@ title: AsyncConversationQuery
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **interval** | **String** | Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
+| **interval** | **String** | Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
 | **conversation_filters** | [**Array<ConversationDetailQueryFilter>**](ConversationDetailQueryFilter.html) | Filters that target conversation-level data | [optional] |
 | **segment_filters** | [**Array<SegmentDetailQueryFilter>**](SegmentDetailQueryFilter.html) | Filters that target individual segments within a conversation | [optional] |
 | **evaluation_filters** | [**Array<EvaluationDetailQueryFilter>**](EvaluationDetailQueryFilter.html) | Filters that target evaluations | [optional] |

data/docs/AsyncUserDetailsQuery.md

@@ -0,0 +1,18 @@
+---
+title: AsyncUserDetailsQuery
+---
+## PureCloud::AsyncUserDetailsQuery
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** | Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
+| **user_filters** | [**Array<UserDetailQueryFilter>**](UserDetailQueryFilter.html) | Filters that target the users to retrieve data for | [optional] |
+| **presence_filters** | [**Array<PresenceDetailQueryFilter>**](PresenceDetailQueryFilter.html) | Filters that target system and organization presence-level data | [optional] |
+| **routing_status_filters** | [**Array<RoutingStatusDetailQueryFilter>**](RoutingStatusDetailQueryFilter.html) | Filters that target agent routing status-level data | [optional] |
+| **order** | **String** | Sort the result set in ascending/descending order. Default is ascending | [optional] |
+| **limit** | **Integer** | Specify number of results to be returned | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AttemptLimitsEntityListing.md

@@ -12,10 +12,10 @@ title: AttemptLimitsEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **next_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/AuditApi.md

@@ -0,0 +1,216 @@
+---
+title: AuditApi
+---
+
+## PureCloud::AuditApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | Description
+------------- | ------------- | -------------
+[**get_audits_query_transaction_id**](AuditApi.html#get_audits_query_transaction_id) | Get status of audit query execution
+[**get_audits_query_transaction_id_results**](AuditApi.html#get_audits_query_transaction_id_results) | Get results of audit query
+[**post_audits_query**](AuditApi.html#post_audits_query) | Create audit query execution
+{: class="table table-striped"}
+
+<a name="get_audits_query_transaction_id"></a>
+
+## [**AuditQueryExecutionStatusResponse**](AuditQueryExecutionStatusResponse.html) get_audits_query_transaction_id(transaction_id)
+
+
+
+Get status of audit query execution
+
+
+
+Wraps GET /api/v2/audits/query/{transactionId} 
+
+Requires ANY permissions: 
+
+* audits:audit: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::AuditApi.new
+
+transaction_id = "transaction_id_example" # String | Transaction ID
+
+
+begin
+  #Get status of audit query execution
+  result = api_instance.get_audits_query_transaction_id(transaction_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuditApi->get_audits_query_transaction_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | **String**| Transaction ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AuditQueryExecutionStatusResponse**](AuditQueryExecutionStatusResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_audits_query_transaction_id_results"></a>
+
+## [**AuditQueryExecutionResultsResponse**](AuditQueryExecutionResultsResponse.html) get_audits_query_transaction_id_results(transaction_id, opts)
+
+
+
+Get results of audit query
+
+
+
+Wraps GET /api/v2/audits/query/{transactionId}/results 
+
+Requires ANY permissions: 
+
+* audits:audit: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::AuditApi.new
+
+transaction_id = "transaction_id_example" # String | Transaction ID
+
+opts = { 
+  cursor: "cursor_example", # String | Indicates where to resume query results (not required for first page)
+  page_size: 25 # Integer | Page size
+}
+
+begin
+  #Get results of audit query
+  result = api_instance.get_audits_query_transaction_id_results(transaction_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuditApi->get_audits_query_transaction_id_results: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | **String**| Transaction ID |  |
+ **cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional]  |
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AuditQueryExecutionResultsResponse**](AuditQueryExecutionResultsResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_audits_query"></a>
+
+## [**AuditQueryExecutionStatusResponse**](AuditQueryExecutionStatusResponse.html) post_audits_query(body)
+
+
+
+Create audit query execution
+
+
+
+Wraps POST /api/v2/audits/query 
+
+Requires ANY permissions: 
+
+* audits:audit: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::AuditApi.new
+
+body = PureCloud::AuditQueryRequest.new # AuditQueryRequest | query
+
+
+begin
+  #Create audit query execution
+  result = api_instance.post_audits_query(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuditApi->post_audits_query: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AuditQueryRequest**](AuditQueryRequest.html)| query |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AuditQueryExecutionStatusResponse**](AuditQueryExecutionStatusResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+