class PureCloud::AnalyticsEvaluation

Attributes

calibration_id[RW]

The calibration id used for the purpose of training evaluators

context_id[RW]

A unique identifier for an evaluation form, regardless of version

deleted[RW]

Whether this evaluation has been deleted

evaluation_id[RW]

Unique identifier for the evaluation

evaluator_id[RW]

A unique identifier of the PureCloud user who evaluated the interaction

event_time[RW]

Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

form_id[RW]

Unique identifier for the form used to evaluate the conversation/agent

form_name[RW]

Name of the evaluation form

o_total_critical_score[RW]
o_total_score[RW]
queue_id[RW]

Unique identifier for the queue the conversation was on

rescored[RW]

Whether this evaluation has ever been rescored

user_id[RW]

Unique identifier for the user being evaluated

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 59
def self.attribute_map
  {
    
    :'evaluation_id' => :'evaluationId',
    
    :'evaluator_id' => :'evaluatorId',
    
    :'user_id' => :'userId',
    
    :'event_time' => :'eventTime',
    
    :'queue_id' => :'queueId',
    
    :'form_id' => :'formId',
    
    :'context_id' => :'contextId',
    
    :'form_name' => :'formName',
    
    :'calibration_id' => :'calibrationId',
    
    :'rescored' => :'rescored',
    
    :'deleted' => :'deleted',
    
    :'o_total_score' => :'oTotalScore',
    
    :'o_total_critical_score' => :'oTotalCriticalScore'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 126
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?(:'evaluationId')
    
    
    self.evaluation_id = attributes[:'evaluationId']
    
  
  end

  
  if attributes.has_key?(:'evaluatorId')
    
    
    self.evaluator_id = attributes[:'evaluatorId']
    
  
  end

  
  if attributes.has_key?(:'userId')
    
    
    self.user_id = attributes[:'userId']
    
  
  end

  
  if attributes.has_key?(:'eventTime')
    
    
    self.event_time = attributes[:'eventTime']
    
  
  end

  
  if attributes.has_key?(:'queueId')
    
    
    self.queue_id = attributes[:'queueId']
    
  
  end

  
  if attributes.has_key?(:'formId')
    
    
    self.form_id = attributes[:'formId']
    
  
  end

  
  if attributes.has_key?(:'contextId')
    
    
    self.context_id = attributes[:'contextId']
    
  
  end

  
  if attributes.has_key?(:'formName')
    
    
    self.form_name = attributes[:'formName']
    
  
  end

  
  if attributes.has_key?(:'calibrationId')
    
    
    self.calibration_id = attributes[:'calibrationId']
    
  
  end

  
  if attributes.has_key?(:'rescored')
    
    
    self.rescored = attributes[:'rescored']
    
  
  end

  
  if attributes.has_key?(:'deleted')
    
    
    self.deleted = attributes[:'deleted']
    
  
  end

  
  if attributes.has_key?(:'oTotalScore')
    
    
    self.o_total_score = attributes[:'oTotalScore']
    
  
  end

  
  if attributes.has_key?(:'oTotalCriticalScore')
    
    
    self.o_total_critical_score = attributes[:'oTotalCriticalScore']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 92
def self.swagger_types
  {
    
    :'evaluation_id' => :'String',
    
    :'evaluator_id' => :'String',
    
    :'user_id' => :'String',
    
    :'event_time' => :'DateTime',
    
    :'queue_id' => :'String',
    
    :'form_id' => :'String',
    
    :'context_id' => :'String',
    
    :'form_name' => :'String',
    
    :'calibration_id' => :'String',
    
    :'rescored' => :'BOOLEAN',
    
    :'deleted' => :'BOOLEAN',
    
    :'o_total_score' => :'Integer',
    
    :'o_total_critical_score' => :'Integer'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 387
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      evaluation_id == o.evaluation_id &&
      evaluator_id == o.evaluator_id &&
      user_id == o.user_id &&
      event_time == o.event_time &&
      queue_id == o.queue_id &&
      form_id == o.form_id &&
      context_id == o.context_id &&
      form_name == o.form_name &&
      calibration_id == o.calibration_id &&
      rescored == o.rescored &&
      deleted == o.deleted &&
      o_total_score == o.o_total_score &&
      o_total_critical_score == o.o_total_critical_score
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 437
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
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 497
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
build_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 418
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 407
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 413
def hash
  [evaluation_id, evaluator_id, user_id, event_time, queue_id, form_id, context_id, form_name, calibration_id, rescored, deleted, o_total_score, o_total_critical_score].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 254
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 480
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 485
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
to_s() click to toggle source
# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 475
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/analytics_evaluation.rb, line 263
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end