Class: NucleusApi::Security

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Security

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
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
259
260
261
262
263
 
# File 'lib/nucleus_api/models/security.rb', line 150

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset_class ⇒ Object

Security asset class



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

def asset_class
  @asset_class
end

#brokers ⇒ Object

brokers



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

def brokers
  @brokers
end

#category ⇒ Object

Security category



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

def category
  @category
end

#create_date ⇒ Object

Returns the value of attribute create_date.



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

def create_date
  @create_date
end

#currency_code ⇒ Object

currency_code



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

def currency_code
  @currency_code
end

#cusip ⇒ Object

cusip



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

def cusip
  @cusip
end

#description ⇒ Object

description



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

def description
  @description
end

#exchange ⇒ Object

Security exchange



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

def exchange
  @exchange
end

#id ⇒ Object

Returns the value of attribute id.



40
41
42
 
# File 'lib/nucleus_api/models/security.rb', line 40

def id
  @id
end

#image ⇒ Object

image



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

def image
  @image
end

#industry ⇒ Object

Security industry



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

def industry
  @industry
end

#is_active ⇒ Object

Security is active



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

def is_active
  @is_active
end

#isin ⇒ Object

isin



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

def isin
  @isin
end

#metadata ⇒ Object

metadata



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

def metadata
  @metadata
end

#name ⇒ Object

Security name



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

def name
  @name
end

#proxy_id ⇒ Object

proxy_id



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

def proxy_id
  @proxy_id
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



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

def secondary_id
  @secondary_id
end

#sector ⇒ Object

Security sector



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

def sector
  @sector
end

#security_class ⇒ Object

Security class



69
70
71
 
# File 'lib/nucleus_api/models/security.rb', line 69

def security_class
  @security_class
end

#security_composition ⇒ Object

Returns the value of attribute security_composition.



71
72
73
 
# File 'lib/nucleus_api/models/security.rb', line 71

def security_composition
  @security_composition
end

#security_country ⇒ Object

Returns the value of attribute security_country.



73
74
75
 
# File 'lib/nucleus_api/models/security.rb', line 73

def security_country
  @security_country
end

#ticker ⇒ Object

Security ticker



76
77
78
 
# File 'lib/nucleus_api/models/security.rb', line 76

def ticker
  @ticker
end

#total_expense_ratio ⇒ Object

total_expense_ratio



79
80
81
 
# File 'lib/nucleus_api/models/security.rb', line 79

def total_expense_ratio
  @total_expense_ratio
end

#type ⇒ Object

Security type



82
83
84
 
# File 'lib/nucleus_api/models/security.rb', line 82

def type
  @type
end

#update_date ⇒ Object

Returns the value of attribute update_date.



84
85
86
 
# File 'lib/nucleus_api/models/security.rb', line 84

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'asset_class' => :'asset_class',
    :'brokers' => :'brokers',
    :'category' => :'category',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'cusip' => :'cusip',
    :'description' => :'description',
    :'exchange' => :'exchange',
    :'id' => :'id',
    :'image' => :'image',
    :'industry' => :'industry',
    :'is_active' => :'is_active',
    :'isin' => :'isin',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'proxy_id' => :'proxy_id',
    :'secondary_id' => :'secondary_id',
    :'sector' => :'sector',
    :'security_class' => :'security_class',
    :'security_composition' => :'security_composition',
    :'security_country' => :'security_country',
    :'ticker' => :'ticker',
    :'total_expense_ratio' => :'total_expense_ratio',
    :'type' => :'type',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'asset_class' => :'String',
    :'brokers' => :'Array<Brokers>',
    :'category' => :'String',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'cusip' => :'String',
    :'description' => :'String',
    :'exchange' => :'String',
    :'id' => :'String',
    :'image' => :'String',
    :'industry' => :'String',
    :'is_active' => :'BOOLEAN',
    :'isin' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'name' => :'String',
    :'proxy_id' => :'String',
    :'secondary_id' => :'String',
    :'sector' => :'String',
    :'security_class' => :'String',
    :'security_composition' => :'Array<SecuritiesComposition>',
    :'security_country' => :'Array<SecuritiesCountry>',
    :'ticker' => :'String',
    :'total_expense_ratio' => :'Float',
    :'type' => :'String',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



290
291
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
 
# File 'lib/nucleus_api/models/security.rb', line 290

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      asset_class == o.asset_class &&
      brokers == o.brokers &&
      category == o.category &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      cusip == o.cusip &&
      description == o.description &&
      exchange == o.exchange &&
      id == o.id &&
      image == o.image &&
      industry == o.industry &&
      is_active == o.is_active &&
      isin == o.isin &&
      metadata == o.metadata &&
      name == o.name &&
      proxy_id == o.proxy_id &&
      secondary_id == o.secondary_id &&
      sector == o.sector &&
      security_class == o.security_class &&
      security_composition == o.security_composition &&
      security_country == o.security_country &&
      ticker == o.ticker &&
      total_expense_ratio == o.total_expense_ratio &&
      type == o.type &&
      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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/nucleus_api/models/security.rb', line 354

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



420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/nucleus_api/models/security.rb', line 420

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/nucleus_api/models/security.rb', line 335

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


322
323
324
 
# File 'lib/nucleus_api/models/security.rb', line 322

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



328
329
330
 
# File 'lib/nucleus_api/models/security.rb', line 328

def hash
  [asset_class, brokers, category, create_date, currency_code, cusip, description, exchange, id, image, industry, is_active, isin, metadata, name, proxy_id, secondary_id, sector, security_class, security_composition, security_country, ticker, total_expense_ratio, type, 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



267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/nucleus_api/models/security.rb', line 267

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

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



401
402
403
 
# File 'lib/nucleus_api/models/security.rb', line 401

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



407
408
409
410
411
412
413
414
 
# File 'lib/nucleus_api/models/security.rb', line 407

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



395
396
397
 
# File 'lib/nucleus_api/models/security.rb', line 395

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



282
283
284
285
286
 
# File 'lib/nucleus_api/models/security.rb', line 282

def valid?
  return false if @name.nil?
  return false if @ticker.nil?
  true
end