purecloudplatformclientv2 20.0.0 → 21.0.0

data/lib/purecloudplatformclientv2/api/quality_api.rb

@@ -1011,6 +1011,7 @@ module PureCloud
     # @option opts [BOOLEAN] :agent_has_read agent has the evaluation
     # @option opts [BOOLEAN] :expand_answer_total_scores get the total scores for evaluations
     # @option opts [Integer] :maximum maximum
+    # @option opts [String] :sort_order sort order options for agentUserId or evaluatorUserId query. Valid options are 'a', 'asc', 'ascending', 'd', 'desc', 'descending'
     # @return [EvaluationEntityListing]
     def get_quality_evaluations_query(opts = {})
       data, _status_code, _headers = get_quality_evaluations_query_with_http_info(opts)
@@ -1037,6 +1038,7 @@ module PureCloud
     # @option opts [BOOLEAN] :agent_has_read agent has the evaluation
     # @option opts [BOOLEAN] :expand_answer_total_scores get the total scores for evaluations
     # @option opts [Integer] :maximum maximum
+    # @option opts [String] :sort_order sort order options for agentUserId or evaluatorUserId query. Valid options are 'a', 'asc', 'ascending', 'd', 'desc', 'descending'
     # @return [Array<(EvaluationEntityListing, Fixnum, Hash)>] EvaluationEntityListing data, response status code and response headers
     def get_quality_evaluations_query_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1138,6 +1140,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1167,6 +1175,7 @@ module PureCloud
       query_params[:'agentHasRead'] = opts[:'agent_has_read'] if opts[:'agent_has_read']
       query_params[:'expandAnswerTotalScores'] = opts[:'expand_answer_total_scores'] if opts[:'expand_answer_total_scores']
       query_params[:'maximum'] = opts[:'maximum'] if opts[:'maximum']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
 
       # header parameters
       header_params = {}

data/lib/purecloudplatformclientv2/api/scripts_api.rb

@@ -860,5 +860,79 @@ module PureCloud
       end
       return data, status_code, headers
     end
+
+    # Get the upload status of an imported script
+    # 
+    # @param upload_id Upload ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :long_poll Enable longPolling endpoint (default to false)
+    # @return [ImportScriptStatusResponse]
+    def get_scripts_upload_status(upload_id, opts = {})
+      data, _status_code, _headers = get_scripts_upload_status_with_http_info(upload_id, opts)
+      return data
+    end
+
+    # Get the upload status of an imported script
+    # 
+    # @param upload_id Upload ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :long_poll Enable longPolling endpoint
+    # @return [Array<(ImportScriptStatusResponse, Fixnum, Hash)>] ImportScriptStatusResponse data, response status code and response headers
+    def get_scripts_upload_status_with_http_info(upload_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ScriptsApi.get_scripts_upload_status ..."
+      end
+      
+      
+      # verify the required parameter 'upload_id' is set
+      fail ArgumentError, "Missing the required parameter 'upload_id' when calling ScriptsApi.get_scripts_upload_status" if upload_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/scripts/uploads/{uploadId}/status".sub('{format}','json').sub('{' + 'uploadId' + '}', upload_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'longPoll'] = opts[:'long_poll'] if opts[:'long_poll']
+
+      # 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 Auth']
+      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 => 'ImportScriptStatusResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ScriptsApi#get_scripts_upload_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/purecloudplatformclientv2/api/signed_data_api.rb

@@ -0,0 +1,90 @@
+=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: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require "uri"
+
+module PureCloud
+  class SignedDataApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Sign identifying information
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Object] :body 
+    # @return [SignedData]
+    def post_signeddata(opts = {})
+      data, _status_code, _headers = post_signeddata_with_http_info(opts)
+      return data
+    end
+
+    # Sign identifying information
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Object] :body 
+    # @return [Array<(SignedData, Fixnum, Hash)>] SignedData data, response status code and response headers
+    def post_signeddata_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SignedDataApi.post_signeddata ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/signeddata".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(opts[:'body'])
+      
+      auth_names = ['PureCloud Auth']
+      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 => 'SignedData')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SignedDataApi#post_signeddata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/purecloudplatformclientv2/api/workforce_management_api.rb

@@ -739,6 +739,69 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get the management units to which the agents belong
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :body body
+    # @return [Array<AgentManagementUnitReference>]
+    def post_workforcemanagement_agents_managementunits(opts = {})
+      data, _status_code, _headers = post_workforcemanagement_agents_managementunits_with_http_info(opts)
+      return data
+    end
+
+    # Get the management units to which the agents belong
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :body body
+    # @return [Array<(Array<AgentManagementUnitReference>, Fixnum, Hash)>] Array<AgentManagementUnitReference> data, response status code and response headers
+    def post_workforcemanagement_agents_managementunits_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_agents_managementunits ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/workforcemanagement/agents/managementunits".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(opts[:'body'])
+      
+      auth_names = ['PureCloud Auth']
+      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 => 'Array<AgentManagementUnitReference>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_agents_managementunits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Request a historical adherence report
     # 
     # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

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'] = '20.0.0'
+      header_params['purecloud-sdk'] = '21.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/adherence_settings.rb

@@ -0,0 +1,335 @@
+=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: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  # Schedule Adherence Configuration
+  class AdherenceSettings
+    # The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence
+    attr_accessor :severe_alert_threshold_minutes
+
+    # Target adherence percentage
+    attr_accessor :adherence_target_percent
+
+    # The threshold in seconds for which agents should not be penalized for being momentarily out of adherence
+    attr_accessor :adherence_exception_threshold_seconds
+
+    # Whether to treat all non-on-queue activities as equivalent for adherence purposes
+    attr_accessor :non_on_queue_activities_equivalent
+
+    # Whether to track on-queue activities
+    attr_accessor :track_on_queue_activity
+
+    # Activity categories that should be ignored for adherence purposes
+    attr_accessor :ignored_activity_categories
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'severe_alert_threshold_minutes' => :'severeAlertThresholdMinutes',
+        
+        :'adherence_target_percent' => :'adherenceTargetPercent',
+        
+        :'adherence_exception_threshold_seconds' => :'adherenceExceptionThresholdSeconds',
+        
+        :'non_on_queue_activities_equivalent' => :'nonOnQueueActivitiesEquivalent',
+        
+        :'track_on_queue_activity' => :'trackOnQueueActivity',
+        
+        :'ignored_activity_categories' => :'ignoredActivityCategories'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'severe_alert_threshold_minutes' => :'Integer',
+        
+        :'adherence_target_percent' => :'Integer',
+        
+        :'adherence_exception_threshold_seconds' => :'Integer',
+        
+        :'non_on_queue_activities_equivalent' => :'BOOLEAN',
+        
+        :'track_on_queue_activity' => :'BOOLEAN',
+        
+        :'ignored_activity_categories' => :'Array<String>'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      
+      if attributes.has_key?(:'severeAlertThresholdMinutes')
+        
+        
+        self.severe_alert_threshold_minutes = attributes[:'severeAlertThresholdMinutes']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'adherenceTargetPercent')
+        
+        
+        self.adherence_target_percent = attributes[:'adherenceTargetPercent']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'adherenceExceptionThresholdSeconds')
+        
+        
+        self.adherence_exception_threshold_seconds = attributes[:'adherenceExceptionThresholdSeconds']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'nonOnQueueActivitiesEquivalent')
+        
+        
+        self.non_on_queue_activities_equivalent = attributes[:'nonOnQueueActivitiesEquivalent']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'trackOnQueueActivity')
+        
+        
+        self.track_on_queue_activity = attributes[:'trackOnQueueActivity']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'ignoredActivityCategories')
+        
+        if (value = attributes[:'ignoredActivityCategories']).is_a?(Array)
+          self.ignored_activity_categories = value
+        end
+        
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          severe_alert_threshold_minutes == o.severe_alert_threshold_minutes &&
+          adherence_target_percent == o.adherence_target_percent &&
+          adherence_exception_threshold_seconds == o.adherence_exception_threshold_seconds &&
+          non_on_queue_activities_equivalent == o.non_on_queue_activities_equivalent &&
+          track_on_queue_activity == o.track_on_queue_activity &&
+          ignored_activity_categories == o.ignored_activity_categories
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [severe_alert_threshold_minutes, adherence_target_percent, adherence_exception_threshold_seconds, non_on_queue_activities_equivalent, track_on_queue_activity, ignored_activity_categories].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = Object.const_get("PureCloud").const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end