Class: MoneyKit::HoldingResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HoldingResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
122
123
124
 
# File 'lib/moneykit/models/holding_response.rb', line 78

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The MoneyKit ID of the account for this holding.



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

def 
  @account_id
end

#cost_basis ⇒ Object

The total purchase cost of the holding, as reported by the institution, denominated in account currency.



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

def cost_basis
  @cost_basis
end

#price ⇒ Object

The per-share price of this holding, as reported by the institution, denominated in account currency.



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

def price
  @price
end

#price_datetime ⇒ Object

The timestamp for which the institution-reported price is valid.



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

def price_datetime
  @price_datetime
end

#quantity ⇒ Object

The units of this security (aka "shares") held.



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

def quantity
  @quantity
end

#security_id ⇒ Object

The MoneyKit ID of the security for this holding.



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

def security_id
  @security_id
end

#value ⇒ Object

The value of this holding, as reported by the institution, denominated in account currency.



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

def value
  @value
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



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

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



53
54
55
 
# File 'lib/moneykit/models/holding_response.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/moneykit/models/holding_response.rb', line 40

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'security_id' => :'security_id',
    :'quantity' => :'quantity',
    :'price' => :'price',
    :'price_datetime' => :'price_datetime',
    :'value' => :'value',
    :'cost_basis' => :'cost_basis'
  }
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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/moneykit/models/holding_response.rb', line 185

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



71
72
73
74
 
# File 'lib/moneykit/models/holding_response.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/moneykit/models/holding_response.rb', line 58

def self.openapi_types
  {
    :'account_id' => :'String',
    :'security_id' => :'String',
    :'quantity' => :'String',
    :'price' => :'String',
    :'price_datetime' => :'Time',
    :'value' => :'String',
    :'cost_basis' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/moneykit/models/holding_response.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      security_id == o.security_id &&
      quantity == o.quantity &&
      price == o.price &&
      price_datetime == o.price_datetime &&
      value == o.value &&
      cost_basis == o.cost_basis
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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/moneykit/models/holding_response.rb', line 280

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


172
173
174
 
# File 'lib/moneykit/models/holding_response.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



178
179
180
 
# File 'lib/moneykit/models/holding_response.rb', line 178

def hash
  [, security_id, quantity, price, price_datetime, value, cost_basis].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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/moneykit/models/holding_response.rb', line 128

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

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

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



256
257
258
 
# File 'lib/moneykit/models/holding_response.rb', line 256

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/moneykit/models/holding_response.rb', line 262

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



250
251
252
 
# File 'lib/moneykit/models/holding_response.rb', line 250

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



148
149
150
151
152
153
154
 
# File 'lib/moneykit/models/holding_response.rb', line 148

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  return false if @security_id.nil?
  return false if @quantity.nil?
  true
end