Class: NucleusApi::AggregationAccountHolding

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

Overview

Aggregation Account Holding Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AggregationAccountHolding

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aggregation_account_id ⇒ Object

aggregationAccountId



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

def 
  @aggregation_account_id
end

#amount ⇒ Object

Returns the value of attribute amount.



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

def amount
  @amount
end

#asset_class ⇒ Object

Returns the value of attribute asset_class.



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

def asset_class
  @asset_class
end

#cost_basis ⇒ Object

Returns the value of attribute cost_basis.



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

def cost_basis
  @cost_basis
end

#create_date ⇒ Object

Returns the value of attribute create_date.



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

def create_date
  @create_date
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



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

def currency_code
  @currency_code
end

#cusip ⇒ Object

Returns the value of attribute cusip.



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

def cusip
  @cusip
end

#exchange ⇒ Object

Returns the value of attribute exchange.



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

def exchange
  @exchange
end

#holding_date ⇒ Object

holdingDate



36
37
38
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 36

def holding_date
  @holding_date
end

#holding_type ⇒ Object

Returns the value of attribute holding_type.



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

def holding_type
  @holding_type
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#isin ⇒ Object

isin



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

def isin
  @isin
end

#metadata ⇒ Object

Returns the value of attribute metadata.



45
46
47
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 45

def metadata
  @metadata
end

#price ⇒ Object

Returns the value of attribute price.



47
48
49
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 47

def price
  @price
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



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

def secondary_id
  @secondary_id
end

#shares ⇒ Object

Returns the value of attribute shares.



51
52
53
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 51

def shares
  @shares
end

#ticker ⇒ Object

ticker



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

def ticker
  @ticker
end

#ticker_name ⇒ Object

tickerName



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

def ticker_name
  @ticker_name
end

#update_date ⇒ Object

Returns the value of attribute update_date.



59
60
61
 
# File 'lib/nucleus_api/models/aggregation_account_holding.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.



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

def self.attribute_map
  {
    :'aggregation_account_id' => :'aggregation_account_id',
    :'amount' => :'amount',
    :'asset_class' => :'asset_class',
    :'cost_basis' => :'cost_basis',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'cusip' => :'cusip',
    :'exchange' => :'exchange',
    :'holding_date' => :'holding_date',
    :'holding_type' => :'holding_type',
    :'id' => :'id',
    :'isin' => :'isin',
    :'metadata' => :'metadata',
    :'price' => :'price',
    :'secondary_id' => :'secondary_id',
    :'shares' => :'shares',
    :'ticker' => :'ticker',
    :'ticker_name' => :'ticker_name',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 87

def self.swagger_types
  {
    :'aggregation_account_id' => :'String',
    :'amount' => :'Float',
    :'asset_class' => :'String',
    :'cost_basis' => :'Float',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'cusip' => :'String',
    :'exchange' => :'String',
    :'holding_date' => :'DateTime',
    :'holding_type' => :'String',
    :'id' => :'String',
    :'isin' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'price' => :'Float',
    :'secondary_id' => :'String',
    :'shares' => :'Float',
    :'ticker' => :'String',
    :'ticker_name' => :'String',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      amount == o.amount &&
      asset_class == o.asset_class &&
      cost_basis == o.cost_basis &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      cusip == o.cusip &&
      exchange == o.exchange &&
      holding_date == o.holding_date &&
      holding_type == o.holding_type &&
      id == o.id &&
      isin == o.isin &&
      metadata == o.metadata &&
      price == o.price &&
      secondary_id == o.secondary_id &&
      shares == o.shares &&
      ticker == o.ticker &&
      ticker_name == o.ticker_name &&
      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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 276

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 342

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 257

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


244
245
246
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



250
251
252
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 250

def hash
  [, amount, asset_class, cost_basis, create_date, currency_code, cusip, exchange, holding_date, holding_type, id, isin, metadata, price, secondary_id, shares, ticker, ticker_name, 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



200
201
202
203
204
205
206
207
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 200

def list_invalid_properties
  invalid_properties = Array.new
  if @shares.nil?
    invalid_properties.push('invalid value for "shares", shares 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



323
324
325
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 323

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



329
330
331
332
333
334
335
336
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 329

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



317
318
319
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 317

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



211
212
213
214
 
# File 'lib/nucleus_api/models/aggregation_account_holding.rb', line 211

def valid?
  return false if @shares.nil?
  true
end