Class: Plaid::IncomeVerificationPrecheckRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/plaid/models/income_verification_precheck_request.rb

Overview

IncomeVerificationPrecheckRequest defines the request schema for ‘/income/verification/precheck`

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(client_id: SKIP, secret: SKIP, user: SKIP, employer: SKIP, transactions_access_token: SKIP, us_military_info: SKIP, additional_properties: nil) ⇒ IncomeVerificationPrecheckRequest

Returns a new instance of IncomeVerificationPrecheckRequest.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 73

def initialize(client_id: SKIP, secret: SKIP, user: SKIP, employer: SKIP,
               transactions_access_token: SKIP, us_military_info: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @client_id = client_id unless client_id == SKIP
  @secret = secret unless secret == SKIP
  @user = user unless user == SKIP
  @employer = employer unless employer == SKIP
  unless transactions_access_token == SKIP
    @transactions_access_token =
      transactions_access_token
  end
  @us_military_info = us_military_info unless us_military_info == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#client_id ⇒ String

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

Returns:

  • (String) 


17
18
19
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 17

def client_id
  @client_id
end

#employer ⇒ IncomeVerificationPrecheckEmployer

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:



32
33
34
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 32

def employer
  @employer
end

#secret ⇒ String

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:

  • (String) 


22
23
24
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 22

def secret
  @secret
end

#transactions_access_token ⇒ String

The access token associated with the Item data is being requested for.

Returns:

  • (String) 


36
37
38
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 36

def transactions_access_token
  @transactions_access_token
end

#us_military_info ⇒ IncomeVerificationPrecheckMilitaryInfo

The access token associated with the Item data is being requested for.

Returns:



40
41
42
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 40

def us_military_info
  @us_military_info
end

#user ⇒ IncomeVerificationPrecheckUser

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:



27
28
29
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 27

def user
  @user
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 92

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
  secret = hash.key?('secret') ? hash['secret'] : SKIP
  user = IncomeVerificationPrecheckUser.from_hash(hash['user']) if hash['user']
  employer = IncomeVerificationPrecheckEmployer.from_hash(hash['employer']) if
    hash['employer']
  transactions_access_token =
    hash.key?('transactions_access_token') ? hash['transactions_access_token'] : SKIP
  if hash['us_military_info']
    us_military_info = IncomeVerificationPrecheckMilitaryInfo.from_hash(hash['us_military_info'])
  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.
  IncomeVerificationPrecheckRequest.new(client_id: client_id,
                                        secret: secret,
                                        user: user,
                                        employer: employer,
                                        transactions_access_token: transactions_access_token,
                                        us_military_info: us_military_info,
                                        additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 43

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_id'] = 'client_id'
  @_hash['secret'] = 'secret'
  @_hash['user'] = 'user'
  @_hash['employer'] = 'employer'
  @_hash['transactions_access_token'] = 'transactions_access_token'
  @_hash['us_military_info'] = 'us_military_info'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



67
68
69
70
71
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 67

def self.nullables
  %w[
    transactions_access_token
  ]
end

.optionals ⇒ Object

An array for optional fields



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 55

def self.optionals
  %w[
    client_id
    secret
    user
    employer
    transactions_access_token
    us_military_info
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



133
134
135
136
137
138
139
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 133

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, user:"\
  " #{@user.inspect}, employer: #{@employer.inspect}, transactions_access_token:"\
  " #{@transactions_access_token.inspect}, us_military_info: #{@us_military_info.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



125
126
127
128
129
130
 
# File 'lib/plaid/models/income_verification_precheck_request.rb', line 125

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id}, secret: #{@secret}, user: #{@user}, employer:"\
  " #{@employer}, transactions_access_token: #{@transactions_access_token}, us_military_info:"\
  " #{@us_military_info}, additional_properties: #{@additional_properties}>"
end