class SibApiV3Sdk::GetEmailEventReportEvents

Attributes

date[RW]

UTC date-time on which the event has been generated

email[RW]

Email address which generates the event

event[RW]

Event which occurred

from[RW]

Sender email from which the emails are sent

ip[RW]

IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks)

message_id[RW]

Message ID which generated the event

reason[RW]

Reason of bounce (only available if the event is hardbounce or softbounce)

subject[RW]

Subject of the event

tag[RW]

Tag of the email which generated the event

template_id[RW]

ID of the template (only available if the email is template based)

Public Class Methods

attribute_map() click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 73
def self.attribute_map
  {
    :'email' => :'email',
    :'date' => :'date',
    :'subject' => :'subject',
    :'message_id' => :'messageId',
    :'event' => :'event',
    :'reason' => :'reason',
    :'tag' => :'tag',
    :'ip' => :'ip',
    :'link' => :'link',
    :'from' => :'from',
    :'template_id' => :'templateId'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 108
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?(:'email')
    self.email = attributes[:'email']
  end

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 90
def self.swagger_types
  {
    :'email' => :'String',
    :'date' => :'String',
    :'subject' => :'String',
    :'message_id' => :'String',
    :'event' => :'String',
    :'reason' => :'String',
    :'tag' => :'String',
    :'ip' => :'String',
    :'link' => :'String',
    :'from' => :'String',
    :'template_id' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 206
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      date == o.date &&
      subject == o.subject &&
      message_id == o.message_id &&
      event == o.event &&
      reason == o.reason &&
      tag == o.tag &&
      ip == o.ip &&
      link == o.link &&
      from == o.from &&
      template_id == o.template_id
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/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 258
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 = SibApiV3Sdk.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/sib-api-v3-sdk/models/get_email_event_report_events.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/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 237
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/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 224
def eql?(o)
  self == o
end
event=(event) click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 196
def event=(event)
  validator = EnumAttributeValidator.new('String', ['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error'])
  unless validator.valid?(event)
    fail ArgumentError, 'invalid value for "event", must be one of #{validator.allowable_values}.'
  end
  @event = event
end
hash() click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 230
def hash
  [email, date, subject, message_id, event, reason, tag, ip, link, from, template_id].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/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 161
def list_invalid_properties
  invalid_properties = Array.new
  if @email.nil?
    invalid_properties.push('invalid value for "email", email cannot be nil.')
  end

  if @date.nil?
    invalid_properties.push('invalid value for "date", date cannot be nil.')
  end

  if @message_id.nil?
    invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
  end

  if @event.nil?
    invalid_properties.push('invalid value for "event", event cannot be nil.')
  end

  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/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 304
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/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 310
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/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 298
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/sib-api-v3-sdk/models/get_email_event_report_events.rb, line 184
def valid?
  return false if @email.nil?
  return false if @date.nil?
  return false if @message_id.nil?
  return false if @event.nil?
  event_validator = EnumAttributeValidator.new('String', ['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error'])
  return false unless event_validator.valid?(@event)
  true
end