class Plaid::RiskCheckEmail
Result summary object specifying values for ‘email` attributes of risk check.
Attributes
Count of all known breaches of this email address if known.
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
List of factors, when available, that contribute towards the risk level of the given risk check type.
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
A list of online services where this email address has been detected to have accounts or other activity.
Public Class Methods
Source
# File lib/plaid/models/risk_check_email.rb, line 90 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/risk_check_email.rb, line 72 def self.attribute_map { :'is_deliverable' => :'is_deliverable', :'breach_count' => :'breach_count', :'first_breached_at' => :'first_breached_at', :'last_breached_at' => :'last_breached_at', :'domain_registered_at' => :'domain_registered_at', :'domain_is_free_provider' => :'domain_is_free_provider', :'domain_is_custom' => :'domain_is_custom', :'domain_is_disposable' => :'domain_is_disposable', :'top_level_domain_is_suspicious' => :'top_level_domain_is_suspicious', :'linked_services' => :'linked_services', :'risk_level' => :'risk_level', :'factors' => :'factors' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/risk_check_email.rb, line 279 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/risk_check_email.rb, line 124 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::RiskCheckEmail` 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 `Plaid::RiskCheckEmail`. 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?(:'is_deliverable') self.is_deliverable = attributes[:'is_deliverable'] end if attributes.key?(:'breach_count') self.breach_count = attributes[:'breach_count'] end if attributes.key?(:'first_breached_at') self.first_breached_at = attributes[:'first_breached_at'] end if attributes.key?(:'last_breached_at') self.last_breached_at = attributes[:'last_breached_at'] end if attributes.key?(:'domain_registered_at') self.domain_registered_at = attributes[:'domain_registered_at'] end if attributes.key?(:'domain_is_free_provider') self.domain_is_free_provider = attributes[:'domain_is_free_provider'] end if attributes.key?(:'domain_is_custom') self.domain_is_custom = attributes[:'domain_is_custom'] end if attributes.key?(:'domain_is_disposable') self.domain_is_disposable = attributes[:'domain_is_disposable'] end if attributes.key?(:'top_level_domain_is_suspicious') self.top_level_domain_is_suspicious = attributes[:'top_level_domain_is_suspicious'] end if attributes.key?(:'linked_services') if (value = attributes[:'linked_services']).is_a?(Array) self.linked_services = value end end if attributes.key?(:'risk_level') self.risk_level = attributes[:'risk_level'] end if attributes.key?(:'factors') if (value = attributes[:'factors']).is_a?(Array) self.factors = value end end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/risk_check_email.rb, line 113 def self.openapi_nullable Set.new([ :'breach_count', :'first_breached_at', :'last_breached_at', :'domain_registered_at', ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/risk_check_email.rb, line 95 def self.openapi_types { :'is_deliverable' => :'RiskCheckEmailIsDeliverableStatus', :'breach_count' => :'Integer', :'first_breached_at' => :'Date', :'last_breached_at' => :'Date', :'domain_registered_at' => :'Date', :'domain_is_free_provider' => :'RiskCheckEmailDomainIsFreeProvider', :'domain_is_custom' => :'RiskCheckEmailDomainIsCustom', :'domain_is_disposable' => :'RiskCheckEmailDomainIsDisposable', :'top_level_domain_is_suspicious' => :'RiskCheckEmailTopLevelDomainIsSuspicious', :'linked_services' => :'Array<RiskCheckLinkedService>', :'risk_level' => :'RiskLevel', :'factors' => :'Array<String>' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/risk_check_email.rb, line 247 def ==(o) return true if self.equal?(o) self.class == o.class && is_deliverable == o.is_deliverable && breach_count == o.breach_count && first_breached_at == o.first_breached_at && last_breached_at == o.last_breached_at && domain_registered_at == o.domain_registered_at && domain_is_free_provider == o.domain_is_free_provider && domain_is_custom == o.domain_is_custom && domain_is_disposable == o.domain_is_disposable && top_level_domain_is_suspicious == o.top_level_domain_is_suspicious && linked_services == o.linked_services && risk_level == o.risk_level && factors == o.factors end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/risk_check_email.rb, line 310 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 = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/risk_check_email.rb, line 381 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/plaid/models/risk_check_email.rb, line 286 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/risk_check_email.rb, line 266 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/risk_check_email.rb, line 272 def hash [is_deliverable, breach_count, first_breached_at, last_breached_at, domain_registered_at, domain_is_free_provider, domain_is_custom, domain_is_disposable, top_level_domain_is_suspicious, linked_services, risk_level, factors].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/risk_check_email.rb, line 236 def linked_services=(linked_services) if linked_services.nil? fail ArgumentError, 'linked_services cannot be nil' end @linked_services = linked_services end
Custom attribute writer method with validation @param [Object] linked_services
Value to be assigned
Source
# File lib/plaid/models/risk_check_email.rb, line 192 def list_invalid_properties invalid_properties = Array.new if @is_deliverable.nil? invalid_properties.push('invalid value for "is_deliverable", is_deliverable cannot be nil.') end if @domain_is_free_provider.nil? invalid_properties.push('invalid value for "domain_is_free_provider", domain_is_free_provider cannot be nil.') end if @domain_is_custom.nil? invalid_properties.push('invalid value for "domain_is_custom", domain_is_custom cannot be nil.') end if @domain_is_disposable.nil? invalid_properties.push('invalid value for "domain_is_disposable", domain_is_disposable cannot be nil.') end if @top_level_domain_is_suspicious.nil? invalid_properties.push('invalid value for "top_level_domain_is_suspicious", top_level_domain_is_suspicious cannot be nil.') end if @linked_services.nil? invalid_properties.push('invalid value for "linked_services", linked_services cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/risk_check_email.rb, line 363 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/risk_check_email.rb, line 351 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/risk_check_email.rb, line 224 def valid? return false if @is_deliverable.nil? return false if @domain_is_free_provider.nil? return false if @domain_is_custom.nil? return false if @domain_is_disposable.nil? return false if @top_level_domain_is_suspicious.nil? return false if @linked_services.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid