Class: Plaid::LinkTokenCreateRequestIncomeVerification

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkTokenCreateRequestIncomeVerification

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 77

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?(:'precheck_id')
    self.precheck_id = attributes[:'precheck_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
end

Instance Attribute Details

#access_tokens ⇒ Object

An array of access tokens corresponding to the Items that will be cross-referenced with the product data. If the ‘transactions` product was not initialized for the Items during link, it will be initialized after this Link session.



29
30
31
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 29

def access_tokens
  @access_tokens
end

#asset_report_id ⇒ Object

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.



23
24
25
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 23

def asset_report_id
  @asset_report_id
end

#bank_income ⇒ Object

Returns the value of attribute bank_income.



34
35
36
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 34

def bank_income
  @bank_income
end

#income_source_types ⇒ Object

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.



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

def income_source_types
  @income_source_types
end

#income_verification_id ⇒ Object

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



20
21
22
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 20

def income_verification_id
  @income_verification_id
end

#payroll_income ⇒ Object

Returns the value of attribute payroll_income.



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

def payroll_income
  @payroll_income
end

#precheck_id ⇒ Object

The ID of a precheck created with ‘/income/verification/precheck`. Will be used to improve conversion of the income verification flow by streamlining the Link interface presented to the end user.



26
27
28
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 26

def precheck_id
  @precheck_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



52
53
54
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 52

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# 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',
    :'precheck_id' => :'precheck_id',
    :'access_tokens' => :'access_tokens',
    :'income_source_types' => :'income_source_types',
    :'bank_income' => :'bank_income',
    :'payroll_income' => :'payroll_income'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



165
166
167
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 165

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 70

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
 
# 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',
    :'precheck_id' => :'String',
    :'access_tokens' => :'Array<String>',
    :'income_source_types' => :'Array<IncomeVerificationSourceType>',
    :'bank_income' => :'LinkTokenCreateRequestIncomeVerificationBankIncome',
    :'payroll_income' => :'LinkTokenCreateRequestIncomeVerificationPayrollIncome'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 138

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 &&
      precheck_id == o.precheck_id &&
      access_tokens == o.access_tokens &&
      income_source_types == o.income_source_types &&
      bank_income == o.bank_income &&
      payroll_income == o.payroll_income
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 195

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 266

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 172

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


152
153
154
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



158
159
160
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 158

def hash
  [income_verification_id, asset_report_id, precheck_id, access_tokens, income_source_types, bank_income, payroll_income].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



125
126
127
128
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 125

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



242
243
244
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 242

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 248

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



236
237
238
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 236

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



132
133
134
 
# File 'lib/plaid/models/link_token_create_request_income_verification.rb', line 132

def valid?
  true
end