Class: NucleusApi::PortfolioHoldingLog

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

Overview

PortfolioHoldingLog Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PortfolioHoldingLog

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

accountId



19
20
21
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 19

def 
  @account_id
end

#amount ⇒ Object

amount



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

def amount
  @amount
end

#cost_basis ⇒ Object

cost_basis



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

def cost_basis
  @cost_basis
end

#create_date ⇒ Object

Returns the value of attribute create_date.



27
28
29
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 27

def create_date
  @create_date
end

#currency_code ⇒ Object

currency_code



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

def currency_code
  @currency_code
end

#date ⇒ Object

date



33
34
35
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 33

def date
  @date
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#model_id ⇒ Object

modelId



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

def model_id
  @model_id
end

#portfolio_id ⇒ Object

portfolioId



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

def portfolio_id
  @portfolio_id
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



43
44
45
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 43

def secondary_id
  @secondary_id
end

#security_id ⇒ Object

securityId



46
47
48
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 46

def security_id
  @security_id
end

#shares ⇒ Object

shares



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

def shares
  @shares
end

#update_date ⇒ Object

Returns the value of attribute update_date.



51
52
53
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 51

def update_date
  @update_date
end

#weight ⇒ Object

weight



54
55
56
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 54

def weight
  @weight
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 57

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'amount' => :'amount',
    :'cost_basis' => :'cost_basis',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'date' => :'date',
    :'id' => :'id',
    :'model_id' => :'model_id',
    :'portfolio_id' => :'portfolio_id',
    :'secondary_id' => :'secondary_id',
    :'security_id' => :'security_id',
    :'shares' => :'shares',
    :'update_date' => :'update_date',
    :'weight' => :'weight'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'account_id' => :'String',
    :'amount' => :'Float',
    :'cost_basis' => :'Float',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'date' => :'DateTime',
    :'id' => :'String',
    :'model_id' => :'String',
    :'portfolio_id' => :'String',
    :'secondary_id' => :'String',
    :'security_id' => :'String',
    :'shares' => :'Float',
    :'update_date' => :'DateTime',
    :'weight' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      amount == o.amount &&
      cost_basis == o.cost_basis &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      date == o.date &&
      id == o.id &&
      model_id == o.model_id &&
      portfolio_id == o.portfolio_id &&
      secondary_id == o.secondary_id &&
      security_id == o.security_id &&
      shares == o.shares &&
      update_date == o.update_date &&
      weight == o.weight
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 325

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 240

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


227
228
229
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



233
234
235
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 233

def hash
  [, amount, cost_basis, create_date, currency_code, date, id, model_id, portfolio_id, secondary_id, security_id, shares, update_date, weight].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



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

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

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



306
307
308
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 306

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



312
313
314
315
316
317
318
319
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 312

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



300
301
302
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 300

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



194
195
196
197
198
199
200
201
202
 
# File 'lib/nucleus_api/models/portfolio_holding_log.rb', line 194

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 @security_id.nil?
  return false if @shares.nil?
  true
end