Class: BudgeaClient::Investment

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/models/investment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Investment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
264
265
266
267
268
269
270
271
 
# File 'lib/budgea_client/models/investment.rb', line 156

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

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

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

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

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

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

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

  if attributes.has_key?(:'quantity')
    self.quantity = attributes[:'quantity']
  else
    self.quantity = 0.0
  end

  if attributes.has_key?(:'unitprice')
    self.unitprice = attributes[:'unitprice']
  else
    self.unitprice = 0.0
  end

  if attributes.has_key?(:'unitvalue')
    self.unitvalue = attributes[:'unitvalue']
  else
    self.unitvalue = 0.0
  end

  if attributes.has_key?(:'valuation')
    self.valuation = attributes[:'valuation']
  else
    self.valuation = 0.0
  end

  if attributes.has_key?(:'diff')
    self.diff = attributes[:'diff']
  else
    self.diff = 0.0
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

Investment code



27
28
29
 
# File 'lib/budgea_client/models/investment.rb', line 27

def code
  @code
end

#code_type ⇒ Object

Code type (ISIN of AMF)



30
31
32
 
# File 'lib/budgea_client/models/investment.rb', line 30

def code_type
  @code_type
end

#deleted ⇒ Object

If set, this investment has been removed from the website



90
91
92
 
# File 'lib/budgea_client/models/investment.rb', line 90

def deleted
  @deleted
end

#description ⇒ Object

Description of the investment



36
37
38
 
# File 'lib/budgea_client/models/investment.rb', line 36

def description
  @description
end

#diff ⇒ Object

Capital gain



51
52
53
 
# File 'lib/budgea_client/models/investment.rb', line 51

def diff
  @diff
end

#diff_percent ⇒ Object

Capital gain in percent (between 0 and 1)



54
55
56
 
# File 'lib/budgea_client/models/investment.rb', line 54

def diff_percent
  @diff_percent
end

#id ⇒ Object

ID of the investment



18
19
20
 
# File 'lib/budgea_client/models/investment.rb', line 18

def id
  @id
end

#id_account ⇒ Object

ID of the related account



21
22
23
 
# File 'lib/budgea_client/models/investment.rb', line 21

def 
  @id_account
end

#id_security ⇒ Object

ID of the related security



69
70
71
 
# File 'lib/budgea_client/models/investment.rb', line 69

def id_security
  @id_security
end

#label ⇒ Object

Label of the investment



24
25
26
 
# File 'lib/budgea_client/models/investment.rb', line 24

def label
  @label
end

#last_update ⇒ Object

Last update of the investment



87
88
89
 
# File 'lib/budgea_client/models/investment.rb', line 87

def last_update
  @last_update
end

#original_currency ⇒ Object

Original currency



72
73
74
 
# File 'lib/budgea_client/models/investment.rb', line 72

def original_currency
  @original_currency
end

#original_diff ⇒ Object

Capital gain in the original currency



84
85
86
 
# File 'lib/budgea_client/models/investment.rb', line 84

def original_diff
  @original_diff
end

#original_unitprice ⇒ Object

Current unit value in the original currency



81
82
83
 
# File 'lib/budgea_client/models/investment.rb', line 81

def original_unitprice
  @original_unitprice
end

#original_unitvalue ⇒ Object

Average buy price in the original currency



78
79
80
 
# File 'lib/budgea_client/models/investment.rb', line 78

def original_unitvalue
  @original_unitvalue
end

#original_valuation ⇒ Object

Valuation in original currency



75
76
77
 
# File 'lib/budgea_client/models/investment.rb', line 75

def original_valuation
  @original_valuation
end

#portfolio_share ⇒ Object

Percent of the portfolio



60
61
62
 
# File 'lib/budgea_client/models/investment.rb', line 60

def portfolio_share
  @portfolio_share
end

#prev_diff ⇒ Object

Capital gain from previous value



57
58
59
 
# File 'lib/budgea_client/models/investment.rb', line 57

def prev_diff
  @prev_diff
end

#prev_vdate ⇒ Object

Value date of the previous value (prev_diff)



66
67
68
 
# File 'lib/budgea_client/models/investment.rb', line 66

def prev_vdate
  @prev_vdate
end

#quantity ⇒ Object

Quantity



39
40
41
 
# File 'lib/budgea_client/models/investment.rb', line 39

def quantity
  @quantity
end

#source ⇒ Object

Source of the ISIN code (website, notFound)



33
34
35
 
# File 'lib/budgea_client/models/investment.rb', line 33

def source
  @source
end

#unitprice ⇒ Object

Average buy price



42
43
44
 
# File 'lib/budgea_client/models/investment.rb', line 42

def unitprice
  @unitprice
end

#unitvalue ⇒ Object

Current unit value



45
46
47
 
# File 'lib/budgea_client/models/investment.rb', line 45

def unitvalue
  @unitvalue
end

#valuation ⇒ Object

Current valuation



48
49
50
 
# File 'lib/budgea_client/models/investment.rb', line 48

def valuation
  @valuation
end

#vdate ⇒ Object

Value date



63
64
65
 
# File 'lib/budgea_client/models/investment.rb', line 63

def vdate
  @vdate
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/budgea_client/models/investment.rb', line 93

def self.attribute_map
  {
    :'id' => :'id',
    :'id_account' => :'id_account',
    :'label' => :'label',
    :'code' => :'code',
    :'code_type' => :'code_type',
    :'source' => :'source',
    :'description' => :'description',
    :'quantity' => :'quantity',
    :'unitprice' => :'unitprice',
    :'unitvalue' => :'unitvalue',
    :'valuation' => :'valuation',
    :'diff' => :'diff',
    :'diff_percent' => :'diff_percent',
    :'prev_diff' => :'prev_diff',
    :'portfolio_share' => :'portfolio_share',
    :'vdate' => :'vdate',
    :'prev_vdate' => :'prev_vdate',
    :'id_security' => :'id_security',
    :'original_currency' => :'original_currency',
    :'original_valuation' => :'original_valuation',
    :'original_unitvalue' => :'original_unitvalue',
    :'original_unitprice' => :'original_unitprice',
    :'original_diff' => :'original_diff',
    :'last_update' => :'last_update',
    :'deleted' => :'deleted'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/budgea_client/models/investment.rb', line 124

def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_account' => :'Integer',
    :'label' => :'String',
    :'code' => :'String',
    :'code_type' => :'String',
    :'source' => :'String',
    :'description' => :'String',
    :'quantity' => :'Float',
    :'unitprice' => :'Float',
    :'unitvalue' => :'Float',
    :'valuation' => :'Float',
    :'diff' => :'Float',
    :'diff_percent' => :'Float',
    :'prev_diff' => :'Float',
    :'portfolio_share' => :'Float',
    :'vdate' => :'Date',
    :'prev_vdate' => :'Date',
    :'id_security' => :'Integer',
    :'original_currency' => :'Object',
    :'original_valuation' => :'Float',
    :'original_unitvalue' => :'Float',
    :'original_unitprice' => :'Float',
    :'original_diff' => :'Float',
    :'last_update' => :'DateTime',
    :'deleted' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/budgea_client/models/investment.rb', line 308

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
       == o. &&
      label == o.label &&
      code == o.code &&
      code_type == o.code_type &&
      source == o.source &&
      description == o.description &&
      quantity == o.quantity &&
      unitprice == o.unitprice &&
      unitvalue == o.unitvalue &&
      valuation == o.valuation &&
      diff == o.diff &&
      diff_percent == o.diff_percent &&
      prev_diff == o.prev_diff &&
      portfolio_share == o.portfolio_share &&
      vdate == o.vdate &&
      prev_vdate == o.prev_vdate &&
      id_security == o.id_security &&
      original_currency == o.original_currency &&
      original_valuation == o.original_valuation &&
      original_unitvalue == o.original_unitvalue &&
      original_unitprice == o.original_unitprice &&
      original_diff == o.original_diff &&
      last_update == o.last_update &&
      deleted == o.deleted
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/budgea_client/models/investment.rb', line 374

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(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 = BudgeaClient.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



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/budgea_client/models/investment.rb', line 440

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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/budgea_client/models/investment.rb', line 353

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


340
341
342
 
# File 'lib/budgea_client/models/investment.rb', line 340

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



346
347
348
 
# File 'lib/budgea_client/models/investment.rb', line 346

def hash
  [id, , label, code, code_type, source, description, quantity, unitprice, unitvalue, valuation, diff, diff_percent, prev_diff, portfolio_share, vdate, prev_vdate, id_security, original_currency, original_valuation, original_unitvalue, original_unitprice, original_diff, last_update, deleted].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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/budgea_client/models/investment.rb', line 275

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

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

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

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



420
421
422
 
# File 'lib/budgea_client/models/investment.rb', line 420

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



426
427
428
429
430
431
432
433
434
 
# File 'lib/budgea_client/models/investment.rb', line 426

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



414
415
416
 
# File 'lib/budgea_client/models/investment.rb', line 414

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



298
299
300
301
302
303
304
 
# File 'lib/budgea_client/models/investment.rb', line 298

def valid?
  return false if @id.nil?
  return false if @id_account.nil?
  return false if @label.nil?
  return false if @code.nil?
  true
end