purecloudplatformclientv2 47.0.0 → 48.0.0

data/docs/UtilitiesApi.md

@@ -11,6 +11,7 @@ Method | Description
 [**get_date**](UtilitiesApi.html#get_date) | Get the current system date/time
 [**get_timezones**](UtilitiesApi.html#get_timezones) | Get time zones list
 [**post_certificate_details**](UtilitiesApi.html#post_certificate_details) | Returns the information about an X509 PEM encoded certificate or certificate chain.
+[**post_gmsc_tokens**](UtilitiesApi.html#post_gmsc_tokens) | Generate a JWT for use with common cloud.
 {: class="table table-striped"}
 
 <a name="get_date"></a>
@@ -202,3 +203,61 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_gmsc_tokens"></a>
+
+## -[**Token**](Token.html) post_gmsc_tokens
+
+
+
+Generate a JWT for use with common cloud.
+
+
+
+Wraps POST /api/v2/gmsc/tokens 
+
+Requires NO permissions: 
+
+
+
+### 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::UtilitiesApi.new
+
+begin
+  #Generate a JWT for use with common cloud.
+  result = api_instance.post_gmsc_tokens
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UtilitiesApi->post_gmsc_tokens: #{e}"
+end
+~~~
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Token**](Token.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ViewFilter.md

@@ -48,6 +48,19 @@ title: ViewFilter
 | **mos** | [**NumericRange**](NumericRange.html) | The desired range for mos values | [optional] |
 | **survey_question_group_score** | [**NumericRange**](NumericRange.html) | The survey question group score used to filter the view | [optional] |
 | **survey_promoter_score** | [**NumericRange**](NumericRange.html) | The survey promoter score used to filter the view | [optional] |
+| **survey_form_context_ids** | **Array<String>** | The list of survey form context ids used to filter the view | [optional] |
+| **conversation_ids** | **Array<String>** | The list of conversation ids used to filter the view | [optional] |
+| **is_ended** | **BOOLEAN** | Indicates filtering for ended | [optional] |
+| **is_surveyed** | **BOOLEAN** | Indicates filtering for survey | [optional] |
+| **survey_scores** | [**Array<NumericRange>**](NumericRange.html) | The list of survey score ranges used to filter the view | [optional] |
+| **promoter_scores** | [**Array<NumericRange>**](NumericRange.html) | The list of promoter score ranges used to filter the view | [optional] |
+| **is_campaign** | **BOOLEAN** | Indicates filtering for campaign | [optional] |
+| **survey_statuses** | **Array<String>** | The list of survey statuses used to filter the view | [optional] |
+| **conversation_properties** | [**ConversationProperties**](ConversationProperties.html) | A grouping of conversation level filters | [optional] |
+| **is_blind_transferred** | **BOOLEAN** | Indicates filtering for blind transferred | [optional] |
+| **is_consulted** | **BOOLEAN** | Indicates filtering for consulted | [optional] |
+| **is_consult_transferred** | **BOOLEAN** | Indicates filtering for consult transferred | [optional] |
+| **remote_participants** | **Array<String>** | The list of remote participants used to filter the view | [optional] |
 {: class="table table-striped"}
 
 

data/lib/purecloudplatformclientv2.rb

@@ -245,6 +245,7 @@ require 'purecloudplatformclientv2/models/contact'
 require 'purecloudplatformclientv2/models/contact_address'
 require 'purecloudplatformclientv2/models/contact_callback_request'
 require 'purecloudplatformclientv2/models/contact_column_time_zone'
+require 'purecloudplatformclientv2/models/contact_column_to_data_action_field_mapping'
 require 'purecloudplatformclientv2/models/contact_list'
 require 'purecloudplatformclientv2/models/contact_list_division_view'
 require 'purecloudplatformclientv2/models/contact_list_division_view_listing'
@@ -345,6 +346,7 @@ require 'purecloudplatformclientv2/models/conversation_message_event_topic_messa
 require 'purecloudplatformclientv2/models/conversation_message_event_topic_message_sticker'
 require 'purecloudplatformclientv2/models/conversation_message_event_topic_uri_reference'
 require 'purecloudplatformclientv2/models/conversation_message_event_topic_wrapup'
+require 'purecloudplatformclientv2/models/conversation_properties'
 require 'purecloudplatformclientv2/models/conversation_query'
 require 'purecloudplatformclientv2/models/conversation_screen_share_event_topic_detail'
 require 'purecloudplatformclientv2/models/conversation_screen_share_event_topic_error_body'
@@ -406,6 +408,7 @@ require 'purecloudplatformclientv2/models/did'
 require 'purecloudplatformclientv2/models/did_entity_listing'
 require 'purecloudplatformclientv2/models/did_pool'
 require 'purecloudplatformclientv2/models/did_pool_entity_listing'
+require 'purecloudplatformclientv2/models/data_action_condition_predicate'
 require 'purecloudplatformclientv2/models/data_schema'
 require 'purecloudplatformclientv2/models/data_table'
 require 'purecloudplatformclientv2/models/data_table_row_entity_listing'
@@ -1108,6 +1111,7 @@ require 'purecloudplatformclientv2/models/scheduling_settings'
 require 'purecloudplatformclientv2/models/schema_category'
 require 'purecloudplatformclientv2/models/schema_category_entity_listing'
 require 'purecloudplatformclientv2/models/schema_reference_entity_listing'
+require 'purecloudplatformclientv2/models/scorable_survey'
 require 'purecloudplatformclientv2/models/screen_recording_session'
 require 'purecloudplatformclientv2/models/screen_recording_session_listing'
 require 'purecloudplatformclientv2/models/screen_recording_session_request'
@@ -1179,11 +1183,16 @@ require 'purecloudplatformclientv2/models/subscriber_response'
 require 'purecloudplatformclientv2/models/subscription_overview_usage'
 require 'purecloudplatformclientv2/models/suggest_search_criteria'
 require 'purecloudplatformclientv2/models/suggest_search_request'
+require 'purecloudplatformclientv2/models/survey'
 require 'purecloudplatformclientv2/models/survey_assignment'
 require 'purecloudplatformclientv2/models/survey_form'
+require 'purecloudplatformclientv2/models/survey_form_and_scoring_set'
 require 'purecloudplatformclientv2/models/survey_form_entity_listing'
 require 'purecloudplatformclientv2/models/survey_question'
 require 'purecloudplatformclientv2/models/survey_question_group'
+require 'purecloudplatformclientv2/models/survey_question_group_score'
+require 'purecloudplatformclientv2/models/survey_question_score'
+require 'purecloudplatformclientv2/models/survey_scoring_set'
 require 'purecloudplatformclientv2/models/system_message_system_message'
 require 'purecloudplatformclientv2/models/system_presence'
 require 'purecloudplatformclientv2/models/system_prompt'
@@ -1211,6 +1220,7 @@ require 'purecloudplatformclientv2/models/time_slot'
 require 'purecloudplatformclientv2/models/time_zone'
 require 'purecloudplatformclientv2/models/time_zone_entity_listing'
 require 'purecloudplatformclientv2/models/time_zone_mapping_preview'
+require 'purecloudplatformclientv2/models/token'
 require 'purecloudplatformclientv2/models/token_info'
 require 'purecloudplatformclientv2/models/transfer_request'
 require 'purecloudplatformclientv2/models/trunk'

data/lib/purecloudplatformclientv2/api/alerting_api.rb

@@ -75,7 +75,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -139,7 +139,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -193,7 +193,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -267,7 +267,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -331,7 +331,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -386,7 +386,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -460,7 +460,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -524,7 +524,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -598,7 +598,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -682,7 +682,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -766,7 +766,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,
         :query_params => query_params,

data/lib/purecloudplatformclientv2/api/analytics_api.rb

@@ -75,7 +75,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -139,7 +139,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -203,7 +203,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -258,7 +258,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -340,7 +340,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -414,7 +414,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -469,7 +469,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -534,7 +534,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -617,7 +617,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -682,7 +682,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -757,7 +757,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -830,7 +830,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -885,7 +885,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -960,7 +960,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1025,7 +1025,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1090,7 +1090,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1155,7 +1155,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1220,7 +1220,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1285,7 +1285,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1350,7 +1350,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1415,7 +1415,7 @@ module PureCloud
       # http body (model)
       post_body = nil
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1480,7 +1480,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1494,6 +1494,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Query for survey aggregates
+    # 
+    # @param body query
+    # @param [Hash] opts the optional parameters
+    # @return [AggregateQueryResponse]
+    def post_analytics_surveys_aggregates_query(body, opts = {})
+      data, _status_code, _headers = post_analytics_surveys_aggregates_query_with_http_info(body, opts)
+      return data
+    end
+
+    # Query for survey aggregates
+    # 
+    # @param body query
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
+    def post_analytics_surveys_aggregates_query_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_surveys_aggregates_query ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_surveys_aggregates_query" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/analytics/surveys/aggregates/query".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      
+      auth_names = ['PureCloud OAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AggregateQueryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_surveys_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Query for user aggregates
     # 
     # @param body query
@@ -1545,7 +1610,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1610,7 +1675,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1675,7 +1740,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1750,7 +1815,7 @@ module PureCloud
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
       
-      auth_names = ['PureCloud Auth']
+      auth_names = ['PureCloud OAuth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,
         :query_params => query_params,