Class: FdxV660Api::ForeignSourceDividendIncome

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/fdx_v660_api/models/foreign_source_dividend_income.rb

Overview

Breakdown of foreign dividend income into qualifiedDividends, nonQualifiedDividends and capitalGains

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(country: SKIP, qualified_dividends: SKIP, non_qualified_dividends: SKIP, capital_gains: SKIP, total_dividends: SKIP, additional_properties: nil) ⇒ ForeignSourceDividendIncome

Returns a new instance of ForeignSourceDividendIncome.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 61

def initialize(country: SKIP, qualified_dividends: SKIP,
               non_qualified_dividends: SKIP, capital_gains: SKIP,
               total_dividends: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @country = country unless country == SKIP
  @qualified_dividends = qualified_dividends unless qualified_dividends == SKIP
  @non_qualified_dividends = non_qualified_dividends unless non_qualified_dividends == SKIP
  @capital_gains = capital_gains unless capital_gains == SKIP
  @total_dividends = total_dividends unless total_dividends == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#capital_gains ⇒ Float

Capital gain distributions

Returns:

  • (Float) 


27
28
29
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 27

def capital_gains
  @capital_gains
end

#country ⇒ Iso3166CountryCode1

Country code

Returns:



15
16
17
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 15

def country
  @country
end

#non_qualified_dividends ⇒ Float

Non-qualified dividends

Returns:

  • (Float) 


23
24
25
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 23

def non_qualified_dividends
  @non_qualified_dividends
end

#qualified_dividends ⇒ Float

Qualified dividends

Returns:

  • (Float) 


19
20
21
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 19

def qualified_dividends
  @qualified_dividends
end

#total_dividends ⇒ Float

Total dividends from this foreign source. Optional if it can be calculated from the other three components

Returns:

  • (Float) 


32
33
34
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 32

def total_dividends
  @total_dividends
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



76
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
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 76

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  country = hash.key?('country') ? hash['country'] : SKIP
  qualified_dividends =
    hash.key?('qualifiedDividends') ? hash['qualifiedDividends'] : SKIP
  non_qualified_dividends =
    hash.key?('nonQualifiedDividends') ? hash['nonQualifiedDividends'] : SKIP
  capital_gains = hash.key?('capitalGains') ? hash['capitalGains'] : SKIP
  total_dividends =
    hash.key?('totalDividends') ? hash['totalDividends'] : 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.
  ForeignSourceDividendIncome.new(country: country,
                                  qualified_dividends: qualified_dividends,
                                  non_qualified_dividends: non_qualified_dividends,
                                  capital_gains: capital_gains,
                                  total_dividends: total_dividends,
                                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



35
36
37
38
39
40
41
42
43
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 35

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['country'] = 'country'
  @_hash['qualified_dividends'] = 'qualifiedDividends'
  @_hash['non_qualified_dividends'] = 'nonQualifiedDividends'
  @_hash['capital_gains'] = 'capitalGains'
  @_hash['total_dividends'] = 'totalDividends'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



57
58
59
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 57

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



46
47
48
49
50
51
52
53
54
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 46

def self.optionals
  %w[
    country
    qualified_dividends
    non_qualified_dividends
    capital_gains
    total_dividends
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



114
115
116
117
118
119
120
121
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 114

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} country: #{@country.inspect}, qualified_dividends:"\
  " #{@qualified_dividends.inspect}, non_qualified_dividends:"\
  " #{@non_qualified_dividends.inspect}, capital_gains: #{@capital_gains.inspect},"\
  " total_dividends: #{@total_dividends.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



106
107
108
109
110
111
 
# File 'lib/fdx_v660_api/models/foreign_source_dividend_income.rb', line 106

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} country: #{@country}, qualified_dividends: #{@qualified_dividends},"\
  " non_qualified_dividends: #{@non_qualified_dividends}, capital_gains: #{@capital_gains},"\
  " total_dividends: #{@total_dividends}, additional_properties: #{@additional_properties}>"
end