Class: MailSlurpClient::WebhookNewContactPayload

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

Overview

NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains a recipient that has not been saved as a contact.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookNewContactPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 141

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#company ⇒ Object

Contact company name



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

def company
  @company
end

#contact_id ⇒ Object

Contact ID



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

def contact_id
  @contact_id
end

#created_at ⇒ Object

Date time of event creation



60
61
62
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 60

def created_at
  @created_at
end

#email_addresses ⇒ Object

Email addresses for contact



49
50
51
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 49

def email_addresses
  @email_addresses
end

#event_name ⇒ Object

Name of the event type webhook is being triggered for.



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

def event_name
  @event_name
end

#first_name ⇒ Object

Contact first name



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

def first_name
  @first_name
end

#group_id ⇒ Object

Contact group ID



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

def group_id
  @group_id
end

#last_name ⇒ Object

Contact last name



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

def last_name
  @last_name
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_new_contact_payload.rb', line 19

def message_id
  @message_id
end

#meta_data ⇒ Object

Returns the value of attribute meta_data.



54
55
56
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 54

def meta_data
  @meta_data
end

#opt_out ⇒ Object

Has contact opted out of emails



57
58
59
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 57

def opt_out
  @opt_out
end

#primary_email_address ⇒ Object

Primary email address for contact



46
47
48
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 46

def primary_email_address
  @primary_email_address
end

#tags ⇒ Object

Tags for contact



52
53
54
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 52

def tags
  @tags
end

#webhook_id ⇒ Object

ID of webhook entity being triggered



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

def webhook_id
  @webhook_id
end

#webhook_name ⇒ Object

Name of the webhook being triggered



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

def webhook_name
  @webhook_name
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 85

def self.attribute_map
  {
    :'message_id' => :'messageId',
    :'webhook_id' => :'webhookId',
    :'webhook_name' => :'webhookName',
    :'event_name' => :'eventName',
    :'contact_id' => :'contactId',
    :'group_id' => :'groupId',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'company' => :'company',
    :'primary_email_address' => :'primaryEmailAddress',
    :'email_addresses' => :'emailAddresses',
    :'tags' => :'tags',
    :'meta_data' => :'metaData',
    :'opt_out' => :'optOut',
    :'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



321
322
323
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 321

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 127

def self.openapi_nullable
  Set.new([
    :'webhook_name',
    :'group_id',
    :'first_name',
    :'last_name',
    :'company',
    :'primary_email_address',
    :'meta_data',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 106

def self.openapi_types
  {
    :'message_id' => :'String',
    :'webhook_id' => :'String',
    :'webhook_name' => :'String',
    :'event_name' => :'String',
    :'contact_id' => :'String',
    :'group_id' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'company' => :'String',
    :'primary_email_address' => :'String',
    :'email_addresses' => :'Array<String>',
    :'tags' => :'Array<String>',
    :'meta_data' => :'Object',
    :'opt_out' => :'Boolean',
    :'created_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message_id == o.message_id &&
      webhook_id == o.webhook_id &&
      webhook_name == o.webhook_name &&
      event_name == o.event_name &&
      contact_id == o.contact_id &&
      group_id == o.group_id &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      company == o.company &&
      primary_email_address == o.primary_email_address &&
      email_addresses == o.email_addresses &&
      tags == o.tags &&
      meta_data == o.meta_data &&
      opt_out == o.opt_out &&
      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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 349

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 418

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



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

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


308
309
310
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



314
315
316
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 314

def hash
  [message_id, webhook_id, webhook_name, event_name, contact_id, group_id, first_name, last_name, company, primary_email_address, email_addresses, tags, meta_data, opt_out, 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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 221

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 @contact_id.nil?
    invalid_properties.push('invalid value for "contact_id", contact_id cannot be nil.')
  end

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

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

  if @opt_out.nil?
    invalid_properties.push('invalid value for "opt_out", opt_out 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



394
395
396
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 394

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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 400

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



388
389
390
 
# File 'lib/mailslurp_client/models/webhook_new_contact_payload.rb', line 388

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



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

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 @contact_id.nil?
  return false if @email_addresses.nil?
  return false if @tags.nil?
  return false if @opt_out.nil?
  return false if @created_at.nil?
  true
end