Class: NucleusApi::Score

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

Overview

Score Object

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Score

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/nucleus_api/models/score.rb', line 129

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

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

  if attributes.has_key?(:'benchmark_id')
    self.benchmark_id = attributes[:'benchmark_id']
  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?(:'goal_id')
    self.goal_id = attributes[:'goal_id']
  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?(:'model_id')
    self.model_id = attributes[:'model_id']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

accountId



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

def 
  @account_id
end

#allocation_id ⇒ Object

allocationId



22
23
24
 
# File 'lib/nucleus_api/models/score.rb', line 22

def allocation_id
  @allocation_id
end

#benchmark_id ⇒ Object

benchmarkId



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

def benchmark_id
  @benchmark_id
end

#client_id ⇒ Object

clientId



28
29
30
 
# File 'lib/nucleus_api/models/score.rb', line 28

def client_id
  @client_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



30
31
32
 
# File 'lib/nucleus_api/models/score.rb', line 30

def create_date
  @create_date
end

#goal_id ⇒ Object

goalId



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

def goal_id
  @goal_id
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#metadata ⇒ Object

metadata



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

def metadata
  @metadata
end

#model_id ⇒ Object

modelId



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

def model_id
  @model_id
end

#portfolio_id ⇒ Object

portfolioId



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

def portfolio_id
  @portfolio_id
end

#score_time_stamp ⇒ Object

Returns the value of attribute score_time_stamp.



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

def score_time_stamp
  @score_time_stamp
end

#score_type ⇒ Object

scoreType



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

def score_type
  @score_type
end

#score_value ⇒ Object

scoreValue



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

def score_value
  @score_value
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



54
55
56
 
# File 'lib/nucleus_api/models/score.rb', line 54

def secondary_id
  @secondary_id
end

#security_id ⇒ Object

securityId



57
58
59
 
# File 'lib/nucleus_api/models/score.rb', line 57

def security_id
  @security_id
end

#update_date ⇒ Object

Returns the value of attribute update_date.



59
60
61
 
# File 'lib/nucleus_api/models/score.rb', line 59

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/nucleus_api/models/score.rb', line 84

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'allocation_id' => :'allocation_id',
    :'benchmark_id' => :'benchmark_id',
    :'client_id' => :'client_id',
    :'create_date' => :'create_date',
    :'goal_id' => :'goal_id',
    :'id' => :'id',
    :'metadata' => :'metadata',
    :'model_id' => :'model_id',
    :'portfolio_id' => :'portfolio_id',
    :'score_time_stamp' => :'score_time_stamp',
    :'score_type' => :'score_type',
    :'score_value' => :'score_value',
    :'secondary_id' => :'secondary_id',
    :'security_id' => :'security_id',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/nucleus_api/models/score.rb', line 106

def self.swagger_types
  {
    :'account_id' => :'String',
    :'allocation_id' => :'String',
    :'benchmark_id' => :'String',
    :'client_id' => :'String',
    :'create_date' => :'DateTime',
    :'goal_id' => :'String',
    :'id' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'model_id' => :'String',
    :'portfolio_id' => :'String',
    :'score_time_stamp' => :'DateTime',
    :'score_type' => :'String',
    :'score_value' => :'String',
    :'secondary_id' => :'String',
    :'security_id' => :'String',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/score.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      allocation_id == o.allocation_id &&
      benchmark_id == o.benchmark_id &&
      client_id == o.client_id &&
      create_date == o.create_date &&
      goal_id == o.goal_id &&
      id == o.id &&
      metadata == o.metadata &&
      model_id == o.model_id &&
      portfolio_id == o.portfolio_id &&
      score_time_stamp == o.score_time_stamp &&
      score_type == o.score_type &&
      score_value == o.score_value &&
      secondary_id == o.secondary_id &&
      security_id == o.security_id &&
      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



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
329
330
 
# File 'lib/nucleus_api/models/score.rb', line 294

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/nucleus_api/models/score.rb', line 360

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



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

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


262
263
264
 
# File 'lib/nucleus_api/models/score.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/nucleus_api/models/score.rb', line 268

def hash
  [, allocation_id, benchmark_id, client_id, create_date, goal_id, id, metadata, model_id, portfolio_id, score_time_stamp, score_type, score_value, secondary_id, security_id, 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



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

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

  if @score_value.nil?
    invalid_properties.push('invalid value for "score_value", score_value 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



341
342
343
 
# File 'lib/nucleus_api/models/score.rb', line 341

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



347
348
349
350
351
352
353
354
 
# File 'lib/nucleus_api/models/score.rb', line 347

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



335
336
337
 
# File 'lib/nucleus_api/models/score.rb', line 335

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



219
220
221
222
223
224
225
 
# File 'lib/nucleus_api/models/score.rb', line 219

def valid?
  return false if @score_type.nil?
  score_type_validator = EnumAttributeValidator.new('String', ['goal_achievement_score', 'portfolio_optimization_score', 'credit_score', 'dimensional_risk_score', 'diversification_score', 'risk_score', 'risk_profile'])
  return false unless score_type_validator.valid?(@score_type)
  return false if @score_value.nil?
  true
end