class MailchimpTransactional::InlineResponse20029

the information for the message

Attributes

_id[RW]

the message's unique id

clicks[RW]

how many times has a link been clicked in this message

clicks_detail[RW]

list of individual clicks for the message

email[RW]

the recipient email address

metadata[RW]

any custom metadata provided when the message was sent

opens[RW]

how many times has this message been opened

opens_detail[RW]

list of individual opens for the message

sender[RW]

the email address of the sender

smtp_events[RW]

a log of up to 3 smtp events for the message

state[RW]

sending status of this message

subject[RW]

the message's subject line

tags[RW]

list of tags on this message

template[RW]

the unique name of the template used, if any

ts[RW]

the Unix timestamp from when this message was sent

Public Class Methods

attribute_map() click to toggle source

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

# File lib/mailchimp_transactional/models/inline_response_200_29.rb, line 83
def self.attribute_map
  {
    :'ts' => :'ts',
    :'_id' => :'_id',
    :'sender' => :'sender',
    :'template' => :'template',
    :'subject' => :'subject',
    :'email' => :'email',
    :'tags' => :'tags',
    :'opens' => :'opens',
    :'opens_detail' => :'opens_detail',
    :'clicks' => :'clicks',
    :'clicks_detail' => :'clicks_detail',
    :'state' => :'state',
    :'metadata' => :'metadata',
    :'smtp_events' => :'smtp_events'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/mailchimp_transactional/models/inline_response_200_29.rb, line 124
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?(:'ts')
    self.ts = attributes[:'ts']
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'smtp_events')
    if (value = attributes[:'smtp_events']).is_a?(Array)
      self.smtp_events = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/mailchimp_transactional/models/inline_response_200_29.rb, line 103
def self.swagger_types
  {
    :'ts' => :'Integer',
    :'_id' => :'String',
    :'sender' => :'String',
    :'template' => :'String',
    :'subject' => :'String',
    :'email' => :'String',
    :'tags' => :'Array<String>',
    :'opens' => :'Integer',
    :'opens_detail' => :'Array<MessagessearchOpensDetail>',
    :'clicks' => :'Integer',
    :'clicks_detail' => :'Array<MessagessearchClicksDetail>',
    :'state' => :'String',
    :'metadata' => :'Object',
    :'smtp_events' => :'Array<InlineResponse20029SmtpEvents>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/mailchimp_transactional/models/inline_response_200_29.rb, line 222
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ts == o.ts &&
      _id == o._id &&
      sender == o.sender &&
      template == o.template &&
      subject == o.subject &&
      email == o.email &&
      tags == o.tags &&
      opens == o.opens &&
      opens_detail == o.opens_detail &&
      clicks == o.clicks &&
      clicks_detail == o.clicks_detail &&
      state == o.state &&
      metadata == o.metadata &&
      smtp_events == o.smtp_events
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/mailchimp_transactional/models/inline_response_200_29.rb, line 277
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 =~ /\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 = MailchimpTransactional.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/mailchimp_transactional/models/inline_response_200_29.rb, line 343
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/mailchimp_transactional/models/inline_response_200_29.rb, line 256
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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/mailchimp_transactional/models/inline_response_200_29.rb, line 243
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/mailchimp_transactional/models/inline_response_200_29.rb, line 249
def hash
  [ts, _id, sender, template, subject, email, tags, opens, opens_detail, clicks, clicks_detail, state, metadata, smtp_events].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/mailchimp_transactional/models/inline_response_200_29.rb, line 197
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/mailchimp_transactional/models/inline_response_200_29.rb, line 212
def state=(state)
  validator = EnumAttributeValidator.new('String', ['sent', 'bounced', 'rejected'])
  unless validator.valid?(state)
    fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
  end
  @state = state
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/mailchimp_transactional/models/inline_response_200_29.rb, line 323
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/mailchimp_transactional/models/inline_response_200_29.rb, line 329
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

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

# File lib/mailchimp_transactional/models/inline_response_200_29.rb, line 317
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/mailchimp_transactional/models/inline_response_200_29.rb, line 204
def valid?
  state_validator = EnumAttributeValidator.new('String', ['sent', 'bounced', 'rejected'])
  return false unless state_validator.valid?(@state)
  true
end