Class: ElasticEmail::EmailValidationResult
- Inherits:
-
Object
- Object
- ElasticEmail::EmailValidationResult
- Defined in:
- lib/ElasticEmail/models/email_validation_result.rb
Instance Attribute Summary collapse
-
#account ⇒ Object
Local part of an email.
-
#date_added ⇒ Object
Date of creation in YYYY-MM-DDThh:ii:ss format.
-
#disposable ⇒ Object
Does the email have a temporary domain.
-
#domain ⇒ Object
Name of selected domain.
-
#email ⇒ Object
Full email address that was verified.
-
#reason ⇒ Object
All detected issues.
-
#result ⇒ Object
Returns the value of attribute result.
-
#role ⇒ Object
Is an email a role email (e.g. info@, noreply@ etc.).
-
#suggested_spelling ⇒ Object
Suggested spelling if a possible mistake was found.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ EmailValidationResult
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ EmailValidationResult
Initializes the object
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 131 132 133 134 135 136 137 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 87 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ElasticEmail::EmailValidationResult` 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 `ElasticEmail::EmailValidationResult`. 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?(:'account') self.account = attributes[:'account'] end if attributes.key?(:'domain') self.domain = attributes[:'domain'] end if attributes.key?(:'email') self.email = attributes[:'email'] end if attributes.key?(:'suggested_spelling') self.suggested_spelling = attributes[:'suggested_spelling'] end if attributes.key?(:'disposable') self.disposable = attributes[:'disposable'] end if attributes.key?(:'role') self.role = attributes[:'role'] end if attributes.key?(:'reason') self.reason = attributes[:'reason'] end if attributes.key?(:'date_added') self.date_added = attributes[:'date_added'] end if attributes.key?(:'result') self.result = attributes[:'result'] else self.result = 'None' end end |
Instance Attribute Details
#account ⇒ Object
Local part of an email
19 20 21 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 19 def account @account end |
#date_added ⇒ Object
Date of creation in YYYY-MM-DDThh:ii:ss format
40 41 42 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 40 def date_added @date_added end |
#disposable ⇒ Object
Does the email have a temporary domain
31 32 33 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 31 def disposable @disposable end |
#domain ⇒ Object
Name of selected domain.
22 23 24 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 22 def domain @domain end |
#email ⇒ Object
Full email address that was verified
25 26 27 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 25 def email @email end |
#reason ⇒ Object
All detected issues
37 38 39 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 37 def reason @reason end |
#result ⇒ Object
Returns the value of attribute result.
42 43 44 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 42 def result @result end |
#role ⇒ Object
Is an email a role email (e.g. info@, noreply@ etc.)
34 35 36 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 34 def role @role end |
#suggested_spelling ⇒ Object
Suggested spelling if a possible mistake was found
28 29 30 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 28 def suggested_spelling @suggested_spelling end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
60 61 62 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 60 def self.acceptable_attributes attribute_map.values end |
.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 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 45 def self.attribute_map { :'account' => :'Account', :'domain' => :'Domain', :'email' => :'Email', :'suggested_spelling' => :'SuggestedSpelling', :'disposable' => :'Disposable', :'role' => :'Role', :'reason' => :'Reason', :'date_added' => :'DateAdded', :'result' => :'Result' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
183 184 185 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 183 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
80 81 82 83 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 80 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 65 def self.openapi_types { :'account' => :'String', :'domain' => :'String', :'email' => :'String', :'suggested_spelling' => :'String', :'disposable' => :'Boolean', :'role' => :'Boolean', :'reason' => :'String', :'date_added' => :'Time', :'result' => :'EmailValidationStatus' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 154 def ==(o) return true if self.equal?(o) self.class == o.class && account == o.account && domain == o.domain && email == o.email && suggested_spelling == o.suggested_spelling && disposable == o.disposable && role == o.role && reason == o.reason && date_added == o.date_added && result == o.result end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
213 214 215 216 217 218 219 220 221 222 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 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 213 def _deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = ElasticEmail.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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
284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 284 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
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 190 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{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[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 end self end |
#eql?(o) ⇒ Boolean
170 171 172 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 170 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
176 177 178 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 176 def hash [account, domain, email, suggested_spelling, disposable, role, reason, date_added, result].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
141 142 143 144 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 141 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
260 261 262 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 260 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 266 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
254 255 256 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 254 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
148 149 150 |
# File 'lib/ElasticEmail/models/email_validation_result.rb', line 148 def valid? true end |