Class: ThePlaidApi::SandboxPublicTokenCreateRequestOptionsIncomeVerification

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb

Overview

A set of parameters for income verification options. This field is required if ‘income_verification` is included in the `initial_products` array.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(income_source_types: SKIP, bank_income: SKIP, additional_properties: nil) ⇒ SandboxPublicTokenCreateRequestOptionsIncomeVerification

Returns a new instance of SandboxPublicTokenCreateRequestOptionsIncomeVerification.



46
47
48
49
50
51
52
53
54
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb', line 46

def initialize(income_source_types: SKIP, bank_income: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @income_source_types = income_source_types unless income_source_types == SKIP
  @bank_income = bank_income unless bank_income == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#bank_income ⇒ SandboxPublicTokenCreateRequestIncomeVerificationBankIncome

Specifies options for Bank Income. This field is required if ‘income_verification` is included in the `initial_products` array and `bank` is specified in `income_source_types`.

Returns:



23
24
25
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb', line 23

def bank_income
  @bank_income
end

#income_source_types ⇒ Array[IncomeVerificationSourceType]

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.

Returns:



17
18
19
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb', line 17

def income_source_types
  @income_source_types
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb', line 57

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  income_source_types =
    hash.key?('income_source_types') ? hash['income_source_types'] : SKIP
  if hash['bank_income']
    bank_income = SandboxPublicTokenCreateRequestIncomeVerificationBankIncome.from_hash(hash['bank_income'])
  end

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  SandboxPublicTokenCreateRequestOptionsIncomeVerification.new(income_source_types: income_source_types,
                                                               bank_income: bank_income,
                                                               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



26
27
28
29
30
31
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb', line 26

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['income_source_types'] = 'income_source_types'
  @_hash['bank_income'] = 'bank_income'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



42
43
44
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb', line 42

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb', line 34

def self.optionals
  %w[
    income_source_types
    bank_income
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



88
89
90
91
92
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb', line 88

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} income_source_types: #{@income_source_types.inspect}, bank_income:"\
  " #{@bank_income.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



81
82
83
84
85
 
# File 'lib/the_plaid_api/models/sandbox_public_token_create_request_options_income_verification.rb', line 81

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} income_source_types: #{@income_source_types}, bank_income: #{@bank_income},"\
  " additional_properties: #{@additional_properties}>"
end