class ElasticEmail::LogStatusSummary

Summary of log status

Attributes

bounced[RW]

Number of bounced messages

clicked[RW]

Number of clicked messages

complaints[RW]

Number of complaint messages

delivered[RW]

Number of delivered messages

email_total[RW]

Number of emails

in_progress[RW]

Number of messages in progress

inbound[RW]

Number of inbound messages

manual_cancel[RW]

Number of manually cancelled messages

not_delivered[RW]

Number of messages flagged with 'Not Delivered'

opened[RW]

Number of opened messages

recipients[RW]

Number of recipients

sms_total[RW]

Number of SMS

unsubscribed[RW]

Number of unsubscribed messages

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/ElasticEmail/models/log_status_summary.rb, line 78
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/log_status_summary.rb, line 59
def self.attribute_map
  {
    :'recipients' => :'Recipients',
    :'email_total' => :'EmailTotal',
    :'sms_total' => :'SmsTotal',
    :'delivered' => :'Delivered',
    :'bounced' => :'Bounced',
    :'in_progress' => :'InProgress',
    :'opened' => :'Opened',
    :'clicked' => :'Clicked',
    :'unsubscribed' => :'Unsubscribed',
    :'complaints' => :'Complaints',
    :'inbound' => :'Inbound',
    :'manual_cancel' => :'ManualCancel',
    :'not_delivered' => :'NotDelivered'
  }
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/log_status_summary.rb, line 223
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/log_status_summary.rb, line 109
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ElasticEmail::LogStatusSummary` 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::LogStatusSummary`. 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?(:'recipients')
    self.recipients = attributes[:'recipients']
  end

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/ElasticEmail/models/log_status_summary.rb, line 102
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/ElasticEmail/models/log_status_summary.rb, line 83
def self.openapi_types
  {
    :'recipients' => :'Integer',
    :'email_total' => :'Integer',
    :'sms_total' => :'Integer',
    :'delivered' => :'Integer',
    :'bounced' => :'Integer',
    :'in_progress' => :'Integer',
    :'opened' => :'Integer',
    :'clicked' => :'Integer',
    :'unsubscribed' => :'Integer',
    :'complaints' => :'Integer',
    :'inbound' => :'Integer',
    :'manual_cancel' => :'Integer',
    :'not_delivered' => :'Integer'
  }
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/log_status_summary.rb, line 190
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      recipients == o.recipients &&
      email_total == o.email_total &&
      sms_total == o.sms_total &&
      delivered == o.delivered &&
      bounced == o.bounced &&
      in_progress == o.in_progress &&
      opened == o.opened &&
      clicked == o.clicked &&
      unsubscribed == o.unsubscribed &&
      complaints == o.complaints &&
      inbound == o.inbound &&
      manual_cancel == o.manual_cancel &&
      not_delivered == o.not_delivered
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/log_status_summary.rb, line 253
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/log_status_summary.rb, line 324
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/log_status_summary.rb, line 230
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/log_status_summary.rb, line 210
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/log_status_summary.rb, line 216
def hash
  [recipients, email_total, sms_total, delivered, bounced, in_progress, opened, clicked, unsubscribed, complaints, inbound, manual_cancel, not_delivered].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/log_status_summary.rb, line 177
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/log_status_summary.rb, line 300
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/log_status_summary.rb, line 306
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/log_status_summary.rb, line 294
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/log_status_summary.rb, line 184
def valid?
  true
end