Class: ThePlaidApi::CraCurrentModeledIncome

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

Overview

Modeled estimate of current income based on recently observed income transactions.

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(monthly:, annual:, additional_properties: nil) ⇒ CraCurrentModeledIncome

Returns a new instance of CraCurrentModeledIncome.



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

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

  @monthly = monthly
  @annual = annual
  @additional_properties = additional_properties
end

Instance Attribute Details

#annual ⇒ CraAnnualIncomeValues

Modeled estimate of the annual income.

Returns:



19
20
21
 
# File 'lib/the_plaid_api/models/cra_current_modeled_income.rb', line 19

def annual
  @annual
end

#monthly ⇒ CraMonthlyIncomeValues

Modeled estimate of the monthly income.

Returns:



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

def monthly
  @monthly
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/the_plaid_api/models/cra_current_modeled_income.rb', line 49

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  monthly = CraMonthlyIncomeValues.from_hash(hash['monthly']) if hash['monthly']
  annual = CraAnnualIncomeValues.from_hash(hash['annual']) if hash['annual']

  # 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.
  CraCurrentModeledIncome.new(monthly: monthly,
                              annual: annual,
                              additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/the_plaid_api/models/cra_current_modeled_income.rb', line 22

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
 
# File 'lib/the_plaid_api/models/cra_current_modeled_income.rb', line 30

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



77
78
79
80
81
 
# File 'lib/the_plaid_api/models/cra_current_modeled_income.rb', line 77

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



70
71
72
73
74
 
# File 'lib/the_plaid_api/models/cra_current_modeled_income.rb', line 70

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