purecloudplatformclientv2 20.0.0 → 21.0.0

data/docs/CreateEmailRequest.md

@@ -20,6 +20,8 @@ title: CreateEmailRequest
 | **from_name** | **String** | The name of the sender of the email. | [optional] |
 | **subject** | **String** | The subject of the email | [optional] |
 | **direction** | **String** | Specify INBOUND to create an inbound email conversation to route to a queue, or OUTBOUND to send an email on behalf of a queue. | [optional] |
+| **html_body** | **String** | An HTML body content of the email. | [optional] |
+| **text_body** | **String** | A text body content of the email. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/CreateQueueRequest.md

@@ -23,6 +23,8 @@ title: CreateQueueRequest
 | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
 | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
 | **queue_flow** | [**UriReference**](UriReference.html) | The in-queue flow to use for conversations waiting in queue. | [optional] |
+| **whisper** | [**UriReference**](UriReference.html) | The prompt used for whisper audio on the queue, if configured. | [optional] |
+| **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper audio should play for all ACD calls, or only for those which are auto-answered. | [optional] |
 | **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
 | **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
 | **default_scripts** | [**Hash<String, Script>**](Script.html) | The default script Ids for the communication types. | [optional] |

data/docs/CreateSecureSession.md

@@ -0,0 +1,16 @@
+---
+title: CreateSecureSession
+---
+## PureCloud::CreateSecureSession
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **source_participant_id** | **String** | requesting participant | [optional] |
+| **flow_id** | **String** | the flow id to execute in the secure session | |
+| **user_data** | **String** | user data for the secure session | |
+| **disconnect** | **BOOLEAN** | if true, disconnect the agent after creating the session | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ExternalContact.md

@@ -25,6 +25,7 @@ title: ExternalContact
 | **modify_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **external_organization** | [**ExternalOrganization**](ExternalOrganization.html) |  | [optional] |
+| **survey_opt_out** | **BOOLEAN** |  | [optional] |
 | **external_data_sources** | [**Array<ExternalDataSource>**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}

data/docs/ImportScriptStatusResponse.md

@@ -0,0 +1,15 @@
+---
+title: ImportScriptStatusResponse
+---
+## PureCloud::ImportScriptStatusResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **url** | **String** |  | [optional] |
+| **succeeded** | **BOOLEAN** |  | [optional] |
+| **message** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/InboundRoute.md

@@ -17,6 +17,7 @@ title: InboundRoute
 | **from_name** | **String** | The sender name to use for outgoing replies. | |
 | **from_email** | **String** | The sender email to use for outgoing replies. | |
 | **flow** | [**UriReference**](UriReference.html) | The flow to use for processing the email. | [optional] |
+| **reply_route** | [**UriReference**](UriReference.html) | The route to use for email replies. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/JsonNode.md

@@ -14,12 +14,12 @@ title: JsonNode
 | **object** | **BOOLEAN** |  | [optional] |
 | **boolean** | **BOOLEAN** |  | [optional] |
 | **number** | **BOOLEAN** |  | [optional] |
+| **floating_point_number** | **BOOLEAN** |  | [optional] |
 | **value_node** | **BOOLEAN** |  | [optional] |
 | **container_node** | **BOOLEAN** |  | [optional] |
 | **missing_node** | **BOOLEAN** |  | [optional] |
 | **pojo** | **BOOLEAN** |  | [optional] |
 | **integral_number** | **BOOLEAN** |  | [optional] |
-| **floating_point_number** | **BOOLEAN** |  | [optional] |
 | **short** | **BOOLEAN** |  | [optional] |
 | **int** | **BOOLEAN** |  | [optional] |
 | **long** | **BOOLEAN** |  | [optional] |

data/docs/ManagementUnit.md

@@ -9,10 +9,12 @@ title: ManagementUnit
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **start_day_of_week** | **String** | Start day of week for workforce management planning purposes | [optional] |
+| **start_day_of_week** | **String** | Start day of week for scheduling and forecasting purposes | [optional] |
 | **time_zone** | **String** | The time zone for the management unit in standard Olson Format (See https://en.wikipedia.org/wiki/Tz_database) | [optional] |
-| **version** | **Integer** | The version of the underlying ManagementUnit object. Useful for handling eventual consistency issues.  User must submit the current version they of the ManagementUnit in any write requests | |
-| **date_modified** | **DateTime** | The date and time at which this management unit was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **settings** | [**ManagementUnitSettings**](ManagementUnitSettings.html) | The configuration settings for this management unit | [optional] |
+| **version** | **Integer** | The version of the underlying entity | |
+| **date_modified** | **DateTime** | The date and time at which this entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | [**User**](User.html) | The user who last modified this entity | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/ManagementUnitReference.md

@@ -0,0 +1,14 @@
+---
+title: ManagementUnitReference
+---
+## PureCloud::ManagementUnitReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ManagementUnitSettings.md

@@ -0,0 +1,19 @@
+---
+title: ManagementUnitSettings
+---
+## PureCloud::ManagementUnitSettings
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **adherence** | [**AdherenceSettings**](AdherenceSettings.html) | Adherence settings for this management unit | [optional] |
+| **short_term_forecasting** | [**ShortTermForecastingSettings**](ShortTermForecastingSettings.html) | Short term forecasting settings for this management unit | [optional] |
+| **time_off** | [**TimeOffRequestSettings**](TimeOffRequestSettings.html) | Time off request settings for this management unit | [optional] |
+| **scheduling** | [**SchedulingSettings**](SchedulingSettings.html) | Scheduling settings for this management unit | [optional] |
+| **version** | **Integer** | The version of the underlying entity | |
+| **date_modified** | **DateTime** | The date and time at which this entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | [**User**](User.html) | The user who last modified this entity | [optional] |
+{: class="table table-striped"}
+
+

data/docs/Message.md

@@ -19,6 +19,9 @@ title: Message
 | **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **disconnected_time** | **DateTime** | The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **provider** | **String** | The source provider for the message. | [optional] |
+| **type** | **String** | Indicates the type of message platform from which the message originated. | [optional] |
+| **recipient_country** | **String** | Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format. | [optional] |
+| **recipient_type** | **String** | The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type. | [optional] |
 | **script_id** | **String** | The UUID of the script to use. | [optional] |
 | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
 | **to_address** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |

data/docs/MessageConversationNotificationMessageDetails.md

@@ -9,6 +9,8 @@ title: MessageConversationNotificationMessageDetails
 |------------ | ------------- | ------------- | -------------|
 | **message** | [**MessageConversationNotificationUriReference**](MessageConversationNotificationUriReference.html) |  | [optional] |
 | **message_time** | **DateTime** |  | [optional] |
+| **message_segment_count** | **Integer** |  | [optional] |
+| **message_status** | **String** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/MessageConversationNotificationMessageMediaParticipant.md

@@ -35,6 +35,9 @@ title: MessageConversationNotificationMessageMediaParticipant
 | **peer** | **String** |  | [optional] |
 | **screen_recording_state** | **String** |  | [optional] |
 | **messages** | [**Array<MessageConversationNotificationMessages>**](MessageConversationNotificationMessages.html) |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **recipient_country** | **String** |  | [optional] |
+| **recipient_type** | **String** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/MessageConversationNotificationMessages.md

@@ -9,6 +9,8 @@ title: MessageConversationNotificationMessages
 |------------ | ------------- | ------------- | -------------|
 | **message** | [**MessageConversationNotificationUriReference**](MessageConversationNotificationUriReference.html) |  | [optional] |
 | **message_time** | **DateTime** |  | [optional] |
+| **message_segment_count** | **Integer** |  | [optional] |
+| **message_status** | **String** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/MessageConversationNotificationParticipants.md

@@ -35,6 +35,9 @@ title: MessageConversationNotificationParticipants
 | **peer** | **String** |  | [optional] |
 | **screen_recording_state** | **String** |  | [optional] |
 | **messages** | [**Array<MessageConversationNotificationMessages>**](MessageConversationNotificationMessages.html) |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **recipient_country** | **String** |  | [optional] |
+| **recipient_type** | **String** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/MessageDetails.md

@@ -9,6 +9,8 @@ title: MessageDetails
 |------------ | ------------- | ------------- | -------------|
 | **message_id** | **String** | UUID identifying the message media. | [optional] |
 | **message_uri** | **String** | A URI for this message entity. | [optional] |
+| **message_status** | **String** | Indicates the delivery status of the message. | [optional] |
+| **message_segment_count** | **Integer** | The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits. | [optional] |
 | **message_time** | **DateTime** | The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 {: class="table table-striped"}
 

data/docs/QualityApi.md

@@ -757,7 +757,8 @@ opts = {
   is_released: true, # BOOLEAN | the evaluation has been released
   agent_has_read: true, # BOOLEAN | agent has the evaluation
   expand_answer_total_scores: true, # BOOLEAN | get the total scores for evaluations
-  maximum: 56 # Integer | maximum
+  maximum: 56, # Integer | maximum
+  sort_order: "sort_order_example" # String | sort order options for agentUserId or evaluatorUserId query. Valid options are 'a', 'asc', 'ascending', 'd', 'desc', 'descending'
 }
 
 begin
@@ -790,6 +791,7 @@ Name | Type | Description  | Notes
  **agent_has_read** | **BOOLEAN**| agent has the evaluation | [optional]  |
  **expand_answer_total_scores** | **BOOLEAN**| get the total scores for evaluations | [optional]  |
  **maximum** | **Integer**| maximum | [optional]  |
+ **sort_order** | **String**| sort order options for agentUserId or evaluatorUserId query. Valid options are 'a', 'asc', 'ascending', 'd', 'desc', 'descending' | [optional]  |
 {: class="table table-striped"}
 
 

data/docs/Queue.md

@@ -23,6 +23,8 @@ title: Queue
 | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
 | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
 | **queue_flow** | [**UriReference**](UriReference.html) | The in-queue flow to use for conversations waiting in queue. | [optional] |
+| **whisper** | [**UriReference**](UriReference.html) | The prompt used for whisper audio on the queue, if configured. | [optional] |
+| **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper audio should play for all ACD calls, or only for those which are auto-answered. | [optional] |
 | **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
 | **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
 | **default_scripts** | [**Hash<String, Script>**](Script.html) | The default script Ids for the communication types. | [optional] |

data/docs/SchedulingSettings.md

@@ -0,0 +1,14 @@
+---
+title: SchedulingSettings
+---
+## PureCloud::SchedulingSettings
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **max_occupancy_percent_for_deferred_work** | **Integer** | Max occupancy percent for deferred work | [optional] |
+| **default_shrinkage_percent** | **Float** | Default shrinkage percent for scheduling | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ScriptsApi.md

@@ -17,6 +17,7 @@ Method | Description
 [**get_scripts_published_script_id_page**](ScriptsApi.html#get_scripts_published_script_id_page) | Get the published page.
 [**get_scripts_published_script_id_pages**](ScriptsApi.html#get_scripts_published_script_id_pages) | Get the list of published pages
 [**get_scripts_published_script_id_variables**](ScriptsApi.html#get_scripts_published_script_id_variables) | Get the published variables
+[**get_scripts_upload_status**](ScriptsApi.html#get_scripts_upload_status) | Get the upload status of an imported script
 {: class="table table-striped"}
 
 <a name="get_script"></a>
@@ -621,3 +622,66 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_scripts_upload_status"></a>
+
+## -[**ImportScriptStatusResponse**](ImportScriptStatusResponse.html) get_scripts_upload_status(upload_id, opts)
+
+Get the upload status of an imported script
+
+
+
+Wraps GET /api/v2/scripts/uploads/{uploadId}/status 
+
+
+### Example
+~~~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::ScriptsApi.new
+
+upload_id = "upload_id_example" # String | Upload ID
+
+opts = { 
+  long_poll: false # BOOLEAN | Enable longPolling endpoint
+}
+
+begin
+  #Get the upload status of an imported script
+  result = api_instance.get_scripts_upload_status(upload_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ScriptsApi->get_scripts_upload_status: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upload_id** | **String**| Upload ID |  |
+ **long_poll** | **BOOLEAN**| Enable longPolling endpoint | [optional] [default to false] |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ImportScriptStatusResponse**](ImportScriptStatusResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/SecureSession.md

@@ -0,0 +1,19 @@
+---
+title: SecureSession
+---
+## PureCloud::SecureSession
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **flow** | [**UriReference**](UriReference.html) | The flow to execute securely | |
+| **user_data** | **String** | Customer-provided data | [optional] |
+| **state** | **String** | The current state of a secure session | |
+| **source_participant_id** | **String** | Unique identifier for the participant initiating the secure session. | [optional] |
+| **disconnect** | **BOOLEAN** | If true, disconnect the agent after creating the session | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SecureSessionEntityListing.md

@@ -0,0 +1,13 @@
+---
+title: SecureSessionEntityListing
+---
+## PureCloud::SecureSessionEntityListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<SecureSession>**](SecureSession.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ShortTermForecastingSettings.md

@@ -0,0 +1,13 @@
+---
+title: ShortTermForecastingSettings
+---
+## PureCloud::ShortTermForecastingSettings
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **default_history_weeks** | **Integer** | The number of weeks to consider by default when generating a volume forecast | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SignedData.md

@@ -0,0 +1,13 @@
+---
+title: SignedData
+---
+## PureCloud::SignedData
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **jwt** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SignedDataApi.md

@@ -0,0 +1,73 @@
+---
+title: SignedDataApi
+---
+
+## PureCloud::SignedDataApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | Description
+------------- | ------------- | -------------
+[**post_signeddata**](SignedDataApi.html#post_signeddata) | Sign identifying information
+{: class="table table-striped"}
+
+<a name="post_signeddata"></a>
+
+## -[**SignedData**](SignedData.html) post_signeddata(opts)
+
+Sign identifying information
+
+
+
+Wraps POST /api/v2/signeddata 
+
+
+### Example
+~~~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::SignedDataApi.new
+
+opts = { 
+  body: nil # Object | 
+}
+
+begin
+  #Sign identifying information
+  result = api_instance.post_signeddata(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SignedDataApi->post_signeddata: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | **Object**|  | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**SignedData**](SignedData.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+