class Plaid::LinkTokenCreateRequestIncomeVerification

Specifies options for initializing Link for use with the Income product. This field is required if ‘income_verification` is included in the `products` array.

Attributes

access_tokens[RW]

An array of access tokens corresponding to Items that a user has previously connected with. Data from these institutions will be cross-referenced with document data received during the Document Income flow to help verify that the uploaded documents are accurate. If the ‘transactions` product was not initialized for these Items during link, it will be initialized after this Link session. This field should only be used with the `payroll` income source type.

asset_report_id[RW]

The ‘asset_report_id` of an asset report associated with the user, as provided by `/asset_report/create`. Providing an `asset_report_id` is optional and can be used to verify the user through a streamlined flow. If provided, the bank linking flow will be skipped.

bank_income[RW]
income_source_types[RW]

The types of source income data that users will be permitted to share. Options include ‘bank` and `payroll`. Currently you can only specify one of these options.

income_verification_id[RW]

The ‘income_verification_id` of the verification instance, as provided by `/income/verification/create`. Replaced by the user token.

payroll_income[RW]
stated_income_sources[RW]

A list of user stated income sources

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/link_token_create_request_income_verification.rb, line 52
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/link_token_create_request_income_verification.rb, line 39
def self.attribute_map
  {
    :'income_verification_id' => :'income_verification_id',
    :'asset_report_id' => :'asset_report_id',
    :'access_tokens' => :'access_tokens',
    :'income_source_types' => :'income_source_types',
    :'bank_income' => :'bank_income',
    :'payroll_income' => :'payroll_income',
    :'stated_income_sources' => :'stated_income_sources'
  }
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/link_token_create_request_income_verification.rb, line 168
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/link_token_create_request_income_verification.rb, line 78
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::LinkTokenCreateRequestIncomeVerification` 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::LinkTokenCreateRequestIncomeVerification`. 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?(:'income_verification_id')
    self.income_verification_id = attributes[:'income_verification_id']
  end

  if attributes.key?(:'asset_report_id')
    self.asset_report_id = attributes[:'asset_report_id']
  end

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

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

  if attributes.key?(:'bank_income')
    self.bank_income = attributes[:'bank_income']
  end

  if attributes.key?(:'payroll_income')
    self.payroll_income = attributes[:'payroll_income']
  end

  if attributes.key?(:'stated_income_sources')
    if (value = attributes[:'stated_income_sources']).is_a?(Array)
      self.stated_income_sources = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/plaid/models/link_token_create_request_income_verification.rb, line 70
def self.openapi_nullable
  Set.new([
    :'access_tokens',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/link_token_create_request_income_verification.rb, line 57
def self.openapi_types
  {
    :'income_verification_id' => :'String',
    :'asset_report_id' => :'String',
    :'access_tokens' => :'Array<String>',
    :'income_source_types' => :'Array<IncomeVerificationSourceType>',
    :'bank_income' => :'LinkTokenCreateRequestIncomeVerificationBankIncome',
    :'payroll_income' => :'LinkTokenCreateRequestIncomeVerificationPayrollIncome',
    :'stated_income_sources' => :'Array<LinkTokenCreateRequestUserStatedIncomeSource>'
  }
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/link_token_create_request_income_verification.rb, line 141
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      income_verification_id == o.income_verification_id &&
      asset_report_id == o.asset_report_id &&
      access_tokens == o.access_tokens &&
      income_source_types == o.income_source_types &&
      bank_income == o.bank_income &&
      payroll_income == o.payroll_income &&
      stated_income_sources == o.stated_income_sources
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/link_token_create_request_income_verification.rb, line 199
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/link_token_create_request_income_verification.rb, line 270
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/link_token_create_request_income_verification.rb, line 175
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/link_token_create_request_income_verification.rb, line 155
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/link_token_create_request_income_verification.rb, line 161
def hash
  [income_verification_id, asset_report_id, access_tokens, income_source_types, bank_income, payroll_income, stated_income_sources].hash
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/link_token_create_request_income_verification.rb, line 128
def list_invalid_properties
  invalid_properties = Array.new
  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/link_token_create_request_income_verification.rb, line 246
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/link_token_create_request_income_verification.rb, line 252
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/link_token_create_request_income_verification.rb, line 240
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/link_token_create_request_income_verification.rb, line 135
def valid?
  true
end