Class: MailSlurpClient::WebhookDto

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

Overview

Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See ruby.api.mailslurp.com/schemas/webhook-payload for the payload schema.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 158

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ai_transform_id ⇒ Object

ID of AI transformer for payload



59
60
61
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 59

def ai_transform_id
  @ai_transform_id
end

#basic_auth ⇒ Object

Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself.



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

def basic_auth
  @basic_auth
end

#created_at ⇒ Object

When the webhook was created



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

def created_at
  @created_at
end

#event_name ⇒ Object

Webhook trigger event name



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

def event_name
  @event_name
end

#health_status ⇒ Object

Webhook health



68
69
70
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 68

def health_status
  @health_status
end

#id ⇒ Object

ID of the Webhook



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

def id
  @id
end

#ignore_insecure_ssl_certificates ⇒ Object

Should notifier ignore insecure SSL certificates



62
63
64
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 62

def ignore_insecure_ssl_certificates
  @ignore_insecure_ssl_certificates
end

#inbox_id ⇒ Object

The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set



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

def inbox_id
  @inbox_id
end

#method ⇒ Object

HTTP method that your server endpoint must listen for



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

def method
  @method
end

#name ⇒ Object

Name of the webhook



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

def name
  @name
end

#payload_json_schema ⇒ Object

Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method



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

def payload_json_schema
  @payload_json_schema
end

#phone_id ⇒ Object

The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set



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

def phone_id
  @phone_id
end

#request_body_template ⇒ Object

Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload.



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

def request_body_template
  @request_body_template
end

#request_headers ⇒ Object

Returns the value of attribute request_headers.



56
57
58
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 56

def request_headers
  @request_headers
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



51
52
53
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 51

def updated_at
  @updated_at
end

#url ⇒ Object

URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.



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

def url
  @url
end

#use_static_ip_range ⇒ Object

Should notifier use static IP range when sending webhook payload



65
66
67
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 65

def use_static_ip_range
  @use_static_ip_range
end

#user_id ⇒ Object

User ID of the Webhook



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 93

def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'userId',
    :'basic_auth' => :'basicAuth',
    :'name' => :'name',
    :'phone_id' => :'phoneId',
    :'inbox_id' => :'inboxId',
    :'request_body_template' => :'requestBodyTemplate',
    :'url' => :'url',
    :'method' => :'method',
    :'payload_json_schema' => :'payloadJsonSchema',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'event_name' => :'eventName',
    :'request_headers' => :'requestHeaders',
    :'ai_transform_id' => :'aiTransformId',
    :'ignore_insecure_ssl_certificates' => :'ignoreInsecureSslCertificates',
    :'use_static_ip_range' => :'useStaticIpRange',
    :'health_status' => :'healthStatus'
  }
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



368
369
370
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 368

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 141

def self.openapi_nullable
  Set.new([
    :'name',
    :'phone_id',
    :'inbox_id',
    :'request_body_template',
    :'created_at',
    :'event_name',
    :'ai_transform_id',
    :'ignore_insecure_ssl_certificates',
    :'use_static_ip_range',
    :'health_status'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 117

def self.openapi_types
  {
    :'id' => :'String',
    :'user_id' => :'String',
    :'basic_auth' => :'Boolean',
    :'name' => :'String',
    :'phone_id' => :'String',
    :'inbox_id' => :'String',
    :'request_body_template' => :'String',
    :'url' => :'String',
    :'method' => :'String',
    :'payload_json_schema' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'event_name' => :'String',
    :'request_headers' => :'WebhookHeaders',
    :'ai_transform_id' => :'String',
    :'ignore_insecure_ssl_certificates' => :'Boolean',
    :'use_static_ip_range' => :'Boolean',
    :'health_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 330

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      basic_auth == o.basic_auth &&
      name == o.name &&
      phone_id == o.phone_id &&
      inbox_id == o.inbox_id &&
      request_body_template == o.request_body_template &&
      url == o.url &&
      method == o.method &&
      payload_json_schema == o.payload_json_schema &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      event_name == o.event_name &&
      request_headers == o.request_headers &&
      ai_transform_id == o.ai_transform_id &&
      ignore_insecure_ssl_certificates == o.ignore_insecure_ssl_certificates &&
      use_static_ip_range == o.use_static_ip_range &&
      health_status == o.health_status
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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 396

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



465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 465

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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 375

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


355
356
357
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 355

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



361
362
363
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 361

def hash
  [id, user_id, basic_auth, name, phone_id, inbox_id, request_body_template, url, method, payload_json_schema, created_at, updated_at, event_name, request_headers, ai_transform_id, ignore_insecure_ssl_certificates, use_static_ip_range, health_status].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



246
247
248
249
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
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 246

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

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

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

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

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

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

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



441
442
443
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 441

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



447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 447

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



435
436
437
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 435

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/mailslurp_client/models/webhook_dto.rb', line 281

def valid?
  return false if @id.nil?
  return false if @user_id.nil?
  return false if @basic_auth.nil?
  return false if @url.nil?
  return false if @method.nil?
  method_validator = EnumAttributeValidator.new('String', ["POST", "DELETE", "GET", "PUT", "PATCH", "HEAD", "OPTIONS", "TRACE"])
  return false unless method_validator.valid?(@method)
  return false if @payload_json_schema.nil?
  return false if @updated_at.nil?
  event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_AI_TRANSFORM_RESULT", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS", "NEW_GUEST_USER"])
  return false unless event_name_validator.valid?(@event_name)
  health_status_validator = EnumAttributeValidator.new('String', ["HEALTHY", "UNHEALTHY"])
  return false unless health_status_validator.valid?(@health_status)
  true
end