Class: Plaid::InvestmentTransaction

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/investment_transaction.rb

Overview

A transaction within an investment account.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvestmentTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/plaid/models/investment_transaction.rb', line 145

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::InvestmentTransaction` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::InvestmentTransaction`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'investment_transaction_id')
    self.investment_transaction_id = attributes[:'investment_transaction_id']
  end

  if attributes.key?(:'cancel_transaction_id')
    self.cancel_transaction_id = attributes[:'cancel_transaction_id']
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  end

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

  if attributes.key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.key?(:'transaction_datetime')
    self.transaction_datetime = attributes[:'transaction_datetime']
  end

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

  if attributes.key?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

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

  if attributes.key?(:'price')
    self.price = attributes[:'price']
  end

  if attributes.key?(:'fees')
    self.fees = attributes[:'fees']
  end

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

  if attributes.key?(:'subtype')
    self.subtype = attributes[:'subtype']
  end

  if attributes.key?(:'iso_currency_code')
    self.iso_currency_code = attributes[:'iso_currency_code']
  end

  if attributes.key?(:'unofficial_currency_code')
    self.unofficial_currency_code = attributes[:'unofficial_currency_code']
  end
end

Instance Attribute Details

#account_id ⇒ Object

The ‘account_id` of the account against which this transaction posted.



26
27
28
 
# File 'lib/plaid/models/investment_transaction.rb', line 26

def 
  @account_id
end

#amount ⇒ Object

The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities.



44
45
46
 
# File 'lib/plaid/models/investment_transaction.rb', line 44

def amount
  @amount
end

#cancel_transaction_id ⇒ Object

A legacy field formerly used internally by Plaid to identify certain canceled transactions.



23
24
25
 
# File 'lib/plaid/models/investment_transaction.rb', line 23

def cancel_transaction_id
  @cancel_transaction_id
end

#date ⇒ Object

The [ISO 8601](wikipedia.org/wiki/ISO_8601) posting date for the transaction. This is typically the settlement date.



32
33
34
 
# File 'lib/plaid/models/investment_transaction.rb', line 32

def date
  @date
end

#fees ⇒ Object

The combined value of all fees applied to this transaction



50
51
52
 
# File 'lib/plaid/models/investment_transaction.rb', line 50

def fees
  @fees
end

#investment_transaction_id ⇒ Object

The ID of the Investment transaction, unique across all Plaid transactions. Like all Plaid identifiers, the ‘investment_transaction_id` is case sensitive.



20
21
22
 
# File 'lib/plaid/models/investment_transaction.rb', line 20

def investment_transaction_id
  @investment_transaction_id
end

#iso_currency_code ⇒ Object

The ISO-4217 currency code of the transaction. Always ‘null` if `unofficial_currency_code` is non-`null`.



57
58
59
 
# File 'lib/plaid/models/investment_transaction.rb', line 57

def iso_currency_code
  @iso_currency_code
end

#name ⇒ Object

The institution’s description of the transaction.



38
39
40
 
# File 'lib/plaid/models/investment_transaction.rb', line 38

def name
  @name
end

#price ⇒ Object

The price of the security at which this transaction occurred.



47
48
49
 
# File 'lib/plaid/models/investment_transaction.rb', line 47

def price
  @price
end

#quantity ⇒ Object

The number of units of the security involved in this transaction. Positive for buy transactions; negative for sell transactions.



41
42
43
 
# File 'lib/plaid/models/investment_transaction.rb', line 41

def quantity
  @quantity
end

#security_id ⇒ Object

The ‘security_id` to which this transaction is related.



29
30
31
 
# File 'lib/plaid/models/investment_transaction.rb', line 29

def security_id
  @security_id
end

#subtype ⇒ Object

Returns the value of attribute subtype.



54
55
56
 
# File 'lib/plaid/models/investment_transaction.rb', line 54

def subtype
  @subtype
end

#transaction_datetime ⇒ Object

Timestamp in [ISO 8601](wikipedia.org/wiki/ISO_8601) format (‘YYYY-MM-DDTHH:mm:ssZ`) representing when the order type was initiated. This field is returned for select financial institutions and reflects the value provided by the institution.



35
36
37
 
# File 'lib/plaid/models/investment_transaction.rb', line 35

def transaction_datetime
  @transaction_datetime
end

#type ⇒ Object

Returns the value of attribute type.



52
53
54
 
# File 'lib/plaid/models/investment_transaction.rb', line 52

def type
  @type
end

#unofficial_currency_code ⇒ Object

The unofficial currency code associated with the holding. Always ‘null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.



60
61
62
 
# File 'lib/plaid/models/investment_transaction.rb', line 60

def unofficial_currency_code
  @unofficial_currency_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



106
107
108
 
# File 'lib/plaid/models/investment_transaction.rb', line 106

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'investment_transaction_id' => :'investment_transaction_id',
    :'cancel_transaction_id' => :'cancel_transaction_id',
    :'account_id' => :'account_id',
    :'security_id' => :'security_id',
    :'date' => :'date',
    :'transaction_datetime' => :'transaction_datetime',
    :'name' => :'name',
    :'quantity' => :'quantity',
    :'amount' => :'amount',
    :'price' => :'price',
    :'fees' => :'fees',
    :'type' => :'type',
    :'subtype' => :'subtype',
    :'iso_currency_code' => :'iso_currency_code',
    :'unofficial_currency_code' => :'unofficial_currency_code'
  }
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



314
315
316
 
# File 'lib/plaid/models/investment_transaction.rb', line 314

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/plaid/models/investment_transaction.rb', line 132

def self.openapi_nullable
  Set.new([
    :'cancel_transaction_id',
    :'security_id',
    :'transaction_datetime',
    :'fees',
    :'iso_currency_code',
    :'unofficial_currency_code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/plaid/models/investment_transaction.rb', line 111

def self.openapi_types
  {
    :'investment_transaction_id' => :'String',
    :'cancel_transaction_id' => :'String',
    :'account_id' => :'String',
    :'security_id' => :'String',
    :'date' => :'Date',
    :'transaction_datetime' => :'Time',
    :'name' => :'String',
    :'quantity' => :'Float',
    :'amount' => :'Float',
    :'price' => :'Float',
    :'fees' => :'Float',
    :'type' => :'InvestmentTransactionType',
    :'subtype' => :'InvestmentTransactionSubtype',
    :'iso_currency_code' => :'String',
    :'unofficial_currency_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/plaid/models/investment_transaction.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      investment_transaction_id == o.investment_transaction_id &&
      cancel_transaction_id == o.cancel_transaction_id &&
       == o. &&
      security_id == o.security_id &&
      date == o.date &&
      transaction_datetime == o.transaction_datetime &&
      name == o.name &&
      quantity == o.quantity &&
      amount == o.amount &&
      price == o.price &&
      fees == o.fees &&
      type == o.type &&
      subtype == o.subtype &&
      iso_currency_code == o.iso_currency_code &&
      unofficial_currency_code == o.unofficial_currency_code
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



345
346
347
348
349
350
351
352
353
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
 
# File 'lib/plaid/models/investment_transaction.rb', line 345

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/plaid/models/investment_transaction.rb', line 416

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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/plaid/models/investment_transaction.rb', line 321

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


301
302
303
 
# File 'lib/plaid/models/investment_transaction.rb', line 301

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



307
308
309
 
# File 'lib/plaid/models/investment_transaction.rb', line 307

def hash
  [investment_transaction_id, cancel_transaction_id, , security_id, date, transaction_datetime, name, quantity, amount, price, fees, type, subtype, iso_currency_code, unofficial_currency_code].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



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
 
# File 'lib/plaid/models/investment_transaction.rb', line 221

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

  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 @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

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

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

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

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

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



392
393
394
 
# File 'lib/plaid/models/investment_transaction.rb', line 392

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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/plaid/models/investment_transaction.rb', line 398

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



386
387
388
 
# File 'lib/plaid/models/investment_transaction.rb', line 386

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



264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/plaid/models/investment_transaction.rb', line 264

def valid?
  return false if @investment_transaction_id.nil?
  return false if @account_id.nil?
  return false if @date.nil?
  return false if @name.nil?
  return false if @quantity.nil?
  return false if @amount.nil?
  return false if @price.nil?
  return false if @type.nil?
  return false if @subtype.nil?
  true
end