class ElasticEmail::EmailStatus

Status information of the specified email

Attributes

date[RW]

Date the email was submitted.

date_clicked[RW]

Date when the email changed the status to 'clicked'

date_opened[RW]

Date when the email changed the status to 'opened'

date_sent[RW]

Date when the email was sent

envelope_from[RW]

Envelope from address

error_message[RW]

Detailed error or bounced message.

from[RW]

Email address this email was sent from.

status[RW]

Value of email's status

status_change_date[RW]

Date of last status change.

status_name[RW]

Name of email's status

to[RW]

Email address this email was sent to.

transaction_id[RW]

ID number of transaction

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/ElasticEmail/models/email_status.rb, line 74
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/ElasticEmail/models/email_status.rb, line 56
def self.attribute_map
  {
    :'from' => :'From',
    :'to' => :'To',
    :'date' => :'Date',
    :'status' => :'Status',
    :'status_name' => :'StatusName',
    :'status_change_date' => :'StatusChangeDate',
    :'date_sent' => :'DateSent',
    :'date_opened' => :'DateOpened',
    :'date_clicked' => :'DateClicked',
    :'error_message' => :'ErrorMessage',
    :'transaction_id' => :'TransactionID',
    :'envelope_from' => :'EnvelopeFrom'
  }
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/ElasticEmail/models/email_status.rb, line 215
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/ElasticEmail/models/email_status.rb, line 106
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ElasticEmail::EmailStatus` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::EmailStatus`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

  if attributes.key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'status_name')
    self.status_name = attributes[:'status_name']
  end

  if attributes.key?(:'status_change_date')
    self.status_change_date = attributes[:'status_change_date']
  end

  if attributes.key?(:'date_sent')
    self.date_sent = attributes[:'date_sent']
  end

  if attributes.key?(:'date_opened')
    self.date_opened = attributes[:'date_opened']
  end

  if attributes.key?(:'date_clicked')
    self.date_clicked = attributes[:'date_clicked']
  end

  if attributes.key?(:'error_message')
    self.error_message = attributes[:'error_message']
  end

  if attributes.key?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  end

  if attributes.key?(:'envelope_from')
    self.envelope_from = attributes[:'envelope_from']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/ElasticEmail/models/email_status.rb, line 97
def self.openapi_nullable
  Set.new([
    :'date_opened',
    :'date_clicked',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/ElasticEmail/models/email_status.rb, line 79
def self.openapi_types
  {
    :'from' => :'String',
    :'to' => :'String',
    :'date' => :'Time',
    :'status' => :'LogJobStatus',
    :'status_name' => :'String',
    :'status_change_date' => :'Time',
    :'date_sent' => :'Time',
    :'date_opened' => :'Time',
    :'date_clicked' => :'Time',
    :'error_message' => :'String',
    :'transaction_id' => :'String',
    :'envelope_from' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ElasticEmail/models/email_status.rb, line 183
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from == o.from &&
      to == o.to &&
      date == o.date &&
      status == o.status &&
      status_name == o.status_name &&
      status_change_date == o.status_change_date &&
      date_sent == o.date_sent &&
      date_opened == o.date_opened &&
      date_clicked == o.date_clicked &&
      error_message == o.error_message &&
      transaction_id == o.transaction_id &&
      envelope_from == o.envelope_from
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/ElasticEmail/models/email_status.rb, line 245
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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 =~ /\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
    # models (e.g. Pet) or oneOf
    klass = ElasticEmail.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/ElasticEmail/models/email_status.rb, line 316
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/ElasticEmail/models/email_status.rb, line 222
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end
eql?(o) click to toggle source

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

# File lib/ElasticEmail/models/email_status.rb, line 202
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ElasticEmail/models/email_status.rb, line 208
def hash
  [from, to, date, status, status_name, status_change_date, date_sent, date_opened, date_clicked, error_message, transaction_id, envelope_from].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/ElasticEmail/models/email_status.rb, line 170
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/ElasticEmail/models/email_status.rb, line 292
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/ElasticEmail/models/email_status.rb, line 298
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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/ElasticEmail/models/email_status.rb, line 286
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/ElasticEmail/models/email_status.rb, line 177
def valid?
  true
end