Class: ThePlaidApi::CreditSessionPayrollIncomeResult

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/credit_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: SKIP, num_w2s_retrieved: SKIP, institution_id: SKIP, institution_name: SKIP, additional_properties: nil) ⇒ CreditSessionPayrollIncomeResult

Returns a new instance of CreditSessionPayrollIncomeResult.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/the_plaid_api/models/credit_session_payroll_income_result.rb', line 53

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

  @num_paystubs_retrieved = num_paystubs_retrieved unless num_paystubs_retrieved == SKIP
  @num_w2s_retrieved = num_w2s_retrieved unless num_w2s_retrieved == SKIP
  @institution_id = institution_id unless institution_id == SKIP
  @institution_name = institution_name unless institution_name == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#institution_id ⇒ String

The Plaid Institution ID associated with the Item.

Returns:

  • (String) 


22
23
24
 
# File 'lib/the_plaid_api/models/credit_session_payroll_income_result.rb', line 22

def institution_id
  @institution_id
end

#institution_name ⇒ String

The Institution Name associated with the Item.

Returns:

  • (String) 


26
27
28
 
# File 'lib/the_plaid_api/models/credit_session_payroll_income_result.rb', line 26

def institution_name
  @institution_name
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/credit_session_payroll_income_result.rb', line 14

def num_paystubs_retrieved
  @num_paystubs_retrieved
end

#num_w2s_retrieved ⇒ Integer

The number of w2s retrieved from a payroll provider.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/the_plaid_api/models/credit_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.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/the_plaid_api/models/credit_session_payroll_income_result.rb', line 67

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'] : SKIP
  num_w2s_retrieved =
    hash.key?('num_w2s_retrieved') ? hash['num_w2s_retrieved'] : SKIP
  institution_id =
    hash.key?('institution_id') ? hash['institution_id'] : SKIP
  institution_name =
    hash.key?('institution_name') ? hash['institution_name'] : SKIP

  # 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.
  CreditSessionPayrollIncomeResult.new(num_paystubs_retrieved: num_paystubs_retrieved,
                                       num_w2s_retrieved: num_w2s_retrieved,
                                       institution_id: institution_id,
                                       institution_name: institution_name,
                                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/the_plaid_api/models/credit_session_payroll_income_result.rb', line 29

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

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/the_plaid_api/models/credit_session_payroll_income_result.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/the_plaid_api/models/credit_session_payroll_income_result.rb', line 39

def self.optionals
  %w[
    num_paystubs_retrieved
    num_w2s_retrieved
    institution_id
    institution_name
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



104
105
106
107
108
109
110
 
# File 'lib/the_plaid_api/models/credit_session_payroll_income_result.rb', line 104

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_id:"\
  " #{@institution_id.inspect}, institution_name: #{@institution_name.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



96
97
98
99
100
101
 
# File 'lib/the_plaid_api/models/credit_session_payroll_income_result.rb', line 96

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_id: #{@institution_id}, institution_name:"\
  " #{@institution_name}, additional_properties: #{@additional_properties}>"
end