purecloudplatformclientv2 75.1.0 → 79.0.0

data/docs/MessagingTemplate.md

@@ -0,0 +1,15 @@
+---
+title: MessagingTemplate
+---
+## PureCloud::MessagingTemplate
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The messaging template name. | |
+| **namespace** | **String** | The messaging template namespace. | |
+| **language** | **String** | The messaging template language. For example, 'en-US' | |
+{: class="table table-striped"}
+
+

data/docs/Organization.md

@@ -19,6 +19,7 @@ title: Organization
 | **default_site_id** | **String** |  | [optional] |
 | **support_uri** | **String** | Email address where support tickets are sent to. | [optional] |
 | **voicemail_enabled** | **BOOLEAN** |  | [optional] |
+| **product_platform** | **String** | Organizations Originating Platform. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 | **features** | **Hash<String, BOOLEAN>** | The state of features available for the organization. | [optional] |
 {: class="table table-striped"}

data/docs/QualityApi.md

@@ -2592,7 +2592,7 @@ Name | Type | Description  | Notes
 
 <a name="get_quality_surveys_scorable"></a>
 
-## [**ScorableSurvey**](ScorableSurvey.html) get_quality_surveys_scorable(opts)
+## [**ScorableSurvey**](ScorableSurvey.html) get_quality_surveys_scorable(customer_survey_url)
 
 
 
@@ -2613,13 +2613,12 @@ require 'purecloudplatformclientv2'
 
 api_instance = PureCloud::QualityApi.new
 
-opts = { 
-  customer_survey_url: "customer_survey_url_example" # String | customerSurveyUrl
-}
+customer_survey_url = "customer_survey_url_example" # String | customerSurveyUrl
+
 
 begin
   #Get a survey as an end-customer, for the purposes of scoring it.
-  result = api_instance.get_quality_surveys_scorable(opts)
+  result = api_instance.get_quality_surveys_scorable(customer_survey_url)
   p result
 rescue PureCloud::ApiError => e
   puts "Exception when calling QualityApi->get_quality_surveys_scorable: #{e}"
@@ -2630,7 +2629,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **customer_survey_url** | **String**| customerSurveyUrl | [optional]  |
+ **customer_survey_url** | **String**| customerSurveyUrl |  |
 {: class="table table-striped"}
 
 

data/docs/Record.md

@@ -0,0 +1,15 @@
+---
+title: Record
+---
+## PureCloud::Record
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the record. | |
+| **type** | **String** | The type of the record. (Example values:  MX, TXT, CNAME) | |
+| **value** | **String** | The value of the record. | |
+{: class="table table-striped"}
+
+

data/docs/ReportingExportMetadataJobListing.md

@@ -0,0 +1,22 @@
+---
+title: ReportingExportMetadataJobListing
+---
+## PureCloud::ReportingExportMetadataJobListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<ReportingExportMetadataJobResponse>**](ReportingExportMetadataJobResponse.html) |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **page_count** | **Integer** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ReportingExportMetadataJobResponse.md

@@ -0,0 +1,22 @@
+---
+title: ReportingExportMetadataJobResponse
+---
+## PureCloud::ReportingExportMetadataJobResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **view_type** | **String** | The view type of the export metadata | [optional] |
+| **date_limitations** | **String** | The date limitations of the export metadata | [optional] |
+| **required_filters** | **Array<String>** | The list of required filters for the export metadata | [optional] |
+| **supported_filters** | **Array<String>** | The list of supported filters for the export metadata | [optional] |
+| **required_column_ids** | **Array<String>** | The list of required column ids for the export metadata | [optional] |
+| **dependent_column_ids** | **Hash<String, Array<String>>** | The list of dependent column ids for the export metadata | [optional] |
+| **available_column_ids** | **Array<String>** | The list of available column ids for the export metadata | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/Response.md

@@ -17,6 +17,8 @@ title: Response
 | **interaction_type** | **String** | The interaction type for this response. | [optional] |
 | **substitutions** | [**Array<ResponseSubstitution>**](ResponseSubstitution.html) | Details about any text substitutions used in the texts for this response. | [optional] |
 | **substitutions_schema** | [**JsonSchemaDocument**](JsonSchemaDocument.html) | Metadata about the text substitutions in json schema format. | [optional] |
+| **response_type** | **String** | The response type represented by the response | [optional] |
+| **messaging_template** | [**MessagingTemplate**](MessagingTemplate.html) | The messaging template definition. This is required when adding to a library with responseType set to MessagingTemplate. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/RoutingApi.md

@@ -13,8 +13,10 @@ Method | Description
 [**delete_routing_queue**](RoutingApi.html#delete_routing_queue) | Delete a queue
 [**delete_routing_queue_user**](RoutingApi.html#delete_routing_queue_user) | Delete queue member
 [**delete_routing_queue_wrapupcode**](RoutingApi.html#delete_routing_queue_wrapupcode) | Delete a wrap-up code from a queue
+[**delete_routing_settings**](RoutingApi.html#delete_routing_settings) | Delete an organization's routing settings
 [**delete_routing_skill**](RoutingApi.html#delete_routing_skill) | Delete Routing Skill
 [**delete_routing_sms_phonenumber**](RoutingApi.html#delete_routing_sms_phonenumber) | Delete a phone number provisioned for SMS.
+[**delete_routing_user_utilization**](RoutingApi.html#delete_routing_user_utilization) | Delete the user's max utilization settings and revert to the organization-wide default.
 [**delete_routing_utilization**](RoutingApi.html#delete_routing_utilization) | Delete the organization-wide max utilization settings and revert to the system default.
 [**delete_routing_wrapupcode**](RoutingApi.html#delete_routing_wrapupcode) | Delete wrap-up code
 [**delete_user_routinglanguage**](RoutingApi.html#delete_user_routinglanguage) | Remove routing language from user
@@ -36,6 +38,7 @@ Method | Description
 [**get_routing_queues_divisionviews**](RoutingApi.html#get_routing_queues_divisionviews) | Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
 [**get_routing_queues_divisionviews_all**](RoutingApi.html#get_routing_queues_divisionviews_all) | Get a paged listing of simplified queue objects.  Can be used to get a digest of all queues in an organization.
 [**get_routing_queues_me**](RoutingApi.html#get_routing_queues_me) | Get a paged listing of queues the user is a member of.
+[**get_routing_settings**](RoutingApi.html#get_routing_settings) | Get an organization's routing settings
 [**get_routing_settings_contactcenter**](RoutingApi.html#get_routing_settings_contactcenter) | Get Contact Center Settings
 [**get_routing_settings_transcription**](RoutingApi.html#get_routing_settings_transcription) | Get Transcription Settings
 [**get_routing_skill**](RoutingApi.html#get_routing_skill) | Get Routing Skill
@@ -45,6 +48,7 @@ Method | Description
 [**get_routing_sms_availablephonenumbers**](RoutingApi.html#get_routing_sms_availablephonenumbers) | Get a list of available phone numbers for SMS provisioning.
 [**get_routing_sms_phonenumber**](RoutingApi.html#get_routing_sms_phonenumber) | Get a phone number provisioned for SMS.
 [**get_routing_sms_phonenumbers**](RoutingApi.html#get_routing_sms_phonenumbers) | Get a list of provisioned phone numbers.
+[**get_routing_user_utilization**](RoutingApi.html#get_routing_user_utilization) | Get the user's max utilization settings.  If not configured, the organization-wide default is returned.
 [**get_routing_utilization**](RoutingApi.html#get_routing_utilization) | Get the organization-wide max utilization settings.
 [**get_routing_wrapupcode**](RoutingApi.html#get_routing_wrapupcode) | Get details about this wrap-up code.
 [**get_routing_wrapupcodes**](RoutingApi.html#get_routing_wrapupcodes) | Get list of wrapup codes.
@@ -75,8 +79,10 @@ Method | Description
 [**put_routing_email_domain_route**](RoutingApi.html#put_routing_email_domain_route) | Update a route
 [**put_routing_message_recipient**](RoutingApi.html#put_routing_message_recipient) | Update a recipient
 [**put_routing_queue**](RoutingApi.html#put_routing_queue) | Update a queue
+[**put_routing_settings**](RoutingApi.html#put_routing_settings) | Update an organization's routing settings
 [**put_routing_settings_transcription**](RoutingApi.html#put_routing_settings_transcription) | Update Transcription Settings
 [**put_routing_sms_phonenumber**](RoutingApi.html#put_routing_sms_phonenumber) | Update a phone number provisioned for SMS.
+[**put_routing_user_utilization**](RoutingApi.html#put_routing_user_utilization) | Update the user's max utilization settings.  Include only those media types requiring custom configuration.
 [**put_routing_utilization**](RoutingApi.html#put_routing_utilization) | Update the organization-wide max utilization settings.  Include only those media types requiring custom configuration.
 [**put_routing_wrapupcode**](RoutingApi.html#put_routing_wrapupcode) | Update wrap-up code
 [**put_user_routingskill**](RoutingApi.html#put_user_routingskill) | Update routing skill proficiency or state.
@@ -416,6 +422,64 @@ nil (empty response body)
 
 
 
+<a name="delete_routing_settings"></a>
+
+##  delete_routing_settings
+
+
+
+Delete an organization's routing settings
+
+
+
+Wraps DELETE /api/v2/routing/settings 
+
+Requires ANY permissions: 
+
+* routing:settings: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::RoutingApi.new
+
+begin
+  #Delete an organization's routing settings
+  api_instance.delete_routing_settings
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->delete_routing_settings: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="delete_routing_skill"></a>
 
 ##  delete_routing_skill(skill_id)
@@ -544,6 +608,70 @@ nil (empty response body)
 
 
 
+<a name="delete_routing_user_utilization"></a>
+
+##  delete_routing_user_utilization(user_id)
+
+
+
+Delete the user's max utilization settings and revert to the organization-wide default.
+
+
+
+Wraps DELETE /api/v2/routing/users/{userId}/utilization 
+
+Requires ANY permissions: 
+
+* routing:utilization:manage
+
+
+### 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::RoutingApi.new
+
+user_id = "user_id_example" # String | User ID
+
+
+begin
+  #Delete the user's max utilization settings and revert to the organization-wide default.
+  api_instance.delete_routing_user_utilization(user_id)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->delete_routing_user_utilization: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="delete_routing_utilization"></a>
 
 ##  delete_routing_utilization
@@ -1994,6 +2122,64 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_routing_settings"></a>
+
+## [**RoutingSettings**](RoutingSettings.html) get_routing_settings
+
+
+
+Get an organization's routing settings
+
+
+
+Wraps GET /api/v2/routing/settings 
+
+Requires NO permissions: 
+
+
+
+### 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::RoutingApi.new
+
+begin
+  #Get an organization's routing settings
+  result = api_instance.get_routing_settings
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->get_routing_settings: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**RoutingSettings**](RoutingSettings.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_routing_settings_contactcenter"></a>
 
 ## [**ContactCenterSettings**](ContactCenterSettings.html) get_routing_settings_contactcenter
@@ -2598,6 +2784,72 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_routing_user_utilization"></a>
+
+## [**Utilization**](Utilization.html) get_routing_user_utilization(user_id)
+
+
+
+Get the user's max utilization settings.  If not configured, the organization-wide default is returned.
+
+
+
+Wraps GET /api/v2/routing/users/{userId}/utilization 
+
+Requires ANY permissions: 
+
+* routing:utilization:manage
+* routing:utilization: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::RoutingApi.new
+
+user_id = "user_id_example" # String | User ID
+
+
+begin
+  #Get the user's max utilization settings.  If not configured, the organization-wide default is returned.
+  result = api_instance.get_routing_user_utilization(user_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->get_routing_user_utilization: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Utilization**](Utilization.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_routing_utilization"></a>
 
 ## [**Utilization**](Utilization.html) get_routing_utilization
@@ -4642,6 +4894,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="put_routing_settings"></a>
+
+## [**RoutingSettings**](RoutingSettings.html) put_routing_settings(body)
+
+
+
+Update an organization's routing settings
+
+
+
+Wraps PUT /api/v2/routing/settings 
+
+Requires ANY permissions: 
+
+* routing:settings: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::RoutingApi.new
+
+body = PureCloud::RoutingSettings.new # RoutingSettings | Organization Settings
+
+
+begin
+  #Update an organization's routing settings
+  result = api_instance.put_routing_settings(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->put_routing_settings: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**RoutingSettings**](RoutingSettings.html)| Organization Settings |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**RoutingSettings**](RoutingSettings.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="put_routing_settings_transcription"></a>
 
 ## [**TranscriptionSettings**](TranscriptionSettings.html) put_routing_settings_transcription(body)
@@ -4775,6 +5092,74 @@ Name | Type | Description  | Notes
 
 
 
+<a name="put_routing_user_utilization"></a>
+
+## [**Utilization**](Utilization.html) put_routing_user_utilization(user_id, body)
+
+
+
+Update the user's max utilization settings.  Include only those media types requiring custom configuration.
+
+
+
+Wraps PUT /api/v2/routing/users/{userId}/utilization 
+
+Requires ANY permissions: 
+
+* routing:utilization:manage
+
+
+### 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::RoutingApi.new
+
+user_id = "user_id_example" # String | User ID
+
+body = PureCloud::Utilization.new # Utilization | utilization
+
+
+begin
+  #Update the user's max utilization settings.  Include only those media types requiring custom configuration.
+  result = api_instance.put_routing_user_utilization(user_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling RoutingApi->put_routing_user_utilization: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID |  |
+ **body** | [**Utilization**](Utilization.html)| utilization |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Utilization**](Utilization.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="put_routing_utilization"></a>
 
 ## [**Utilization**](Utilization.html) put_routing_utilization(body)