Class: MailSlurpClient::InboxReplierDto

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

Overview

Inbox replier. Will automatically reply to inbound emails that match given field for an inbox.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InboxReplierDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#charsetObject

Returns the value of attribute charset.



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

def charset
  @charset
end

#created_atObject

Returns the value of attribute created_at.



44
45
46
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 44

def created_at
  @created_at
end

#fieldObject

Returns the value of attribute field.



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

def field
  @field
end

#fromObject

Returns the value of attribute from.



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

def from
  @from
end

#idObject

Returns the value of attribute id.



18
19
20
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 18

def id
  @id
end

#ignore_reply_toObject

Returns the value of attribute ignore_reply_to.



42
43
44
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 42

def ignore_reply_to
  @ignore_reply_to
end

#inbox_idObject

Returns the value of attribute inbox_id.



20
21
22
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 20

def inbox_id
  @inbox_id
end

#is_htmlObject

Returns the value of attribute is_html.



36
37
38
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 36

def is_html
  @is_html
end

#matchObject

Returns the value of attribute match.



26
27
28
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 26

def match
  @match
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#reply_toObject

Returns the value of attribute reply_to.



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

def reply_to
  @reply_to
end

#subjectObject

Returns the value of attribute subject.



30
31
32
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 30

def subject
  @subject
end

#template_idObject

Returns the value of attribute template_id.



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

def template_id
  @template_id
end

#template_variablesObject

Returns the value of attribute template_variables.



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

def template_variables
  @template_variables
end

Class Method Details

.attribute_mapObject

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'inbox_id' => :'inboxId',
    :'name' => :'name',
    :'field' => :'field',
    :'match' => :'match',
    :'reply_to' => :'replyTo',
    :'subject' => :'subject',
    :'from' => :'from',
    :'charset' => :'charset',
    :'is_html' => :'isHTML',
    :'template_id' => :'templateId',
    :'template_variables' => :'templateVariables',
    :'ignore_reply_to' => :'ignoreReplyTo',
    :'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



287
288
289
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 287

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

.openapi_nullableObject

List of attributes with nullable: true



109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 109

def self.openapi_nullable
  Set.new([
    :'inbox_id',
    :'name',
    :'reply_to',
    :'subject',
    :'from',
    :'charset',
    :'template_id',
    :'template_variables',
  ])
end

.openapi_typesObject

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 89

def self.openapi_types
  {
    :'id' => :'String',
    :'inbox_id' => :'String',
    :'name' => :'String',
    :'field' => :'String',
    :'match' => :'String',
    :'reply_to' => :'String',
    :'subject' => :'String',
    :'from' => :'String',
    :'charset' => :'String',
    :'is_html' => :'Boolean',
    :'template_id' => :'String',
    :'template_variables' => :'Hash<String, Object>',
    :'ignore_reply_to' => :'Boolean',
    :'created_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      inbox_id == o.inbox_id &&
      name == o.name &&
      field == o.field &&
      match == o.match &&
      reply_to == o.reply_to &&
      subject == o.subject &&
      from == o.from &&
      charset == o.charset &&
      is_html == o.is_html &&
      template_id == o.template_id &&
      template_variables == o.template_variables &&
      ignore_reply_to == o.ignore_reply_to &&
      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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 315

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



384
385
386
387
388
389
390
391
392
393
394
395
396
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 384

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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 294

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


274
275
276
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 274

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



280
281
282
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 280

def hash
  [id, inbox_id, name, field, match, reply_to, subject, from, charset, is_html, template_id, template_variables, ignore_reply_to, created_at].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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

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

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

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

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

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

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



360
361
362
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 360

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 366

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



354
355
356
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 354

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



229
230
231
232
233
234
235
236
237
238
239
# File 'lib/mailslurp_client/models/inbox_replier_dto.rb', line 229

def valid?
  return false if @id.nil?
  return false if @field.nil?
  field_validator = EnumAttributeValidator.new('String', ["RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS"])
  return false unless field_validator.valid?(@field)
  return false if @match.nil?
  return false if @is_html.nil?
  return false if @ignore_reply_to.nil?
  return false if @created_at.nil?
  true
end