Class: MailSlurpClient::CreateEmailAuditOptions

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

Overview

Authenticated saved email audit request

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEmailAuditOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 79

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

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

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

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

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

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

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

Instance Attribute Details

#email_analysis ⇒ Object

Returns the value of attribute email_analysis.



33
34
35
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 33

def email_analysis
  @email_analysis
end

#from_address ⇒ Object

Optional sender address context



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

def from_address
  @from_address
end

#has_attachments ⇒ Object

Whether the source email included attachments



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

def has_attachments
  @has_attachments
end

#html_body ⇒ Object

Optional HTML email body



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

def html_body
  @html_body
end

#recipient ⇒ Object

Optional recipient context



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

def recipient
  @recipient
end

#subject ⇒ Object

Optional subject line context



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

def subject
  @subject
end

#text_body ⇒ Object

Optional text email body



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

def text_body
  @text_body
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 39

def self.attribute_map
  {
    :'from_address' => :'fromAddress',
    :'recipient' => :'recipient',
    :'subject' => :'subject',
    :'html_body' => :'htmlBody',
    :'text_body' => :'textBody',
    :'email_analysis' => :'emailAnalysis',
    :'has_attachments' => :'hasAttachments'
  }
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



283
284
285
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 283

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'from_address',
    :'recipient',
    :'subject',
    :'html_body',
    :'text_body',
    :'email_analysis',
    :'has_attachments'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 52

def self.openapi_types
  {
    :'from_address' => :'String',
    :'recipient' => :'String',
    :'subject' => :'String',
    :'html_body' => :'String',
    :'text_body' => :'String',
    :'email_analysis' => :'EmailAnalysis',
    :'has_attachments' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 256

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from_address == o.from_address &&
      recipient == o.recipient &&
      subject == o.subject &&
      html_body == o.html_body &&
      text_body == o.text_body &&
      email_analysis == o.email_analysis &&
      has_attachments == o.has_attachments
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



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
342
343
344
345
346
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 311

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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 380

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



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

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


270
271
272
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 276

def hash
  [from_address, recipient, subject, html_body, text_body, email_analysis, has_attachments].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



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 123

def list_invalid_properties
  invalid_properties = Array.new
  if !@from_address.nil? && @from_address.to_s.length > 320
    invalid_properties.push('invalid value for "from_address", the character length must be smaller than or equal to 320.')
  end

  if !@from_address.nil? && @from_address.to_s.length < 0
    invalid_properties.push('invalid value for "from_address", the character length must be great than or equal to 0.')
  end

  if !@recipient.nil? && @recipient.to_s.length > 320
    invalid_properties.push('invalid value for "recipient", the character length must be smaller than or equal to 320.')
  end

  if !@recipient.nil? && @recipient.to_s.length < 0
    invalid_properties.push('invalid value for "recipient", the character length must be great than or equal to 0.')
  end

  if !@subject.nil? && @subject.to_s.length > 998
    invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 998.')
  end

  if !@subject.nil? && @subject.to_s.length < 0
    invalid_properties.push('invalid value for "subject", the character length must be great than or equal to 0.')
  end

  if !@html_body.nil? && @html_body.to_s.length > 200000
    invalid_properties.push('invalid value for "html_body", the character length must be smaller than or equal to 200000.')
  end

  if !@html_body.nil? && @html_body.to_s.length < 0
    invalid_properties.push('invalid value for "html_body", the character length must be great than or equal to 0.')
  end

  if !@text_body.nil? && @text_body.to_s.length > 200000
    invalid_properties.push('invalid value for "text_body", the character length must be smaller than or equal to 200000.')
  end

  if !@text_body.nil? && @text_body.to_s.length < 0
    invalid_properties.push('invalid value for "text_body", the character length must be great than or equal to 0.')
  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



356
357
358
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 356

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 362

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



350
351
352
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 350

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



170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/mailslurp_client/models/create_email_audit_options.rb', line 170

def valid?
  return false if !@from_address.nil? && @from_address.to_s.length > 320
  return false if !@from_address.nil? && @from_address.to_s.length < 0
  return false if !@recipient.nil? && @recipient.to_s.length > 320
  return false if !@recipient.nil? && @recipient.to_s.length < 0
  return false if !@subject.nil? && @subject.to_s.length > 998
  return false if !@subject.nil? && @subject.to_s.length < 0
  return false if !@html_body.nil? && @html_body.to_s.length > 200000
  return false if !@html_body.nil? && @html_body.to_s.length < 0
  return false if !@text_body.nil? && @text_body.to_s.length > 200000
  return false if !@text_body.nil? && @text_body.to_s.length < 0
  true
end