Class: SibApiV3Sdk::GetEmailEventReportEvents

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/get_email_event_report_events.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetEmailEventReportEvents

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 104

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

end

Instance Attribute Details

#date ⇒ Object

UTC date-time on which the event has been generated



22
23
24
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 22

def date
  @date
end

#email ⇒ Object

Email address which generates the event



19
20
21
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 19

def email
  @email
end

#event ⇒ Object

Event which occurred



31
32
33
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 31

def event
  @event
end

#from ⇒ Object

Sender email from which the emails are sent



46
47
48
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 46

def from
  @from
end

#ip ⇒ Object

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



40
41
42
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 40

def ip
  @ip
end

#link ⇒ Object

The link which is sent to the user (only available if the event is requests or opened or clicks)



43
44
45
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 43

def link
  @link
end

#message_id ⇒ Object

Message ID which generated the event



28
29
30
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 28

def message_id
  @message_id
end

#reason ⇒ Object

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



34
35
36
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 34

def reason
  @reason
end

#subject ⇒ Object

Subject of the event



25
26
27
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 25

def subject
  @subject
end

#tag ⇒ Object

Tag of the email which generated the event



37
38
39
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 37

def tag
  @tag
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 71

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'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 87

def self.swagger_types
  {
    :'email' => :'String',
    :'date' => :'DateTime',
    :'subject' => :'String',
    :'message_id' => :'String',
    :'event' => :'String',
    :'reason' => :'String',
    :'tag' => :'String',
    :'ip' => :'String',
    :'link' => :'String',
    :'from' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 199

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
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 250

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 229

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 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


216
217
218
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 222

def hash
  [email, date, subject, message_id, event, reason, tag, ip, link, from].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 154

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

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



296
297
298
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 296

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



302
303
304
305
306
307
308
309
310
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 302

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



290
291
292
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 290

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



177
178
179
180
181
182
183
184
185
 
# File 'lib/sib-api-v3-sdk/models/get_email_event_report_events.rb', line 177

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"])
  return false unless event_validator.valid?(@event)
  return true
end