class IntegrationApi::Email

Email Object

Attributes

click[RW]
create_date[RW]
delivery_status[RW]

deliveryStatus

delivery_status_timestamp[RW]

deliveryStatusTimestamp

email_id[RW]
from[RW]

from

id[RW]
nucleus_business_id[RW]

nucleusBusinessId

nucleus_client_id[RW]

nucleusClientId

open[RW]
reason[RW]

reason

secondary_id[RW]
spam[RW]

spam

subject[RW]

subject

to[RW]

to

unsubscribe[RW]

unsubscribe

update_date[RW]
vendor_id[RW]

vendorId

vendor_name[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/integration_api/models/email.rb, line 68
def self.attribute_map
  {
    :'click' => :'click',
    :'create_date' => :'create_date',
    :'delivery_status' => :'delivery_status',
    :'delivery_status_timestamp' => :'delivery_status_timestamp',
    :'email_id' => :'email_id',
    :'from' => :'from',
    :'id' => :'id',
    :'nucleus_business_id' => :'nucleus_business_id',
    :'nucleus_client_id' => :'nucleus_client_id',
    :'open' => :'open',
    :'reason' => :'reason',
    :'secondary_id' => :'secondary_id',
    :'spam' => :'spam',
    :'subject' => :'subject',
    :'to' => :'to',
    :'unsubscribe' => :'unsubscribe',
    :'update_date' => :'update_date',
    :'vendor_id' => :'vendor_id',
    :'vendor_name' => :'vendor_name'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/integration_api/models/email.rb, line 119
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?(:'click')
    if (value = attributes[:'click']).is_a?(Array)
      self.click = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'vendor_name')
    self.vendor_name = attributes[:'vendor_name']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/integration_api/models/email.rb, line 93
def self.swagger_types
  {
    :'click' => :'Array<EmailClick>',
    :'create_date' => :'DateTime',
    :'delivery_status' => :'String',
    :'delivery_status_timestamp' => :'DateTime',
    :'email_id' => :'String',
    :'from' => :'String',
    :'id' => :'String',
    :'nucleus_business_id' => :'String',
    :'nucleus_client_id' => :'String',
    :'open' => :'Array<EmailOpen>',
    :'reason' => :'String',
    :'secondary_id' => :'String',
    :'spam' => :'BOOLEAN',
    :'subject' => :'String',
    :'to' => :'String',
    :'unsubscribe' => :'BOOLEAN',
    :'update_date' => :'DateTime',
    :'vendor_id' => :'String',
    :'vendor_name' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/integration_api/models/email.rb, line 221
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      click == o.click &&
      create_date == o.create_date &&
      delivery_status == o.delivery_status &&
      delivery_status_timestamp == o.delivery_status_timestamp &&
      email_id == o.email_id &&
      from == o.from &&
      id == o.id &&
      nucleus_business_id == o.nucleus_business_id &&
      nucleus_client_id == o.nucleus_client_id &&
      open == o.open &&
      reason == o.reason &&
      secondary_id == o.secondary_id &&
      spam == o.spam &&
      subject == o.subject &&
      to == o.to &&
      unsubscribe == o.unsubscribe &&
      update_date == o.update_date &&
      vendor_id == o.vendor_id &&
      vendor_name == o.vendor_name
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/integration_api/models/email.rb, line 280
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/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
    temp_model = IntegrationApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/integration_api/models/email.rb, line 345
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

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/integration_api/models/email.rb, line 260
def build_from_hash(attributes)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/integration_api/models/email.rb, line 247
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/integration_api/models/email.rb, line 253
def hash
  [click, create_date, delivery_status, delivery_status_timestamp, email_id, from, id, nucleus_business_id, nucleus_client_id, open, reason, secondary_id, spam, subject, to, unsubscribe, update_date, vendor_id, vendor_name].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/integration_api/models/email.rb, line 208
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/integration_api/models/email.rb, line 326
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/integration_api/models/email.rb, line 332
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/integration_api/models/email.rb, line 320
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/integration_api/models/email.rb, line 215
def valid?
  true
end