Class: FinnhubRuby::BondTickData

Inherits:
Object
  • Object
show all
Defined in:
lib/finnhub_ruby/models/bond_tick_data.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BondTickData

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
176
177
178
179
180
181
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 103

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ats ⇒ Object

ATS flag. Y or empty



49
50
51
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 49

def ats
  @ats
end

#c ⇒ Object

List of trade conditions. A comprehensive list of trade conditions code can be found <a target="_blank" href="docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing">here</a>



52
53
54
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 52

def c
  @c
end

#count ⇒ Object

Number of ticks returned. If count < limit, all data for that date has been returned.



22
23
24
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 22

def count
  @count
end

#cp ⇒ Object

List of values showing the counterparty of each trade. List of supported values: <a target="_blank" href="docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing",>here</a>



43
44
45
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 43

def cp
  @cp
end

#p ⇒ Object

List of price data.



31
32
33
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 31

def p
  @p
end

#rp ⇒ Object

List of values showing the reporting party of each trade. List of supported values: <a target="_blank" href="docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing",>here</a>



46
47
48
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 46

def rp
  @rp
end

#si ⇒ Object

List of values showing the side (Buy/sell) of each trade. List of supported values: <a target="_blank" href="docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing",>here</a>



40
41
42
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 40

def si
  @si
end

#skip ⇒ Object

Number of ticks skipped.



19
20
21
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 19

def skip
  @skip
end

#t ⇒ Object

List of timestamp in UNIX ms.



37
38
39
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 37

def t
  @t
end

#total ⇒ Object

Total number of ticks for that date.



25
26
27
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 25

def total
  @total
end

#v ⇒ Object

List of volume data.



28
29
30
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 28

def v
  @v
end

#y ⇒ Object

List of yield data.



34
35
36
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 34

def y
  @y
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/finnhub_ruby/models/bond_tick_data.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/finnhub_ruby/models/bond_tick_data.rb', line 55

def self.attribute_map
  {
    :'skip' => :'skip',
    :'count' => :'count',
    :'total' => :'total',
    :'v' => :'v',
    :'p' => :'p',
    :'y' => :'y',
    :'t' => :'t',
    :'si' => :'si',
    :'cp' => :'cp',
    :'rp' => :'rp',
    :'ats' => :'ats',
    :'c' => :'c'
  }
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



230
231
232
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 230

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/finnhub_ruby/models/bond_tick_data.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/finnhub_ruby/models/bond_tick_data.rb', line 78

def self.openapi_types
  {
    :'skip' => :'Integer',
    :'count' => :'Integer',
    :'total' => :'Integer',
    :'v' => :'Array<Float>',
    :'p' => :'Array<Float>',
    :'y' => :'Array<Float>',
    :'t' => :'Array<Integer>',
    :'si' => :'Array<String>',
    :'cp' => :'Array<String>',
    :'rp' => :'Array<String>',
    :'ats' => :'Array<String>',
    :'c' => :'Array<Array<String>>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      skip == o.skip &&
      count == o.count &&
      total == o.total &&
      v == o.v &&
      p == o.p &&
      y == o.y &&
      t == o.t &&
      si == o.si &&
      cp == o.cp &&
      rp == o.rp &&
      ats == o.ats &&
      c == o.c
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



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
296
297
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 260

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 331

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 237

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


217
218
219
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 223

def hash
  [skip, count, total, v, p, y, t, si, cp, rp, ats, c].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



185
186
187
188
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 185

def list_invalid_properties
  invalid_properties = Array.new
  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



307
308
309
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 307

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 313

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



301
302
303
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 301

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



192
193
194
 
# File 'lib/finnhub_ruby/models/bond_tick_data.rb', line 192

def valid?
  true
end