class PureCloud::InboundRoute

Attributes

auto_bcc[RW]

The recipients that should be automatically blind copied on outbound emails associated with this InboundRoute.

flow[RW]

The flow to use for processing the email.

from_email[RW]

The sender email to use for outgoing replies.

from_name[RW]

The sender name to use for outgoing replies.

id[RW]

The globally unique identifier for the object.

language[RW]

The language to use for routing.

name[RW]
pattern[RW]

The search pattern that the mailbox name should match.

priority[RW]

The priority to use for routing.

queue[RW]

The queue to route the emails to.

reply_email_address[RW]

The route to use for email replies.

self_uri[RW]

The URI for this object

skills[RW]

The skills to use for routing.

spam_flow[RW]

The flow to use for processing inbound emails that have been marked as spam.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/inbound_route.rb, line 63
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'pattern' => :'pattern',
    
    :'queue' => :'queue',
    
    :'priority' => :'priority',
    
    :'skills' => :'skills',
    
    :'language' => :'language',
    
    :'from_name' => :'fromName',
    
    :'from_email' => :'fromEmail',
    
    :'flow' => :'flow',
    
    :'reply_email_address' => :'replyEmailAddress',
    
    :'auto_bcc' => :'autoBcc',
    
    :'spam_flow' => :'spamFlow',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

  
  if attributes.has_key?(:'priority')
    
    
    self.priority = attributes[:'priority']
    
  
  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?(:'fromName')
    
    
    self.from_name = attributes[:'fromName']
    
  
  end

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/inbound_route.rb, line 98
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'pattern' => :'String',
    
    :'queue' => :'DomainEntityRef',
    
    :'priority' => :'Integer',
    
    :'skills' => :'Array<DomainEntityRef>',
    
    :'language' => :'DomainEntityRef',
    
    :'from_name' => :'String',
    
    :'from_email' => :'String',
    
    :'flow' => :'DomainEntityRef',
    
    :'reply_email_address' => :'QueueEmailAddress',
    
    :'auto_bcc' => :'Array<EmailAddress>',
    
    :'spam_flow' => :'DomainEntityRef',
    
    :'self_uri' => :'String'
    
  }
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/inbound_route.rb, line 432
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      pattern == o.pattern &&
      queue == o.queue &&
      priority == o.priority &&
      skills == o.skills &&
      language == o.language &&
      from_name == o.from_name &&
      from_email == o.from_email &&
      flow == o.flow &&
      reply_email_address == o.reply_email_address &&
      auto_bcc == o.auto_bcc &&
      spam_flow == o.spam_flow &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/inbound_route.rb, line 483
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/inbound_route.rb, line 543
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/inbound_route.rb, line 464
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/inbound_route.rb, line 453
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/inbound_route.rb, line 459
def hash
  [id, name, pattern, queue, priority, skills, language, from_name, from_email, flow, reply_email_address, auto_bcc, spam_flow, self_uri].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/inbound_route.rb, line 275
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/inbound_route.rb, line 526
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/inbound_route.rb, line 531
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/inbound_route.rb, line 521
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/inbound_route.rb, line 284
def valid?
  
  
  
  
  
  
  
  
  
  
  if @pattern.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @from_name.nil?
    return false
  end

  
  
  
  
  
  if @from_email.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end