purecloudplatformclientv2 85.0.1 → 86.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c095d48da39d28e16efb295b31a1f8730c39bc2e
-  data.tar.gz: 300cc81d267546d49fad1531deb27fd1b533465d
+  metadata.gz: 94df2dc8faf76d99f1baeab94ae8e900a0dd3b2e
+  data.tar.gz: 2cf2e224c7502c797b89ed3afa0455ba30fb8eb9
 SHA512:
-  metadata.gz: a07cb315eecc34652dac9dbadb271b53d4652f770ea3c77e7f3014ba5d64164613283111b5d146dc8db81b66d91ef07a873980055460ca14ff5f0435fb8ec6a5
-  data.tar.gz: 50beb021bbfe8d9f998f3bc9b2e2dc95d84767a2a5c75a25db6ad8dd1aa7337c7ca9ddbaa9afe95449609adcd1eed2194648eaa1af5703eea37ffd96be9ff20c
+  metadata.gz: 7fe2b6754ac72c681aad1bbd99f65dada157c07829db90965a39709ff710f2cb1ce6cf9c3a1ee7bf529e69484ac5428dd6979de5cb6506fcac6a971e06771b99
+  data.tar.gz: eac5c1404bca9cedfddcfcbe4752e2adb6e7db4c3e7461978ac4a90945406335dad91c05e2b976a520e8b355159338b5ea3dfc0086fc6f49b9a24ef3b9fd4371

data/README.md

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

data/docs/AnalyticsEvaluation.md

@@ -18,8 +18,8 @@ title: AnalyticsEvaluation
 | **calibration_id** | **String** | The calibration id used for the purpose of training evaluators | [optional] |
 | **rescored** | **BOOLEAN** | Whether this evaluation has ever been rescored | [optional] |
 | **deleted** | **BOOLEAN** | Whether this evaluation has been deleted | [optional] |
-| **o_total_score** | **Integer** |  | [optional] |
 | **o_total_critical_score** | **Integer** |  | [optional] |
+| **o_total_score** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/Call.md

@@ -32,6 +32,7 @@ title: Call
 | **uui_data** | **String** | User to User Information (UUI) data managed by SIP session application. | [optional] |
 | **_self** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
 | **other** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
+| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/CallBasic.md

@@ -32,6 +32,7 @@ title: CallBasic
 | **uui_data** | **String** | User to User Information (UUI) data managed by SIP session application. | [optional] |
 | **_self** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
 | **other** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
+| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/Callback.md

@@ -29,6 +29,7 @@ title: Callback
 | **automated_callback_config_id** | **String** | The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal. | [optional] |
 | **provider** | **String** | The source provider for the callback. | [optional] |
 | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
+| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/CallbackBasic.md

@@ -29,6 +29,7 @@ title: CallbackBasic
 | **automated_callback_config_id** | **String** | The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal. | [optional] |
 | **provider** | **String** | The source provider for the callback. | [optional] |
 | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
+| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/Cobrowsesession.md

@@ -22,6 +22,7 @@ title: Cobrowsesession
 | **provider** | **String** | The source provider for the co-browse session. | [optional] |
 | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
 | **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's call, divided into activity segments. | [optional] |
+| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/{PartialUploadResponse.md → ContextEntity.md}

@@ -1,13 +1,13 @@
 ---
-title: PartialUploadResponse
+title: ContextEntity
 ---
-## PureCloud::PartialUploadResponse
+## PureCloud::ContextEntity
 
 ## Properties
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The reference id for a partial import request | [optional] |
+| **name** | **String** | The name of the entity. | |
 {: class="table table-striped"}
 
 

data/docs/ContextIntent.md

@@ -0,0 +1,13 @@
+---
+title: ContextIntent
+---
+## PureCloud::ContextIntent
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the intent. | |
+{: class="table table-striped"}
+
+

data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md

@@ -46,6 +46,7 @@ title: ConversationCallbackEventTopicCallbackMediaParticipant
 | **callback_numbers** | **Array<String>** |  | [optional] |
 | **callback_user_name** | **String** |  | [optional] |
 | **skip_enabled** | **BOOLEAN** |  | [optional] |
+| **external_campaign** | **BOOLEAN** |  | [optional] |
 | **timeout_seconds** | **Integer** |  | [optional] |
 | **callback_scheduled_time** | **DateTime** |  | [optional] |
 | **automated_callback_config_id** | **String** |  | [optional] |

data/docs/ConversationChat.md

@@ -24,6 +24,7 @@ title: ConversationChat
 | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
 | **avatar_image_url** | **String** | If available, the URI to the avatar image of this communication. | [optional] |
 | **journey_context** | [**JourneyContext**](JourneyContext.html) | A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context). | [optional] |
+| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ConversationEventTopicCallback.md

@@ -19,6 +19,7 @@ title: ConversationEventTopicCallback
 | **callback_user_name** | **String** |  | [optional] |
 | **script_id** | **String** |  | [optional] |
 | **peer_id** | **String** |  | [optional] |
+| **external_campaign** | **BOOLEAN** |  | [optional] |
 | **skip_enabled** | **BOOLEAN** |  | [optional] |
 | **provider** | **String** |  | [optional] |
 | **timeout_seconds** | **Integer** |  | [optional] |

data/docs/Coretype.md

@@ -0,0 +1,23 @@
+---
+title: Coretype
+---
+## PureCloud::Coretype
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **version** | **Integer** | A positive integer denoting the core type's version | [optional] |
+| **date_created** | **DateTime** | The date the core type was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **schema** | [**Schema**](Schema.html) | The core type's built-in schema | [optional] |
+| **current** | **BOOLEAN** | A boolean indicating if the core type's version is the current one in use by the system | [optional] |
+| **validation_fields** | **Array<String>** | An array of strings naming the fields of the core type subject to validation.  Validation constraints are specified by a schema author using the core type. | [optional] |
+| **validation_limits** | [**ValidationLimits**](ValidationLimits.html) | A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types.  For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. | [optional] |
+| **item_validation_fields** | **Array<String>** | Specific to the \"tag\" core type, this is an array of strings naming the tag item fields of the core type subject to validation | [optional] |
+| **item_validation_limits** | [**ItemValidationLimits**](ItemValidationLimits.html) | A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as \"tag\" and \"enum\".  Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CoretypeListing.md

@@ -0,0 +1,15 @@
+---
+title: CoretypeListing
+---
+## PureCloud::CoretypeListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **total** | **Integer** |  | [optional] |
+| **entities** | [**Array<Coretype>**](Coretype.html) |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/DataExtensionsApi.md

@@ -0,0 +1,198 @@
+---
+title: DataExtensionsApi
+---
+
+## PureCloud::DataExtensionsApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | Description
+------------- | ------------- | -------------
+[**get_dataextensions_coretype**](DataExtensionsApi.html#get_dataextensions_coretype) | Get a specific named core type.
+[**get_dataextensions_coretypes**](DataExtensionsApi.html#get_dataextensions_coretypes) | Get the core types from which all schemas are built.
+[**get_dataextensions_limits**](DataExtensionsApi.html#get_dataextensions_limits) | Get quantitative limits on schemas
+{: class="table table-striped"}
+
+<a name="get_dataextensions_coretype"></a>
+
+## [**Coretype**](Coretype.html) get_dataextensions_coretype(coretype_name)
+
+
+
+Get a specific named core type.
+
+
+
+Wraps GET /api/v2/dataextensions/coretypes/{coretypeName} 
+
+Requires ANY permissions: 
+
+* externalContacts:customFields: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::DataExtensionsApi.new
+
+coretype_name = "coretype_name_example" # String | The core type's name
+
+
+begin
+  #Get a specific named core type.
+  result = api_instance.get_dataextensions_coretype(coretype_name)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling DataExtensionsApi->get_dataextensions_coretype: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **coretype_name** | **String**| The core type&#39;s name | <br />**Values**: text, longtext, url, identifier, enum, date, datetime, integer, number, checkbox, tag |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Coretype**](Coretype.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_dataextensions_coretypes"></a>
+
+## [**CoretypeListing**](CoretypeListing.html) get_dataextensions_coretypes
+
+
+
+Get the core types from which all schemas are built.
+
+
+
+Wraps GET /api/v2/dataextensions/coretypes 
+
+Requires ANY permissions: 
+
+* externalContacts:customFields: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::DataExtensionsApi.new
+
+begin
+  #Get the core types from which all schemas are built.
+  result = api_instance.get_dataextensions_coretypes
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling DataExtensionsApi->get_dataextensions_coretypes: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CoretypeListing**](CoretypeListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_dataextensions_limits"></a>
+
+## [**SchemaQuantityLimits**](SchemaQuantityLimits.html) get_dataextensions_limits
+
+
+
+Get quantitative limits on schemas
+
+
+
+Wraps GET /api/v2/dataextensions/limits 
+
+Requires ANY permissions: 
+
+* externalContacts:customFields: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::DataExtensionsApi.new
+
+begin
+  #Get quantitative limits on schemas
+  result = api_instance.get_dataextensions_limits
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling DataExtensionsApi->get_dataextensions_limits: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**SchemaQuantityLimits**](SchemaQuantityLimits.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DataSchemaListing.md

@@ -0,0 +1,15 @@
+---
+title: DataSchemaListing
+---
+## PureCloud::DataSchemaListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **total** | **Integer** |  | [optional] |
+| **entities** | [**Array<DataSchema>**](DataSchema.html) |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/DetectedDialogAct.md

@@ -0,0 +1,14 @@
+---
+title: DetectedDialogAct
+---
+## PureCloud::DetectedDialogAct
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the detected dialog act. | [optional] |
+| **probability** | **Float** | The probability of the detected dialog act. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/DetectedIntent.md

@@ -0,0 +1,15 @@
+---
+title: DetectedIntent
+---
+## PureCloud::DetectedIntent
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the detected intent. | [optional] |
+| **probability** | **Float** | The probability of the detected intent. | [optional] |
+| **entities** | [**Array<DetectedNamedEntity>**](DetectedNamedEntity.html) | The collection of named entities detected. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/DetectedNamedEntity.md

@@ -0,0 +1,16 @@
+---
+title: DetectedNamedEntity
+---
+## PureCloud::DetectedNamedEntity
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the detected named entity. | [optional] |
+| **entity_type** | **String** | The type of the detected named entity. | [optional] |
+| **probability** | **Float** | The probability of the detected named entity. | [optional] |
+| **value** | [**DetectedNamedEntityValue**](DetectedNamedEntityValue.html) | The value of the detected named entity. | [optional] |
+{: class="table table-striped"}
+
+