class Plaid::RiskCheckEmail

Result summary object specifying values for ‘email` attributes of risk check.

Attributes

breach_count[RW]

Count of all known breaches of this email address if known.

domain_is_custom[RW]
domain_is_disposable[RW]
domain_is_free_provider[RW]
domain_registered_at[RW]

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

first_breached_at[RW]

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

is_deliverable[RW]
last_breached_at[RW]

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

linked_services[RW]

A list of online services where this email address has been detected to have accounts or other activity.

top_level_domain_is_suspicious[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/risk_check_email.rb, line 83
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/plaid/models/risk_check_email.rb, line 67
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'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/risk_check_email.rb, line 258
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/plaid/models/risk_check_email.rb, line 115
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
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/plaid/models/risk_check_email.rb, line 104
def self.openapi_nullable
  Set.new([
    :'breach_count',
    :'first_breached_at',
    :'last_breached_at',
    :'domain_registered_at',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/risk_check_email.rb, line 88
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>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/plaid/models/risk_check_email.rb, line 228
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
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/plaid/models/risk_check_email.rb, line 289
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
_to_hash(value) click to toggle source

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

# File lib/plaid/models/risk_check_email.rb, line 360
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/risk_check_email.rb, line 265
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
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/plaid/models/risk_check_email.rb, line 245
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/plaid/models/risk_check_email.rb, line 251
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].hash
end
linked_services=(linked_services) click to toggle source

Custom attribute writer method with validation @param [Object] linked_services Value to be assigned

# File lib/plaid/models/risk_check_email.rb, line 217
def linked_services=(linked_services)
  if linked_services.nil?
    fail ArgumentError, 'linked_services cannot be nil'
  end


  @linked_services = linked_services
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/plaid/models/risk_check_email.rb, line 173
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
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/risk_check_email.rb, line 336
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/risk_check_email.rb, line 342
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/plaid/models/risk_check_email.rb, line 330
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/plaid/models/risk_check_email.rb, line 205
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