Class: MailSlurpClient::CheckCampaignProbeResults

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

Overview

One-shot public campaign probe preflight results

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CheckCampaignProbeResults

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/check_campaign_probe_results.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attachment_mention_issue_count ⇒ Object

Returns the value of attribute attachment_mention_issue_count.



48
49
50
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 48

def attachment_mention_issue_count
  @attachment_mention_issue_count
end

#checked_images ⇒ Object

Returns the value of attribute checked_images.



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

def checked_images
  @checked_images
end

#checked_links ⇒ Object

Returns the value of attribute checked_links.



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

def checked_links
  @checked_links
end

#compatibility_not_supported_count ⇒ Object

Returns the value of attribute compatibility_not_supported_count.



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

def compatibility_not_supported_count
  @compatibility_not_supported_count
end

#compatibility_unknown_count ⇒ Object

Returns the value of attribute compatibility_unknown_count.



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

def compatibility_unknown_count
  @compatibility_unknown_count
end

#compatibility_warning_count ⇒ Object

Returns the value of attribute compatibility_warning_count.



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

def compatibility_warning_count
  @compatibility_warning_count
end

#error_message ⇒ Object

Returns the value of attribute error_message.



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

def error_message
  @error_message
end

#failing_checks ⇒ Object

Returns the value of attribute failing_checks.



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

def failing_checks
  @failing_checks
end

#health_score ⇒ Object

Returns the value of attribute health_score.



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

def health_score
  @health_score
end

#html_error_count ⇒ Object

Returns the value of attribute html_error_count.



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

def html_error_count
  @html_error_count
end

#html_info_count ⇒ Object

Returns the value of attribute html_info_count.



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

def html_info_count
  @html_info_count
end

#html_warning_count ⇒ Object

Returns the value of attribute html_warning_count.



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

def html_warning_count
  @html_warning_count
end

#image_issue_count ⇒ Object

Returns the value of attribute image_issue_count.



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

def image_issue_count
  @image_issue_count
end

#insights ⇒ Object

Returns the value of attribute insights.



50
51
52
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 50

def insights
  @insights
end

#link_issue_count ⇒ Object

Returns the value of attribute link_issue_count.



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

def link_issue_count
  @link_issue_count
end

#passing_checks ⇒ Object

Returns the value of attribute passing_checks.



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

def passing_checks
  @passing_checks
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#total_checks ⇒ Object

Returns the value of attribute total_checks.



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

def total_checks
  @total_checks
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'status' => :'status',
    :'health_score' => :'healthScore',
    :'total_checks' => :'totalChecks',
    :'passing_checks' => :'passingChecks',
    :'failing_checks' => :'failingChecks',
    :'checked_links' => :'checkedLinks',
    :'checked_images' => :'checkedImages',
    :'link_issue_count' => :'linkIssueCount',
    :'image_issue_count' => :'imageIssueCount',
    :'compatibility_warning_count' => :'compatibilityWarningCount',
    :'compatibility_not_supported_count' => :'compatibilityNotSupportedCount',
    :'compatibility_unknown_count' => :'compatibilityUnknownCount',
    :'html_error_count' => :'htmlErrorCount',
    :'html_warning_count' => :'htmlWarningCount',
    :'html_info_count' => :'htmlInfoCount',
    :'attachment_mention_issue_count' => :'attachmentMentionIssueCount',
    :'insights' => :'insights',
    :'error_message' => :'errorMessage'
  }
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



371
372
373
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 371

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



125
126
127
128
129
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 125

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 101

def self.openapi_types
  {
    :'status' => :'String',
    :'health_score' => :'Integer',
    :'total_checks' => :'Integer',
    :'passing_checks' => :'Integer',
    :'failing_checks' => :'Integer',
    :'checked_links' => :'Integer',
    :'checked_images' => :'Integer',
    :'link_issue_count' => :'Integer',
    :'image_issue_count' => :'Integer',
    :'compatibility_warning_count' => :'Integer',
    :'compatibility_not_supported_count' => :'Integer',
    :'compatibility_unknown_count' => :'Integer',
    :'html_error_count' => :'Integer',
    :'html_warning_count' => :'Integer',
    :'html_info_count' => :'Integer',
    :'attachment_mention_issue_count' => :'Integer',
    :'insights' => :'Array<String>',
    :'error_message' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 333

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      health_score == o.health_score &&
      total_checks == o.total_checks &&
      passing_checks == o.passing_checks &&
      failing_checks == o.failing_checks &&
      checked_links == o.checked_links &&
      checked_images == o.checked_images &&
      link_issue_count == o.link_issue_count &&
      image_issue_count == o.image_issue_count &&
      compatibility_warning_count == o.compatibility_warning_count &&
      compatibility_not_supported_count == o.compatibility_not_supported_count &&
      compatibility_unknown_count == o.compatibility_unknown_count &&
      html_error_count == o.html_error_count &&
      html_warning_count == o.html_warning_count &&
      html_info_count == o.html_info_count &&
      attachment_mention_issue_count == o.attachment_mention_issue_count &&
      insights == o.insights &&
      error_message == o.error_message
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



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 399

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



468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 468

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



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

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


358
359
360
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 358

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



364
365
366
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 364

def hash
  [status, health_score, total_checks, passing_checks, failing_checks, checked_links, checked_images, link_issue_count, image_issue_count, compatibility_warning_count, compatibility_not_supported_count, compatibility_unknown_count, html_error_count, html_warning_count, html_info_count, attachment_mention_issue_count, insights, error_message].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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
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
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 223

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



444
445
446
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 444

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



450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 450

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



438
439
440
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 438

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/mailslurp_client/models/check_campaign_probe_results.rb', line 298

def valid?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["HEALTHY", "WARNING", "FAILED"])
  return false unless status_validator.valid?(@status)
  return false if @health_score.nil?
  return false if @total_checks.nil?
  return false if @passing_checks.nil?
  return false if @failing_checks.nil?
  return false if @checked_links.nil?
  return false if @checked_images.nil?
  return false if @link_issue_count.nil?
  return false if @image_issue_count.nil?
  return false if @compatibility_warning_count.nil?
  return false if @compatibility_not_supported_count.nil?
  return false if @compatibility_unknown_count.nil?
  return false if @html_error_count.nil?
  return false if @html_warning_count.nil?
  return false if @html_info_count.nil?
  return false if @attachment_mention_issue_count.nil?
  return false if @insights.nil?
  true
end