class PureCloud::CreateEmailRequest

Attributes

attributes[RW]

The list of attributes to associate with the customer participant.

direction[RW]

Specify INBOUND to create an inbound email conversation to route to a queue, or OUTBOUND to send an email on behalf of a queue.

from_address[RW]

The email address of the sender of the email.

from_name[RW]

The name of the sender of the email.

language_id[RW]

The ID of the langauge to use for routing.

priority[RW]

The priority to assign to the conversation for routing.

provider[RW]

The name of the provider that is sourcing the web chat.

queue_id[RW]

The ID of the queue to use for routing the chat conversation.

skill_ids[RW]

The list of skill ID's to use for routing.

subject[RW]

The subject of the email

to_address[RW]

The email address of the recipient of the email.

to_name[RW]

The name of the recipient of the email.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/create_email_request.rb, line 58
def self.attribute_map
  {
    
    :'queue_id' => :'queueId',
    
    :'provider' => :'provider',
    
    :'skill_ids' => :'skillIds',
    
    :'language_id' => :'languageId',
    
    :'priority' => :'priority',
    
    :'attributes' => :'attributes',
    
    :'to_address' => :'toAddress',
    
    :'to_name' => :'toName',
    
    :'from_address' => :'fromAddress',
    
    :'from_name' => :'fromName',
    
    :'subject' => :'subject',
    
    :'direction' => :'direction'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/create_email_request.rb, line 107
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'queueId']
    self.queue_id = attributes[:'queueId']
  end
  
  if attributes[:'provider']
    self.provider = attributes[:'provider']
  end
  
  if attributes[:'skillIds']
    if (value = attributes[:'skillIds']).is_a?(Array)
      self.skill_ids = value
    end
  end
  
  if attributes[:'languageId']
    self.language_id = attributes[:'languageId']
  end
  
  if attributes[:'priority']
    self.priority = attributes[:'priority']
  end
  
  if attributes[:'attributes']
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
  end
  
  if attributes[:'toAddress']
    self.to_address = attributes[:'toAddress']
  end
  
  if attributes[:'toName']
    self.to_name = attributes[:'toName']
  end
  
  if attributes[:'fromAddress']
    self.from_address = attributes[:'fromAddress']
  end
  
  if attributes[:'fromName']
    self.from_name = attributes[:'fromName']
  end
  
  if attributes[:'subject']
    self.subject = attributes[:'subject']
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/create_email_request.rb, line 89
def self.swagger_types
  {
    :'queue_id' => :'String',
    :'provider' => :'String',
    :'skill_ids' => :'Array<String>',
    :'language_id' => :'String',
    :'priority' => :'Integer',
    :'attributes' => :'Hash<String, String>',
    :'to_address' => :'String',
    :'to_name' => :'String',
    :'from_address' => :'String',
    :'from_name' => :'String',
    :'subject' => :'String',
    :'direction' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/create_email_request.rb, line 178
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      queue_id == o.queue_id &&
      provider == o.provider &&
      skill_ids == o.skill_ids &&
      language_id == o.language_id &&
      priority == o.priority &&
      attributes == o.attributes &&
      to_address == o.to_address &&
      to_name == o.to_name &&
      from_address == o.from_address &&
      from_name == o.from_name &&
      subject == o.subject &&
      direction == o.direction
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/create_email_request.rb, line 225
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/purecloud/models/create_email_request.rb, line 285
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/purecloud/models/create_email_request.rb, line 206
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).

# File lib/purecloud/models/create_email_request.rb, line 169
def direction=(direction)
  allowed_values = ["OUTBOUND", "INBOUND"]
  if direction && !allowed_values.include?(direction)
    fail "invalid value for 'direction', must be one of #{allowed_values}"
  end
  @direction = direction
end
eql?(o) click to toggle source

@see the `==` method

# File lib/purecloud/models/create_email_request.rb, line 196
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/create_email_request.rb, line 201
def hash
  [queue_id, provider, skill_ids, language_id, priority, attributes, to_address, to_name, from_address, from_name, subject, direction].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/create_email_request.rb, line 268
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/create_email_request.rb, line 273
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/purecloud/models/create_email_request.rb, line 263
def to_s
  to_hash.to_s
end