Class: NucleusApi::ClientViewGoalData

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/client_view_goal_data.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClientViewGoalData

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 87

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'accounts')
    if (value = attributes[:'accounts']).is_a?(Array)
      self.accounts = value
    end
  end

  if attributes.has_key?(:'accumulation_horizon')
    self.accumulation_horizon = attributes[:'accumulation_horizon']
  end

  if attributes.has_key?(:'decumulation_horizon')
    self.decumulation_horizon = attributes[:'decumulation_horizon']
  end

  if attributes.has_key?(:'goal_amount')
    self.goal_amount = attributes[:'goal_amount']
  end

  if attributes.has_key?(:'goal_asset_size_by_goal')
    self.goal_asset_size_by_goal = attributes[:'goal_asset_size_by_goal']
  end

  if attributes.has_key?(:'goal_asset_size_by_goal_date')
    self.goal_asset_size_by_goal_date = attributes[:'goal_asset_size_by_goal_date']
  end

  if attributes.has_key?(:'goal_category')
    self.goal_category = attributes[:'goal_category']
  end

  if attributes.has_key?(:'goal_create_date')
    self.goal_create_date = attributes[:'goal_create_date']
  end

  if attributes.has_key?(:'goal_id')
    self.goal_id = attributes[:'goal_id']
  end

  if attributes.has_key?(:'goal_name')
    self.goal_name = attributes[:'goal_name']
  end

  if attributes.has_key?(:'goal_type')
    self.goal_type = attributes[:'goal_type']
  end

  if attributes.has_key?(:'goal_update_date')
    self.goal_update_date = attributes[:'goal_update_date']
  end

  if attributes.has_key?(:'is_decumulation')
    self.is_decumulation = attributes[:'is_decumulation']
  end

  if attributes.has_key?(:'portfolios')
    if (value = attributes[:'portfolios']).is_a?(Array)
      self.portfolios = value
    end
  end
end

Instance Attribute Details

#accounts ⇒ Object

Returns the value of attribute accounts.



17
18
19
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 17

def accounts
  @accounts
end

#accumulation_horizon ⇒ Object

Returns the value of attribute accumulation_horizon.



19
20
21
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 19

def accumulation_horizon
  @accumulation_horizon
end

#decumulation_horizon ⇒ Object

Returns the value of attribute decumulation_horizon.



21
22
23
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 21

def decumulation_horizon
  @decumulation_horizon
end

#goal_amount ⇒ Object

Returns the value of attribute goal_amount.



23
24
25
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 23

def goal_amount
  @goal_amount
end

#goal_asset_size_by_goal ⇒ Object

Returns the value of attribute goal_asset_size_by_goal.



25
26
27
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 25

def goal_asset_size_by_goal
  @goal_asset_size_by_goal
end

#goal_asset_size_by_goal_date ⇒ Object

Returns the value of attribute goal_asset_size_by_goal_date.



27
28
29
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 27

def goal_asset_size_by_goal_date
  @goal_asset_size_by_goal_date
end

#goal_category ⇒ Object

Returns the value of attribute goal_category.



29
30
31
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 29

def goal_category
  @goal_category
end

#goal_create_date ⇒ Object

Returns the value of attribute goal_create_date.



31
32
33
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 31

def goal_create_date
  @goal_create_date
end

#goal_id ⇒ Object

Returns the value of attribute goal_id.



33
34
35
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 33

def goal_id
  @goal_id
end

#goal_name ⇒ Object

Returns the value of attribute goal_name.



35
36
37
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 35

def goal_name
  @goal_name
end

#goal_type ⇒ Object

Returns the value of attribute goal_type.



37
38
39
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 37

def goal_type
  @goal_type
end

#goal_update_date ⇒ Object

Returns the value of attribute goal_update_date.



39
40
41
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 39

def goal_update_date
  @goal_update_date
end

#is_decumulation ⇒ Object

Returns the value of attribute is_decumulation.



41
42
43
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 41

def is_decumulation
  @is_decumulation
end

#portfolios ⇒ Object

Returns the value of attribute portfolios.



43
44
45
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 43

def portfolios
  @portfolios
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 46

def self.attribute_map
  {
    :'accounts' => :'accounts',
    :'accumulation_horizon' => :'accumulation_horizon',
    :'decumulation_horizon' => :'decumulation_horizon',
    :'goal_amount' => :'goal_amount',
    :'goal_asset_size_by_goal' => :'goal_asset_size_by_goal',
    :'goal_asset_size_by_goal_date' => :'goal_asset_size_by_goal_date',
    :'goal_category' => :'goal_category',
    :'goal_create_date' => :'goal_create_date',
    :'goal_id' => :'goal_id',
    :'goal_name' => :'goal_name',
    :'goal_type' => :'goal_type',
    :'goal_update_date' => :'goal_update_date',
    :'is_decumulation' => :'is_decumulation',
    :'portfolios' => :'portfolios'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 66

def self.swagger_types
  {
    :'accounts' => :'Array<VAccountVO>',
    :'accumulation_horizon' => :'Float',
    :'decumulation_horizon' => :'Float',
    :'goal_amount' => :'Float',
    :'goal_asset_size_by_goal' => :'Float',
    :'goal_asset_size_by_goal_date' => :'Date',
    :'goal_category' => :'String',
    :'goal_create_date' => :'DateTime',
    :'goal_id' => :'String',
    :'goal_name' => :'String',
    :'goal_type' => :'String',
    :'goal_update_date' => :'DateTime',
    :'is_decumulation' => :'BOOLEAN',
    :'portfolios' => :'Array<VPortfolioVO>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accounts == o.accounts &&
      accumulation_horizon == o.accumulation_horizon &&
      decumulation_horizon == o.decumulation_horizon &&
      goal_amount == o.goal_amount &&
      goal_asset_size_by_goal == o.goal_asset_size_by_goal &&
      goal_asset_size_by_goal_date == o.goal_asset_size_by_goal_date &&
      goal_category == o.goal_category &&
      goal_create_date == o.goal_create_date &&
      goal_id == o.goal_id &&
      goal_name == o.goal_name &&
      goal_type == o.goal_type &&
      goal_update_date == o.goal_update_date &&
      is_decumulation == o.is_decumulation &&
      portfolios == o.portfolios
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 222

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = NucleusApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 288

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 203

def build_from_hash(attributes)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


190
191
192
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



196
197
198
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 196

def hash
  [accounts, accumulation_horizon, decumulation_horizon, goal_amount, goal_asset_size_by_goal, goal_asset_size_by_goal_date, goal_category, goal_create_date, goal_id, goal_name, goal_type, goal_update_date, is_decumulation, portfolios].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



156
157
158
159
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 156

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



269
270
271
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 269

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



275
276
277
278
279
280
281
282
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 275

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



263
264
265
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 263

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



163
164
165
 
# File 'lib/nucleus_api/models/client_view_goal_data.rb', line 163

def valid?
  true
end