Class: MxPlatformRuby::HoldingResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/mx-platform-ruby/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



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
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
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 129

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_guidObject

Returns the value of attribute account_guid.



18
19
20
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 18

def 
  @account_guid
end

#cost_basisObject

Returns the value of attribute cost_basis.



20
21
22
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 20

def cost_basis
  @cost_basis
end

#created_atObject

Returns the value of attribute created_at.



22
23
24
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 22

def created_at
  @created_at
end

#currency_codeObject

Returns the value of attribute currency_code.



24
25
26
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 24

def currency_code
  @currency_code
end

#cusipObject

Returns the value of attribute cusip.



26
27
28
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 26

def cusip
  @cusip
end

#daily_changeObject

Returns the value of attribute daily_change.



28
29
30
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 28

def daily_change
  @daily_change
end

#descriptionObject

Returns the value of attribute description.



30
31
32
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 30

def description
  @description
end

#guidObject

Returns the value of attribute guid.



32
33
34
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 32

def guid
  @guid
end

#holding_typeObject

Returns the value of attribute holding_type.



34
35
36
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 34

def holding_type
  @holding_type
end

#idObject

Returns the value of attribute id.



36
37
38
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 36

def id
  @id
end

#market_valueObject

Returns the value of attribute market_value.



38
39
40
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 38

def market_value
  @market_value
end

#member_guidObject

Returns the value of attribute member_guid.



40
41
42
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 40

def member_guid
  @member_guid
end

#metadataObject

Returns the value of attribute metadata.



42
43
44
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 42

def 
  @metadata
end

#purchase_priceObject

Returns the value of attribute purchase_price.



44
45
46
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 44

def purchase_price
  @purchase_price
end

#sharesObject

Returns the value of attribute shares.



46
47
48
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 46

def shares
  @shares
end

#symbolObject

Returns the value of attribute symbol.



48
49
50
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 48

def symbol
  @symbol
end

#updated_atObject

Returns the value of attribute updated_at.



50
51
52
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 50

def updated_at
  @updated_at
end

#user_guidObject

Returns the value of attribute user_guid.



52
53
54
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 52

def user_guid
  @user_guid
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



79
80
81
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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
71
72
73
74
75
76
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 55

def self.attribute_map
  {
    :'account_guid' => :'account_guid',
    :'cost_basis' => :'cost_basis',
    :'created_at' => :'created_at',
    :'currency_code' => :'currency_code',
    :'cusip' => :'cusip',
    :'daily_change' => :'daily_change',
    :'description' => :'description',
    :'guid' => :'guid',
    :'holding_type' => :'holding_type',
    :'id' => :'id',
    :'market_value' => :'market_value',
    :'member_guid' => :'member_guid',
    :'metadata' => :'metadata',
    :'purchase_price' => :'purchase_price',
    :'shares' => :'shares',
    :'symbol' => :'symbol',
    :'updated_at' => :'updated_at',
    :'user_guid' => :'user_guid'
  }
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



268
269
270
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 268

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

.openapi_nullableObject

List of attributes with nullable: true



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 108

def self.openapi_nullable
  Set.new([
    :'cost_basis',
    :'created_at',
    :'currency_code',
    :'cusip',
    :'daily_change',
    :'description',
    :'holding_type',
    :'id',
    :'market_value',
    :'metadata',
    :'purchase_price',
    :'shares',
    :'symbol',
    :'updated_at',
  ])
end

.openapi_typesObject

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 84

def self.openapi_types
  {
    :'account_guid' => :'String',
    :'cost_basis' => :'Float',
    :'created_at' => :'String',
    :'currency_code' => :'String',
    :'cusip' => :'String',
    :'daily_change' => :'Float',
    :'description' => :'String',
    :'guid' => :'String',
    :'holding_type' => :'String',
    :'id' => :'String',
    :'market_value' => :'Float',
    :'member_guid' => :'String',
    :'metadata' => :'String',
    :'purchase_price' => :'Float',
    :'shares' => :'Float',
    :'symbol' => :'String',
    :'updated_at' => :'String',
    :'user_guid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      cost_basis == o.cost_basis &&
      created_at == o.created_at &&
      currency_code == o.currency_code &&
      cusip == o.cusip &&
      daily_change == o.daily_change &&
      description == o.description &&
      guid == o.guid &&
      holding_type == o.holding_type &&
      id == o.id &&
      market_value == o.market_value &&
      member_guid == o.member_guid &&
       == o. &&
      purchase_price == o.purchase_price &&
      shares == o.shares &&
      symbol == o.symbol &&
      updated_at == o.updated_at &&
      user_guid == o.user_guid
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



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
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 298

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 = MxPlatformRuby.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



369
370
371
372
373
374
375
376
377
378
379
380
381
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 369

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 275

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


255
256
257
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 255

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



261
262
263
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 261

def hash
  [, cost_basis, created_at, currency_code, cusip, daily_change, description, guid, holding_type, id, market_value, member_guid, , purchase_price, shares, symbol, updated_at, user_guid].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



217
218
219
220
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 217

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



345
346
347
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 345

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



351
352
353
354
355
356
357
358
359
360
361
362
363
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 351

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



339
340
341
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 339

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



224
225
226
# File 'lib/mx-platform-ruby/models/holding_response.rb', line 224

def valid?
  true
end