Class: MailSafePro::BatchEmailResponse

Inherits:
ApiModelBase show all
Defined in:
lib/mailsafepro/models/batch_email_response.rb

Overview

Batch validation response

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ BatchEmailResponse

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
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSafePro::BatchEmailResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MailSafePro::BatchEmailResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'count')
    self.count = attributes[:'count']
  else
    self.count = nil
  end

  if attributes.key?(:'valid_count')
    self.valid_count = attributes[:'valid_count']
  else
    self.valid_count = nil
  end

  if attributes.key?(:'invalid_count')
    self.invalid_count = attributes[:'invalid_count']
  else
    self.invalid_count = nil
  end

  if attributes.key?(:'processing_time')
    self.processing_time = attributes[:'processing_time']
  else
    self.processing_time = nil
  end

  if attributes.key?(:'average_time')
    self.average_time = attributes[:'average_time']
  else
    self.average_time = nil
  end

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

Instance Attribute Details

#average_time ⇒ Object

Average processing time per email



32
33
34
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 32

def average_time
  @average_time
end

#count ⇒ Object

Total emails processed



20
21
22
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 20

def count
  @count
end

#invalid_count ⇒ Object

Number of invalid emails



26
27
28
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 26

def invalid_count
  @invalid_count
end

#processing_time ⇒ Object

Total processing time in seconds



29
30
31
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 29

def processing_time
  @processing_time
end

#results ⇒ Object

Individual validation results



35
36
37
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 35

def results
  @results
end

#valid_count ⇒ Object

Number of valid emails



23
24
25
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 23

def valid_count
  @valid_count
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



50
51
52
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 50

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 55

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 38

def self.attribute_map
  {
    :'count' => :'count',
    :'valid_count' => :'valid_count',
    :'invalid_count' => :'invalid_count',
    :'processing_time' => :'processing_time',
    :'average_time' => :'average_time',
    :'results' => :'results'
  }
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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 310

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 60

def self.openapi_types
  {
    :'count' => :'Integer',
    :'valid_count' => :'Integer',
    :'invalid_count' => :'Integer',
    :'processing_time' => :'Float',
    :'average_time' => :'Float',
    :'results' => :'Array<EmailResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



284
285
286
287
288
289
290
291
292
293
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      count == o.count &&
      valid_count == o.valid_count &&
      invalid_count == o.invalid_count &&
      processing_time == o.processing_time &&
      average_time == o.average_time &&
      results == o.results
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 303

def hash
  [count, valid_count, invalid_count, processing_time, average_time, results].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



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
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 134

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @count.nil?
    invalid_properties.push('invalid value for "count", count cannot be nil.')
  end

  if @count < 0
    invalid_properties.push('invalid value for "count", must be greater than or equal to 0.')
  end

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

  if @valid_count < 0
    invalid_properties.push('invalid value for "valid_count", must be greater than or equal to 0.')
  end

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

  if @invalid_count < 0
    invalid_properties.push('invalid value for "invalid_count", must be greater than or equal to 0.')
  end

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

  if @processing_time < 0.0
    invalid_properties.push('invalid value for "processing_time", must be greater than or equal to 0.0.')
  end

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

  if @average_time < 0.0
    invalid_properties.push('invalid value for "average_time", must be greater than or equal to 0.0.')
  end

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 332

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/mailsafepro/models/batch_email_response.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @count.nil?
  return false if @count < 0
  return false if @valid_count.nil?
  return false if @valid_count < 0
  return false if @invalid_count.nil?
  return false if @invalid_count < 0
  return false if @processing_time.nil?
  return false if @processing_time < 0.0
  return false if @average_time.nil?
  return false if @average_time < 0.0
  return false if @results.nil?
  true
end