class PureCloud::HistoricalAdherenceQueryResult

Attributes

actuals[RW]

List of actual activity with offset for this user

adherence_percentage[RW]

Adherence percentage for this user, in the scale of 0 - 100

conformance_percentage[RW]

Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period.

day_metrics[RW]

Adherence and conformance metrics for days in query range

end_date[RW]

End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time

exception_info[RW]

List of adherence exceptions for this user

impact[RW]

The impact of the current adherence state for this user

start_date[RW]

Beginning of the date range that was queried, in ISO-8601 format

user_id[RW]

The ID of the user for whom the adherence is queried

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb, line 49
def self.attribute_map
  {
    
    :'user_id' => :'userId',
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate',
    
    :'adherence_percentage' => :'adherencePercentage',
    
    :'conformance_percentage' => :'conformancePercentage',
    
    :'impact' => :'impact',
    
    :'exception_info' => :'exceptionInfo',
    
    :'day_metrics' => :'dayMetrics',
    
    :'actuals' => :'actuals'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb, line 100
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?(:'userId')
    
    
    self.user_id = attributes[:'userId']
    
  
  end

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

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

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

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

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

  
  if attributes.has_key?(:'exceptionInfo')
    
    if (value = attributes[:'exceptionInfo']).is_a?(Array)
      self.exception_info = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'dayMetrics')
    
    if (value = attributes[:'dayMetrics']).is_a?(Array)
      self.day_metrics = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'actuals')
    
    if (value = attributes[:'actuals']).is_a?(Array)
      self.actuals = value
    end
    
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb, line 74
def self.swagger_types
  {
    
    :'user_id' => :'String',
    
    :'start_date' => :'DateTime',
    
    :'end_date' => :'DateTime',
    
    :'adherence_percentage' => :'Float',
    
    :'conformance_percentage' => :'Float',
    
    :'impact' => :'String',
    
    :'exception_info' => :'Array<HistoricalAdherenceExceptionInfo>',
    
    :'day_metrics' => :'Array<HistoricalAdherenceDayMetrics>',
    
    :'actuals' => :'Array<HistoricalAdherenceActuals>'
    
  }
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/historical_adherence_query_result.rb, line 309
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      adherence_percentage == o.adherence_percentage &&
      conformance_percentage == o.conformance_percentage &&
      impact == o.impact &&
      exception_info == o.exception_info &&
      day_metrics == o.day_metrics &&
      actuals == o.actuals
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb, line 355
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/historical_adherence_query_result.rb, line 415
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/historical_adherence_query_result.rb, line 336
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/historical_adherence_query_result.rb, line 325
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/historical_adherence_query_result.rb, line 331
def hash
  [user_id, start_date, end_date, adherence_percentage, conformance_percentage, impact, exception_info, day_metrics, actuals].hash
end
impact=(impact) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] impact Object to be assigned

# File lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb, line 281
def impact=(impact)
  allowed_values = ["Positive", "Negative", "Neutral", "Unknown"]
  if impact && !allowed_values.include?(impact)
    fail ArgumentError, "invalid value for 'impact', must be one of #{allowed_values}."
  end
  @impact = impact
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/historical_adherence_query_result.rb, line 198
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/historical_adherence_query_result.rb, line 398
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb, line 403
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/historical_adherence_query_result.rb, line 393
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/historical_adherence_query_result.rb, line 207
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Positive", "Negative", "Neutral", "Unknown"]
  if @impact && !allowed_values.include?(@impact)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end