Class: NucleusApi::GoalTrack

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

Overview

Goal Simulation Result Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GoalTrack

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/nucleus_api/models/goal_track.rb', line 122

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?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accounts ⇒ Object

Returns the value of attribute accounts.



18
19
20
 
# File 'lib/nucleus_api/models/goal_track.rb', line 18

def accounts
  @accounts
end

#accumulation_horizon ⇒ Object

accumulationHorizon



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

def accumulation_horizon
  @accumulation_horizon
end

#client_id ⇒ Object

clientId



24
25
26
 
# File 'lib/nucleus_api/models/goal_track.rb', line 24

def client_id
  @client_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



26
27
28
 
# File 'lib/nucleus_api/models/goal_track.rb', line 26

def create_date
  @create_date
end

#current_investment ⇒ Object

currentInvestment



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

def current_investment
  @current_investment
end

#decumulation_horizon ⇒ Object

decumulationHorizon



32
33
34
 
# File 'lib/nucleus_api/models/goal_track.rb', line 32

def decumulation_horizon
  @decumulation_horizon
end

#goal_achievement_score ⇒ Object

goalAchievementScore



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

def goal_achievement_score
  @goal_achievement_score
end

#goal_amount ⇒ Object

goalAmount



38
39
40
 
# File 'lib/nucleus_api/models/goal_track.rb', line 38

def goal_amount
  @goal_amount
end

#goal_id ⇒ Object

goalId



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

def goal_id
  @goal_id
end

#goal_probability ⇒ Object

goalProbability



44
45
46
 
# File 'lib/nucleus_api/models/goal_track.rb', line 44

def goal_probability
  @goal_probability
end

#id ⇒ Object

Returns the value of attribute id.



46
47
48
 
# File 'lib/nucleus_api/models/goal_track.rb', line 46

def id
  @id
end

#metadata ⇒ Object

metadata



49
50
51
 
# File 'lib/nucleus_api/models/goal_track.rb', line 49

def metadata
  @metadata
end

#on_track ⇒ Object

onTrack



52
53
54
 
# File 'lib/nucleus_api/models/goal_track.rb', line 52

def on_track
  @on_track
end

#progress ⇒ Object

progress



55
56
57
 
# File 'lib/nucleus_api/models/goal_track.rb', line 55

def progress
  @progress
end

#projection_balance ⇒ Object

projectionBalance



58
59
60
 
# File 'lib/nucleus_api/models/goal_track.rb', line 58

def projection_balance
  @projection_balance
end

#projection_date ⇒ Object

projectionDate



61
62
63
 
# File 'lib/nucleus_api/models/goal_track.rb', line 61

def projection_date
  @projection_date
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



63
64
65
 
# File 'lib/nucleus_api/models/goal_track.rb', line 63

def secondary_id
  @secondary_id
end

#status_time_stamp ⇒ Object

statusTimeStamp



66
67
68
 
# File 'lib/nucleus_api/models/goal_track.rb', line 66

def status_time_stamp
  @status_time_stamp
end

#update_date ⇒ Object

Returns the value of attribute update_date.



68
69
70
 
# File 'lib/nucleus_api/models/goal_track.rb', line 68

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



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/nucleus_api/models/goal_track.rb', line 71

def self.attribute_map
  {
    :'accounts' => :'accounts',
    :'accumulation_horizon' => :'accumulation_horizon',
    :'client_id' => :'client_id',
    :'create_date' => :'create_date',
    :'current_investment' => :'current_investment',
    :'decumulation_horizon' => :'decumulation_horizon',
    :'goal_achievement_score' => :'goal_achievement_score',
    :'goal_amount' => :'goal_amount',
    :'goal_id' => :'goal_id',
    :'goal_probability' => :'goal_probability',
    :'id' => :'id',
    :'metadata' => :'metadata',
    :'on_track' => :'on_track',
    :'progress' => :'progress',
    :'projection_balance' => :'projection_balance',
    :'projection_date' => :'projection_date',
    :'secondary_id' => :'secondary_id',
    :'status_time_stamp' => :'status_time_stamp',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/nucleus_api/models/goal_track.rb', line 96

def self.swagger_types
  {
    :'accounts' => :'Array<GoalTrackAccounts>',
    :'accumulation_horizon' => :'Float',
    :'client_id' => :'String',
    :'create_date' => :'DateTime',
    :'current_investment' => :'Float',
    :'decumulation_horizon' => :'Float',
    :'goal_achievement_score' => :'Float',
    :'goal_amount' => :'Float',
    :'goal_id' => :'String',
    :'goal_probability' => :'Float',
    :'id' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'on_track' => :'BOOLEAN',
    :'progress' => :'Float',
    :'projection_balance' => :'Float',
    :'projection_date' => :'Date',
    :'secondary_id' => :'String',
    :'status_time_stamp' => :'DateTime',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/nucleus_api/models/goal_track.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accounts == o.accounts &&
      accumulation_horizon == o.accumulation_horizon &&
      client_id == o.client_id &&
      create_date == o.create_date &&
      current_investment == o.current_investment &&
      decumulation_horizon == o.decumulation_horizon &&
      goal_achievement_score == o.goal_achievement_score &&
      goal_amount == o.goal_amount &&
      goal_id == o.goal_id &&
      goal_probability == o.goal_probability &&
      id == o.id &&
      metadata == o.metadata &&
      on_track == o.on_track &&
      progress == o.progress &&
      projection_balance == o.projection_balance &&
      projection_date == o.projection_date &&
      secondary_id == o.secondary_id &&
      status_time_stamp == o.status_time_stamp &&
      update_date == o.update_date
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/nucleus_api/models/goal_track.rb', line 292

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/nucleus_api/models/goal_track.rb', line 358

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/nucleus_api/models/goal_track.rb', line 273

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


260
261
262
 
# File 'lib/nucleus_api/models/goal_track.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/nucleus_api/models/goal_track.rb', line 266

def hash
  [accounts, accumulation_horizon, client_id, create_date, current_investment, decumulation_horizon, goal_achievement_score, goal_amount, goal_id, goal_probability, id, metadata, on_track, progress, projection_balance, projection_date, secondary_id, status_time_stamp, update_date].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



211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/nucleus_api/models/goal_track.rb', line 211

def list_invalid_properties
  invalid_properties = Array.new
  if @goal_id.nil?
    invalid_properties.push('invalid value for "goal_id", goal_id cannot be nil.')
  end

  if @status_time_stamp.nil?
    invalid_properties.push('invalid value for "status_time_stamp", status_time_stamp cannot be nil.')
  end

  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



339
340
341
 
# File 'lib/nucleus_api/models/goal_track.rb', line 339

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



345
346
347
348
349
350
351
352
 
# File 'lib/nucleus_api/models/goal_track.rb', line 345

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



333
334
335
 
# File 'lib/nucleus_api/models/goal_track.rb', line 333

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



226
227
228
229
230
 
# File 'lib/nucleus_api/models/goal_track.rb', line 226

def valid?
  return false if @goal_id.nil?
  return false if @status_time_stamp.nil?
  true
end