Class: ThePlaidApi::YtdNetIncomeSummaryFieldNumber

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

Overview

Year-to-date earnings after any tax withholdings, benefit payments or deductions, as reported on the paystub.

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(value:, verification_status:, additional_properties: nil) ⇒ YtdNetIncomeSummaryFieldNumber

Returns a new instance of YtdNetIncomeSummaryFieldNumber.



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

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

  @value = value
  @verification_status = verification_status
  @additional_properties = additional_properties
end

Instance Attribute Details

#value ⇒ Float

The value of the field.

Returns:

  • (Float) 


15
16
17
 
# File 'lib/the_plaid_api/models/ytd_net_income_summary_field_number.rb', line 15

def value
  @value
end

#verification_status ⇒ VerificationStatus

The verification status. One of the following: ‘“VERIFIED”`: The information was successfully verified. `“UNVERIFIED”`: The verification has not yet been performed. `“NEEDS_INFO”`: The verification was attempted but could not be completed due to missing information. “`UNABLE_TO_VERIFY`”: The verification was performed and the information could not be verified. `“UNKNOWN”`: The verification status is unknown.

Returns:



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

def verification_status
  @verification_status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  value = hash.key?('value') ? hash['value'] : nil
  verification_status =
    hash.key?('verification_status') ? hash['verification_status'] : nil

  # 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.
  YtdNetIncomeSummaryFieldNumber.new(value: value,
                                     verification_status: verification_status,
                                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



37
38
39
 
# File 'lib/the_plaid_api/models/ytd_net_income_summary_field_number.rb', line 37

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



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

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



78
79
80
81
82
 
# File 'lib/the_plaid_api/models/ytd_net_income_summary_field_number.rb', line 78

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