class PureCloud::WebChatRoutingTarget

Attributes

language[RW]

The language name to use for routing.

priority[RW]

The priority to assign to the conversation for routing.

skills[RW]

The list of skill names to use for routing.

target_address[RW]

The target of the route, in the format appropriate given the 'targetType'.

target_type[RW]

The target type of the routing target, such as 'QUEUE'.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/web_chat_routing_target.rb, line 37
def self.attribute_map
  {
    
    :'target_type' => :'targetType',
    
    :'target_address' => :'targetAddress',
    
    :'skills' => :'skills',
    
    :'language' => :'language',
    
    :'priority' => :'priority'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/web_chat_routing_target.rb, line 72
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?(:'targetType')
    
    
    self.target_type = attributes[:'targetType']
    
  
  end

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/web_chat_routing_target.rb, line 54
def self.swagger_types
  {
    
    :'target_type' => :'String',
    
    :'target_address' => :'String',
    
    :'skills' => :'Array<String>',
    
    :'language' => :'String',
    
    :'priority' => :'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/web_chat_routing_target.rb, line 215
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      target_type == o.target_type &&
      target_address == o.target_address &&
      skills == o.skills &&
      language == o.language &&
      priority == o.priority
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/web_chat_routing_target.rb, line 257
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/web_chat_routing_target.rb, line 317
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/web_chat_routing_target.rb, line 238
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/web_chat_routing_target.rb, line 227
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/web_chat_routing_target.rb, line 233
def hash
  [target_type, target_address, skills, language, priority].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/web_chat_routing_target.rb, line 130
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
target_type=(target_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/web_chat_routing_target.rb, line 182
def target_type=(target_type)
  allowed_values = ["QUEUE"]
  if target_type && !allowed_values.include?(target_type)
    fail ArgumentError, "invalid value for 'target_type', must be one of #{allowed_values}."
  end
  @target_type = target_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/web_chat_routing_target.rb, line 305
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/web_chat_routing_target.rb, line 295
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/web_chat_routing_target.rb, line 139
def valid?
  
  
  if @target_type.nil?
    return false
  end

  
  
  allowed_values = ["QUEUE"]
  if @target_type && !allowed_values.include?(@target_type)
    return false
  end
  
  
  
  
  if @target_address.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end