class PureCloud::ObservationValue

Attributes

address_from[RW]

The address that initiated an action

address_to[RW]

The address receiving an action

ani[RW]

Automatic Number Identification (caller's number)

conversation_id[RW]

Unique identifier for the conversation

converted_from[RW]

Session media type that was converted from in case of a media type conversion

converted_to[RW]

Session media type that was converted to in case of a media type conversion

direction[RW]

The direction of the communication

dnis[RW]

Dialed number identification service (number dialed by the calling party)

observation_date[RW]

The time at which the observation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

participant_name[RW]

A human readable name identifying the participant

requested_language_id[RW]

Unique identifier for the language requested for an interaction

requested_routing_skill_ids[RW]

Unique identifier for a skill requested for an interaction

requested_routings[RW]

All routing types for requested/attempted routing methods

routing_priority[RW]

Routing priority for the current interaction

scored_agents[RW]
session_id[RW]

The unique identifier of this session

team_id[RW]

The team id the user is a member of

used_routing[RW]

Complete routing method

user_id[RW]

Unique identifier for the user

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/observation_value.rb, line 78
def self.attribute_map
  {
    
    :'observation_date' => :'observationDate',
    
    :'conversation_id' => :'conversationId',
    
    :'session_id' => :'sessionId',
    
    :'requested_routing_skill_ids' => :'requestedRoutingSkillIds',
    
    :'requested_language_id' => :'requestedLanguageId',
    
    :'routing_priority' => :'routingPriority',
    
    :'participant_name' => :'participantName',
    
    :'user_id' => :'userId',
    
    :'direction' => :'direction',
    
    :'converted_from' => :'convertedFrom',
    
    :'converted_to' => :'convertedTo',
    
    :'address_from' => :'addressFrom',
    
    :'address_to' => :'addressTo',
    
    :'ani' => :'ani',
    
    :'dnis' => :'dnis',
    
    :'team_id' => :'teamId',
    
    :'requested_routings' => :'requestedRoutings',
    
    :'used_routing' => :'usedRouting',
    
    :'scored_agents' => :'scoredAgents'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/observation_value.rb, line 169
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?(:'observationDate')
    
    
    self.observation_date = attributes[:'observationDate']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/observation_value.rb, line 123
def self.swagger_types
  {
    
    :'observation_date' => :'DateTime',
    
    :'conversation_id' => :'String',
    
    :'session_id' => :'String',
    
    :'requested_routing_skill_ids' => :'Array<String>',
    
    :'requested_language_id' => :'String',
    
    :'routing_priority' => :'Integer',
    
    :'participant_name' => :'String',
    
    :'user_id' => :'String',
    
    :'direction' => :'String',
    
    :'converted_from' => :'String',
    
    :'converted_to' => :'String',
    
    :'address_from' => :'String',
    
    :'address_to' => :'String',
    
    :'ani' => :'String',
    
    :'dnis' => :'String',
    
    :'team_id' => :'String',
    
    :'requested_routings' => :'Array<String>',
    
    :'used_routing' => :'String',
    
    :'scored_agents' => :'Array<AnalyticsScoredAgent>'
    
  }
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/observation_value.rb, line 577
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      observation_date == o.observation_date &&
      conversation_id == o.conversation_id &&
      session_id == o.session_id &&
      requested_routing_skill_ids == o.requested_routing_skill_ids &&
      requested_language_id == o.requested_language_id &&
      routing_priority == o.routing_priority &&
      participant_name == o.participant_name &&
      user_id == o.user_id &&
      direction == o.direction &&
      converted_from == o.converted_from &&
      converted_to == o.converted_to &&
      address_from == o.address_from &&
      address_to == o.address_to &&
      ani == o.ani &&
      dnis == o.dnis &&
      team_id == o.team_id &&
      requested_routings == o.requested_routings &&
      used_routing == o.used_routing &&
      scored_agents == o.scored_agents
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/observation_value.rb, line 633
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/observation_value.rb, line 693
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/observation_value.rb, line 614
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
direction=(direction) click to toggle source

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

# File lib/purecloudplatformclientv2/models/observation_value.rb, line 505
def direction=(direction)
  allowed_values = ["inbound", "outbound"]
  if direction && !allowed_values.include?(direction)
    fail ArgumentError, "invalid value for 'direction', must be one of #{allowed_values}."
  end
  @direction = direction
end
eql?(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/observation_value.rb, line 603
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/observation_value.rb, line 609
def hash
  [observation_date, conversation_id, session_id, requested_routing_skill_ids, requested_language_id, routing_priority, participant_name, user_id, direction, converted_from, converted_to, address_from, address_to, ani, dnis, team_id, requested_routings, used_routing, scored_agents].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/observation_value.rb, line 357
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/observation_value.rb, line 676
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/observation_value.rb, line 681
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/observation_value.rb, line 671
def to_s
  to_hash.to_s
end
used_routing=(used_routing) click to toggle source

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

# File lib/purecloudplatformclientv2/models/observation_value.rb, line 559
def used_routing=(used_routing)
  allowed_values = ["Predictive", "Preferred", "Manual", "Last", "Bullseye", "Standard"]
  if used_routing && !allowed_values.include?(used_routing)
    fail ArgumentError, "invalid value for 'used_routing', must be one of #{allowed_values}."
  end
  @used_routing = used_routing
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/observation_value.rb, line 366
def valid?
  
  
  if @observation_date.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["inbound", "outbound"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Predictive", "Preferred", "Manual", "Last", "Bullseye", "Standard"]
  if @used_routing && !allowed_values.include?(@used_routing)
    return false
  end
  
  
  
  
  
  
  
end