Class: MailSafePro::BatchValidationRequest

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

Overview

Request model for batch email validation

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 = {}) ⇒ BatchValidationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
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/mailsafepro/models/batch_validation_request.rb', line 74

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

  if attributes.key?(:'check_smtp')
    self.check_smtp = attributes[:'check_smtp']
  else
    self.check_smtp = false
  end

  if attributes.key?(:'include_raw_dns')
    self.include_raw_dns = attributes[:'include_raw_dns']
  else
    self.include_raw_dns = false
  end

  if attributes.key?(:'batch_size')
    self.batch_size = attributes[:'batch_size']
  else
    self.batch_size = 100
  end

  if attributes.key?(:'concurrent_requests')
    self.concurrent_requests = attributes[:'concurrent_requests']
  else
    self.concurrent_requests = 5
  end
end

Instance Attribute Details

#batch_size ⇒ Object

Number of emails to process in each batch



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

def batch_size
  @batch_size
end

#check_smtp ⇒ Object

Perform SMTP verification for all emails



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

def check_smtp
  @check_smtp
end

#concurrent_requests ⇒ Object

Maximum concurrent validation requests



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

def concurrent_requests
  @concurrent_requests
end

#emails ⇒ Object

List of email addresses to validate (can include invalid formats)



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

def emails
  @emails
end

#include_raw_dns ⇒ Object

Include raw DNS records in responses



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

def include_raw_dns
  @include_raw_dns
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



46
47
48
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 35

def self.attribute_map
  {
    :'emails' => :'emails',
    :'check_smtp' => :'check_smtp',
    :'include_raw_dns' => :'include_raw_dns',
    :'batch_size' => :'batch_size',
    :'concurrent_requests' => :'concurrent_requests'
  }
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 252

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



67
68
69
70
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 56

def self.openapi_types
  {
    :'emails' => :'Array<String>',
    :'check_smtp' => :'Boolean',
    :'include_raw_dns' => :'Boolean',
    :'batch_size' => :'Integer',
    :'concurrent_requests' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      emails == o.emails &&
      check_smtp == o.check_smtp &&
      include_raw_dns == o.include_raw_dns &&
      batch_size == o.batch_size &&
      concurrent_requests == o.concurrent_requests
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


239
240
241
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 245

def hash
  [emails, check_smtp, include_raw_dns, batch_size, concurrent_requests].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
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 123

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

  if @emails.length > 1000
    invalid_properties.push('invalid value for "emails", number of items must be less than or equal to 1000.')
  end

  if @emails.length < 1
    invalid_properties.push('invalid value for "emails", number of items must be greater than or equal to 1.')
  end

  if !@batch_size.nil? && @batch_size > 1000
    invalid_properties.push('invalid value for "batch_size", must be smaller than or equal to 1000.')
  end

  if !@batch_size.nil? && @batch_size < 1
    invalid_properties.push('invalid value for "batch_size", must be greater than or equal to 1.')
  end

  if !@concurrent_requests.nil? && @concurrent_requests > 50
    invalid_properties.push('invalid value for "concurrent_requests", must be smaller than or equal to 50.')
  end

  if !@concurrent_requests.nil? && @concurrent_requests < 1
    invalid_properties.push('invalid value for "concurrent_requests", must be greater than or equal to 1.')
  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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 274

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



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/mailsafepro/models/batch_validation_request.rb', line 159

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @emails.nil?
  return false if @emails.length > 1000
  return false if @emails.length < 1
  return false if !@batch_size.nil? && @batch_size > 1000
  return false if !@batch_size.nil? && @batch_size < 1
  return false if !@concurrent_requests.nil? && @concurrent_requests > 50
  return false if !@concurrent_requests.nil? && @concurrent_requests < 1
  true
end