Class: MoneyKit::InvestmentTransactionResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/moneykit/models/investment_transaction_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvestmentTransactionResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
106
107
108
109
110
111
112
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
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 103

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MoneyKit::InvestmentTransactionResponse` 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 `MoneyKit::InvestmentTransactionResponse`. 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']
  else
    self.investment_transaction_id = nil
  end

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

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

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

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

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  else
    self.description = nil
  end

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account in which this investment transaction occurred.



22
23
24
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 22

def 
  @account_id
end

#amount ⇒ Object

The total value of this transaction, denominated in account currency. Positive values indicate debits (withdrawals); negative values are credits (deposits). When a transaction has both quantity and price, the amount should be equal to ‘quantity * price + fees`.



25
26
27
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 25

def amount
  @amount
end

#date ⇒ Object

The effective (posted) date of the transaction, in ISO-8601 format.



28
29
30
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 28

def date
  @date
end

#datetime ⇒ Object

If the institution has provided the actual time of the transaction, this field contains the full date and time of the transaction, in ISO-8601 format. If the time is not available, this field will be null. <p>Note that the time is generally reported in the timezone of the institution or the account holder.



31
32
33
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 31

def datetime
  @datetime
end

#description ⇒ Object

A normalized, cleaned transaction description suitable for presentation to the end user.



34
35
36
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 34

def description
  @description
end

#fees ⇒ Object

The combined value of any fees applied to the transaction. Fees are reported as positive values; refunds are reported as negative values.



40
41
42
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 40

def fees
  @fees
end

#forex_rate ⇒ Object

The currency exchange rate applied. Only present for transactions involving a security that is denominated in a currency other than the account currency.



43
44
45
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 43

def forex_rate
  @forex_rate
end

#investment_transaction_id ⇒ Object

The unique ID for this investment transaction.



19
20
21
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 19

def investment_transaction_id
  @investment_transaction_id
end

#price ⇒ Object

The price per share, denominated in account currency. Omitted for transactions not involving a security.



46
47
48
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 46

def price
  @price
end

#quantity ⇒ Object

The units of security (aka "shares") bought, sold, or transferred. Omitted for transactions not involving a security. Positive values indicate shares added to the account.



49
50
51
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 49

def quantity
  @quantity
end

#security_id ⇒ Object

The MoneyKit ID of the security involved in this transaction (for example, the security bought or sold, or upon which interest or dividends are paid.



52
53
54
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 52

def security_id
  @security_id
end

#type ⇒ Object

The type of transaction (buy, sell, cash, fee, transfer). May include a dotted subtype, for example, ‘buy.buy_to_cover` or `fee.transfer_fee`.



37
38
39
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 37

def type
  @type
end

Class Method Details

._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



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
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 280

def self._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 = MoneyKit.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 55

def self.attribute_map
  {
    :'investment_transaction_id' => :'investment_transaction_id',
    :'account_id' => :'account_id',
    :'amount' => :'amount',
    :'date' => :'date',
    :'datetime' => :'datetime',
    :'description' => :'description',
    :'type' => :'type',
    :'fees' => :'fees',
    :'forex_rate' => :'forex_rate',
    :'price' => :'price',
    :'quantity' => :'quantity',
    :'security_id' => :'security_id'
  }
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 256

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 96

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 78

def self.openapi_types
  {
    :'investment_transaction_id' => :'String',
    :'account_id' => :'String',
    :'amount' => :'String',
    :'date' => :'Date',
    :'datetime' => :'Time',
    :'description' => :'String',
    :'type' => :'String',
    :'fees' => :'String',
    :'forex_rate' => :'String',
    :'price' => :'String',
    :'quantity' => :'String',
    :'security_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      investment_transaction_id == o.investment_transaction_id &&
       == o. &&
      amount == o.amount &&
      date == o.date &&
      datetime == o.datetime &&
      description == o.description &&
      type == o.type &&
      fees == o.fees &&
      forex_rate == o.forex_rate &&
      price == o.price &&
      quantity == o.quantity &&
      security_id == o.security_id
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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 351

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


243
244
245
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 249

def hash
  [investment_transaction_id, , amount, date, datetime, description, type, fees, forex_rate, price, quantity, security_id].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



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
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 179

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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 @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

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

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

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



327
328
329
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 327

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 333

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



321
322
323
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 321

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
215
216
217
218
219
220
 
# File 'lib/moneykit/models/investment_transaction_response.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @investment_transaction_id.nil?
  return false if @account_id.nil?
  return false if @amount.nil?
  return false if @date.nil?
  return false if @description.nil?
  return false if @type.nil?
  true
end