Class: MailSlurpClient::AnalyzeDmarcReportResults

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

Overview

Aggregate analysis results for an uploaded DMARC XML report

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyzeDmarcReportResults

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 90

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#dkim_aligned_count ⇒ Object

Returns the value of attribute dkim_aligned_count.



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

def dkim_aligned_count
  @dkim_aligned_count
end

#errors ⇒ Object

Returns the value of attribute errors.



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

def errors
  @errors
end

#failed_alignment_count ⇒ Object

Returns the value of attribute failed_alignment_count.



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

def failed_alignment_count
  @failed_alignment_count
end

#fully_aligned_count ⇒ Object

Returns the value of attribute fully_aligned_count.



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

def fully_aligned_count
  @fully_aligned_count
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#none_count ⇒ Object

Returns the value of attribute none_count.



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

def none_count
  @none_count
end

#quarantine_count ⇒ Object

Returns the value of attribute quarantine_count.



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

def quarantine_count
  @quarantine_count
end

#record_count ⇒ Object

Returns the value of attribute record_count.



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

def record_count
  @record_count
end

#reject_count ⇒ Object

Returns the value of attribute reject_count.



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

def reject_count
  @reject_count
end

#spf_aligned_count ⇒ Object

Returns the value of attribute spf_aligned_count.



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

def spf_aligned_count
  @spf_aligned_count
end

#top_sources ⇒ Object

Returns the value of attribute top_sources.



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

def top_sources
  @top_sources
end

#total_messages ⇒ Object

Returns the value of attribute total_messages.



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

def total_messages
  @total_messages
end

#warnings ⇒ Object

Returns the value of attribute warnings.



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

def warnings
  @warnings
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 45

def self.attribute_map
  {
    :'metadata' => :'metadata',
    :'record_count' => :'recordCount',
    :'total_messages' => :'totalMessages',
    :'reject_count' => :'rejectCount',
    :'quarantine_count' => :'quarantineCount',
    :'none_count' => :'noneCount',
    :'dkim_aligned_count' => :'dkimAlignedCount',
    :'spf_aligned_count' => :'spfAlignedCount',
    :'fully_aligned_count' => :'fullyAlignedCount',
    :'failed_alignment_count' => :'failedAlignmentCount',
    :'top_sources' => :'topSources',
    :'warnings' => :'warnings',
    :'errors' => :'errors'
  }
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



275
276
277
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 275

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 83

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 64

def self.openapi_types
  {
    :'metadata' => :'DmarcReportMetadata',
    :'record_count' => :'Integer',
    :'total_messages' => :'Integer',
    :'reject_count' => :'Integer',
    :'quarantine_count' => :'Integer',
    :'none_count' => :'Integer',
    :'dkim_aligned_count' => :'Integer',
    :'spf_aligned_count' => :'Integer',
    :'fully_aligned_count' => :'Integer',
    :'failed_alignment_count' => :'Integer',
    :'top_sources' => :'Array<DmarcReportSourceSummary>',
    :'warnings' => :'Array<String>',
    :'errors' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      metadata == o.metadata &&
      record_count == o.record_count &&
      total_messages == o.total_messages &&
      reject_count == o.reject_count &&
      quarantine_count == o.quarantine_count &&
      none_count == o.none_count &&
      dkim_aligned_count == o.dkim_aligned_count &&
      spf_aligned_count == o.spf_aligned_count &&
      fully_aligned_count == o.fully_aligned_count &&
      failed_alignment_count == o.failed_alignment_count &&
      top_sources == o.top_sources &&
      warnings == o.warnings &&
      errors == o.errors
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



303
304
305
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
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 303

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 372

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 282

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


262
263
264
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



268
269
270
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 268

def hash
  [metadata, record_count, total_messages, reject_count, quarantine_count, none_count, dkim_aligned_count, spf_aligned_count, fully_aligned_count, failed_alignment_count, top_sources, warnings, errors].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



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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 164

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

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

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

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

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

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

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

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

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

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

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

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

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



348
349
350
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 348

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 354

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



342
343
344
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 342

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/mailslurp_client/models/analyze_dmarc_report_results.rb', line 223

def valid?
  return false if @metadata.nil?
  return false if @record_count.nil?
  return false if @total_messages.nil?
  return false if @reject_count.nil?
  return false if @quarantine_count.nil?
  return false if @none_count.nil?
  return false if @dkim_aligned_count.nil?
  return false if @spf_aligned_count.nil?
  return false if @fully_aligned_count.nil?
  return false if @failed_alignment_count.nil?
  return false if @top_sources.nil?
  return false if @warnings.nil?
  return false if @errors.nil?
  true
end