purecloudplatformclientv2 75.1.0 → 79.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6efd666e0730badebec1987c177e559ecd8d4291
-  data.tar.gz: ccb492dc1ea2661854469712bf83025be4304c1a
+  metadata.gz: 2fb7ad6b87905946dfc74db0074de53b61f551e6
+  data.tar.gz: 6f6596a2d8a487e68467d888aedbc0cfc98dca6b
 SHA512:
-  metadata.gz: 59e17b5de762bb169dabc5cac286a98b2592b873396bb148a63695f8386aab530cab810d4b1c9c8b794f91e4302ac63fea39658bf326744d9861f89adb45ae3d
-  data.tar.gz: 2b6fcd69ae8d9169842b61d4b5fd880e92ee21ad9c5c1788bc2680120b73e8e13a6d7c1e3b08cd871a3552292e0e8e9d200e3de4bfeac2e8307ba0b37657f218
+  metadata.gz: 5c11fc677709bf7299ebc3245733d791db6f363f4d1775c3497f8126c230d391db0594bc8eba9085e4721faedfb605e9ae536b0f77340ee5bdde76dca683a833
+  data.tar.gz: 60f5105b91dc8cfbf71977085f83822c7e2164ef26f33040bdcb8c6c1f067661ab3a2c259fd205eb39647d05d9976b6ee9adbe9532e186456cc3ab1ff40ebb28

data/README.md

@@ -1,7 +1,7 @@
 ---
 title: PureCloud Ruby Gem
 ---
-![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=75.1.0)
+![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=79.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', '~> 75.1.0'
+gem install 'purecloudplatformclientv2', '~> 79.0.0'
 ```
 
 ### Install from Git

data/docs/ActivityCode.md

@@ -8,6 +8,7 @@ title: ActivityCode
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
 | **name** | **String** | The name of the activity code. Default activity codes will be created with an empty name | [optional] |
 | **is_active** | **BOOLEAN** | Whether this activity code is active or has been deleted | [optional] |
 | **is_default** | **BOOLEAN** | Whether this is a default activity code | [optional] |
@@ -17,7 +18,6 @@ title: ActivityCode
 | **counts_as_work_time** | **BOOLEAN** | Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints | [optional] |
 | **agent_time_off_selectable** | **BOOLEAN** | Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off. | [optional] |
 | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for the associated management unit's list of activity codes | |
-| **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 
 

data/docs/AnalyticsApi.md

@@ -16,6 +16,7 @@ Method | Description
 [**get_analytics_conversations_details_job**](AnalyticsApi.html#get_analytics_conversations_details_job) | Get status for async query for conversation details
 [**get_analytics_conversations_details_job_results**](AnalyticsApi.html#get_analytics_conversations_details_job_results) | Fetch a page of results for an async query
 [**get_analytics_reporting_exports**](AnalyticsApi.html#get_analytics_reporting_exports) | Get all view export requests for a user
+[**get_analytics_reporting_exports_metadata**](AnalyticsApi.html#get_analytics_reporting_exports_metadata) | Get all export metadata
 [**get_analytics_reporting_metadata**](AnalyticsApi.html#get_analytics_reporting_metadata) | Get list of reporting metadata.
 [**get_analytics_reporting_report_id_metadata**](AnalyticsApi.html#get_analytics_reporting_report_id_metadata) | Get a reporting metadata.
 [**get_analytics_reporting_reportformats**](AnalyticsApi.html#get_analytics_reporting_reportformats) | Get a list of report formats
@@ -470,7 +471,8 @@ 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)
+  cursor: "cursor_example", # String | Indicates where to resume query results (not required for first page)
+  page_size: 56 # Integer | The desired maximum number of results
 }
 
 begin
@@ -488,6 +490,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **job_id** | **String**| jobId |  |
  **cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional]  |
+ **page_size** | **Integer**| The desired maximum number of results | [optional]  |
 {: class="table table-striped"}
 
 
@@ -561,6 +564,65 @@ This endpoint does not need any parameter.
 
 
 
+<a name="get_analytics_reporting_exports_metadata"></a>
+
+## [**ReportingExportMetadataJobListing**](ReportingExportMetadataJobListing.html) get_analytics_reporting_exports_metadata
+
+
+
+Get all export metadata
+
+
+
+Wraps GET /api/v2/analytics/reporting/exports/metadata 
+
+Requires ANY permissions: 
+
+* analytics:dataExport: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
+
+begin
+  #Get all export metadata
+  result = api_instance.get_analytics_reporting_exports_metadata
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AnalyticsApi->get_analytics_reporting_exports_metadata: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ReportingExportMetadataJobListing**](ReportingExportMetadataJobListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_analytics_reporting_metadata"></a>
 
 ## [**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html) get_analytics_reporting_metadata(opts)
@@ -1250,7 +1312,8 @@ 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)
+  cursor: "cursor_example", # String | Indicates where to resume query results (not required for first page)
+  page_size: 56 # Integer | The desired maximum number of results
 }
 
 begin
@@ -1268,6 +1331,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **job_id** | **String**| jobId |  |
  **cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional]  |
+ **page_size** | **Integer**| The desired maximum number of results | [optional]  |
 {: class="table table-striped"}
 
 

data/docs/AnalyticsConversationAsyncQueryResponse.md

@@ -7,8 +7,8 @@ title: AnalyticsConversationAsyncQueryResponse
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **conversations** | [**Array<AnalyticsConversation>**](AnalyticsConversation.html) |  | [optional] |
 | **cursor** | **String** | Optional cursor to indicate where to resume the results | [optional] |
+| **conversations** | [**Array<AnalyticsConversation>**](AnalyticsConversation.html) |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/AnalyticsConversationQueryResponse.md

@@ -7,8 +7,8 @@ title: AnalyticsConversationQueryResponse
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **conversations** | [**Array<AnalyticsConversation>**](AnalyticsConversation.html) |  | [optional] |
 | **aggregations** | [**Array<AggregationResult>**](AggregationResult.html) |  | [optional] |
+| **conversations** | [**Array<AnalyticsConversationWithoutAttributes>**](AnalyticsConversationWithoutAttributes.html) |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/AnalyticsParticipant.md

@@ -14,6 +14,7 @@ title: AnalyticsParticipant
 | **external_contact_id** | **String** | External Contact Identifier | [optional] |
 | **external_organization_id** | **String** | External Organization Identifier | [optional] |
 | **flagged_reason** | **String** | Reason for which participant flagged conversation | [optional] |
+| **team_id** | **String** | The team id the user is a member of | [optional] |
 | **sessions** | [**Array<AnalyticsSession>**](AnalyticsSession.html) | List of sessions associated to this participant | [optional] |
 | **attributes** | **Hash<String, String>** | List of attributes associated to this participant | [optional] |
 {: class="table table-striped"}

data/docs/AnalyticsParticipantWithoutAttributes.md

@@ -14,6 +14,7 @@ title: AnalyticsParticipantWithoutAttributes
 | **external_contact_id** | **String** | External Contact Identifier | [optional] |
 | **external_organization_id** | **String** | External Organization Identifier | [optional] |
 | **flagged_reason** | **String** | Reason for which participant flagged conversation | [optional] |
+| **team_id** | **String** | The team id the user is a member of | [optional] |
 | **sessions** | [**Array<AnalyticsSession>**](AnalyticsSession.html) | List of sessions associated to this participant | [optional] |
 {: class="table table-striped"}
 

data/docs/ArchitectApi.md

@@ -56,6 +56,9 @@ Method | Description
 [**get_flow_versions**](ArchitectApi.html#get_flow_versions) | Get flow version list
 [**get_flows**](ArchitectApi.html#get_flows) | Get a pageable list of flows, filtered by query parameters
 [**get_flows_datatable**](ArchitectApi.html#get_flows_datatable) | Returns a specific datatable by id
+[**get_flows_datatable_export_job**](ArchitectApi.html#get_flows_datatable_export_job) | Returns the state information about an export job
+[**get_flows_datatable_import_job**](ArchitectApi.html#get_flows_datatable_import_job) | Returns the state information about an import job
+[**get_flows_datatable_import_jobs**](ArchitectApi.html#get_flows_datatable_import_jobs) | Get all recent import jobs
 [**get_flows_datatable_row**](ArchitectApi.html#get_flows_datatable_row) | Returns a specific row for the datatable
 [**get_flows_datatable_rows**](ArchitectApi.html#get_flows_datatable_rows) | Returns the rows for the datatable with the given id
 [**get_flows_datatables**](ArchitectApi.html#get_flows_datatables) | Retrieve a list of datatables for the org
@@ -80,6 +83,8 @@ Method | Description
 [**post_flows_actions_publish**](ArchitectApi.html#post_flows_actions_publish) | Publish flow
 [**post_flows_actions_revert**](ArchitectApi.html#post_flows_actions_revert) | Revert flow
 [**post_flows_actions_unlock**](ArchitectApi.html#post_flows_actions_unlock) | Unlock flow
+[**post_flows_datatable_export_jobs**](ArchitectApi.html#post_flows_datatable_export_jobs) | Begin an export process for exporting all rows from a datatable
+[**post_flows_datatable_import_jobs**](ArchitectApi.html#post_flows_datatable_import_jobs) | Begin an import process for importing rows into a datatable
 [**post_flows_datatable_rows**](ArchitectApi.html#post_flows_datatable_rows) | Create a new row entry for the datatable.
 [**post_flows_datatables**](ArchitectApi.html#post_flows_datatables) | Create a new datatable with the specified json-schema definition
 [**post_flows_outcomes**](ArchitectApi.html#post_flows_outcomes) | Create a flow outcome
@@ -3503,6 +3508,213 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_flows_datatable_export_job"></a>
+
+## [**DataTableExportJob**](DataTableExportJob.html) get_flows_datatable_export_job(datatable_id, export_job_id)
+
+
+
+Returns the state information about an export job
+
+Returns the state information about an export job.
+
+Wraps GET /api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId} 
+
+Requires ANY permissions: 
+
+* architect:datatable: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::ArchitectApi.new
+
+datatable_id = "datatable_id_example" # String | id of datatable
+
+export_job_id = "export_job_id_example" # String | id of export job
+
+
+begin
+  #Returns the state information about an export job
+  result = api_instance.get_flows_datatable_export_job(datatable_id, export_job_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->get_flows_datatable_export_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **datatable_id** | **String**| id of datatable |  |
+ **export_job_id** | **String**| id of export job |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**DataTableExportJob**](DataTableExportJob.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_flows_datatable_import_job"></a>
+
+## [**DataTableImportJob**](DataTableImportJob.html) get_flows_datatable_import_job(datatable_id, import_job_id)
+
+
+
+Returns the state information about an import job
+
+Returns the state information about an import job.
+
+Wraps GET /api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId} 
+
+Requires ANY permissions: 
+
+* architect:datatable: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::ArchitectApi.new
+
+datatable_id = "datatable_id_example" # String | id of datatable
+
+import_job_id = "import_job_id_example" # String | id of import job
+
+
+begin
+  #Returns the state information about an import job
+  result = api_instance.get_flows_datatable_import_job(datatable_id, import_job_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->get_flows_datatable_import_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **datatable_id** | **String**| id of datatable |  |
+ **import_job_id** | **String**| id of import job |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**DataTableImportJob**](DataTableImportJob.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_flows_datatable_import_jobs"></a>
+
+## [**EntityListing**](EntityListing.html) get_flows_datatable_import_jobs(datatable_id, opts)
+
+
+
+Get all recent import jobs
+
+Get all recent import jobs
+
+Wraps GET /api/v2/flows/datatables/{datatableId}/import/jobs 
+
+Requires ANY permissions: 
+
+* architect:datatable:edit
+
+
+### 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::ArchitectApi.new
+
+datatable_id = "datatable_id_example" # String | id of datatable
+
+opts = { 
+  page_number: 1, # Integer | Page number
+  page_size: 25 # Integer | Page size
+}
+
+begin
+  #Get all recent import jobs
+  result = api_instance.get_flows_datatable_import_jobs(datatable_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->get_flows_datatable_import_jobs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **datatable_id** | **String**| id of datatable |  |
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**EntityListing**](EntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_flows_datatable_row"></a>
 
 ## Hash&lt;String, Object&gt;** get_flows_datatable_row(datatable_id, row_id, opts)
@@ -5133,6 +5345,139 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_flows_datatable_export_jobs"></a>
+
+## [**DataTableExportJob**](DataTableExportJob.html) post_flows_datatable_export_jobs(datatable_id)
+
+
+
+Begin an export process for exporting all rows from a datatable
+
+Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response
+
+Wraps POST /api/v2/flows/datatables/{datatableId}/export/jobs 
+
+Requires ANY permissions: 
+
+* architect:datatable: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::ArchitectApi.new
+
+datatable_id = "datatable_id_example" # String | id of datatable
+
+
+begin
+  #Begin an export process for exporting all rows from a datatable
+  result = api_instance.post_flows_datatable_export_jobs(datatable_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->post_flows_datatable_export_jobs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **datatable_id** | **String**| id of datatable |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**DataTableExportJob**](DataTableExportJob.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_flows_datatable_import_jobs"></a>
+
+## [**DataTableImportJob**](DataTableImportJob.html) post_flows_datatable_import_jobs(datatable_id, body)
+
+
+
+Begin an import process for importing rows into a datatable
+
+Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response
+
+Wraps POST /api/v2/flows/datatables/{datatableId}/import/jobs 
+
+Requires ANY permissions: 
+
+* architect:datatable:edit
+
+
+### 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::ArchitectApi.new
+
+datatable_id = "datatable_id_example" # String | id of datatable
+
+body = PureCloud::DataTableImportJob.new # DataTableImportJob | import job information
+
+
+begin
+  #Begin an import process for importing rows into a datatable
+  result = api_instance.post_flows_datatable_import_jobs(datatable_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ArchitectApi->post_flows_datatable_import_jobs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **datatable_id** | **String**| id of datatable |  |
+ **body** | [**DataTableImportJob**](DataTableImportJob.html)| import job information |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**DataTableImportJob**](DataTableImportJob.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_flows_datatable_rows"></a>
 
 ## Hash&lt;String, Object&gt;** post_flows_datatable_rows(datatable_id, data_table_row)