Class: MailSlurpClient::WebhookEmailOpenedPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/webhook_email_opened_payload.rb

Overview

EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when an email containing a tracking pixel is opened and the pixel image is loaded by a reader.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookEmailOpenedPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::WebhookEmailOpenedPayload` 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 `MailSlurpClient::WebhookEmailOpenedPayload`. 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?(:'message_id')
    self.message_id = attributes[:'message_id']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Date time of event creation



43
44
45
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 43

def created_at
  @created_at
end

#event_name ⇒ Object

Name of the event type webhook is being triggered for.



25
26
27
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 25

def event_name
  @event_name
end

#inbox_id ⇒ Object

Id of the inbox



31
32
33
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 31

def inbox_id
  @inbox_id
end

#message_id ⇒ Object

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.



19
20
21
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 19

def message_id
  @message_id
end

#pixel_id ⇒ Object

ID of the tracking pixel



34
35
36
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 34

def pixel_id
  @pixel_id
end

#recipient ⇒ Object

Email address for the recipient of the tracking pixel



40
41
42
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 40

def recipient
  @recipient
end

#sent_email_id ⇒ Object

ID of sent email



37
38
39
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 37

def sent_email_id
  @sent_email_id
end

#webhook_id ⇒ Object

ID of webhook entity being triggered



22
23
24
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 22

def webhook_id
  @webhook_id
end

#webhook_name ⇒ Object

Name of the webhook being triggered



28
29
30
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 28

def webhook_name
  @webhook_name
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 68

def self.attribute_map
  {
    :'message_id' => :'messageId',
    :'webhook_id' => :'webhookId',
    :'event_name' => :'eventName',
    :'webhook_name' => :'webhookName',
    :'inbox_id' => :'inboxId',
    :'pixel_id' => :'pixelId',
    :'sent_email_id' => :'sentEmailId',
    :'recipient' => :'recipient',
    :'created_at' => :'createdAt'
  }
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



252
253
254
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 252

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
102
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 98

def self.openapi_nullable
  Set.new([
    :'webhook_name',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 83

def self.openapi_types
  {
    :'message_id' => :'String',
    :'webhook_id' => :'String',
    :'event_name' => :'String',
    :'webhook_name' => :'String',
    :'inbox_id' => :'String',
    :'pixel_id' => :'String',
    :'sent_email_id' => :'String',
    :'recipient' => :'String',
    :'created_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message_id == o.message_id &&
      webhook_id == o.webhook_id &&
      event_name == o.event_name &&
      webhook_name == o.webhook_name &&
      inbox_id == o.inbox_id &&
      pixel_id == o.pixel_id &&
      sent_email_id == o.sent_email_id &&
      recipient == o.recipient &&
      created_at == o.created_at
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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 280

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
    MailSlurpClient.const_get(type).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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 349

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 259

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


239
240
241
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 245

def hash
  [message_id, webhook_id, event_name, webhook_name, inbox_id, pixel_id, sent_email_id, recipient, created_at].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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 158

def list_invalid_properties
  invalid_properties = Array.new
  if @message_id.nil?
    invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
  end

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

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

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

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

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

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

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

  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



325
326
327
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 325

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 331

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



319
320
321
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 319

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



197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/mailslurp_client/models/webhook_email_opened_payload.rb', line 197

def valid?
  return false if @message_id.nil?
  return false if @webhook_id.nil?
  return false if @event_name.nil?
  event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS"])
  return false unless event_name_validator.valid?(@event_name)
  return false if @inbox_id.nil?
  return false if @pixel_id.nil?
  return false if @sent_email_id.nil?
  return false if @recipient.nil?
  return false if @created_at.nil?
  true
end