Class: NucleusApi::SecurityPrice

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecurityPrice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

  if attributes.has_key?(:'price')
    self.price = attributes[:'price']
  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?(:'update_date')
    self.update_date = attributes[:'update_date']
  end

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

Instance Attribute Details

#adjusted_price ⇒ Object

Security adjusted price



18
19
20
 
# File 'lib/nucleus_api/models/security_price.rb', line 18

def adjusted_price
  @adjusted_price
end

#create_date ⇒ Object

Returns the value of attribute create_date.



20
21
22
 
# File 'lib/nucleus_api/models/security_price.rb', line 20

def create_date
  @create_date
end

#currency_code ⇒ Object

currency_code



23
24
25
 
# File 'lib/nucleus_api/models/security_price.rb', line 23

def currency_code
  @currency_code
end

#date ⇒ Object

Security date



26
27
28
 
# File 'lib/nucleus_api/models/security_price.rb', line 26

def date
  @date
end

#high ⇒ Object

high



29
30
31
 
# File 'lib/nucleus_api/models/security_price.rb', line 29

def high
  @high
end

#id ⇒ Object

Returns the value of attribute id.



31
32
33
 
# File 'lib/nucleus_api/models/security_price.rb', line 31

def id
  @id
end

#low ⇒ Object

low



34
35
36
 
# File 'lib/nucleus_api/models/security_price.rb', line 34

def low
  @low
end

#open ⇒ Object

open



37
38
39
 
# File 'lib/nucleus_api/models/security_price.rb', line 37

def open
  @open
end

#price ⇒ Object

Security price



40
41
42
 
# File 'lib/nucleus_api/models/security_price.rb', line 40

def price
  @price
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



42
43
44
 
# File 'lib/nucleus_api/models/security_price.rb', line 42

def secondary_id
  @secondary_id
end

#security_id ⇒ Object

Security id



45
46
47
 
# File 'lib/nucleus_api/models/security_price.rb', line 45

def security_id
  @security_id
end

#update_date ⇒ Object

Returns the value of attribute update_date.



47
48
49
 
# File 'lib/nucleus_api/models/security_price.rb', line 47

def update_date
  @update_date
end

#volume ⇒ Object

volume



50
51
52
 
# File 'lib/nucleus_api/models/security_price.rb', line 50

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/nucleus_api/models/security_price.rb', line 53

def self.attribute_map
  {
    :'adjusted_price' => :'adjusted_price',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'date' => :'date',
    :'high' => :'high',
    :'id' => :'id',
    :'low' => :'low',
    :'open' => :'open',
    :'price' => :'price',
    :'secondary_id' => :'secondary_id',
    :'security_id' => :'security_id',
    :'update_date' => :'update_date',
    :'volume' => :'volume'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nucleus_api/models/security_price.rb', line 72

def self.swagger_types
  {
    :'adjusted_price' => :'Float',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'date' => :'DateTime',
    :'high' => :'Float',
    :'id' => :'String',
    :'low' => :'Float',
    :'open' => :'Float',
    :'price' => :'Float',
    :'secondary_id' => :'String',
    :'security_id' => :'String',
    :'update_date' => :'DateTime',
    :'volume' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/nucleus_api/models/security_price.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      adjusted_price == o.adjusted_price &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      date == o.date &&
      high == o.high &&
      id == o.id &&
      low == o.low &&
      open == o.open &&
      price == o.price &&
      secondary_id == o.secondary_id &&
      security_id == o.security_id &&
      update_date == o.update_date &&
      volume == o.volume
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
261
262
263
264
265
266
267
268
269
 
# File 'lib/nucleus_api/models/security_price.rb', line 233

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/nucleus_api/models/security_price.rb', line 299

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/nucleus_api/models/security_price.rb', line 214

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


201
202
203
 
# File 'lib/nucleus_api/models/security_price.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/nucleus_api/models/security_price.rb', line 207

def hash
  [adjusted_price, create_date, currency_code, date, high, id, low, open, price, secondary_id, security_id, update_date, volume].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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/nucleus_api/models/security_price.rb', line 153

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

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

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



280
281
282
 
# File 'lib/nucleus_api/models/security_price.rb', line 280

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



286
287
288
289
290
291
292
293
 
# File 'lib/nucleus_api/models/security_price.rb', line 286

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



274
275
276
 
# File 'lib/nucleus_api/models/security_price.rb', line 274

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



172
173
174
175
176
177
 
# File 'lib/nucleus_api/models/security_price.rb', line 172

def valid?
  return false if @date.nil?
  return false if @price.nil?
  return false if @security_id.nil?
  true
end