Class: MailSlurpClient::WebhookNewAttachmentPayload

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

Overview

NEW_ATTACHMENT 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 an attachment. You can use the attachmentId to download the attachment.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookNewAttachmentPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
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
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 101

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

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

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

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

Instance Attribute Details

#attachment_id ⇒ Object

ID of attachment. Use the ‘AttachmentController` to



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

def attachment_id
  @attachment_id
end

#content_length ⇒ Object

Size of attachment in bytes



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

def content_length
  @content_length
end

#content_type ⇒ Object

Content type of attachment such as ‘image/png’ or ‘application/pdf



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

def content_type
  @content_type
end

#event_name ⇒ Object

Name of the event type webhook is being triggered for.



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

def event_name
  @event_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_attachment_payload.rb', line 19

def message_id
  @message_id
end

#name ⇒ Object

Filename of the attachment if present



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

def name
  @name
end

#webhook_id ⇒ Object

ID of webhook entity being triggered



22
23
24
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_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_attachment_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.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 65

def self.attribute_map
  {
    :'message_id' => :'messageId',
    :'webhook_id' => :'webhookId',
    :'webhook_name' => :'webhookName',
    :'event_name' => :'eventName',
    :'attachment_id' => :'attachmentId',
    :'name' => :'name',
    :'content_type' => :'contentType',
    :'content_length' => :'contentLength'
  }
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



237
238
239
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 237

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
97
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 79

def self.openapi_types
  {
    :'message_id' => :'String',
    :'webhook_id' => :'String',
    :'webhook_name' => :'String',
    :'event_name' => :'String',
    :'attachment_id' => :'String',
    :'name' => :'String',
    :'content_type' => :'String',
    :'content_length' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 209

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 &&
      attachment_id == o.attachment_id &&
      name == o.name &&
      content_type == o.content_type &&
      content_length == o.content_length
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 265

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 334

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 244

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


224
225
226
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



230
231
232
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 230

def hash
  [message_id, webhook_id, webhook_name, event_name, attachment_id, name, content_type, content_length].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



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
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 149

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

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

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

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



310
311
312
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 310

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 316

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



304
305
306
 
# File 'lib/mailslurp_client/models/webhook_new_attachment_payload.rb', line 304

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



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

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 @attachment_id.nil?
  return false if @name.nil?
  return false if @content_type.nil?
  return false if @content_length.nil?
  true
end