Class: NucleusApi::PortfolioTransaction

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

Overview

PortfolioTransaction Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PortfolioTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
272
273
274
275
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 197

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'transaction_code_id')
    self.transaction_code_id = attributes[:'transaction_code_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/portfolio_transaction.rb', line 19

def 
  @account_id
end

#amount ⇒ Object

amount



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

def amount
  @amount
end

#balance ⇒ Object

balance



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

def balance
  @balance
end

#category ⇒ Object

category



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

def category
  @category
end

#check ⇒ Object

Returns the value of attribute check.



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

def check
  @check
end

#create_date ⇒ Object

Returns the value of attribute create_date.



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

def create_date
  @create_date
end

#currency_code ⇒ Object

currency_code



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

def currency_code
  @currency_code
end

#date ⇒ Object

date



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

def date
  @date
end

#date_available ⇒ Object

dateAvailable



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

def date_available
  @date_available
end

#description ⇒ Object

description



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

def description
  @description
end

#funding_id ⇒ Object

fundingId



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

def funding_id
  @funding_id
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#is_cleansed ⇒ Object

is_cleansed



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

def is_cleansed
  @is_cleansed
end

#is_disputed ⇒ Object

is_disputed



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

def is_disputed
  @is_disputed
end

#is_read ⇒ Object

isRead



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

def is_read
  @is_read
end

#is_recurring ⇒ Object

is_recurring



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

def is_recurring
  @is_recurring
end

#location ⇒ Object

location



64
65
66
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 64

def location
  @location
end

#memo ⇒ Object

memo



67
68
69
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 67

def memo
  @memo
end

#merchant ⇒ Object

merchant



70
71
72
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 70

def merchant
  @merchant
end

#merchant_category_code ⇒ Object

merchant_category_code



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

def merchant_category_code
  @merchant_category_code
end

#merchant_id ⇒ Object

merchantId



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

def merchant_id
  @merchant_id
end

#metadata ⇒ Object

metadata



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

def metadata
  @metadata
end

#mid ⇒ Object

mid



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

def mid
  @mid
end

#model_id ⇒ Object

modelId



85
86
87
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 85

def model_id
  @model_id
end

#portfolio_id ⇒ Object

portfolioId



88
89
90
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 88

def portfolio_id
  @portfolio_id
end

#price ⇒ Object

price



91
92
93
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 91

def price
  @price
end

#quantity ⇒ Object

quantity



94
95
96
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 94

def quantity
  @quantity
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



96
97
98
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 96

def secondary_id
  @secondary_id
end

#security_id ⇒ Object

securityId



99
100
101
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 99

def security_id
  @security_id
end

#status ⇒ Object

status



102
103
104
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 102

def status
  @status
end

#subcategory ⇒ Object

subcategory



105
106
107
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 105

def subcategory
  @subcategory
end

#transaction_category_id ⇒ Object

transactionCategoryId



108
109
110
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 108

def transaction_category_id
  @transaction_category_id
end

#transaction_code_id ⇒ Object

alertId



111
112
113
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 111

def transaction_code_id
  @transaction_code_id
end

#update_date ⇒ Object

Returns the value of attribute update_date.



113
114
115
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 113

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'amount' => :'amount',
    :'balance' => :'balance',
    :'category' => :'category',
    :'check' => :'check',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'date' => :'date',
    :'date_available' => :'date_available',
    :'description' => :'description',
    :'funding_id' => :'funding_id',
    :'id' => :'id',
    :'is_cleansed' => :'is_cleansed',
    :'is_disputed' => :'is_disputed',
    :'is_read' => :'is_read',
    :'is_recurring' => :'is_recurring',
    :'location' => :'location',
    :'memo' => :'memo',
    :'merchant' => :'merchant',
    :'merchant_category_code' => :'merchant_category_code',
    :'merchant_id' => :'merchant_id',
    :'metadata' => :'metadata',
    :'mid' => :'mid',
    :'model_id' => :'model_id',
    :'portfolio_id' => :'portfolio_id',
    :'price' => :'price',
    :'quantity' => :'quantity',
    :'secondary_id' => :'secondary_id',
    :'security_id' => :'security_id',
    :'status' => :'status',
    :'subcategory' => :'subcategory',
    :'transaction_category_id' => :'transaction_category_id',
    :'transaction_code_id' => :'transaction_code_id',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'account_id' => :'String',
    :'amount' => :'Float',
    :'balance' => :'Float',
    :'category' => :'String',
    :'check' => :'Check',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'date' => :'DateTime',
    :'date_available' => :'DateTime',
    :'description' => :'String',
    :'funding_id' => :'String',
    :'id' => :'String',
    :'is_cleansed' => :'BOOLEAN',
    :'is_disputed' => :'BOOLEAN',
    :'is_read' => :'BOOLEAN',
    :'is_recurring' => :'BOOLEAN',
    :'location' => :'Location',
    :'memo' => :'String',
    :'merchant' => :'String',
    :'merchant_category_code' => :'Integer',
    :'merchant_id' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'mid' => :'String',
    :'model_id' => :'String',
    :'portfolio_id' => :'String',
    :'price' => :'Float',
    :'quantity' => :'Float',
    :'secondary_id' => :'String',
    :'security_id' => :'String',
    :'status' => :'String',
    :'subcategory' => :'String',
    :'transaction_category_id' => :'String',
    :'transaction_code_id' => :'String',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
411
412
413
414
415
416
417
418
419
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 382

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      amount == o.amount &&
      balance == o.balance &&
      category == o.category &&
      check == o.check &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      date == o.date &&
      date_available == o.date_available &&
      description == o.description &&
      funding_id == o.funding_id &&
      id == o.id &&
      is_cleansed == o.is_cleansed &&
      is_disputed == o.is_disputed &&
      is_read == o.is_read &&
      is_recurring == o.is_recurring &&
      location == o.location &&
      memo == o.memo &&
      merchant == o.merchant &&
      merchant_category_code == o.merchant_category_code &&
      merchant_id == o.merchant_id &&
      metadata == o.metadata &&
      mid == o.mid &&
      model_id == o.model_id &&
      portfolio_id == o.portfolio_id &&
      price == o.price &&
      quantity == o.quantity &&
      secondary_id == o.secondary_id &&
      security_id == o.security_id &&
      status == o.status &&
      subcategory == o.subcategory &&
      transaction_category_id == o.transaction_category_id &&
      transaction_code_id == o.transaction_code_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



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 455

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



521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 521

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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 436

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


423
424
425
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 423

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



429
430
431
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 429

def hash
  [, amount, balance, category, check, create_date, currency_code, date, date_available, description, funding_id, id, is_cleansed, is_disputed, is_read, is_recurring, location, memo, merchant, merchant_category_code, merchant_id, metadata, mid, model_id, portfolio_id, price, quantity, secondary_id, security_id, status, subcategory, transaction_category_id, transaction_code_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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 344

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

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

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

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

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



502
503
504
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 502

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



508
509
510
511
512
513
514
515
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 508

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



496
497
498
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 496

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



371
372
373
374
375
376
377
378
 
# File 'lib/nucleus_api/models/portfolio_transaction.rb', line 371

def valid?
  return false if @account_id.nil?
  return false if @date.nil?
  return false if @model_id.nil?
  return false if @portfolio_id.nil?
  return false if @transaction_code_id.nil?
  true
end