Class: MailSlurpClient::CreateWebhookOptions

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

Overview

Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the webhook's event is triggered. Webhooks are great for processing many inbound emails and responding to other events at scale. Customize the payload sent to your endpoint by setting the `requestBodyTemplate` property to a string with moustache style variables. Property names from the standard payload model for the given event are available as variables.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWebhookOptions

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/mailslurp_client/models/create_webhook_options.rb', line 104

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

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

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

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

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

Instance Attribute Details

#basic_auth ⇒ Object

Returns the value of attribute basic_auth.



21
22
23
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 21

def basic_auth
  @basic_auth
end

#event_name ⇒ Object

Optional webhook event name. Default is `EMAIL_RECEIVED` and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name.



27
28
29
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 27

def event_name
  @event_name
end

#ignore_insecure_ssl_certificates ⇒ Object

Ignore insecure SSL certificates when sending request. Useful for self-signed certs.



38
39
40
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 38

def ignore_insecure_ssl_certificates
  @ignore_insecure_ssl_certificates
end

#include_headers ⇒ Object

Returns the value of attribute include_headers.



29
30
31
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 29

def include_headers
  @include_headers
end

#name ⇒ Object

Optional name for the webhook



24
25
26
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 24

def name
  @name
end

#request_body_template ⇒ Object

Template for the JSON body of the webhook request that will be sent to your server. Use Moustache style `{variableName}` templating to use parts of the standard webhook payload for the given event.



32
33
34
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 32

def request_body_template
  @request_body_template
end

#url ⇒ Object

Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. See docs.mailslurp.com/webhooks for event payload documentation.



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

def url
  @url
end

#use_static_ip_range ⇒ Object

Use static IP range when calling webhook endpoint



35
36
37
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 35

def use_static_ip_range
  @use_static_ip_range
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 63

def self.attribute_map
  {
    :'url' => :'url',
    :'basic_auth' => :'basicAuth',
    :'name' => :'name',
    :'event_name' => :'eventName',
    :'include_headers' => :'includeHeaders',
    :'request_body_template' => :'requestBodyTemplate',
    :'use_static_ip_range' => :'useStaticIpRange',
    :'ignore_insecure_ssl_certificates' => :'ignoreInsecureSslCertificates'
  }
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



212
213
214
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 212

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 91

def self.openapi_nullable
  Set.new([
    :'basic_auth',
    :'name',
    :'event_name',
    :'request_body_template',
    :'use_static_ip_range',
    :'ignore_insecure_ssl_certificates'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 77

def self.openapi_types
  {
    :'url' => :'String',
    :'basic_auth' => :'BasicAuthOptions',
    :'name' => :'String',
    :'event_name' => :'String',
    :'include_headers' => :'WebhookHeaders',
    :'request_body_template' => :'String',
    :'use_static_ip_range' => :'Boolean',
    :'ignore_insecure_ssl_certificates' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      basic_auth == o.basic_auth &&
      name == o.name &&
      event_name == o.event_name &&
      include_headers == o.include_headers &&
      request_body_template == o.request_body_template &&
      use_static_ip_range == o.use_static_ip_range &&
      ignore_insecure_ssl_certificates == o.ignore_insecure_ssl_certificates
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



240
241
242
243
244
245
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
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 240

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 309

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 219

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


199
200
201
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 205

def hash
  [url, basic_auth, name, event_name, include_headers, request_body_template, use_static_ip_range, ignore_insecure_ssl_certificates].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
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 154

def list_invalid_properties
  invalid_properties = Array.new
  if @url.nil?
    invalid_properties.push('invalid value for "url", url 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



285
286
287
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 285

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 291

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



279
280
281
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 279

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



165
166
167
168
169
170
 
# File 'lib/mailslurp_client/models/create_webhook_options.rb', line 165

def valid?
  return false if @url.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)
  true
end