purecloudplatformclientv2 59.0.0 → 60.0.0

data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb

@@ -0,0 +1,222 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
+
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
+
+=end
+
+require "uri"
+
+module PureCloud
+  class SpeechTextAnalyticsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get a Speech & Text Analytics program by id
+    # 
+    # @param program_id The id of the topic to get
+    # @param [Hash] opts the optional parameters
+    # @return [Program]
+    def get_speechandtextanalytics_program(program_id, opts = {})
+      data, _status_code, _headers = get_speechandtextanalytics_program_with_http_info(program_id, opts)
+      return data
+    end
+
+    # Get a Speech & Text Analytics program by id
+    # 
+    # @param program_id The id of the topic to get
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Program, Fixnum, Hash)>] Program data, response status code and response headers
+    def get_speechandtextanalytics_program_with_http_info(program_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_speechandtextanalytics_program ..."
+      end
+      
+      
+      # verify the required parameter 'program_id' is set
+      fail ArgumentError, "Missing the required parameter 'program_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_program" if program_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/speechandtextanalytics/programs/{programId}".sub('{format}','json').sub('{' + 'programId' + '}', program_id.to_s)
+
+      # 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 = nil
+      
+      auth_names = ['PureCloud OAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Program')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_speechandtextanalytics_program\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a Speech & Text Analytics topic by id
+    # 
+    # @param topic_id The id of the topic to get
+    # @param [Hash] opts the optional parameters
+    # @return [Topic]
+    def get_speechandtextanalytics_topic(topic_id, opts = {})
+      data, _status_code, _headers = get_speechandtextanalytics_topic_with_http_info(topic_id, opts)
+      return data
+    end
+
+    # Get a Speech &amp; Text Analytics topic by id
+    # 
+    # @param topic_id The id of the topic to get
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Topic, Fixnum, Hash)>] Topic data, response status code and response headers
+    def get_speechandtextanalytics_topic_with_http_info(topic_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_speechandtextanalytics_topic ..."
+      end
+      
+      
+      # verify the required parameter 'topic_id' is set
+      fail ArgumentError, "Missing the required parameter 'topic_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_topic" if topic_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/speechandtextanalytics/topics/{topicId}".sub('{format}','json').sub('{' + 'topicId' + '}', topic_id.to_s)
+
+      # 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 = nil
+      
+      auth_names = ['PureCloud OAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Topic')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_speechandtextanalytics_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create new Speech & Text Analytics topic
+    # 
+    # @param body The topic to create
+    # @param [Hash] opts the optional parameters
+    # @return [Topic]
+    def post_speechandtextanalytics_topics(body, opts = {})
+      data, _status_code, _headers = post_speechandtextanalytics_topics_with_http_info(body, opts)
+      return data
+    end
+
+    # Create new Speech &amp; Text Analytics topic
+    # 
+    # @param body The topic to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Topic, Fixnum, Hash)>] Topic data, response status code and response headers
+    def post_speechandtextanalytics_topics_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.post_speechandtextanalytics_topics ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling SpeechTextAnalyticsApi.post_speechandtextanalytics_topics" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/speechandtextanalytics/topics".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 => 'Topic')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#post_speechandtextanalytics_topics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -957,7 +957,6 @@ module PureCloud
     # @option opts [Array<String>] :jid jid
     # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
     # @option opts [Array<String>] :expand Which fields, if any, to expand
-    # @option opts [String] :state Only list users of this state (default to active)
     # @return [UserProfileEntityListing]
     def get_profiles_users(opts = {})
       data, _status_code, _headers = get_profiles_users_with_http_info(opts)
@@ -973,7 +972,6 @@ module PureCloud
     # @option opts [Array<String>] :jid jid
     # @option opts [String] :sort_order Ascending or descending sort order
     # @option opts [Array<String>] :expand Which fields, if any, to expand
-    # @option opts [String] :state Only list users of this state
     # @return [Array<(UserProfileEntityListing, Fixnum, Hash)>] UserProfileEntityListing data, response status code and response headers
     def get_profiles_users_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1020,16 +1018,6 @@ module PureCloud
       
       
       
-      
-      
-      
-      if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
-        fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
-      end
-      
-      
-      
-      
       # resource path
       local_var_path = "/api/v2/profiles/users".sub('{format}','json')
 
@@ -1041,7 +1029,6 @@ module PureCloud
       query_params[:'jid'] = @api_client.build_collection_param(opts[:'jid'], :multi) if opts[:'jid']
       query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
-      query_params[:'state'] = opts[:'state'] if opts[:'state']
 
       # header parameters
       header_params = {}

data/lib/purecloudplatformclientv2/api/workforce_management_api.rb

@@ -2497,8 +2497,8 @@ module PureCloud
       
       
       
-      if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'ActivityCodes', 'Agents', 'BusinessUnitActivityCodes', 'BusinessUnits', 'HistoricalAdherence', 'IntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'ServiceGoalGroups', 'ServiceGoalTemplates', 'ShiftTrading', 'ShortTermForecasts', 'TimeOffRequests', 'WorkPlans'].include?(opts[:'feature'])
-        fail ArgumentError, 'invalid value for "feature", must be one of AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BusinessUnitActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ServiceGoalTemplates, ShiftTrading, ShortTermForecasts, TimeOffRequests, WorkPlans'
+      if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'ActivityCodes', 'Agents', 'BusinessUnitActivityCodes', 'BusinessUnits', 'HistoricalAdherence', 'IntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'ServiceGoalGroups', 'ServiceGoalTemplates', 'PlanningGroups', 'ShiftTrading', 'ShortTermForecasts', 'TimeOffRequests', 'WorkPlans'].include?(opts[:'feature'])
+        fail ArgumentError, 'invalid value for "feature", must be one of AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BusinessUnitActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, TimeOffRequests, WorkPlans'
       end
       
       

data/lib/purecloudplatformclientv2/api_client.rb

@@ -76,7 +76,7 @@ module PureCloud
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
-      header_params['purecloud-sdk'] = '59.0.0'
+      header_params['purecloud-sdk'] = '60.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/action_entity_listing.rb

@@ -30,10 +30,10 @@ module PureCloud
 
     attr_accessor :self_uri
 
-    attr_accessor :previous_uri
-
     attr_accessor :next_uri
 
+    attr_accessor :previous_uri
+
     attr_accessor :last_uri
 
     attr_accessor :page_count
@@ -54,10 +54,10 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
-        :'previous_uri' => :'previousUri',
-        
         :'next_uri' => :'nextUri',
         
+        :'previous_uri' => :'previousUri',
+        
         :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
@@ -81,10 +81,10 @@ module PureCloud
         
         :'self_uri' => :'String',
         
-        :'previous_uri' => :'String',
-        
         :'next_uri' => :'String',
         
+        :'previous_uri' => :'String',
+        
         :'last_uri' => :'String',
         
         :'page_count' => :'Integer'
@@ -157,19 +157,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
@@ -312,8 +312,8 @@ module PureCloud
           total == o.total &&
           first_uri == o.first_uri &&
           self_uri == o.self_uri &&
-          previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
+          previous_uri == o.previous_uri &&
           last_uri == o.last_uri &&
           page_count == o.page_count
     end
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, first_uri, self_uri, previous_uri, next_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, self_uri, next_uri, previous_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb

@@ -30,10 +30,10 @@ module PureCloud
 
     attr_accessor :self_uri
 
-    attr_accessor :previous_uri
-
     attr_accessor :next_uri
 
+    attr_accessor :previous_uri
+
     attr_accessor :last_uri
 
     attr_accessor :page_count
@@ -54,10 +54,10 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
-        :'previous_uri' => :'previousUri',
-        
         :'next_uri' => :'nextUri',
         
+        :'previous_uri' => :'previousUri',
+        
         :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
@@ -81,10 +81,10 @@ module PureCloud
         
         :'self_uri' => :'String',
         
-        :'previous_uri' => :'String',
-        
         :'next_uri' => :'String',
         
+        :'previous_uri' => :'String',
+        
         :'last_uri' => :'String',
         
         :'page_count' => :'Integer'
@@ -157,19 +157,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
@@ -312,8 +312,8 @@ module PureCloud
           total == o.total &&
           first_uri == o.first_uri &&
           self_uri == o.self_uri &&
-          previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
+          previous_uri == o.previous_uri &&
           last_uri == o.last_uri &&
           page_count == o.page_count
     end
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, first_uri, self_uri, previous_uri, next_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, self_uri, next_uri, previous_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb

@@ -45,10 +45,10 @@ module PureCloud
     # The calibration id used for the purpose of training evaluators
     attr_accessor :calibration_id
 
-    attr_accessor :o_total_score
-
     attr_accessor :o_total_critical_score
 
+    attr_accessor :o_total_score
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -71,9 +71,9 @@ module PureCloud
         
         :'calibration_id' => :'calibrationId',
         
-        :'o_total_score' => :'oTotalScore',
+        :'o_total_critical_score' => :'oTotalCriticalScore',
         
-        :'o_total_critical_score' => :'oTotalCriticalScore'
+        :'o_total_score' => :'oTotalScore'
         
       }
     end
@@ -100,9 +100,9 @@ module PureCloud
         
         :'calibration_id' => :'String',
         
-        :'o_total_score' => :'Integer',
+        :'o_total_critical_score' => :'Integer',
         
-        :'o_total_critical_score' => :'Integer'
+        :'o_total_score' => :'Integer'
         
       }
     end
@@ -197,19 +197,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'oTotalScore')
+      if attributes.has_key?(:'oTotalCriticalScore')
         
         
-        self.o_total_score = attributes[:'oTotalScore']
+        self.o_total_critical_score = attributes[:'oTotalCriticalScore']
         
       
       end
 
       
-      if attributes.has_key?(:'oTotalCriticalScore')
+      if attributes.has_key?(:'oTotalScore')
         
         
-        self.o_total_critical_score = attributes[:'oTotalCriticalScore']
+        self.o_total_score = attributes[:'oTotalScore']
         
       
       end
@@ -346,8 +346,8 @@ module PureCloud
           context_id == o.context_id &&
           form_name == o.form_name &&
           calibration_id == o.calibration_id &&
-          o_total_score == o.o_total_score &&
-          o_total_critical_score == o.o_total_critical_score
+          o_total_critical_score == o.o_total_critical_score &&
+          o_total_score == o.o_total_score
     end
 
     # @see the `==` method
@@ -359,7 +359,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [evaluation_id, evaluator_id, user_id, event_time, queue_id, form_id, context_id, form_name, calibration_id, o_total_score, o_total_critical_score].hash
+      [evaluation_id, evaluator_id, user_id, event_time, queue_id, form_id, context_id, form_name, calibration_id, o_total_critical_score, o_total_score].hash
     end
 
     # build the object from hash