Class: ThePlaidApi::LinkSessionPayrollIncomeResult

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

Overview

The details of a digital payroll income verification in Link.

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(num_paystubs_retrieved:, num_w2s_retrieved:, institution:, additional_properties: nil) ⇒ LinkSessionPayrollIncomeResult

Returns a new instance of LinkSessionPayrollIncomeResult.



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

def initialize(num_paystubs_retrieved:, num_w2s_retrieved:, institution:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @num_paystubs_retrieved = num_paystubs_retrieved
  @num_w2s_retrieved = num_w2s_retrieved
  @institution = institution
  @additional_properties = additional_properties
end

Instance Attribute Details

#institution ⇒ LinkSessionSuccessMetadataInstitution

An institution object. If the Item was created via Same-Day or Instant micro-deposit verification, will be ‘null`.

Returns:



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

def institution
  @institution
end

#num_paystubs_retrieved ⇒ Integer

The number of paystubs retrieved from a payroll provider.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/the_plaid_api/models/link_session_payroll_income_result.rb', line 14

def num_paystubs_retrieved
  @num_paystubs_retrieved
end

#num_w2s_retrieved ⇒ Integer

The number of W-2s retrieved from a payroll provider.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/the_plaid_api/models/link_session_payroll_income_result.rb', line 18

def num_w2s_retrieved
  @num_w2s_retrieved
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  num_paystubs_retrieved =
    hash.key?('num_paystubs_retrieved') ? hash['num_paystubs_retrieved'] : nil
  num_w2s_retrieved =
    hash.key?('num_w2s_retrieved') ? hash['num_w2s_retrieved'] : nil
  institution = LinkSessionSuccessMetadataInstitution.from_hash(hash['institution']) if
    hash['institution']

  # 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.
  LinkSessionPayrollIncomeResult.new(num_paystubs_retrieved: num_paystubs_retrieved,
                                     num_w2s_retrieved: num_w2s_retrieved,
                                     institution: institution,
                                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['num_paystubs_retrieved'] = 'num_paystubs_retrieved'
  @_hash['num_w2s_retrieved'] = 'num_w2s_retrieved'
  @_hash['institution'] = 'institution'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



40
41
42
43
44
 
# File 'lib/the_plaid_api/models/link_session_payroll_income_result.rb', line 40

def self.nullables
  %w[
    institution
  ]
end

.optionals ⇒ Object

An array for optional fields



35
36
37
 
# File 'lib/the_plaid_api/models/link_session_payroll_income_result.rb', line 35

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



92
93
94
95
96
97
 
# File 'lib/the_plaid_api/models/link_session_payroll_income_result.rb', line 92

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



84
85
86
87
88
89
 
# File 'lib/the_plaid_api/models/link_session_payroll_income_result.rb', line 84

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