Class: MailSlurpClient::CreateInboxReplierOptions

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

Overview

Options for creating an inbox replier. Repliers can be attached to inboxes and send automated responses when an inbound email matches given criteria.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateInboxReplierOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
195
196
197
198
199
200
201
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 135

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

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

  if attributes.key?(:'body')
    self.body = attributes[:'body']
  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
end

Instance Attribute Details

#body ⇒ Object

Email body for reply



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

def body
  @body
end

#charset ⇒ Object

Email reply charset



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

def charset
  @charset
end

#field ⇒ Object

Field to match against to trigger inbox replier for inbound email



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

def field
  @field
end

#from ⇒ Object

Send email from address



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

def from
  @from
end

#ignore_reply_to ⇒ Object

Ignore sender replyTo when responding. Send directly to the sender if enabled.



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

def ignore_reply_to
  @ignore_reply_to
end

#inbox_id ⇒ Object

Inbox ID to attach replier to



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

def inbox_id
  @inbox_id
end

#is_html ⇒ Object

Send HTML email



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

def is_html
  @is_html
end

#match ⇒ Object

String or wildcard style match for field specified when evaluating reply rules. Use `*` to match anything.



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

def match
  @match
end

#name ⇒ Object

Name for replier



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

def name
  @name
end

#reply_to ⇒ Object

Reply-to email address when sending replying



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

def reply_to
  @reply_to
end

#subject ⇒ Object

Subject override when replying to email



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

def subject
  @subject
end

#template_id ⇒ Object

ID of template to use when sending a reply



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

def template_id
  @template_id
end

#template_variables ⇒ Object

Template variable values



55
56
57
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 55

def template_variables
  @template_variables
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 80

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



278
279
280
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 278

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 99

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      ignore_reply_to == o.ignore_reply_to &&
      is_html == o.is_html &&
      body == o.body &&
      template_id == o.template_id &&
      template_variables == o.template_variables
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



306
307
308
309
310
311
312
313
314
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
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 306

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



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

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 285

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


265
266
267
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



271
272
273
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 271

def hash
  [inbox_id, name, field, match, reply_to, subject, from, charset, ignore_reply_to, is_html, body, template_id, template_variables].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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 205

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

  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



351
352
353
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 351

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 357

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



345
346
347
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 345

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



224
225
226
227
228
229
230
231
 
# File 'lib/mailslurp_client/models/create_inbox_replier_options.rb', line 224

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